Class SuiGraphQLClient<Queries>

Object methods

Type Parameters

Queries extends Record<string, GraphQLDocument> = {}

Hierarchy (View Summary)

BaseClient
- SuiGraphQLClient

Implements

TransportMethods

Indexable

[key: number]: boolean

Constructors

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>
Overrides BaseClient.constructor
- Defined in packages/sui/src/graphql/client.ts:116

Properties

base

base: BaseClient

cache

cache: ClientCache

core

core: GraphQLCoreClient

network

network: Network

Accessors

mvr

get mvr(): MvrMethods
Returns MvrMethods
Implementation of TransportMethods.mvr
- Defined in packages/sui/src/graphql/client.ts:108

Methods

$extend

$extend<
    const Registrations extends
        SuiClientRegistration<SuiGraphQLClient<Queries>>[],
>(
    ...registrations: Registrations,
): ClientWithExtensions<
    {
        [K in string
        | number
        | symbol]: UnionToIntersection<
            {
                [K in string
                | number
                | symbol]: Registrations[K] extends SuiClientRegistration<
                    SuiGraphQLClient<Queries>,
                    Name,
                    Extension,
                >
                    ? { [K2 in string]: Extension }
                    : never
            }[number],
        >[K]
    },
    SuiGraphQLClient<Queries>,
>
Type Parameters
- const Registrations extends SuiClientRegistration<SuiGraphQLClient<Queries>>[]
Parameters
- ...registrations: Registrations
Returns ClientWithExtensions<
    {
        [K in string
        | number
        | symbol]: UnionToIntersection<
            {
                [K in string
                | number
                | symbol]: Registrations[K] extends SuiClientRegistration<
                    SuiGraphQLClient<Queries>,
                    Name,
                    Extension,
                >
                    ? { [K2 in string]: Extension }
                    : never
            }[number],
        >[K]
    },
    SuiGraphQLClient<Queries>,
>
Inherited from BaseClient.$extend
- Defined in packages/sui/src/client/client.ts:26

defaultNameServiceName

defaultNameServiceName(
input: DefaultNameServiceNameOptions,
): Promise<DefaultNameServiceNameResponse>
Parameters
- input: DefaultNameServiceNameOptions
Returns Promise<DefaultNameServiceNameResponse>
Implementation of TransportMethods.defaultNameServiceName
- Defined in packages/sui/src/graphql/client.ts:391

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>>
- Defined in packages/sui/src/graphql/client.ts:165

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>>
Implementation of TransportMethods.executeTransaction
- Defined in packages/sui/src/graphql/client.ts:225

getBalance

getBalance(input: GetBalanceOptions): Promise<GetBalanceResponse>
Parameters
- input: GetBalanceOptions
Returns Promise<GetBalanceResponse>
Implementation of TransportMethods.getBalance
- Defined in packages/sui/src/graphql/client.ts:203

getChainIdentifier

getChainIdentifier(
input?: GetChainIdentifierOptions,
): Promise<GetChainIdentifierResponse>
Parameters
- Optionalinput: GetChainIdentifierOptions
Returns Promise<GetChainIdentifierResponse>
Implementation of TransportMethods.getChainIdentifier
- Defined in packages/sui/src/graphql/client.ts:267

getCoinMetadata

getCoinMetadata(input: GetCoinMetadataOptions): Promise<GetCoinMetadataResponse>
Parameters
- input: GetCoinMetadataOptions
Returns Promise<GetCoinMetadataResponse>
Implementation of TransportMethods.getCoinMetadata
- Defined in packages/sui/src/graphql/client.ts:213

getCurrentSystemState

getCurrentSystemState(
input?: GetCurrentSystemStateOptions,
): Promise<GetCurrentSystemStateResponse>
Parameters
- Optionalinput: GetCurrentSystemStateOptions
Returns Promise<GetCurrentSystemStateResponse>
Implementation of TransportMethods.getCurrentSystemState
- Defined in packages/sui/src/graphql/client.ts:255

getDynamicField

getDynamicField(input: GetDynamicFieldOptions): Promise<GetDynamicFieldResponse>
Parameters
- input: GetDynamicFieldOptions
Returns Promise<GetDynamicFieldResponse>
Implementation of TransportMethods.getDynamicField
- Defined in packages/sui/src/graphql/client.ts:353

getDynamicObjectField

getDynamicObjectField<Include extends ObjectInclude = {}>(
input: GetDynamicObjectFieldOptions<Include>,
): Promise<GetDynamicObjectFieldResponse<Include>>
Type Parameters
- Include extends ObjectInclude = {}
Parameters
- input: GetDynamicObjectFieldOptions<Include>
Returns Promise<GetDynamicObjectFieldResponse<Include>>
- Defined in packages/sui/src/graphql/client.ts:359

getMoveFunction

getMoveFunction(input: GetMoveFunctionOptions): Promise<GetMoveFunctionResponse>
Parameters
- input: GetMoveFunctionOptions
Returns Promise<GetMoveFunctionResponse>
Implementation of TransportMethods.getMoveFunction
- Defined in packages/sui/src/graphql/client.ts:375

getObject

getObject<Include extends ObjectInclude = {}>(
input: GetObjectOptions<Include>,
): Promise<GetObjectResponse<Include>>
Type Parameters
- Include extends ObjectInclude = {}
Parameters
- input: GetObjectOptions<Include>
Returns Promise<GetObjectResponse<Include>>
- Defined in packages/sui/src/graphql/client.ts:187

getObjects

getObjects<Include extends ObjectInclude = {}>(
input: GetObjectsOptions<Include>,
): Promise<GetObjectsResponse<Include>>
Type Parameters
- Include extends ObjectInclude = {}
Parameters
- input: GetObjectsOptions<Include>
Returns Promise<GetObjectsResponse<Include>>
Implementation of TransportMethods.getObjects
- Defined in packages/sui/src/graphql/client.ts:181

getProtocolConfig

getProtocolConfig(
input?: GetProtocolConfigOptions,
): Promise<GetProtocolConfigResponse>
Parameters
- Optionalinput: GetProtocolConfigOptions
Returns Promise<GetProtocolConfigResponse>
Implementation of TransportMethods.getProtocolConfig
- Defined in packages/sui/src/graphql/client.ts:261

getReferenceGasPrice

getReferenceGasPrice(
input?: GetReferenceGasPriceOptions,
): Promise<GetReferenceGasPriceResponse>
Parameters
- Optionalinput: GetReferenceGasPriceOptions
Returns Promise<GetReferenceGasPriceResponse>
Implementation of TransportMethods.getReferenceGasPrice
- Defined in packages/sui/src/graphql/client.ts:249

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>>
Implementation of TransportMethods.getTransaction
- Defined in packages/sui/src/graphql/client.ts:219

listBalances

listBalances(input: ListBalancesOptions): Promise<ListBalancesResponse>
Parameters
- input: ListBalancesOptions
Returns Promise<ListBalancesResponse>
Implementation of TransportMethods.listBalances
- Defined in packages/sui/src/graphql/client.ts:207

listCoins

listCoins(input: ListCoinsOptions): Promise<ListCoinsResponse>
Parameters
- input: ListCoinsOptions
Returns Promise<ListCoinsResponse>
Implementation of TransportMethods.listCoins
- Defined in packages/sui/src/graphql/client.ts:193

listDynamicFields

listDynamicFields<Include extends DynamicFieldInclude = {}>(
    input: ListDynamicFieldsOptions & {
        include?: Include & DynamicFieldInclude;
    },
): Promise<ListDynamicFieldsWithValueResponse<Include>>
Type Parameters
- Include extends DynamicFieldInclude = {}
Parameters
- input: ListDynamicFieldsOptions & { include?: Include & DynamicFieldInclude }
Returns Promise<ListDynamicFieldsWithValueResponse<Include>>
Implementation of TransportMethods.listDynamicFields
- Defined in packages/sui/src/graphql/client.ts:273

listEvents

listEvents(input: ListEventsOptions): Promise<ListEventsResponse>
Parameters
- input: ListEventsOptions
Returns Promise<ListEventsResponse>
Implementation of TransportMethods.listEvents
- Defined in packages/sui/src/graphql/client.ts:371

listOwnedObjects

listOwnedObjects<Include extends ObjectInclude = {}>(
input: ListOwnedObjectsOptions<Include>,
): Promise<ListOwnedObjectsResponse<Include>>
Type Parameters
- Include extends ObjectInclude = {}
Parameters
- input: ListOwnedObjectsOptions<Include>
Returns Promise<ListOwnedObjectsResponse<Include>>
Implementation of TransportMethods.listOwnedObjects
- Defined in packages/sui/src/graphql/client.ts:197

listTransactions

listTransactions<Include extends TransactionInclude = {}>(
input: ListTransactionsOptions<Include>,
): Promise<ListTransactionsResponse<Include>>
Type Parameters
- Include extends TransactionInclude = {}
Parameters
- input: ListTransactionsOptions<Include>
Returns Promise<ListTransactionsResponse<Include>>
Implementation of TransportMethods.listTransactions
- Defined in packages/sui/src/graphql/client.ts:365

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>>
- Defined in packages/sui/src/graphql/client.ts:137

resolveNameServiceAddress

resolveNameServiceAddress(
input: ResolveNameServiceAddressOptions,
): Promise<ResolveNameServiceAddressResponse>
Parameters
- input: ResolveNameServiceAddressOptions
Returns Promise<ResolveNameServiceAddressResponse>
Implementation of TransportMethods.resolveNameServiceAddress
- Defined in packages/sui/src/graphql/client.ts:397

resolveTransactionPlugin

resolveTransactionPlugin(): TransactionPlugin
Returns TransactionPlugin
Implementation of TransportMethods.resolveTransactionPlugin
- Defined in packages/sui/src/graphql/client.ts:381

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>>
- Defined in packages/sui/src/graphql/client.ts:231

simulateTransaction

simulateTransaction<Include extends SimulateTransactionInclude = {}>(
input: GraphQLSimulateTransactionOptions<Include>,
): Promise<SimulateTransactionResult<Include>>
Type Parameters
- Include extends SimulateTransactionInclude = {}
Parameters
- input: GraphQLSimulateTransactionOptions<Include>
Returns Promise<SimulateTransactionResult<Include>>
Implementation of TransportMethods.simulateTransaction
- Defined in packages/sui/src/graphql/client.ts:243

verifyZkLoginSignature

verifyZkLoginSignature(
input: VerifyZkLoginSignatureOptions,
): Promise<ZkLoginVerifyResponse>
Parameters
- input: VerifyZkLoginSignatureOptions
Returns Promise<ZkLoginVerifyResponse>
Implementation of TransportMethods.verifyZkLoginSignature
- Defined in packages/sui/src/graphql/client.ts:385

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>>
- Defined in packages/sui/src/graphql/client.ts:237

Class SuiGraphQLClient<Queries>

Type Parameters

Hierarchy (View Summary)

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SuiGraphQLClient<Queries>

Properties

base

cache

core

network

Accessors

mvr

Returns MvrMethods

Methods

$extend

Type Parameters

Parameters

defaultNameServiceName

Parameters

Returns Promise<DefaultNameServiceNameResponse>

execute

Type Parameters

Parameters

Returns Promise<GraphQLQueryResult<Result>>

executeTransaction

Type Parameters

Parameters

Returns Promise<SuiClientTypes.TransactionResult<Include>>

getBalance

Parameters

Returns Promise<GetBalanceResponse>

getChainIdentifier

Parameters

Returns Promise<GetChainIdentifierResponse>

getCoinMetadata

Parameters

Returns Promise<GetCoinMetadataResponse>

getCurrentSystemState

Parameters

Returns Promise<GetCurrentSystemStateResponse>

getDynamicField

Parameters

Returns Promise<GetDynamicFieldResponse>

getDynamicObjectField

Type Parameters

Parameters

Returns Promise<GetDynamicObjectFieldResponse<Include>>

getMoveFunction

Parameters

Returns Promise<GetMoveFunctionResponse>

getObject

Type Parameters

Parameters

Returns Promise<GetObjectResponse<Include>>

getObjects

Type Parameters

Parameters

Returns Promise<GetObjectsResponse<Include>>

getProtocolConfig

Parameters

Returns Promise<GetProtocolConfigResponse>

getReferenceGasPrice

Parameters

Returns Promise<GetReferenceGasPriceResponse>

getTransaction

Type Parameters

Parameters

Returns Promise<SuiClientTypes.TransactionResult<Include>>

listBalances

Parameters