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

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>>

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>>

signAndExecuteTransaction

• signAndExecuteTransaction<Include extends TransactionInclude = {}>(
      __namedParameters: {
          additionalSignatures?: string[];
          signer: Signer;
          transaction: Uint8Array<ArrayBufferLike> | Transaction;
      } & Omit<ExecuteTransactionOptions<Include>, "transaction" | "signatures">,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • __namedParameters: {
        additionalSignatures?: string[];
        signer: Signer;
        transaction: Uint8Array<ArrayBufferLike> | Transaction;
    } & Omit<ExecuteTransactionOptions<Include>, "transaction" | "signatures">

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

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>>