Class SuiClient

constructor

• new SuiClient(options: SuiClientOptions): SuiClient

  Establish a connection to a Sui RPC endpoint

  Parameters

  • options: SuiClientOptions

    configuration options for the API Client

  Returns SuiClient

core

jsonRpc

call

• call<T = unknown>(
      method: string,
      params: unknown[],
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<T>

  Invoke any RPC method

  Type Parameters

  • T = unknown

  Parameters

  • method: string

    the method to be invoked
  • params: unknown[]
  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<T>

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>

dryRunTransactionBlock

• dryRunTransactionBlock(
      input: DryRunTransactionBlockParams,
  ): Promise<DryRunTransactionBlockResponse>

  Dry run a transaction block and return the result.

  Parameters

  • input: DryRunTransactionBlockParams

  Returns Promise<DryRunTransactionBlockResponse>

executeTransactionBlock

• executeTransactionBlock(
      __namedParameters: ExecuteTransactionBlockParams,
  ): Promise<SuiTransactionBlockResponse>

  Parameters

  • __namedParameters: ExecuteTransactionBlockParams

  Returns Promise<SuiTransactionBlockResponse>

experimental_asClientExtension

• experimental_asClientExtension(
      this: SuiClient,
  ): { name: "jsonRPC"; register: () => SuiClient }

  Parameters

  • this: SuiClient

  Returns { name: "jsonRPC"; register: () => SuiClient }

getAddressMetrics

• getAddressMetrics(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<AddressMetrics>

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<AddressMetrics>

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

getAllCoins

• getAllCoins(input: GetAllCoinsParams): Promise<PaginatedCoins>

  Get all Coin objects owned by an address.

  Parameters

  • input: GetAllCoinsParams

  Returns Promise<PaginatedCoins>

getAllEpochAddressMetrics

• getAllEpochAddressMetrics(
      input?: { descendingOrder?: boolean; signal?: AbortSignal },
  ): Promise<AllEpochsAddressMetrics>

  Parameters

  • Optionalinput: { descendingOrder?: boolean; signal?: AbortSignal }

  Returns Promise<AllEpochsAddressMetrics>

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>

getChainIdentifier

• getChainIdentifier(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<string>

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<string>

getCheckpoint

• getCheckpoint(input: GetCheckpointParams): Promise<Checkpoint>

  Returns information about a given checkpoint

  Parameters

  • input: GetCheckpointParams

  Returns Promise<Checkpoint>

getCheckpoints

• getCheckpoints(
      input: PaginationArguments<null | string> & GetCheckpointsParams,
  ): Promise<CheckpointPage>

  Returns historical checkpoints paginated

  Parameters

  • input: PaginationArguments<null | string> & GetCheckpointsParams

  Returns Promise<CheckpointPage>

getCoinMetadata

• getCoinMetadata(input: GetCoinMetadataParams): Promise<null | CoinMetadata>

  Fetch CoinMetadata for a given coin type

  Parameters

  • input: GetCoinMetadataParams

  Returns Promise<null | CoinMetadata>

getCoins

• getCoins(input: GetCoinsParams): Promise<PaginatedCoins>

  Get all Coin<coin_type> objects owned by an address.

  Parameters

  • input: GetCoinsParams

  Returns Promise<PaginatedCoins>

getCommitteeInfo

• getCommitteeInfo(input?: GetCommitteeInfoParams): Promise<CommitteeInfo>

  Return the committee information for the asked epoch

  Parameters

  • Optionalinput: GetCommitteeInfoParams

  Returns Promise<CommitteeInfo>

getCurrentEpoch

• getCurrentEpoch(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<EpochInfo>

  Return the committee information for the asked epoch

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<EpochInfo>

getDynamicFieldObject

• getDynamicFieldObject(
      input: GetDynamicFieldObjectParams,
  ): Promise<SuiObjectResponse>

  Return the dynamic field object information for a specified object

  Parameters

  • input: GetDynamicFieldObjectParams

  Returns Promise<SuiObjectResponse>

getDynamicFields

• getDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage>

  Return the list of dynamic field objects owned by an object

  Parameters

  • input: GetDynamicFieldsParams

  Returns Promise<DynamicFieldPage>

getEpochMetrics

• getEpochMetrics(
      input?: { descendingOrder?: boolean; signal?: AbortSignal } & PaginationArguments<
          null
          | string,
      >,
  ): Promise<EpochMetricsPage>

  Parameters

  • Optionalinput: { descendingOrder?: boolean; signal?: AbortSignal } & PaginationArguments<
        null
        | string,
    >

  Returns Promise<EpochMetricsPage>

getEpochs

• getEpochs(
      input?: { descendingOrder?: boolean; signal?: AbortSignal } & PaginationArguments<
          null
          | string,
      >,
  ): Promise<EpochPage>

  Return the committee information for the asked epoch

  Parameters

  • Optionalinput: { descendingOrder?: boolean; signal?: AbortSignal } & PaginationArguments<
        null
        | string,
    >

  Returns Promise<EpochPage>

getLatestCheckpointSequenceNumber

• getLatestCheckpointSequenceNumber(
      __namedParameters?: GetLatestCheckpointSequenceNumberParams,
  ): Promise<string>

  Get the sequence number of the latest checkpoint that has been executed

  Parameters

  • __namedParameters: GetLatestCheckpointSequenceNumberParams = {}

  Returns Promise<string>

getLatestSuiSystemState

• getLatestSuiSystemState(
      __namedParameters?: GetLatestSuiSystemStateParams,
  ): Promise<SuiSystemStateSummary>

  Return the latest system state content.

  Parameters

  • __namedParameters: GetLatestSuiSystemStateParams = {}

  Returns Promise<SuiSystemStateSummary>

getMoveCallMetrics

• getMoveCallMetrics(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<MoveCallMetrics>

  Returns list of top move calls by usage

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<MoveCallMetrics>

getMoveFunctionArgTypes

• getMoveFunctionArgTypes(
      input: GetMoveFunctionArgTypesParams,
  ): Promise<SuiMoveFunctionArgType[]>

  Get Move function argument types like read, write and full access

  Parameters

  • input: GetMoveFunctionArgTypesParams

  Returns Promise<SuiMoveFunctionArgType[]>

getNetworkMetrics

• getNetworkMetrics(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<NetworkMetrics>

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<NetworkMetrics>

getNormalizedMoveFunction

• getNormalizedMoveFunction(
      input: GetNormalizedMoveFunctionParams,
  ): Promise<SuiMoveNormalizedFunction>

  Get a structured representation of Move function

  Parameters

  • input: GetNormalizedMoveFunctionParams

  Returns Promise<SuiMoveNormalizedFunction>

getNormalizedMoveModule

• getNormalizedMoveModule(
      input: GetNormalizedMoveModuleParams,
  ): Promise<SuiMoveNormalizedModule>

  Get a structured representation of Move module

  Parameters

  • input: GetNormalizedMoveModuleParams

  Returns Promise<SuiMoveNormalizedModule>

getNormalizedMoveModulesByPackage

• getNormalizedMoveModulesByPackage(
      input: GetNormalizedMoveModulesByPackageParams,
  ): Promise<SuiMoveNormalizedModules>

  Get a map from module name to structured representations of Move modules

  Parameters

  • input: GetNormalizedMoveModulesByPackageParams

  Returns Promise<SuiMoveNormalizedModules>

getNormalizedMoveStruct

• getNormalizedMoveStruct(
      input: GetNormalizedMoveStructParams,
  ): Promise<SuiMoveNormalizedStruct>

  Get a structured representation of Move struct

  Parameters

  • input: GetNormalizedMoveStructParams

  Returns Promise<SuiMoveNormalizedStruct>

getObject

• getObject(input: GetObjectParams): Promise<SuiObjectResponse>

  Get details about an object

  Parameters

  • input: GetObjectParams

  Returns Promise<SuiObjectResponse>

getOwnedObjects

• getOwnedObjects(input: GetOwnedObjectsParams): Promise<PaginatedObjectsResponse>

  Get all objects owned by an address

  Parameters

  • input: GetOwnedObjectsParams

  Returns Promise<PaginatedObjectsResponse>

getProtocolConfig

• getProtocolConfig(input?: GetProtocolConfigParams): Promise<ProtocolConfig>

  Parameters

  • Optionalinput: GetProtocolConfigParams

  Returns Promise<ProtocolConfig>

getReferenceGasPrice

• getReferenceGasPrice(
      __namedParameters?: GetReferenceGasPriceParams,
  ): Promise<bigint>

  Getting the reference gas price for the network

  Parameters

  • __namedParameters: GetReferenceGasPriceParams = {}

  Returns Promise<bigint>

getRpcApiVersion

• getRpcApiVersion(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<undefined | string>

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<undefined | string>

getStakes

• getStakes(input: GetStakesParams): Promise<DelegatedStake[]>

  Return the delegated stakes for an address

  Parameters

  • input: GetStakesParams

  Returns Promise<DelegatedStake[]>

getStakesByIds

• getStakesByIds(input: GetStakesByIdsParams): Promise<DelegatedStake[]>

  Return the delegated stakes queried by id.

  Parameters

  • input: GetStakesByIdsParams

  Returns Promise<DelegatedStake[]>

getTotalSupply

• getTotalSupply(input: GetTotalSupplyParams): Promise<CoinSupply>

  Fetch total supply for a coin

  Parameters

  • input: GetTotalSupplyParams

  Returns Promise<CoinSupply>

getTotalTransactionBlocks

• getTotalTransactionBlocks(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<bigint>

  Get total number of transactions

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<bigint>

getTransactionBlock

• getTransactionBlock(
      input: GetTransactionBlockParams,
  ): Promise<SuiTransactionBlockResponse>

  Parameters

  • input: GetTransactionBlockParams

  Returns Promise<SuiTransactionBlockResponse>

getValidatorsApy

• getValidatorsApy(
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<ValidatorsApy>

  Return the Validators APYs

  Parameters

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<ValidatorsApy>

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

multiGetTransactionBlocks

• multiGetTransactionBlocks(
      input: MultiGetTransactionBlocksParams,
  ): Promise<SuiTransactionBlockResponse[]>

  Parameters

  • input: MultiGetTransactionBlocksParams

  Returns Promise<SuiTransactionBlockResponse[]>

queryEvents

• queryEvents(input: QueryEventsParams): Promise<PaginatedEvents>

  Get events for a given query criteria

  Parameters

  • input: QueryEventsParams

  Returns Promise<PaginatedEvents>

queryTransactionBlocks

• queryTransactionBlocks(
      input: QueryTransactionBlocksParams,
  ): Promise<PaginatedTransactionResponse>

  Get transaction blocks for a given query criteria

  Parameters

  • input: QueryTransactionBlocksParams

  Returns Promise<PaginatedTransactionResponse>

resolveNameServiceAddress

• resolveNameServiceAddress(
      input: ResolveNameServiceAddressParams,
  ): Promise<null | string>

  Parameters

  • input: ResolveNameServiceAddressParams

  Returns Promise<null | string>

resolveNameServiceNames

• resolveNameServiceNames(
      __namedParameters: ResolveNameServiceNamesParams & {
          format?: "at" | "dot";
      },
  ): Promise<ResolvedNameServiceNames>

  Parameters

  • __namedParameters: ResolveNameServiceNamesParams & { format?: "at" | "dot" }

  Returns Promise<ResolvedNameServiceNames>

signAndExecuteTransaction

• signAndExecuteTransaction(
      __namedParameters: {
          signer: Signer;
          transaction: Uint8Array<ArrayBufferLike> | Transaction;
      } & Omit<ExecuteTransactionBlockParams, "signature" | "transactionBlock">,
  ): Promise<SuiTransactionBlockResponse>

  Parameters

  • __namedParameters: { signer: Signer; transaction: Uint8Array<ArrayBufferLike> | Transaction } & Omit<
        ExecuteTransactionBlockParams,
        "signature"
        | "transactionBlock",
    >

  Returns Promise<SuiTransactionBlockResponse>

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

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

tryGetPastObject

• tryGetPastObject(input: TryGetPastObjectParams): Promise<ObjectRead>

  Parameters

  • input: TryGetPastObjectParams

  Returns Promise<ObjectRead>

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>