Class APTOS

account

aptos

connected

name

network

provider

rpc_url

signer

wallet

connect

• connect(): Promise<boolean>

• Connects to the Aptos network

  Returns Promise<boolean>

  A boolean indicating whether the connection was successful

connectWallet

• connectWallet(privateKey): Promise<Account>

• Connects to a wallet using a private key

  Parameters

  • privateKey: string

    The private key of the wallet (hex string)

  Returns Promise<Account>

  The Account object

disconnect

• disconnect(): Promise<boolean>

• Disconnects from the RPC provider and the wallet

  Returns Promise<boolean>

  A boolean indicating if the disconnection was successful

getAddress

• getAddress(): string

• Returns the address of the connected wallet

  Returns string

  The wallet address as hex string

getAPTBalance

• getAPTBalance(address): Promise<any>

• Gets the APT balance from the Aptos network given an address

  Parameters

  • address: string

    The wallet address

  Returns Promise<any>

  XM operation object for Demos Network relay

getAPTBalanceDirect

• getAPTBalanceDirect(address): Promise<string>

• Gets the APT balance directly from Aptos RPC given an address

  The other get balance methods use this method to get the balance

  Parameters

  • address: string

    The wallet address

  Returns Promise<string>

  The balance as a string (in Octas)

getBalance

• getBalance(address): Promise<any>

• Gets the APT balance from the Aptos network given an address

  Parameters

  • address: string

    The wallet address

  Returns Promise<any>

  XM operation object for Demos Network relay

getCoinBalance

• getCoinBalance(coinType, address): Promise<any>

• Gets a coin balance from the Aptos network given a coin type and address

  Parameters

  • coinType: string

    The coin type (e.g., "0x1::aptos_coin::AptosCoin")
  • address: string

    The wallet address

  Returns Promise<any>

  XM operation object for Demos Network relay

getCoinBalanceDirect

• getCoinBalanceDirect(coinType, address): Promise<string>

• Gets the balance of a specific coin type directly from Aptos RPC given a coin type and address

  The other get balance methods use this method to get the balance

  Parameters

  • coinType: string

    The coin type (e.g., "0x1::aptos_coin::AptosCoin")
  • address: string

    The wallet address

  Returns Promise<string>

  The balance as a string

getEmptyTransaction

• getEmptyTransaction(): Promise<SimpleTransaction>

• Creates an empty transaction template

  Returns Promise<SimpleTransaction>

getPublicKey

• getPublicKey(): string

• Gets the public key of the connected wallet

  Returns string

  The public key as hex string

isAddress

• isAddress(address): boolean

• Check if an address is valid

  Parameters

  • address: string

    The address to validate

  Returns boolean

  Boolean indicating if the address is valid

preparePay

• preparePay(receiver, amount): Promise<string>

• Creates a signed transaction to transfer APT

  Parameters

  • receiver: string

    The receiver's address
  • amount: string

    The amount to transfer (in Octas)

  Returns Promise<string>

  The signed Aptos transaction as hex string

preparePays

• preparePays(payments): Promise<string[]>

• Creates multiple signed transactions to transfer APT

  Parameters

  • payments: IPayOptions[]

    Array of payment parameters

  Returns Promise<string[]>

  Array of signed Aptos transactions as hex strings

prepareTransfer

• prepareTransfer<T, Options>(this, receiver, amount, options?): Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

• Creates a signed transaction to transfer default chain currency

  Type Parameters

  • T extends DefaultChain
  • Options extends {}

  Parameters

  • this: T
  • receiver: string

    The receiver's address
  • amount: string

    The amount to transfer
  • Optionaloptions: Options

    Options

  Returns Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

  The signed transaction

prepareTransfers

• prepareTransfers<T, Options>(this, payments, options?): Promise<Awaited<ReturnType<T["preparePays"]>>>

• Creatthis.provider = new JsonRpcProvider(this.rpc_url)es a list of signed transactions to transfer default chain currency

  Type Parameters

  • T extends DefaultChain
  • Options extends {}

  Parameters

  • this: T
  • payments: IPayOptions[]

    A list of transfers to prepare
  • Optionaloptions: Options

    Options

  Returns Promise<Awaited<ReturnType<T["preparePays"]>>>

  An ordered list of signed transactions

readFromContract

• readFromContract(moduleAddress, moduleName, functionName, args, typeArguments?): Promise<XMScript>

• Read from a smart contract via Demos Network XM operation (default behavior)

  Parameters

  • moduleAddress: string

    The module address
  • moduleName: string

    The module name
  • functionName: string

    The function name
  • args: any[]

    Function arguments
  • typeArguments: string[] = []

    Type arguments for generic functions (optional)

  Returns Promise<XMScript>

  The XMScript object ready to be used in a Demos transaction

readFromContractDirect

• readFromContractDirect(moduleAddress, moduleName, functionName, args, typeArguments?): Promise<any>

• Read from a smart contract directly (bypasses Demos Network) Use only when explicit direct access is needed

  Parameters

  • moduleAddress: string

    The module address
  • moduleName: string

    The module name
  • functionName: string

    The function name
  • args: any[]

    Function arguments
  • typeArguments: string[] = []

    Type arguments for generic functions (optional)

  Returns Promise<any>

  The function result

setNetwork

• setNetwork(network): void

• Sets the network and reinitializes the Aptos client

  Parameters

  • network: Network

  Returns void

setRpc

• setRpc(rpc_url): void

• Sets the RPC URL and reinitializes the Aptos client

  Parameters

  • rpc_url: string

  Returns void

signMessage

• signMessage(message): Promise<string>

• Signs a message using the connected wallet

  Parameters

  • message: string

    The message to sign

  Returns Promise<string>

  The signed message as hex string

signTransaction

• signTransaction(transaction): Promise<string>

• Signs a transaction using the connected wallet

  Parameters

  • transaction: SimpleTransaction

    The transaction to sign

  Returns Promise<string>

  The signed Aptos transaction as hex string

signTransactions

• signTransactions(transactions): Promise<string[]>

• Signs multiple transactions

  Parameters

  • transactions: SimpleTransaction[]

    Array of transactions to sign

  Returns Promise<string[]>

  Array of signed Aptos transactions as hex strings

verifyMessage

• verifyMessage(message, signature, publicKey): Promise<boolean>

• Verifies a message signature

  Parameters

  • message: string

    The original message
  • signature: string

    The signature to verify
  • publicKey: string

    The public key to verify against

  Returns Promise<boolean>

  Boolean indicating if the signature is valid

waitForTransaction

• waitForTransaction(transactionHash): Promise<UserTransactionResponse>

• Wait for transaction confirmation

  Parameters

  • transactionHash: string

    The transaction hash

  Returns Promise<UserTransactionResponse>

  The transaction response

writeToContract

• writeToContract(moduleAddress, moduleName, functionName, args, typeArguments?): Promise<XMScript>

• Prepare a smart contract write transaction for Demos Network relay Builds transaction for XM operations - does NOT execute directly All contract writes must go through Demos Network XM system

  Parameters

  • moduleAddress: string

    The module address
  • moduleName: string

    The module name
  • functionName: string

    The function name
  • args: any[]

    Function arguments
  • typeArguments: string[] = []

    Type arguments (optional)

  Returns Promise<XMScript>

  The XMScript object ready to be used in a Demos transaction

Staticcreate

• create<T>(this, rpc_url?): Promise<T>

• Creates a new instance of this sdk

  Type Parameters

  • T extends DefaultChain

  Parameters

  • this: (new (rpc_url: string) => T)
    • • new (rpc_url): T

      • Parameters

        • rpc_url: string

        Returns T

  • rpc_url: string = ""

    The RPC URL

  Returns Promise<T>

  The sdk instance connected to the RPC provider