Class ATokensClient

The ATokensClient class provides methods to interact with AToken contracts on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for creating tokens, retrieving metadata, and managing token balances.

Remarks

This client is designed to work with the AToken contracts and provides a high-level API for common operations. The client can be instantiated in two ways:

Using the constructor directly with a provider and optional signer
Using the static buildWithDefaultSigner method which automatically configures the client with the provider's ATokens profile account

Example

// Using buildWithDefaultSigner
const provider = new AptosProvider();
const client = ATokensClient.buildWithDefaultSigner(provider);

// Using constructor directly
const provider = new AptosProvider();
const signer = provider.getATokensProfileAccount();
const client = new ATokensClient(provider, signer);

// Get token balance
const balance = await client.balanceOf(ownerAddress, metadataAddress);

Param: provider

The AptosProvider instance used to interact with the Aptos blockchain.

Param: signer

Optional Ed25519Account signer for transaction signing.

Hierarchy (View Summary)

AptosContractWrapperBaseClass
- ATokensClient

Constructors

constructor

new ATokensClient(
provider: AptosProvider,
signer?: Ed25519Account,
): ATokensClient
Creates an instance of the aTokensClient.
Parameters
- provider: AptosProvider
  The AptosProvider instance to interact with the Aptos blockchain.
- Optionalsigner: Ed25519Account
  Optional Ed25519Account instance used for signing transactions.
Returns ATokensClient
Overrides AptosContractWrapperBaseClass.constructor
- Defined in clients/aTokensClient.ts:51

Properties

tokensContract

tokensContract: TokensContract

Methods

assetMetadata

assetMetadata(symbol: string): Promise<AccountAddress>
Retrieves the metadata of a specific asset for a given owner and symbol.
Parameters
- symbol: string
  The symbol of the asset.
Returns Promise<AccountAddress>
A promise that resolves to the account address containing the asset metadata.
- Defined in clients/aTokensClient.ts:141

balanceOf

balanceOf(
owner: AccountAddress,
metadataAddress: AccountAddress,
): Promise<bigint>
Retrieves the balance of a specific token for a given account.
Parameters
- owner: AccountAddress
  The address of the account whose token balance is being queried.
- metadataAddress: AccountAddress
  The address of the token's metadata.
Returns Promise<bigint>
A promise that resolves to the balance of the token as a bigint.
- Defined in clients/aTokensClient.ts:208

buildTx

buildTx(
    user: AccountAddress,
    functionId: `${string}::${string}::${string}`,
    funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[],
    typeArgs?: string[],
): Promise<SimpleTransaction>
Builds a transaction for the specified user, function, and arguments.
Parameters
- user: AccountAddress
  The account address of the user initiating the transaction.
- functionId: `${string}::${string}::${string}`
  The identifier of the Move function to be called.
- funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[]
  An array of arguments for the entry function.
- typeArgs: string[] = []
Returns Promise<SimpleTransaction>
A promise that resolves to a SimpleTransaction object.
Inherited from AptosContractWrapperBaseClass.buildTx
- Defined in clients/baseClass.ts:234

callViewMethod

callViewMethod<T extends MoveValue[]>(
    functionId: `${string}::${string}::${string}`,
    funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[],
    typeArgs?: string[],
): Promise<T>
Calls a view method on the Aptos blockchain.
Type Parameters
- T extends MoveValue[]
  The type of the return value, which extends an array of MoveValue.
Parameters
- functionId: `${string}::${string}::${string}`
  The identifier of the function to call.
- funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[]
  The arguments to pass to the function.
- typeArgs: string[] = []
  Optional generic type arguments for the function (e.g. ["0x1::aptos_coin::AptosCoin"]).
Returns Promise<T>
- A promise that resolves to the result of the view method call.
Inherited from AptosContractWrapperBaseClass.callViewMethod
- Defined in clients/baseClass.ts:260

decimals

decimals(metadataAddress: AccountAddress): Promise<bigint>
Retrieves the number of decimals for a given token.
Parameters
- metadataAddress: AccountAddress
  The address of the token metadata.
Returns Promise<bigint>
A promise that resolves to the number of decimals as a bigint.
- Defined in clients/aTokensClient.ts:328

fundAccount

fundAccount(
account: AccountAddress,
amount: bigint,
): Promise<UserTransactionResponse>
Funds an account with a specified amount.
Parameters
- account: AccountAddress
  The address of the account to be funded.
- amount: bigint
  The amount to fund the account with, in bigint.
Returns Promise<UserTransactionResponse>
A promise that resolves to a UserTransactionResponse.
Inherited from AptosContractWrapperBaseClass.fundAccount
- Defined in clients/baseClass.ts:282

getAccounAptBalance

getAccounAptBalance(
    account: Ed25519Account,
    accountAddress: AccountAddress,
    versionToWaitFor?: bigint,
): Promise<bigint>
Retrieves the Aptos balance of a specified account.
Parameters
- account: Ed25519Account
  The Ed25519 account object.
- accountAddress: AccountAddress
  The address of the account to retrieve the balance for.
- OptionalversionToWaitFor: bigint
  (Optional) The specific version to wait for before retrieving the balance.
Returns Promise<bigint>
A promise that resolves to the balance of the account in bigint.
Inherited from AptosContractWrapperBaseClass.getAccounAptBalance
- Defined in clients/baseClass.ts:297

getDecimals

getDecimals(
funcAddr: `${string}::${string}::${string}`,
metadataAddr: AccountAddress,
): Promise<bigint>
Retrieves the decimal precision of a token.
Parameters
- funcAddr: `${string}::${string}::${string}`
  The address of the Move function to call.
- metadataAddr: AccountAddress
  The account address containing the token metadata.
Returns Promise<bigint>
A promise that resolves to the decimal precision of the token as a bigint.
- Defined in clients/aTokensClient.ts:359

getEventsFromAccount

getEventsFromAccount(
    account: AccountAddress,
    limit: number,
): Promise<
    {
        account_address: string;
        creation_number: any;
        data: any;
        event_index: any;
        indexed_type: string;
        sequence_number: any;
        transaction_block_height: any;
        transaction_version: any;
        type: string;
    }[],
>
Retrieves events associated with a specific account.
Parameters
- account: AccountAddress
  The address of the account to retrieve events for.
- limit: number
  The maximum number of events to retrieve.
Returns Promise<
    {
        account_address: string;
        creation_number: any;
        data: any;
        event_index: any;
        indexed_type: string;
        sequence_number: any;
        transaction_block_height: any;
        transaction_version: any;
        type: string;
    }[],
>
A promise that resolves to an array of event objects, each containing:
- account_address: The address of the account.
- creation_number: The creation number of the event.
- data: The data associated with the event.
- event_index: The index of the event.
- sequence_number: The sequence number of the event.
- transaction_block_height: The block height of the transaction.
- transaction_version: The version of the transaction.
- type: The type of the event.
- indexed_type: The indexed type of the event.
Inherited from AptosContractWrapperBaseClass.getEventsFromAccount
- Defined in clients/baseClass.ts:355

getMetadataAddress

getMetadataAddress(
funcAddr: `${string}::${string}::${string}`,
coinName: string,
): Promise<AccountAddress>
Retrieves the metadata address for a given coin.
Parameters
- funcAddr: `${string}::${string}::${string}`
  The Move function identifier to call.
- coinName: string
  The name of the coin for which to retrieve the metadata address.
Returns Promise<AccountAddress>
A promise that resolves to the account address containing the metadata.
- Defined in clients/aTokensClient.ts:344

getMetadataBySymbol

getMetadataBySymbol(symbol: string): Promise<AccountAddress>
Retrieves the metadata of an AToken by its symbol for a given account owner.
Parameters
- symbol: string
  The symbol of the AToken.
Returns Promise<AccountAddress>
A promise that resolves to the account address containing the metadata.
- Defined in clients/aTokensClient.ts:97

getPreviousIndex

getPreviousIndex(
user: AccountAddress,
metadataAddress: AccountAddress,
): Promise<bigint>
Retrieves the previous index for a given user and metadata address.
Parameters
- user: AccountAddress
  The account address of the user.
- metadataAddress: AccountAddress
  The account address of the metadata.
Returns Promise<bigint>
A promise that resolves to the previous index as a bigint.
- Defined in clients/aTokensClient.ts:261

getReserveTreasuryAddress

getReserveTreasuryAddress(
metadataAddress: AccountAddress,
): Promise<AccountAddress>
Retrieves the reserve treasury address for a given metadata address.
Parameters
- metadataAddress: AccountAddress
  The account address of the metadata.
Returns Promise<AccountAddress>
A promise that resolves to the account address of the reserve treasury.
- Defined in clients/aTokensClient.ts:155

getScaledUserBalanceAndSupply

getScaledUserBalanceAndSupply(
owner: AccountAddress,
metadataAddress: AccountAddress,
): Promise<{ scaledUserBalance: bigint; supply: bigint }>
Retrieves the scaled user balance and total supply for a given user and token metadata address.
Parameters
- owner: AccountAddress
  The account address of the user whose balance is being queried.
- metadataAddress: AccountAddress
  The account address of the token metadata.
Returns Promise<{ scaledUserBalance: bigint; supply: bigint }>
A promise that resolves to an object containing the scaled user balance and the total supply.
- Defined in clients/aTokensClient.ts:281

getSigner

getSigner(): Ed25519Account
Retrieves the current Ed25519Account signer.

Returns Ed25519Account
The current signer.
Inherited from AptosContractWrapperBaseClass.getSigner
- Defined in clients/baseClass.ts:199

getTokenAccountAddress

getTokenAccountAddress(metadataAddress: AccountAddress): Promise<AccountAddress>
Retrieves the token account address associated with the given metadata address.
Parameters
- metadataAddress: AccountAddress
  The address of the metadata account.
Returns Promise<AccountAddress>
A promise that resolves to the token account address.
- Defined in clients/aTokensClient.ts:111

getTokenAddress

getTokenAddress(symbol: string): Promise<AccountAddress>
Retrieves the token address for a given owner and token symbol.
Parameters
- symbol: string
Returns Promise<AccountAddress>
A promise that resolves to the account address of the token.
- Defined in clients/aTokensClient.ts:127

getTxEvents

getTxEvents(txHash: HexInput): Promise<{ data: unknown }[]>
Retrieves the events associated with a given transaction hash.
Parameters
- txHash: HexInput
  The hash of the transaction to retrieve events for.
Returns Promise<{ data: unknown }[]>
A promise that resolves to an array of objects containing the event data.

Remarks
This method fetches the transaction details using the provided Aptos provider. It then checks if the transaction response is of type BlockMetadataTransactionResponse or UserTransactionResponse to extract the events. The event data is parsed from JSON and returned in an array.
Inherited from AptosContractWrapperBaseClass.getTxEvents
- Defined in clients/baseClass.ts:321

getUnderlyingAssetAddress

getUnderlyingAssetAddress(
metadataAddress: AccountAddress,
): Promise<AccountAddress>
Retrieves the underlying asset address for a given metadata address.
Parameters
- metadataAddress: AccountAddress
  The address of the metadata account.
Returns Promise<AccountAddress>
A promise that resolves to the underlying asset address.
- Defined in clients/aTokensClient.ts:171

name

name(metadataAddress: AccountAddress): Promise<string>
Retrieves the name of the token associated with the given metadata address.
Parameters
- metadataAddress: AccountAddress
  The address of the account metadata.
Returns Promise<string>
A promise that resolves to the name of the token as a string.
- Defined in clients/aTokensClient.ts:300

rescueTokens

rescueTokens(
    token: AccountAddress,
    to: AccountAddress,
    amount: bigint,
    metadataAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Rescues tokens from the contract and sends them to a specified address.
Parameters
- token: AccountAddress
  The address of the token to be rescued.
- to: AccountAddress
  The address to which the rescued tokens will be sent.
- amount: bigint
  The amount of tokens to be rescued.
- metadataAddress: AccountAddress
  The address of the metadata associated with the token.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the response of the committed transaction.
- Defined in clients/aTokensClient.ts:79

scaledBalanceOf

scaledBalanceOf(
owner: AccountAddress,
metadataAddress: AccountAddress,
): Promise<bigint>
Retrieves the scaled balance of a specific account for a given token.
Parameters
- owner: AccountAddress
  The address of the account whose scaled balance is being queried.
- metadataAddress: AccountAddress
  The address of the token's metadata.
Returns Promise<bigint>
A promise that resolves to the scaled balance of the specified account as a bigint.
- Defined in clients/aTokensClient.ts:188

scaledTotalSupply

scaledTotalSupply(metadataAddress: AccountAddress): Promise<bigint>
Retrieves the scaled total supply of a token.
Parameters
- metadataAddress: AccountAddress
  The address of the token's metadata.
Returns Promise<bigint>
A promise that resolves to the scaled total supply of the token as a bigint.
- Defined in clients/aTokensClient.ts:227

sendTxAndAwaitResponse

sendTxAndAwaitResponse(
    functionId: `${string}::${string}::${string}`,
    funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[],
    typeArgs?: string[],
): Promise<CommittedTransactionResponse>
Sends a transaction and awaits the response.
Parameters
- functionId: `${string}::${string}::${string}`
  The ID of the Move function to be called.
- funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[]
  An array of arguments for the entry function.
- typeArgs: string[] = []
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the committed transaction response.
Inherited from AptosContractWrapperBaseClass.sendTxAndAwaitResponse
- Defined in clients/baseClass.ts:210

setSigner

setSigner(senderAccount: Ed25519Account): void
Sets the signer for the client.
Parameters
- senderAccount: Ed25519Account
  The Ed25519 account to be used as the signer.
Returns void
Inherited from AptosContractWrapperBaseClass.setSigner
- Defined in clients/baseClass.ts:169

symbol

symbol(metadataAddress: AccountAddress): Promise<string>
Retrieves the symbol of the AToken associated with the given metadata address.
Parameters
- metadataAddress: AccountAddress
  The address of the account metadata.
Returns Promise<string>
A promise that resolves to the symbol of the AToken as a string.
- Defined in clients/aTokensClient.ts:314

totalSupply

totalSupply(metadataAddress: AccountAddress): Promise<bigint>
Retrieves the total supply of a token given its metadata address.
Parameters
- metadataAddress: AccountAddress
  The address of the token's metadata.
Returns Promise<bigint>
A promise that resolves to the total supply of the token as a bigint.
- Defined in clients/aTokensClient.ts:245

withModuleSigner

withModuleSigner(): ATokensClient
Sets the signer to the module signer and returns the current instance.

Returns ATokensClient
The current instance with the module signer set.
Inherited from AptosContractWrapperBaseClass.withModuleSigner
- Defined in clients/baseClass.ts:189

withSigner

withSigner(senderAccount: Ed25519Account): ATokensClient
Sets the signer for the current instance using the provided Ed25519 account.
Parameters
- senderAccount: Ed25519Account
  The Ed25519 account to be used as the signer.
Returns ATokensClient
The current instance with the signer set.
Inherited from AptosContractWrapperBaseClass.withSigner
- Defined in clients/baseClass.ts:179

`Static`buildWithDefaultSigner

buildWithDefaultSigner(provider: AptosProvider): ATokensClient
Creates an instance of ATokensClient using the default signer from the provided AptosProvider.
Parameters
- provider: AptosProvider
  The AptosProvider instance to use for creating the ATokensClient.
Returns ATokensClient
A new instance of ATokensClient.
- Defined in clients/aTokensClient.ts:62

Class ATokensClient

Remarks

Example

Param: provider

Param: signer

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ATokensClient

Properties

tokensContract

Methods

assetMetadata

Parameters

Returns Promise<AccountAddress>

balanceOf

Parameters

Returns Promise<bigint>

buildTx

Parameters

Returns Promise<SimpleTransaction>

callViewMethod

Type Parameters

Parameters

Returns Promise<T>

decimals

Parameters

Returns Promise<bigint>

fundAccount

Parameters

Returns Promise<UserTransactionResponse>

getAccounAptBalance

Parameters

Returns Promise<bigint>

getDecimals

Parameters

Returns Promise<bigint>

getEventsFromAccount

Parameters

Returns Promise< { account_address: string; creation_number: any; data: any; event_index: any; indexed_type: string; sequence_number: any; transaction_block_height: any; transaction_version: any; type: string; }[],>

getMetadataAddress

Parameters

Returns Promise<AccountAddress>

getMetadataBySymbol

Parameters

Returns Promise<AccountAddress>

getPreviousIndex

Parameters

Returns Promise<bigint>

getReserveTreasuryAddress

Parameters

Returns Promise<AccountAddress>

getScaledUserBalanceAndSupply

Parameters

Returns Promise<{ scaledUserBalance: bigint; supply: bigint }>

getSigner

Returns Ed25519Account

getTokenAccountAddress

Parameters

Returns Promise<AccountAddress>

getTokenAddress

Parameters

Returns Promise<AccountAddress>

getTxEvents

Parameters

Returns Promise<{ data: unknown }[]>

Remarks

getUnderlyingAssetAddress

Parameters

Returns Promise<AccountAddress>

name

Parameters

Returns Promise<string>

rescueTokens

Parameters

Returns Promise<
{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[],
>

`Static`buildWithDefaultSigner