Class CoreClientAbstract

constructor

• new CoreClient(options: CoreClientOptions): CoreClient

  Parameters

  • options: CoreClientOptions

  Returns CoreClient

core

mvr

AbstractdefaultNameServiceName

• defaultNameServiceName(
      options: DefaultNameServiceNameOptions,
  ): Promise<DefaultNameServiceNameResponse>

  Parameters

  • options: DefaultNameServiceNameOptions

  Returns Promise<DefaultNameServiceNameResponse>

AbstractexecuteTransaction

• executeTransaction<Include extends TransactionInclude = {}>(
      options: ExecuteTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • options: ExecuteTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

AbstractgetBalance

• getBalance(options: GetBalanceOptions): Promise<GetBalanceResponse>

  Parameters

  • options: GetBalanceOptions

  Returns Promise<GetBalanceResponse>

AbstractgetChainIdentifier

• getChainIdentifier(
      options?: GetChainIdentifierOptions,
  ): Promise<GetChainIdentifierResponse>

  Parameters

  • Optionaloptions: GetChainIdentifierOptions

  Returns Promise<GetChainIdentifierResponse>

AbstractgetCoinMetadata

• getCoinMetadata(
      options: GetCoinMetadataOptions,
  ): Promise<GetCoinMetadataResponse>

  Parameters

  • options: GetCoinMetadataOptions

  Returns Promise<GetCoinMetadataResponse>

AbstractgetCurrentSystemState

• getCurrentSystemState(
      options?: GetCurrentSystemStateOptions,
  ): Promise<GetCurrentSystemStateResponse>

  Parameters

  • Optionaloptions: GetCurrentSystemStateOptions

  Returns Promise<GetCurrentSystemStateResponse>

getDynamicField

• getDynamicField(
      options: GetDynamicFieldOptions,
  ): Promise<GetDynamicFieldResponse>

  Parameters

  • options: GetDynamicFieldOptions

  Returns Promise<GetDynamicFieldResponse>

getDynamicObjectField

• getDynamicObjectField<Include extends ObjectInclude = {}>(
      options: GetDynamicObjectFieldOptions<Include>,
  ): Promise<GetDynamicObjectFieldResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • options: GetDynamicObjectFieldOptions<Include>

  Returns Promise<GetDynamicObjectFieldResponse<Include>>

AbstractgetMoveFunction

• getMoveFunction(
      options: GetMoveFunctionOptions,
  ): Promise<GetMoveFunctionResponse>

  Parameters

  • options: GetMoveFunctionOptions

  Returns Promise<GetMoveFunctionResponse>

getObject

• getObject<Include extends ObjectInclude = {}>(
      options: GetObjectOptions<Include>,
  ): Promise<GetObjectResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • options: GetObjectOptions<Include>

  Returns Promise<GetObjectResponse<Include>>

AbstractgetObjects

• getObjects<Include extends ObjectInclude = {}>(
      options: GetObjectsOptions<Include>,
  ): Promise<GetObjectsResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • options: GetObjectsOptions<Include>

  Returns Promise<GetObjectsResponse<Include>>

AbstractgetProtocolConfig

• getProtocolConfig(
      options?: GetProtocolConfigOptions,
  ): Promise<GetProtocolConfigResponse>

  Parameters

  • Optionaloptions: GetProtocolConfigOptions

  Returns Promise<GetProtocolConfigResponse>

AbstractgetReferenceGasPrice

• getReferenceGasPrice(
      options?: GetReferenceGasPriceOptions,
  ): Promise<GetReferenceGasPriceResponse>

  Parameters

  • Optionaloptions: GetReferenceGasPriceOptions

  Returns Promise<GetReferenceGasPriceResponse>

AbstractgetTransaction

• getTransaction<Include extends TransactionInclude = {}>(
      options: GetTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • options: GetTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

AbstractlistBalances

• listBalances(options: ListBalancesOptions): Promise<ListBalancesResponse>

  Parameters

  • options: ListBalancesOptions

  Returns Promise<ListBalancesResponse>

AbstractlistCheckpoints

• listCheckpoints(
      options: ListCheckpointsOptions,
  ): Promise<ListCheckpointsResponse>

  Parameters

  • options: ListCheckpointsOptions

  Returns Promise<ListCheckpointsResponse>

AbstractlistCoins

• listCoins(options: ListCoinsOptions): Promise<ListCoinsResponse>

  Parameters

  • options: ListCoinsOptions

  Returns Promise<ListCoinsResponse>

AbstractlistDynamicFields

• listDynamicFields(
      options: ListDynamicFieldsOptions,
  ): Promise<ListDynamicFieldsResponse>

  Parameters

  • options: ListDynamicFieldsOptions

  Returns Promise<ListDynamicFieldsResponse>

AbstractlistEvents

• listEvents(options: ListEventsOptions): Promise<ListEventsResponse>

  Parameters

  • options: ListEventsOptions

  Returns Promise<ListEventsResponse>

AbstractlistOwnedObjects

• listOwnedObjects<Include extends ObjectInclude = {}>(
      options: ListOwnedObjectsOptions<Include>,
  ): Promise<ListOwnedObjectsResponse<Include>>

  Type Parameters

  • Include extends ObjectInclude = {}

  Parameters

  • options: ListOwnedObjectsOptions<Include>

  Returns Promise<ListOwnedObjectsResponse<Include>>

AbstractlistTransactions

• listTransactions<Include extends TransactionInclude = {}>(
      options: ListTransactionsOptions<Include>,
  ): Promise<ListTransactionsResponse<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • options: ListTransactionsOptions<Include>

  Returns Promise<ListTransactionsResponse<Include>>

AbstractresolveTransactionPlugin

• resolveTransactionPlugin(): TransactionPlugin

  Returns TransactionPlugin

signAndExecuteTransaction

• signAndExecuteTransaction<Include extends TransactionInclude = {}>(
      __namedParameters: SignAndExecuteTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • __namedParameters: SignAndExecuteTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>

AbstractsimulateTransaction

• simulateTransaction<Include extends SimulateTransactionInclude = {}>(
      options: SimulateTransactionOptions<Include>,
  ): Promise<SimulateTransactionResult<Include>>

  Type Parameters

  • Include extends SimulateTransactionInclude = {}

  Parameters

  • options: SimulateTransactionOptions<Include>

  Returns Promise<SimulateTransactionResult<Include>>

AbstractverifyZkLoginSignature

• verifyZkLoginSignature(
      options: VerifyZkLoginSignatureOptions,
  ): Promise<ZkLoginVerifyResponse>

  Parameters

  • options: VerifyZkLoginSignatureOptions

  Returns Promise<ZkLoginVerifyResponse>

waitForTransaction

• waitForTransaction<Include extends TransactionInclude = {}>(
      options: WaitForTransactionOptions<Include>,
  ): Promise<SuiClientTypes.TransactionResult<Include>>

  Type Parameters

  • Include extends TransactionInclude = {}

  Parameters

  • options: WaitForTransactionOptions<Include>

  Returns Promise<SuiClientTypes.TransactionResult<Include>>