Class SuiGraphQLClient<Queries>

constructor

• new SuiGraphQLClient<
      Queries extends
          Record<
              string,
              GraphQLDocument<Record<string, unknown>, Record<string, unknown>>,
          > = {},
  >(
      __namedParameters: SuiGraphQLClientOptions<Queries>,
  ): SuiGraphQLClient<Queries>

  Type Parameters

  • Queries extends Record<
        string,
        GraphQLDocument<Record<string, unknown>, Record<string, unknown>>,
    > = {}

  Parameters

  • __namedParameters: SuiGraphQLClientOptions<Queries>

  Returns SuiGraphQLClient<Queries>

core

mvr

• get mvr(): MvrMethods

  Returns MvrMethods

defaultNameServiceName

• defaultNameServiceName(
      input: DefaultNameServiceNameOptions,
  ): Promise<DefaultNameServiceNameResponse>

  Parameters

  • input: DefaultNameServiceNameOptions

  Returns Promise<DefaultNameServiceNameResponse>

execute

• execute<
      const Query extends string,
      Result = Queries[Query] extends GraphQLDocument<R, unknown>
          ? R
          : Record<string, unknown>,
      Variables = Queries[Query] extends GraphQLDocument<unknown, V>
          ? V
          : Record<string, unknown>,
  >(
      query: Query,
      options: Omit<GraphQLQueryOptions<Result, Variables>, "query">,
  ): Promise<GraphQLQueryResult<Result>>

  Type Parameters

  • const Query extends string
  • Result = Queries[Query] extends GraphQLDocument<R, unknown> ? R : Record<string, unknown>
  • Variables = Queries[Query] extends GraphQLDocument<unknown, V> ? V : Record<string, unknown>

  Parameters

  • query: Query
  • options: Omit<GraphQLQueryOptions<Result, Variables>, "query">

  Returns Promise<GraphQLQueryResult<Result>>

executeTransaction

• executeTransaction<Include extends TransactionInclude = {}>(
      input: ExecuteTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • input: ExecuteTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

getBalance

• getBalance(input: GetBalanceOptions): Promise<GetBalanceResponse>

  Parameters

  • input: GetBalanceOptions

  Returns Promise<GetBalanceResponse>

getDynamicField

• getDynamicField(input: GetDynamicFieldOptions): Promise<GetDynamicFieldResponse>

  Parameters

  • input: GetDynamicFieldOptions

  Returns Promise<GetDynamicFieldResponse>

getMoveFunction

• getMoveFunction(input: GetMoveFunctionOptions): Promise<GetMoveFunctionResponse>

  Parameters

  • input: GetMoveFunctionOptions

  Returns Promise<GetMoveFunctionResponse>

getObject

• getObject<Include extends ObjectInclude = {}>(
      input: GetObjectOptions<Include>,
  ): Promise<GetObjectResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • input: GetObjectOptions<Include>

  Returns Promise<GetObjectResponse<Include>>

getObjects

• getObjects<Include extends ObjectInclude = {}>(
      input: GetObjectsOptions<Include>,
  ): Promise<GetObjectsResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • input: GetObjectsOptions<Include>

  Returns Promise<GetObjectsResponse<Include>>

getReferenceGasPrice

• getReferenceGasPrice(): Promise<GetReferenceGasPriceResponse>

  Returns Promise<GetReferenceGasPriceResponse>

getTransaction

• getTransaction<Include extends TransactionInclude = {}>(
      input: GetTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • input: GetTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

listBalances

• listBalances(input: ListBalancesOptions): Promise<ListBalancesResponse>

  Parameters

  • input: ListBalancesOptions

  Returns Promise<ListBalancesResponse>

listCoins

• listCoins(input: ListCoinsOptions): Promise<ListCoinsResponse>

  Parameters

  • input: ListCoinsOptions

  Returns Promise<ListCoinsResponse>

listDynamicFields

• listDynamicFields(
      input: ListDynamicFieldsOptions,
  ): Promise<ListDynamicFieldsResponse>

  Parameters

  • input: ListDynamicFieldsOptions

  Returns Promise<ListDynamicFieldsResponse>

listOwnedObjects

• listOwnedObjects<Include extends ObjectInclude = {}>(
      input: ListOwnedObjectsOptions<Include>,
  ): Promise<ListOwnedObjectsResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • input: ListOwnedObjectsOptions<Include>

  Returns Promise<ListOwnedObjectsResponse<Include>>

query

• query<Result = Record<string, unknown>, Variables = Record<string, unknown>>(
      options: GraphQLQueryOptions<Result, Variables>,
  ): Promise<GraphQLQueryResult<Result>>

  Type Parameters

  • Result = Record<string, unknown>
  • Variables = Record<string, unknown>

  Parameters

  • options: GraphQLQueryOptions<Result, Variables>

  Returns Promise<GraphQLQueryResult<Result>>

resolveTransactionPlugin

• resolveTransactionPlugin(): TransactionPlugin

  Returns TransactionPlugin

signAndExecuteTransaction

• signAndExecuteTransaction<Include extends TransactionInclude = {}>(
      input: SignAndExecuteTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • input: SignAndExecuteTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

simulateTransaction

• simulateTransaction<Include extends SimulateTransactionInclude = {}>(
      input: SimulateTransactionOptions<Include>,
  ): Promise<SimulateTransactionResult<Include>>

  Type Parameters

  • Include extends SimulateTransactionInclude = {}

  Parameters

  • input: SimulateTransactionOptions<Include>

  Returns Promise<SimulateTransactionResult<Include>>

verifyZkLoginSignature

• verifyZkLoginSignature(
      input: VerifyZkLoginSignatureOptions,
  ): Promise<ZkLoginVerifyResponse>

  Parameters

  • input: VerifyZkLoginSignatureOptions

  Returns Promise<ZkLoginVerifyResponse>

waitForTransaction

• waitForTransaction<Include extends TransactionInclude = {}>(
      input: WaitForTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • input: WaitForTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>