Class GrpcCoreClient

Hierarchy

Experimental_CoreClient
- GrpcCoreClient

Constructors

constructor

new GrpcCoreClient(__namedParameters: GrpcCoreClientOptions): GrpcCoreClient
Parameters
- __namedParameters: GrpcCoreClientOptions
Returns GrpcCoreClient
Overrides Experimental_CoreClient.constructor
- Defined in sui-grpc/src/core.ts:28

Properties

base

base: Experimental_BaseClient

cache

cache: ClientCache

core

core: GrpcCoreClient

mvr

mvr: MvrMethods

network

network: Network

Methods

$extend

$extend<const Registrations extends SuiClientRegistration<GrpcCoreClient>[]>(
    ...registrations: Registrations,
): ClientWithExtensions<
    {
        [K in string
        | number
        | symbol]: UnionToIntersection<
            {
                [K in string
                | number
                | symbol]: Registrations[K<K>] extends SuiClientRegistration<
                    GrpcCoreClient,
                    Name,
                    Extension,
                >
                    ? { [K2 in string]: Extension }
                    : never
            }[number],
        >[K]
    },
    GrpcCoreClient,
>
Type Parameters
- const Registrations extends SuiClientRegistration<GrpcCoreClient>[]
Parameters
- ...registrations: Registrations
Returns ClientWithExtensions<
    {
        [K in string
        | number
        | symbol]: UnionToIntersection<
            {
                [K in string
                | number
                | symbol]: Registrations[K<K>] extends SuiClientRegistration<
                    GrpcCoreClient,
                    Name,
                    Extension,
                >
                    ? { [K2 in string]: Extension }
                    : never
            }[number],
        >[K]
    },
    GrpcCoreClient,
>
Inherited from Experimental_CoreClient.$extend
- Defined in typescript/dist/cjs/experimental/client.d.ts:11

dryRunTransaction

dryRunTransaction(
options: DryRunTransactionOptions,
): Promise<DryRunTransactionResponse>
Parameters
- options: DryRunTransactionOptions
Returns Promise<DryRunTransactionResponse>
Overrides Experimental_CoreClient.dryRunTransaction
- Defined in sui-grpc/src/core.ts:196

executeTransaction

executeTransaction(
options: ExecuteTransactionOptions,
): Promise<ExecuteTransactionResponse>
Parameters
- options: ExecuteTransactionOptions
Returns Promise<ExecuteTransactionResponse>
Overrides Experimental_CoreClient.executeTransaction
- Defined in sui-grpc/src/core.ts:166

getAllBalances

getAllBalances(_options: GetAllBalancesOptions): Promise<GetAllBalancesResponse>
Parameters
- _options: GetAllBalancesOptions
Returns Promise<GetAllBalancesResponse>
Overrides Experimental_CoreClient.getAllBalances
- Defined in sui-grpc/src/core.ts:146

getBalance

getBalance(_options: GetBalanceOptions): Promise<GetBalanceResponse>
Parameters
- _options: GetBalanceOptions
Returns Promise<GetBalanceResponse>
Overrides Experimental_CoreClient.getBalance
- Defined in sui-grpc/src/core.ts:140

getCoins

getCoins(options: GetCoinsOptions): Promise<GetCoinsResponse>
Parameters
- options: GetCoinsOptions
Returns Promise<GetCoinsResponse>
Overrides Experimental_CoreClient.getCoins
- Defined in sui-grpc/src/core.ts:108

getDynamicField

getDynamicField(
options: GetDynamicFieldOptions,
): Promise<GetDynamicFieldResponse>
Parameters
- options: GetDynamicFieldOptions
Returns Promise<GetDynamicFieldResponse>
Inherited from Experimental_CoreClient.getDynamicField
- Defined in typescript/dist/cjs/experimental/core.d.ts:28

getDynamicFields

getDynamicFields(
options: GetDynamicFieldsOptions,
): Promise<GetDynamicFieldsResponse>
Parameters
- options: GetDynamicFieldsOptions
Returns Promise<GetDynamicFieldsResponse>
Overrides Experimental_CoreClient.getDynamicFields
- Defined in sui-grpc/src/core.ts:227

getObject

getObject(options: GetObjectOptions): Promise<GetObjectResponse>
Parameters
- options: GetObjectOptions
Returns Promise<GetObjectResponse>
Inherited from Experimental_CoreClient.getObject
- Defined in typescript/dist/cjs/experimental/core.d.ts:16

getObjects

getObjects(options: GetObjectsOptions): Promise<GetObjectsResponse>
Parameters
- options: GetObjectsOptions
Returns Promise<GetObjectsResponse>
Overrides Experimental_CoreClient.getObjects
- Defined in sui-grpc/src/core.ts:33

getOwnedObjects

getOwnedObjects(
options: GetOwnedObjectsOptions,
): Promise<GetOwnedObjectsResponse>
Parameters
- options: GetOwnedObjectsOptions
Returns Promise<GetOwnedObjectsResponse>
Overrides Experimental_CoreClient.getOwnedObjects
- Defined in sui-grpc/src/core.ts:77

getReferenceGasPrice

getReferenceGasPrice(): Promise<GetReferenceGasPriceResponse>
Returns Promise<GetReferenceGasPriceResponse>
Overrides Experimental_CoreClient.getReferenceGasPrice
- Defined in sui-grpc/src/core.ts:219

getTransaction

getTransaction(options: GetTransactionOptions): Promise<GetTransactionResponse>
Parameters
- options: GetTransactionOptions
Returns Promise<GetTransactionResponse>
Overrides Experimental_CoreClient.getTransaction
- Defined in sui-grpc/src/core.ts:152

resolveTransactionPlugin

resolveTransactionPlugin(): never
Returns never
Overrides Experimental_CoreClient.resolveTransactionPlugin
- Defined in sui-grpc/src/core.ts:276

verifyZkLoginSignature

verifyZkLoginSignature(
options: VerifyZkLoginSignatureOptions,
): Promise<ZkLoginVerifyResponse>
Parameters
- options: VerifyZkLoginSignatureOptions
Returns Promise<ZkLoginVerifyResponse>
Overrides Experimental_CoreClient.verifyZkLoginSignature
- Defined in sui-grpc/src/core.ts:251

waitForTransaction

waitForTransaction(
__namedParameters: { signal?: AbortSignal; timeout?: number } & GetTransactionOptions,
): Promise<GetTransactionResponse>
Parameters
- __namedParameters: { signal?: AbortSignal; timeout?: number } & GetTransactionOptions
  - Optionalsignal?: AbortSignal
    An optional abort signal that can be used to cancel the wait.
  - Optionaltimeout?: number
    The amount of time to wait for transaction. Defaults to one minute.
Returns Promise<GetTransactionResponse>
Inherited from Experimental_CoreClient.waitForTransaction
- Defined in typescript/dist/cjs/experimental/core.d.ts:29

Class GrpcCoreClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GrpcCoreClient

Properties

base

cache

core

mvr

network

Methods

$extend

Type Parameters

Parameters

Returns ClientWithExtensions< { [K in string | number | symbol]: UnionToIntersection< { [K in string | number | symbol]: Registrations[K<K>] extends SuiClientRegistration< GrpcCoreClient, Name, Extension, > ? { [K2 in string]: Extension } : never }[number], >[K] }, GrpcCoreClient,>

dryRunTransaction

Parameters

Returns Promise<DryRunTransactionResponse>

executeTransaction

Parameters

Returns Promise<ExecuteTransactionResponse>

getAllBalances

Parameters

Returns Promise<GetAllBalancesResponse>

getBalance

Parameters

Returns Promise<GetBalanceResponse>

getCoins

Parameters

Returns Promise<GetCoinsResponse>

getDynamicField

Parameters

Returns Promise<GetDynamicFieldResponse>

getDynamicFields

Parameters

Returns Promise<GetDynamicFieldsResponse>

getObject

Parameters

Returns Promise<GetObjectResponse>

getObjects

Parameters

Returns Promise<GetObjectsResponse>

getOwnedObjects

Parameters

Returns Promise<GetOwnedObjectsResponse>

getReferenceGasPrice

Returns Promise<GetReferenceGasPriceResponse>

getTransaction

Parameters

Returns Promise<GetTransactionResponse>

resolveTransactionPlugin

Returns never

verifyZkLoginSignature

Parameters

Returns Promise<ZkLoginVerifyResponse>

waitForTransaction

Parameters

Optionalsignal?: AbortSignal

Optionaltimeout?: number

Returns Promise<GetTransactionResponse>

Settings

On This Page

Returns ClientWithExtensions<
{
[K in string
| number
| symbol]: UnionToIntersection<
{
[K in string
| number
| symbol]: Registrations[K<K>] extends SuiClientRegistration<
GrpcCoreClient,
Name,
Extension,
>
? { [K2 in string]: Extension }
: never
}[number],
>[K]
},
GrpcCoreClient,
>

`Optional`signal?: AbortSignal

`Optional`timeout?: number