Class SupraClient

constructor

• new SupraClient(url, chainId?): SupraClient

• Parameters

  • url: string
  • chainId: number = ...

  Returns SupraClient

chainId

delayBetweenPoolingRequest

maxRetryForTransactionCompletion

supraNodeURL

fundAccountWithFaucet

• fundAccountWithFaucet(account): Promise<FaucetRequestResponse>

• Airdrop test Supra token on given account

  Parameters

  • account: HexString

    Hex-encoded 32 byte Supra account address

  Returns Promise<FaucetRequestResponse>

  FaucetRequestResponse

getAccountCoinBalance

• getAccountCoinBalance(account, coinType): Promise<bigint>

• Get Coin balance of given account

  Parameters

  • account: HexString

    Supra account address for getting balance
  • coinType: string

    Type of a coin resource

  Returns Promise<bigint>

  Supra Balance

getAccountCompleteTransactionsDetail

• getAccountCompleteTransactionsDetail(account, count?): Promise<TransactionDetail[]>

• Get transactions sent by the account and Coin transfer related transactions

  Parameters

  • account: HexString

    Supra account address
  • count: number = 15

    Number of coin transfer transactions and account sent transaction to be considered, For instance if the value is N so total N*2 transactions will be returned.

  Returns Promise<TransactionDetail[]>

  List of TransactionDetail

getAccountInfo

• getAccountInfo(account): Promise<AccountInfo>

• Get info of given supra account

  Parameters

  • account: HexString

    Hex-encoded 32 byte Supra account address

  Returns Promise<AccountInfo>

  AccountInfo

getAccountResources

• getAccountResources(account): Promise<AccountResources>

• Get list of all resources held by given supra account

  Parameters

  • account: HexString

    Hex-encoded 32 byte Supra account address

  Returns Promise<AccountResources>

  AccountResources

getAccountSupraCoinBalance

• getAccountSupraCoinBalance(account): Promise<bigint>

• Get Supra balance of given account

  Parameters

  • account: HexString

    Supra Account address for getting balance

  Returns Promise<bigint>

  Supra Balance

getAccountTransactionsDetail

• getAccountTransactionsDetail(account, count?, start?): Promise<TransactionDetail[]>

• Get transactions sent by the account

  Parameters

  • account: HexString

    Supra account address
  • count: number = 15

    Number of transactions details
  • start: null | number = null

    Cursor for pagination based response

  Returns Promise<TransactionDetail[]>

  List of TransactionDetail

getChainId

• getChainId(): Promise<ChainId>

• Get Chain Id Of Supra Network

  Returns Promise<ChainId>

  Chain Id of network

getCoinInfo

• getCoinInfo(coinType): Promise<CoinInfo>

• Get Supra balance of given account

  Parameters

  • coinType: string

    Type of a coin resource

  Returns Promise<CoinInfo>

  CoinInfo

getCoinTransactionsDetail

• getCoinTransactionsDetail(account, count?, start?): Promise<TransactionDetail[]>

• Get Coin Transfer related transactions associated with the account

  Parameters

  • account: HexString

    Supra account address
  • count: number = 15

    Number of transactions details
  • start: null | number = null

    Cursor for pagination based response

  Returns Promise<TransactionDetail[]>

  List of TransactionDetail

getGasPrice

• getGasPrice(): Promise<bigint>

• Get current mean_gas_price

  Returns Promise<bigint>

  Current mean_gas_price

getResourceData

• getResourceData(account, resourceType): Promise<any>

• Get data of resource held by given supra account

  Parameters

  • account: HexString

    Hex-encoded 32 byte Supra account address
  • resourceType: string

    Type of a resource

  Returns Promise<any>

  Resource data

getTransactionDetail

• getTransactionDetail(account, transactionHash): Promise<null | TransactionDetail>

• Get transaction details of given transaction hash

  Parameters

  • account: HexString

    Hex-encoded 32 byte Supra account address
  • transactionHash: string

    Hex-encoded 32 byte transaction hash for getting transaction details

  Returns Promise<null | TransactionDetail>

  TransactionDetail

getTransactionStatus

• getTransactionStatus(transactionHash): Promise<null | TransactionStatus>

• Get status of given supra transaction

  Parameters

  • transactionHash: string

    Hex-encoded 32 byte transaction hash for getting transaction status

  Returns Promise<null | TransactionStatus>

  TransactionStatus

isAccountExists

• isAccountExists(account): Promise<boolean>

• Check whether given account exists onchain or not

  Parameters

  • account: HexString

    Hex-encoded 32 byte Supra account address

  Returns Promise<boolean>

  true if account exists otherwise false

publishPackage

• publishPackage(senderAccount, packageMetadata, modulesCode): Promise<TransactionResponse>

• Publish package or module on supra network

  Parameters

  • senderAccount: SupraAccount

    Module Publisher KeyPair
  • packageMetadata: Uint8Array

    Package Metadata
  • modulesCode: Uint8Array[]

    module code

  Returns Promise<TransactionResponse>

  TransactionResponse

sendTxUsingSerializedRawTransaction

• sendTxUsingSerializedRawTransaction(senderAccount, serializedRawTransaction): Promise<TransactionResponse>

• Send entry_function_payload type tx using serialized raw transaction datas

  Parameters

  • senderAccount: SupraAccount

    Sender KeyPair
  • serializedRawTransaction: Uint8Array

    Serialized raw transaction data

  Returns Promise<TransactionResponse>

  TransactionResponse

simulateTx

• simulateTx(sendTxPayload): Promise<void>

• Simulate a transaction using the provided transaction payload

  Parameters

  • sendTxPayload: SendTxPayload

    Transaction payload

  Returns Promise<void>

transferCoin

• transferCoin(senderAccount, receiverAccountAddr, amount, coinType, waitForTransactionCompletion?): Promise<TransactionResponse>

• Transfer coin

  Parameters

  • senderAccount: SupraAccount

    Sender KeyPair
  • receiverAccountAddr: HexString

    Receiver Supra Account address
  • amount: bigint

    Amount to transfer
  • coinType: string

    Type of coin
  • waitForTransactionCompletion: boolean = false

  Returns Promise<TransactionResponse>

  TransactionResponse

transferSupraCoin

• transferSupraCoin(senderAccount, receiverAccountAddr, amount, waitForTransactionCompletion?): Promise<TransactionResponse>

• Transfer supra coin

  Parameters

  • senderAccount: SupraAccount

    Sender KeyPair
  • receiverAccountAddr: HexString

    Receiver Supra Account address
  • amount: bigint

    Amount to transfer
  • waitForTransactionCompletion: boolean = false

  Returns Promise<TransactionResponse>

  TransactionResponse

Static createRawTxObject

• createRawTxObject(senderAddr, senderSequenceNumber, moduleAddr, moduleName, functionName, functionTypeArgs, functionArgs, chainId, maxGas?, gasUnitPrice?, txExpiryTime?): Promise<RawTransaction>

• Parameters

  • senderAddr: HexString
  • senderSequenceNumber: bigint
  • moduleAddr: string
  • moduleName: string
  • functionName: string
  • functionTypeArgs: TypeTag[]
  • functionArgs: Uint8Array[]
  • chainId: ChainId
  • maxGas: bigint = ...
  • gasUnitPrice: bigint = ...
  • txExpiryTime: bigint = ...

  Returns Promise<RawTransaction>

Static createSerializedRawTxObject

• createSerializedRawTxObject(senderAddr, senderSequenceNumber, moduleAddr, moduleName, functionName, functionTypeArgs, functionArgs, chainId, maxGas?, gasUnitPrice?, txExpiryTime?): Promise<Uint8Array>

• Create serialized raw transaction object for entry_function_payload type tx

  Parameters

  • senderAddr: HexString

    Sender account address
  • senderSequenceNumber: bigint

    Sender account sequence number
  • moduleAddr: string

    Target module address
  • moduleName: string

    Target module name
  • functionName: string

    Target function name
  • functionTypeArgs: TypeTag[]

    Target function type args
  • functionArgs: Uint8Array[]

    Target function args
  • chainId: ChainId

    Supra network chain id
  • maxGas: bigint = ...

    Maximum gas for transaction
  • gasUnitPrice: bigint = ...

    Maximum gas unit price for transaction
  • txExpiryTime: bigint = ...

    Expiry time for transaction

  Returns Promise<Uint8Array>

  Serialized raw transaction object

Static init

• init(url): Promise<SupraClient>

• Creates and initializes SupraClient instance

  Parameters

  • url: string

    rpc url of supra rpc node

  Returns Promise<SupraClient>

  SupraClient initialized instance