Class SuiClient

Index

Constructors

Properties

Accessors

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): SuiClient
Establish a connection to a Sui RPC endpoint
Parameters
- options: NetworkOrTransport
  configuration options for the API Client
Returns SuiClient
- Defined in sdk/typescript/src/client/client.ts:143

Properties

`Protected` transport

transport: SuiTransport

Accessors

[SUI_CLIENT_BRAND]

get [SUI_CLIENT_BRAND](): boolean
Returns boolean
- Defined in sdk/typescript/src/client/client.ts:134

Methods

call

call<T>(method, params): 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 sdk/typescript/src/client/client.ts:232

devInspectTransactionBlock

devInspectTransactionBlock(input): 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 sdk/typescript/src/client/client.ts:567

dryRunTransactionBlock

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

executeTransactionBlock

executeTransactionBlock(input): Promise<SuiTransactionBlockResponse>
Parameters
- input: ExecuteTransactionBlockParams
Returns Promise<SuiTransactionBlockResponse>
- Defined in sdk/typescript/src/client/client.ts:411

getAddressMetrics

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

getAllBalances

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

getAllCoins

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

getAllEpochAddressMetrics

getAllEpochAddressMetrics(input?): Promise<AllEpochsAddressMetrics>
Parameters
- Optional input: {
  descendingOrder?: boolean;
  }
  - Optional descendingOrder?: boolean
Returns Promise<AllEpochsAddressMetrics>
- Defined in sdk/typescript/src/client/client.ts:689

getBalance

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

getChainIdentifier

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

getCheckpoint

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

getCheckpoints

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

getCoinMetadata

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

getCoins

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

getCommitteeInfo

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

getCurrentEpoch

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

Returns Promise<EpochInfo>
- Defined in sdk/typescript/src/client/client.ts:722

getDynamicFieldObject

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

getDynamicFields

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

getEpochMetrics

getEpochMetrics(input?): Promise<EpochMetricsPage>
Parameters
- Optional input: {
  descendingOrder?: boolean;
  } & PaginationArguments<null | string>
Returns Promise<EpochMetricsPage>
- Defined in sdk/typescript/src/client/client.ts:680

getEpochs

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

getLatestCheckpointSequenceNumber

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

Returns Promise<string>
- Defined in sdk/typescript/src/client/client.ts:635

getLatestSuiSystemState

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

Returns Promise<SuiSystemStateSummary>
- Defined in sdk/typescript/src/client/client.ts:507

getMoveCallMetrics

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

Returns Promise<MoveCallMetrics>
- Defined in sdk/typescript/src/client/client.ts:715

getMoveFunctionArgTypes

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

getNetworkMetrics

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

getNormalizedMoveFunction

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

getNormalizedMoveModule

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

getNormalizedMoveModulesByPackage

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

getNormalizedMoveStruct

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

getObject

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

getOwnedObjects

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

getProtocolConfig

getProtocolConfig(input?): Promise<ProtocolConfig>
Parameters
- Optional input: GetProtocolConfigParams
Returns Promise<ProtocolConfig>
- Defined in sdk/typescript/src/client/client.ts:766

getReferenceGasPrice

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

Returns Promise<bigint>
- Defined in sdk/typescript/src/client/client.ts:471

getRpcApiVersion

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

getStakes

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

getStakesByIds

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

getTotalSupply

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

getTotalTransactionBlocks

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

Returns Promise<bigint>
- Defined in sdk/typescript/src/client/client.ts:460

getTransactionBlock

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

getValidatorsApy

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

Returns Promise<ValidatorsApy>
- Defined in sdk/typescript/src/client/client.ts:729

multiGetObjects

multiGetObjects(input): 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 sdk/typescript/src/client/client.ts:342

multiGetTransactionBlocks

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

queryEvents

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

queryTransactionBlocks

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

resolveNameServiceAddress

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

resolveNameServiceNames

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

signAndExecuteTransaction

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

subscribeEvent

subscribeEvent(input): Promise<Unsubscribe>
Subscribe to get notifications whenever an event matching the filter occurs
Parameters
- input: SubscribeEventParams & {
  onMessage: ((event) => void);
  }
Returns Promise<Unsubscribe>
Deprecated
- Defined in sdk/typescript/src/client/client.ts:531

subscribeTransaction

subscribeTransaction(input): Promise<Unsubscribe>
Parameters
- input: SubscribeTransactionParams & {
  onMessage: ((event) => void);
  }
Returns Promise<Unsubscribe>
Deprecated
- Defined in sdk/typescript/src/client/client.ts:548

tryGetPastObject

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

waitForTransaction

waitForTransaction(__namedParameters): 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
Returns Promise<SuiTransactionBlockResponse>
- Defined in sdk/typescript/src/client/client.ts:779

Class SuiClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SuiClient

Properties

Protected transport

Accessors

[SUI_CLIENT_BRAND]

Returns boolean

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

Optional descendingOrder?: boolean

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

`Protected` transport

`Optional` descendingOrder?: boolean