Class TransferStrategyClient

The TransferStrategyClient class provides methods to interact with the Transfer Strategy contract on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for managing reward transfer strategies, emergency withdrawals, and retrieving strategy-related data within the AAVE protocol.

Remarks

This client is designed to work with the Transfer Strategy contract and provides a high-level API for managing reward distribution strategies. 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 = TransferStrategyClient.buildWithDefaultSigner(provider);

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

// Create a new pull rewards transfer strategy
const tx = await client.createPullRewardsTransferStrategy(
  rewardsAdminAddress,
  incentivesControllerAddress,
  rewardsVaultAddress
);

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

peripheryContract

Methods

buildTx callViewMethod createPullRewardsTransferStrategy fundAccount getAccounAptBalance getEventsFromAccount getSigner getTxEvents pullRewardsTransferStrategyEmergencyWithdrawal pullRewardsTransferStrategyGetIncentivesController pullRewardsTransferStrategyGetRewardsAdmin pullRewardsTransferStrategyGetRewardsVault sendTxAndAwaitResponse setSigner withModuleSigner withSigner buildWithDefaultSigner

Constructors

constructor

Properties

peripheryContract

peripheryContract: PeripheryContract

Methods

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.

createPullRewardsTransferStrategy

  • createPullRewardsTransferStrategy(
        rewardsAdmin: AccountAddress,
        incentivesController: AccountAddress,
        rewardsVault: AccountAddress,
    ): Promise<CommittedTransactionResponse>

    Creates a new pull rewards transfer strategy.

    Parameters

    • rewardsAdmin: AccountAddress

      The address of the rewards admin

    • incentivesController: AccountAddress

      The address of the incentives controller

    • rewardsVault: AccountAddress

      The signer capability of the rewards vault

    Returns Promise<CommittedTransactionResponse>

    A promise that resolves to a CommittedTransactionResponse

    Throws

    Will throw an error if the sender is not an emission admin

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.

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.

getSigner

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.

pullRewardsTransferStrategyEmergencyWithdrawal

  • pullRewardsTransferStrategyEmergencyWithdrawal(
        token: AccountAddress,
        to: AccountAddress,
        amount: bigint,
        strategy: AccountAddress,
    ): Promise<CommittedTransactionResponse>

    Performs an emergency withdrawal of rewards from the transfer strategy. Only the rewards admin can call this function.

    Parameters

    • token: AccountAddress

      The address of the token to withdraw

    • to: AccountAddress

      The address to which tokens will be transferred

    • amount: bigint

      The amount of tokens to transfer

    • strategy: AccountAddress

      The pull rewards transfer strategy object

    Returns Promise<CommittedTransactionResponse>

    A promise that resolves to a CommittedTransactionResponse

    Throws

    Will throw an error if the caller is not the rewards admin

pullRewardsTransferStrategyGetIncentivesController

  • pullRewardsTransferStrategyGetIncentivesController(
        strategy: AccountAddress,
    ): Promise<AccountAddress>

    Gets the incentives controller address for a pull rewards transfer strategy.

    Parameters

    • strategy: AccountAddress

      The pull rewards transfer strategy object

    Returns Promise<AccountAddress>

    A promise that resolves to the address of the incentives controller

pullRewardsTransferStrategyGetRewardsAdmin

  • pullRewardsTransferStrategyGetRewardsAdmin(
        strategy: AccountAddress,
    ): Promise<AccountAddress>

    Gets the rewards admin address for a pull rewards transfer strategy.

    Parameters

    • strategy: AccountAddress

      The pull rewards transfer strategy object

    Returns Promise<AccountAddress>

    A promise that resolves to the address of the rewards admin

pullRewardsTransferStrategyGetRewardsVault

  • pullRewardsTransferStrategyGetRewardsVault(
        strategy: AccountAddress,
    ): Promise<AccountAddress>

    Gets the rewards vault address for a pull rewards transfer strategy.

    Parameters

    • strategy: AccountAddress

      The pull rewards transfer strategy object

    Returns Promise<AccountAddress>

    A promise that resolves to the address of the rewards vault

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

withModuleSigner

withSigner

StaticbuildWithDefaultSigner

Settings

Member Visibility

On This Page

Constructors
Properties
Methods