Function useSuiClientQueries

Type Parameters

• const Queries extends readonly (
      | {
          method: "resolveNameServiceNames";
          options?: UseSuiClientQueryOptions<"resolveNameServiceNames", unknown>;
          params: ResolveNameServiceNamesParams & { format?: "at" | "dot" };
      }
      | {
          method: "getRpcApiVersion";
          options?: UseSuiClientQueryOptions<"getRpcApiVersion", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getCoins";
          options?: UseSuiClientQueryOptions<"getCoins", unknown>;
          params: GetCoinsParams;
      }
      | {
          method: "getAllCoins";
          options?: UseSuiClientQueryOptions<"getAllCoins", unknown>;
          params: GetAllCoinsParams;
      }
      | {
          method: "getBalance";
          options?: UseSuiClientQueryOptions<"getBalance", unknown>;
          params: GetBalanceParams;
      }
      | {
          method: "getAllBalances";
          options?: UseSuiClientQueryOptions<"getAllBalances", unknown>;
          params: GetAllBalancesParams;
      }
      | {
          method: "getCoinMetadata";
          options?: UseSuiClientQueryOptions<"getCoinMetadata", unknown>;
          params: GetCoinMetadataParams;
      }
      | {
          method: "getTotalSupply";
          options?: UseSuiClientQueryOptions<"getTotalSupply", unknown>;
          params: GetTotalSupplyParams;
      }
      | {
          method: "getMoveFunctionArgTypes";
          options?: UseSuiClientQueryOptions<"getMoveFunctionArgTypes", unknown>;
          params: GetMoveFunctionArgTypesParams;
      }
      | {
          method: "getNormalizedMoveModulesByPackage";
          options?: UseSuiClientQueryOptions<
              "getNormalizedMoveModulesByPackage",
              unknown,
          >;
          params: GetNormalizedMoveModulesByPackageParams;
      }
      | {
          method: "getNormalizedMoveModule";
          options?: UseSuiClientQueryOptions<"getNormalizedMoveModule", unknown>;
          params: GetNormalizedMoveModuleParams;
      }
      | {
          method: "getNormalizedMoveFunction";
          options?: UseSuiClientQueryOptions<"getNormalizedMoveFunction", unknown>;
          params: GetNormalizedMoveFunctionParams;
      }
      | {
          method: "getNormalizedMoveStruct";
          options?: UseSuiClientQueryOptions<"getNormalizedMoveStruct", unknown>;
          params: GetNormalizedMoveStructParams;
      }
      | {
          method: "getOwnedObjects";
          options?: UseSuiClientQueryOptions<"getOwnedObjects", unknown>;
          params: {
              cursor?: null | string;
              limit?: null | number;
              owner: string;
              signal?: AbortSignal;
          } & SuiObjectResponseQuery;
      }
      | {
          method: "getObject";
          options?: UseSuiClientQueryOptions<"getObject", unknown>;
          params: GetObjectParams;
      }
      | {
          method: "tryGetPastObject";
          options?: UseSuiClientQueryOptions<"tryGetPastObject", unknown>;
          params: TryGetPastObjectParams;
      }
      | {
          method: "multiGetObjects";
          options?: UseSuiClientQueryOptions<"multiGetObjects", unknown>;
          params: MultiGetObjectsParams;
      }
      | {
          method: "queryTransactionBlocks";
          options?: UseSuiClientQueryOptions<"queryTransactionBlocks", unknown>;
          params: {
              cursor?: null | string;
              limit?: null | number;
              order?: null | "ascending" | "descending";
              signal?: AbortSignal;
          } & SuiTransactionBlockResponseQuery;
      }
      | {
          method: "getTransactionBlock";
          options?: UseSuiClientQueryOptions<"getTransactionBlock", unknown>;
          params: GetTransactionBlockParams;
      }
      | {
          method: "multiGetTransactionBlocks";
          options?: UseSuiClientQueryOptions<"multiGetTransactionBlocks", unknown>;
          params: MultiGetTransactionBlocksParams;
      }
      | {
          method: "executeTransactionBlock";
          options?: UseSuiClientQueryOptions<"executeTransactionBlock", unknown>;
          params: ExecuteTransactionBlockParams;
      }
      | {
          method: "signAndExecuteTransaction";
          options?: UseSuiClientQueryOptions<"signAndExecuteTransaction", unknown>;
          params: {
              signer: Signer;
              transaction: Uint8Array<ArrayBufferLike> | Transaction;
          } & Omit<ExecuteTransactionBlockParams, "transactionBlock" | "signature">;
      }
      | {
          method: "getTotalTransactionBlocks";
          options?: UseSuiClientQueryOptions<"getTotalTransactionBlocks", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getReferenceGasPrice";
          options?: UseSuiClientQueryOptions<"getReferenceGasPrice", unknown>;
          params: GetReferenceGasPriceParams;
      }
      | {
          method: "getStakes";
          options?: UseSuiClientQueryOptions<"getStakes", unknown>;
          params: GetStakesParams;
      }
      | {
          method: "getStakesByIds";
          options?: UseSuiClientQueryOptions<"getStakesByIds", unknown>;
          params: GetStakesByIdsParams;
      }
      | {
          method: "getLatestSuiSystemState";
          options?: UseSuiClientQueryOptions<"getLatestSuiSystemState", unknown>;
          params: GetLatestSuiSystemStateParams;
      }
      | {
          method: "queryEvents";
          options?: UseSuiClientQueryOptions<"queryEvents", unknown>;
          params: QueryEventsParams;
      }
      | {
          method: "subscribeEvent";
          options?: UseSuiClientQueryOptions<"subscribeEvent", unknown>;
          params: SubscribeEventParams & { onMessage: (event: SuiEvent) => void };
      }
      | {
          method: "subscribeTransaction";
          options?: UseSuiClientQueryOptions<"subscribeTransaction", unknown>;
          params: SubscribeTransactionParams & {
              onMessage: (event: TransactionEffects) => void;
          };
      }
      | {
          method: "devInspectTransactionBlock";
          options?: UseSuiClientQueryOptions<"devInspectTransactionBlock", unknown>;
          params: DevInspectTransactionBlockParams;
      }
      | {
          method: "dryRunTransactionBlock";
          options?: UseSuiClientQueryOptions<"dryRunTransactionBlock", unknown>;
          params: DryRunTransactionBlockParams;
      }
      | {
          method: "getDynamicFields";
          options?: UseSuiClientQueryOptions<"getDynamicFields", unknown>;
          params: GetDynamicFieldsParams;
      }
      | {
          method: "getDynamicFieldObject";
          options?: UseSuiClientQueryOptions<"getDynamicFieldObject", unknown>;
          params: GetDynamicFieldObjectParams;
      }
      | {
          method: "getLatestCheckpointSequenceNumber";
          options?: UseSuiClientQueryOptions<
              "getLatestCheckpointSequenceNumber",
              unknown,
          >;
          params: GetLatestCheckpointSequenceNumberParams;
      }
      | {
          method: "getCheckpoint";
          options?: UseSuiClientQueryOptions<"getCheckpoint", unknown>;
          params: GetCheckpointParams;
      }
      | {
          method: "getCheckpoints";
          options?: UseSuiClientQueryOptions<"getCheckpoints", unknown>;
          params: PaginationArguments<null | string> & GetCheckpointsParams;
      }
      | {
          method: "getCommitteeInfo";
          options?: UseSuiClientQueryOptions<"getCommitteeInfo", unknown>;
          params: GetCommitteeInfoParams;
      }
      | {
          method: "getNetworkMetrics";
          options?: UseSuiClientQueryOptions<"getNetworkMetrics", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getAddressMetrics";
          options?: UseSuiClientQueryOptions<"getAddressMetrics", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getEpochMetrics";
          options?: UseSuiClientQueryOptions<"getEpochMetrics", unknown>;
          params: { descendingOrder?: boolean; signal?: AbortSignal } & PaginationArguments<
              null
              | string,
          >;
      }
      | {
          method: "getAllEpochAddressMetrics";
          options?: UseSuiClientQueryOptions<"getAllEpochAddressMetrics", unknown>;
          params: { descendingOrder?: boolean; signal?: AbortSignal };
      }
      | {
          method: "getEpochs";
          options?: UseSuiClientQueryOptions<"getEpochs", unknown>;
          params: { descendingOrder?: boolean; signal?: AbortSignal } & PaginationArguments<
              null
              | string,
          >;
      }
      | {
          method: "getMoveCallMetrics";
          options?: UseSuiClientQueryOptions<"getMoveCallMetrics", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getCurrentEpoch";
          options?: UseSuiClientQueryOptions<"getCurrentEpoch", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getValidatorsApy";
          options?: UseSuiClientQueryOptions<"getValidatorsApy", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "getChainIdentifier";
          options?: UseSuiClientQueryOptions<"getChainIdentifier", unknown>;
          params: { signal?: AbortSignal };
      }
      | {
          method: "resolveNameServiceAddress";
          options?: UseSuiClientQueryOptions<"resolveNameServiceAddress", unknown>;
          params: ResolveNameServiceAddressParams;
      }
      | {
          method: "getProtocolConfig";
          options?: UseSuiClientQueryOptions<"getProtocolConfig", unknown>;
          params: GetProtocolConfigParams;
      }
      | {
          method: "verifyZkLoginSignature";
          options?: UseSuiClientQueryOptions<"verifyZkLoginSignature", unknown>;
          params: VerifyZkLoginSignatureParams;
      }
      | {
          method: "waitForTransaction";
          options?: UseSuiClientQueryOptions<"waitForTransaction", unknown>;
          params: { pollInterval?: number; signal?: AbortSignal; timeout?: number } & GetTransactionBlockParams;
      }
  )[]
• Results = UseSuiClientQueriesResults<Queries>