Class SuiClient

Indexable

[key: number]: boolean

Index

Constructors

Properties

Methods

call devInspectTransactionBlock dryRunTransactionBlock executeTransactionBlock getAddressMetrics getAllBalances getAllCoins getAllEpochAddressMetrics getBalance getChainIdentifier getCheckpoint getCheckpoints getCoinMetadata getCoins getCommitteeInfo getCurrentEpoch getDynamicFieldObject getDynamicFields getEpochMetrics getEpochs getLatestCheckpointSequenceNumber getLatestSuiSystemState getMoveCallMetrics getMoveFunctionArgTypes getNetworkMetrics getNormalizedMoveFunction getNormalizedMoveModule getNormalizedMoveModulesByPackage getNormalizedMoveStruct getObject getOwnedObjects getProtocolConfig getReferenceGasPrice getRpcApiVersion getStakes getStakesByIds getTotalSupply getTotalTransactionBlocks getTransactionBlock getValidatorsApy multiGetObjects multiGetTransactionBlocks queryEvents queryTransactionBlocks resolveNameServiceAddress resolveNameServiceNames signAndExecuteTransaction subscribeEvent subscribeTransaction tryGetPastObject waitForTransaction

Constructors

constructor

new SuiClient(options: NetworkOrTransport): SuiClient
Establish a connection to a Sui RPC endpoint
Parameters
- options: NetworkOrTransport
  configuration options for the API Client
Returns SuiClient
- Defined in packages/typescript/src/client/client.ts:141

Properties

`Protected`transport

transport: SuiTransport

Methods

call

call<T = unknown>(method: string, params: unknown[]): Promise<T>
Invoke any RPC method
Type Parameters
- T = unknown
Parameters
- method: string
  the method to be invoked
- params: unknown[]
Returns Promise<T>
- Defined in packages/typescript/src/client/client.ts:230

devInspectTransactionBlock

devInspectTransactionBlock(
input: DevInspectTransactionBlockParams,
): Promise<DevInspectResults>
Runs the transaction block in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.
Parameters
- input: DevInspectTransactionBlockParams
Returns Promise<DevInspectResults>
- Defined in packages/typescript/src/client/client.ts:577

dryRunTransactionBlock

dryRunTransactionBlock(
input: DryRunTransactionBlockParams,
): Promise<DryRunTransactionBlockResponse>
Dry run a transaction block and return the result.
Parameters
- input: DryRunTransactionBlockParams
Returns Promise<DryRunTransactionBlockResponse>
- Defined in packages/typescript/src/client/client.ts:606

executeTransactionBlock

executeTransactionBlock(
__namedParameters: ExecuteTransactionBlockParams,
): Promise<SuiTransactionBlockResponse>
Parameters
- __namedParameters: ExecuteTransactionBlockParams
Returns Promise<SuiTransactionBlockResponse>
- Defined in packages/typescript/src/client/client.ts:409

getAddressMetrics

getAddressMetrics(): Promise<AddressMetrics>
Returns Promise<AddressMetrics>
- Defined in packages/typescript/src/client/client.ts:686

getAllBalances

getAllBalances(input: GetAllBalancesParams): Promise<CoinBalance[]>
Get the total coin balance for all coin types, owned by the address owner.
Parameters
- input: GetAllBalancesParams
Returns Promise<CoinBalance[]>
- Defined in packages/typescript/src/client/client.ts:198

getAllCoins

getAllCoins(input: GetAllCoinsParams): Promise<PaginatedCoins>
Get all Coin objects owned by an address.
Parameters
- input: GetAllCoinsParams
Returns Promise<PaginatedCoins>
- Defined in packages/typescript/src/client/client.ts:171

getAllEpochAddressMetrics

getAllEpochAddressMetrics(
input?: { descendingOrder?: boolean },
): Promise<AllEpochsAddressMetrics>
Parameters
- Optionalinput: { descendingOrder?: boolean }
Returns Promise<AllEpochsAddressMetrics>
- Defined in packages/typescript/src/client/client.ts:699

getBalance

getBalance(input: GetBalanceParams): Promise<CoinBalance>
Get the total coin balance for one coin type, owned by the address owner.
Parameters
- input: GetBalanceParams
Returns Promise<CoinBalance>
- Defined in packages/typescript/src/client/client.ts:185

getChainIdentifier

getChainIdentifier(): Promise<string>
Returns Promise<string>
- Defined in packages/typescript/src/client/client.ts:744

getCheckpoint

getCheckpoint(input: GetCheckpointParams): Promise<Checkpoint>
Returns information about a given checkpoint
Parameters
- input: GetCheckpointParams
Returns Promise<Checkpoint>
- Defined in packages/typescript/src/client/client.ts:656

getCheckpoints

getCheckpoints(
input: PaginationArguments<null | string> & GetCheckpointsParams,
): Promise<CheckpointPage>
Returns historical checkpoints paginated
Parameters
- input: PaginationArguments<null | string> & GetCheckpointsParams
Returns Promise<CheckpointPage>
- Defined in packages/typescript/src/client/client.ts:663

getCoinMetadata

getCoinMetadata(input: GetCoinMetadataParams): Promise<null | CoinMetadata>
Fetch CoinMetadata for a given coin type
Parameters
- input: GetCoinMetadataParams
Returns Promise<null | CoinMetadata>
- Defined in packages/typescript/src/client/client.ts:208

getCoins

getCoins(input: GetCoinsParams): Promise<PaginatedCoins>
Get all Coin<coin_type> objects owned by an address.
Parameters
- input: GetCoinsParams
Returns Promise<PaginatedCoins>
- Defined in packages/typescript/src/client/client.ts:157

getCommitteeInfo

getCommitteeInfo(input?: GetCommitteeInfoParams): Promise<CommitteeInfo>
Return the committee information for the asked epoch
Parameters
- Optionalinput: GetCommitteeInfoParams
Returns Promise<CommitteeInfo>
- Defined in packages/typescript/src/client/client.ts:675

getCurrentEpoch

getCurrentEpoch(): Promise<EpochInfo>
Return the committee information for the asked epoch

Returns Promise<EpochInfo>
- Defined in packages/typescript/src/client/client.ts:732

getDynamicFieldObject

getDynamicFieldObject(
input: GetDynamicFieldObjectParams,
): Promise<SuiObjectResponse>
Return the dynamic field object information for a specified object
Parameters
- input: GetDynamicFieldObjectParams
Returns Promise<SuiObjectResponse>
- Defined in packages/typescript/src/client/client.ts:635

getDynamicFields

getDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage>
Return the list of dynamic field objects owned by an object
Parameters
- input: GetDynamicFieldsParams
Returns Promise<DynamicFieldPage>
- Defined in packages/typescript/src/client/client.ts:622

getEpochMetrics

getEpochMetrics(
    input?: { descendingOrder?: boolean } & PaginationArguments<
        null
        | string,
    >,
): Promise<EpochMetricsPage>
Parameters
- Optionalinput: { descendingOrder?: boolean } & PaginationArguments<null | string>
Returns Promise<EpochMetricsPage>
- Defined in packages/typescript/src/client/client.ts:690

getEpochs

getEpochs(
    input?: { descendingOrder?: boolean } & PaginationArguments<
        null
        | string,
    >,
): Promise<EpochPage>
Return the committee information for the asked epoch
Parameters
- Optionalinput: { descendingOrder?: boolean } & PaginationArguments<null | string>
Returns Promise<EpochPage>
- Defined in packages/typescript/src/client/client.ts:711

getLatestCheckpointSequenceNumber

getLatestCheckpointSequenceNumber(): Promise<string>
Get the sequence number of the latest checkpoint that has been executed

Returns Promise<string>
- Defined in packages/typescript/src/client/client.ts:645

getLatestSuiSystemState

getLatestSuiSystemState(): Promise<SuiSystemStateSummary>
Return the latest system state content.

Returns Promise<SuiSystemStateSummary>
- Defined in packages/typescript/src/client/client.ts:517

getMoveCallMetrics

getMoveCallMetrics(): Promise<MoveCallMetrics>
Returns list of top move calls by usage

Returns Promise<MoveCallMetrics>
- Defined in packages/typescript/src/client/client.ts:725

getMoveFunctionArgTypes

getMoveFunctionArgTypes(
input: GetMoveFunctionArgTypesParams,
): Promise<SuiMoveFunctionArgType[]>
Get Move function argument types like read, write and full access
Parameters
- input: GetMoveFunctionArgTypesParams
Returns Promise<SuiMoveFunctionArgType[]>
- Defined in packages/typescript/src/client/client.ts:237

getNetworkMetrics

getNetworkMetrics(): Promise<NetworkMetrics>
Returns Promise<NetworkMetrics>
- Defined in packages/typescript/src/client/client.ts:682

getNormalizedMoveFunction

getNormalizedMoveFunction(
input: GetNormalizedMoveFunctionParams,
): Promise<SuiMoveNormalizedFunction>
Get a structured representation of Move function
Parameters
- input: GetNormalizedMoveFunctionParams
Returns Promise<SuiMoveNormalizedFunction>
- Defined in packages/typescript/src/client/client.ts:274

getNormalizedMoveModule

getNormalizedMoveModule(
input: GetNormalizedMoveModuleParams,
): Promise<SuiMoveNormalizedModule>
Get a structured representation of Move module
Parameters
- input: GetNormalizedMoveModuleParams
Returns Promise<SuiMoveNormalizedModule>
- Defined in packages/typescript/src/client/client.ts:262

getNormalizedMoveModulesByPackage

getNormalizedMoveModulesByPackage(
input: GetNormalizedMoveModulesByPackageParams,
): Promise<SuiMoveNormalizedModules>
Get a map from module name to structured representations of Move modules
Parameters
- input: GetNormalizedMoveModulesByPackageParams
Returns Promise<SuiMoveNormalizedModules>
- Defined in packages/typescript/src/client/client.ts:250

getNormalizedMoveStruct

getNormalizedMoveStruct(
input: GetNormalizedMoveStructParams,
): Promise<SuiMoveNormalizedStruct>
Get a structured representation of Move struct
Parameters
- input: GetNormalizedMoveStructParams
Returns Promise<SuiMoveNormalizedStruct>
- Defined in packages/typescript/src/client/client.ts:286

getObject

getObject(input: GetObjectParams): Promise<SuiObjectResponse>
Get details about an object
Parameters
- input: GetObjectParams
Returns Promise<SuiObjectResponse>
- Defined in packages/typescript/src/client/client.ts:320

getOwnedObjects

getOwnedObjects(input: GetOwnedObjectsParams): Promise<PaginatedObjectsResponse>
Get all objects owned by an address
Parameters
- input: GetOwnedObjectsParams
Returns Promise<PaginatedObjectsResponse>
- Defined in packages/typescript/src/client/client.ts:298

getProtocolConfig

getProtocolConfig(input?: GetProtocolConfigParams): Promise<ProtocolConfig>
Parameters
- Optionalinput: GetProtocolConfigParams
Returns Promise<ProtocolConfig>
- Defined in packages/typescript/src/client/client.ts:776

getReferenceGasPrice

getReferenceGasPrice(): Promise<bigint>
Getting the reference gas price for the network

Returns Promise<bigint>
- Defined in packages/typescript/src/client/client.ts:481

getRpcApiVersion

getRpcApiVersion(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/typescript/src/client/client.ts:145

getStakes

getStakes(input: GetStakesParams): Promise<DelegatedStake[]>
Return the delegated stakes for an address
Parameters
- input: GetStakesParams
Returns Promise<DelegatedStake[]>
- Defined in packages/typescript/src/client/client.ts:492

getStakesByIds

getStakesByIds(input: GetStakesByIdsParams): Promise<DelegatedStake[]>
Return the delegated stakes queried by id.
Parameters
- input: GetStakesByIdsParams
Returns Promise<DelegatedStake[]>
- Defined in packages/typescript/src/client/client.ts:502

getTotalSupply

getTotalSupply(input: GetTotalSupplyParams): Promise<CoinSupply>
Fetch total supply for a coin
Parameters
- input: GetTotalSupplyParams
Returns Promise<CoinSupply>
- Defined in packages/typescript/src/client/client.ts:218

getTotalTransactionBlocks

getTotalTransactionBlocks(): Promise<bigint>
Get total number of transactions

Returns Promise<bigint>
- Defined in packages/typescript/src/client/client.ts:470

getTransactionBlock

getTransactionBlock(
input: GetTransactionBlockParams,
): Promise<SuiTransactionBlockResponse>
Parameters
- input: GetTransactionBlockParams
Returns Promise<SuiTransactionBlockResponse>
- Defined in packages/typescript/src/client/client.ts:377

getValidatorsApy

getValidatorsApy(): Promise<ValidatorsApy>
Return the Validators APYs

Returns Promise<ValidatorsApy>
- Defined in packages/typescript/src/client/client.ts:739

multiGetObjects

multiGetObjects(input: MultiGetObjectsParams): Promise<SuiObjectResponse[]>
Batch get details about a list of objects. If any of the object ids are duplicates the call will fail
Parameters
- input: MultiGetObjectsParams
Returns Promise<SuiObjectResponse[]>
- Defined in packages/typescript/src/client/client.ts:340

multiGetTransactionBlocks

multiGetTransactionBlocks(
input: MultiGetTransactionBlocksParams,
): Promise<SuiTransactionBlockResponse[]>
Parameters
- input: MultiGetTransactionBlocksParams
Returns Promise<SuiTransactionBlockResponse[]>
- Defined in packages/typescript/src/client/client.ts:389

queryEvents

queryEvents(input: QueryEventsParams): Promise<PaginatedEvents>
Get events for a given query criteria
Parameters
- input: QueryEventsParams
Returns Promise<PaginatedEvents>
- Defined in packages/typescript/src/client/client.ts:524

queryTransactionBlocks

queryTransactionBlocks(
input: QueryTransactionBlocksParams,
): Promise<PaginatedTransactionResponse>
Get transaction blocks for a given query criteria
Parameters
- input: QueryTransactionBlocksParams
Returns Promise<PaginatedTransactionResponse>
- Defined in packages/typescript/src/client/client.ts:360

resolveNameServiceAddress

resolveNameServiceAddress(
input: ResolveNameServiceAddressParams,
): Promise<null | string>
Parameters
- input: ResolveNameServiceAddressParams
Returns Promise<null | string>
- Defined in packages/typescript/src/client/client.ts:750

resolveNameServiceNames

resolveNameServiceNames(
    __namedParameters: ResolveNameServiceNamesParams & {
        format?: "at" | "dot";
    },
): Promise<ResolvedNameServiceNames>
Parameters
- __namedParameters: ResolveNameServiceNamesParams & { format?: "at" | "dot" }
Returns Promise<ResolvedNameServiceNames>
- Defined in packages/typescript/src/client/client.ts:757

signAndExecuteTransaction

signAndExecuteTransaction(
    __namedParameters: {
        signer: Signer;
        transaction: Uint8Array | Transaction;
    } & Omit<ExecuteTransactionBlockParams, "signature" | "transactionBlock">,
): Promise<SuiTransactionBlockResponse>
Parameters
- __namedParameters: { signer: Signer; transaction: Uint8Array | Transaction } & Omit<
      ExecuteTransactionBlockParams,
      "signature"
      | "transactionBlock",
  >
Returns Promise<SuiTransactionBlockResponse>
- Defined in packages/typescript/src/client/client.ts:437

subscribeEvent

subscribeEvent(
input: SubscribeEventParams & { onMessage: (event: SuiEvent) => void },
): Promise<Unsubscribe>
Subscribe to get notifications whenever an event matching the filter occurs
Parameters
- input: SubscribeEventParams & { onMessage: (event: SuiEvent) => void }
  - onMessage: (event: SuiEvent) => void
    function to run when we receive a notification of a new event matching the filter
Returns Promise<Unsubscribe>
Deprecated
- Defined in packages/typescript/src/client/client.ts:541

subscribeTransaction

subscribeTransaction(
    input: SubscribeTransactionParams & {
        onMessage: (event: TransactionEffects) => void;
    },
): Promise<Unsubscribe>
Parameters
- input: SubscribeTransactionParams & { onMessage: (event: TransactionEffects) => void }
  - onMessage: (event: TransactionEffects) => void
    function to run when we receive a notification of a new event matching the filter
Returns Promise<Unsubscribe>
Deprecated
- Defined in packages/typescript/src/client/client.ts:558

tryGetPastObject

tryGetPastObject(input: TryGetPastObjectParams): Promise<ObjectRead>
Parameters
- input: TryGetPastObjectParams
Returns Promise<ObjectRead>
- Defined in packages/typescript/src/client/client.ts:330

waitForTransaction

waitForTransaction(
    __namedParameters: {
        pollInterval?: number;
        signal?: AbortSignal;
        timeout?: number;
    } & GetTransactionBlockParams,
): Promise<SuiTransactionBlockResponse>
Wait for a transaction block result to be available over the API. This can be used in conjunction with executeTransactionBlock to wait for the transaction to be available via the API. This currently polls the getTransactionBlock API to check for the transaction.
Parameters
- __namedParameters: { pollInterval?: number; signal?: AbortSignal; timeout?: number } & GetTransactionBlockParams
  - OptionalpollInterval?: number
    The amount of time to wait between checks for the transaction block. Defaults to 2 seconds.
  - Optionalsignal?: AbortSignal
    An optional abort signal that can be used to cancel
  - Optionaltimeout?: number
    The amount of time to wait for a transaction block. Defaults to one minute.
Returns Promise<SuiTransactionBlockResponse>
- Defined in packages/typescript/src/client/client.ts:789

Class SuiClient

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SuiClient

Properties

Protectedtransport

Methods

call

Type Parameters

Parameters

Returns Promise<T>

devInspectTransactionBlock

Parameters

Returns Promise<DevInspectResults>

dryRunTransactionBlock

Parameters

Returns Promise<DryRunTransactionBlockResponse>

executeTransactionBlock

Parameters

Returns Promise<SuiTransactionBlockResponse>

getAddressMetrics

Returns Promise<AddressMetrics>

getAllBalances

Parameters

Returns Promise<CoinBalance[]>

getAllCoins

Parameters

Returns Promise<PaginatedCoins>

getAllEpochAddressMetrics

Parameters

Returns Promise<AllEpochsAddressMetrics>

getBalance

Parameters

Returns Promise<CoinBalance>

getChainIdentifier

Returns Promise<string>

getCheckpoint

Parameters

Returns Promise<Checkpoint>

getCheckpoints

Parameters

Returns Promise<CheckpointPage>

getCoinMetadata

Parameters

Returns Promise<null | CoinMetadata>

getCoins

Parameters

Returns Promise<PaginatedCoins>

getCommitteeInfo

Parameters

Returns Promise<CommitteeInfo>

getCurrentEpoch

Returns Promise<EpochInfo>

getDynamicFieldObject

Parameters

Returns Promise<SuiObjectResponse>

getDynamicFields

Parameters

Returns Promise<DynamicFieldPage>

getEpochMetrics

Parameters

Returns Promise<EpochMetricsPage>

getEpochs

Parameters

Returns Promise<EpochPage>

getLatestCheckpointSequenceNumber

Returns Promise<string>

getLatestSuiSystemState

Returns Promise<SuiSystemStateSummary>

getMoveCallMetrics

Returns Promise<MoveCallMetrics>

getMoveFunctionArgTypes

Parameters

Returns Promise<SuiMoveFunctionArgType[]>

`Protected`transport