Class VariableTokensClient

The VariableTokensClient class provides methods to interact with variable tokens on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for managing variable debt tokens, retrieving token metadata, balances, and other related information within the AAVE protocol.

Remarks

This client is designed to work with variable debt tokens and provides a high-level API for token operations. The client can be instantiated in two ways:

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

Example

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

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

// Get token metadata and balance
const metadataAddress = await client.getMetadataBySymbol("USDC");
const balance = await client.balanceOf(userAddress, metadataAddress);

// Get scaled balance and total supply
const { scaledUserBalance, supply } = await client.getScaledUserBalanceAndSupply(
  userAddress,
  metadataAddress
);

Param: provider

The AptosProvider instance used to interact with the Aptos blockchain.

Param: signer

Optional Ed25519Account signer for transaction signing.

Hierarchy (View Summary)

Constructors

constructor

Properties

tokensContract

Methods

balanceOf buildTx callViewMethod decimals fundAccount getAccounAptBalance getAssetMetadata getEventsFromAccount getMetadataBySymbol getPreviousIndex getScaledUserBalanceAndSupply getSigner getTokenAddress getTxEvents getUnderlyingAssetAddress name scaledBalanceOf scaledTotalSupply sendTxAndAwaitResponse setSigner symbol totalSupply withModuleSigner withSigner buildWithDefaultSigner

Constructors

constructor

Properties

tokensContract

tokensContract: TokensContract

Methods

balanceOf

  • balanceOf(
        owner: AccountAddress,
        metadataAddress: AccountAddress,
    ): Promise<bigint>

    Retrieves the balance of variable tokens for a given owner and metadata address.

    Parameters

    • owner: AccountAddress

      The account address of the token owner.

    • metadataAddress: AccountAddress

      The account address of the token metadata.

    Returns Promise<bigint>

    A promise that resolves to the balance of the variable tokens as a bigint.

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.

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.

decimals

  • decimals(metadataAddress: AccountAddress): Promise<bigint>

    Retrieves the number of decimals for a given token.

    Parameters

    • metadataAddress: AccountAddress

      The address of the token's metadata.

    Returns Promise<bigint>

    A promise that resolves to the number of decimals as a bigint.

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.

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.

getAssetMetadata

  • getAssetMetadata(symbol: string): Promise<AccountAddress>

    Retrieves the metadata of a specific asset for a given owner.

    Parameters

    • symbol: string

      The symbol of the asset.

    Returns Promise<AccountAddress>

    A promise that resolves to the account address containing the asset metadata.

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.

getMetadataBySymbol

  • getMetadataBySymbol(symbol: string): Promise<AccountAddress>

    Retrieves the metadata associated with a given token symbol for a specific account.

    Parameters

    • symbol: string

      The symbol of the token for which metadata is being requested.

    Returns Promise<AccountAddress>

    A promise that resolves to the account address containing the metadata.

    Throws

    Will throw an error if the call to the view method fails.

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 a bigint representing the previous index.

getScaledUserBalanceAndSupply

  • getScaledUserBalanceAndSupply(
        owner: AccountAddress,
        metadataAddress: AccountAddress,
    ): Promise<{ scaledUserBalance: bigint; supply: bigint }>

    Retrieves the scaled user balance and supply for a given owner and metadata address.

    Parameters

    • owner: AccountAddress

      The account address of the owner.

    • metadataAddress: AccountAddress

      The account address of the metadata.

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

    A promise that resolves to a bigint representing the scaled user balance and supply.

getSigner

getTokenAddress

  • getTokenAddress(symbol: string): Promise<AccountAddress>

    Retrieves the token address for a given owner and token symbol.

    Parameters

    • symbol: string

      The symbol of the token.

    Returns Promise<AccountAddress>

    A promise that resolves to the account address of the token.

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.

getUnderlyingAssetAddress

  • getUnderlyingAssetAddress(
        metadataAddress: AccountAddress,
    ): Promise<AccountAddress>

    Retrieves the underlying asset 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 underlying asset.

name

  • name(metadataAddress: AccountAddress): Promise<string>

    Retrieves the name associated with a given metadata address.

    Parameters

    • metadataAddress: AccountAddress

      The address of the metadata to query.

    Returns Promise<string>

    A promise that resolves to the name as a string.

scaledBalanceOf

  • scaledBalanceOf(
        owner: AccountAddress,
        metadataAddress: AccountAddress,
    ): Promise<bigint>

    Retrieves the scaled balance of a specific token for a given owner.

    Parameters

    • owner: AccountAddress

      The address of the account owner.

    • metadataAddress: AccountAddress

      The address of the token metadata.

    Returns Promise<bigint>

    A promise that resolves to the scaled balance as a bigint.

scaledTotalSupply

  • scaledTotalSupply(metadataAddress: AccountAddress): Promise<bigint>

    Retrieves the scaled 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 scaled total supply of the token as a bigint.

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.

setSigner

symbol

  • symbol(metadataAddress: AccountAddress): Promise<string>

    Retrieves the symbol of a variable token given its metadata address.

    Parameters

    • metadataAddress: AccountAddress

      The address of the token's metadata.

    Returns Promise<string>

    A promise that resolves to the symbol of the token as a string.

totalSupply

  • totalSupply(metadataAddress: AccountAddress): Promise<bigint>

    Retrieves the total supply of a specific token.

    Parameters

    • metadataAddress: AccountAddress

      The account address of the token metadata.

    Returns Promise<bigint>

    A promise that resolves to the total supply of the token as a bigint.

withModuleSigner

withSigner

StaticbuildWithDefaultSigner

Settings

Member Visibility

On This Page

Constructors
Properties
Methods