Class RewardsControllerClient

The RewardsControllerClient class provides methods to interact with the Rewards Controller contract on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for managing rewards, claiming rewards, and retrieving reward-related data within the AAVE protocol.

Remarks

This client is designed to work with the Rewards Controller contract and provides a high-level API for reward 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 pool profile account

Example

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

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

// Claim rewards for specific assets
const tx = await client.claimRewards(
  [assetAddress],
  1000n,
  recipientAddress,
  rewardAddress,
  rewardsControllerAddress
);

Param: provider

The AptosProvider instance used to interact with the Aptos blockchain.

Param: signer

Optional Ed25519Account signer for transaction signing.

Hierarchy (View Summary)

AptosContractWrapperBaseClass
- RewardsControllerClient

Constructors

constructor

new RewardsControllerClient(
provider: AptosProvider,
signer?: Ed25519Account,
): RewardsControllerClient
Creates an instance of RewardsControllerClient.
Parameters
- provider: AptosProvider
  The Aptos blockchain provider.
- Optionalsigner: Ed25519Account
  Optional Ed25519 account signer.
Returns RewardsControllerClient
Overrides AptosContractWrapperBaseClass.constructor
- Defined in clients/rewardsControllerClient.ts:125

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.
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

claimAllRewards

claimAllRewards(
    assets: AccountAddress[],
    to: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Claims all rewards for a user
Parameters
- assets: AccountAddress[]
  Vector of asset addresses
- to: AccountAddress
  The address to which rewards are transferred
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<CommittedTransactionResponse>
The transaction response containing a tuple of reward addresses and their corresponding amounts
- Defined in clients/rewardsControllerClient.ts:295

claimAllRewardsOnBehalf

claimAllRewardsOnBehalf(
    assets: AccountAddress[],
    user: AccountAddress,
    to: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Claims all rewards on behalf of a user
Parameters
- assets: AccountAddress[]
  Vector of asset addresses
- user: AccountAddress
  The address of the user
- to: AccountAddress
  The address to which rewards are transferred
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<CommittedTransactionResponse>
The transaction response containing a tuple of reward addresses and their corresponding amounts
- Defined in clients/rewardsControllerClient.ts:314

claimAllRewardsToSelf

claimAllRewardsToSelf(
assets: AccountAddress[],
rewardsControllerAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Claims all rewards and transfers them to the caller
Parameters
- assets: AccountAddress[]
  Vector of asset addresses
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<CommittedTransactionResponse>
The transaction response containing a tuple of reward addresses and their corresponding amounts
- Defined in clients/rewardsControllerClient.ts:332

claimRewards

claimRewards(
    assets: AccountAddress[],
    amount: bigint,
    to: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Claims rewards for a user
Parameters
- assets: AccountAddress[]
  Vector of asset addresses
- amount: bigint
  The amount of rewards to claim
- to: AccountAddress
  The address to which rewards are transferred
- reward: AccountAddress
  The address of the reward
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<CommittedTransactionResponse>
The transaction response containing the amount of rewards claimed
- Defined in clients/rewardsControllerClient.ts:231

claimRewardsOnBehalf

claimRewardsOnBehalf(
    assets: AccountAddress[],
    amount: bigint,
    user: AccountAddress,
    to: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Claims rewards on behalf of a user
Parameters
- assets: AccountAddress[]
  Vector of asset addresses
- amount: bigint
  The amount of rewards to claim
- user: AccountAddress
  The address of the user
- to: AccountAddress
  The address to which rewards are transferred
- reward: AccountAddress
  The address of the reward
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<CommittedTransactionResponse>
The transaction response containing the amount of rewards claimed
- Defined in clients/rewardsControllerClient.ts:254

claimRewardsToSelf

claimRewardsToSelf(
    assets: AccountAddress[],
    amount: bigint,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Claims rewards and transfers them to the caller
Parameters
- assets: AccountAddress[]
  Vector of asset addresses
- amount: bigint
  The amount of rewards to claim
- reward: AccountAddress
  The address of the reward
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<CommittedTransactionResponse>
The transaction response containing the amount of rewards claimed
- Defined in clients/rewardsControllerClient.ts:276

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

getAllUserRewards

getAllUserRewards(
    assets: AccountAddress[],
    user: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<[AccountAddress[], bigint[]]>
Gets all rewards for a user across multiple assets.
Parameters
- assets: AccountAddress[]
  Array of asset addresses to check rewards for.
- user: AccountAddress
  The address of the user.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<[AccountAddress[], bigint[]]>
A promise that resolves to a tuple containing: - Array of reward token addresses - Array of corresponding reward amounts as u256 values If no rewards controller data exists, returns [[], []].
- Defined in clients/rewardsControllerClient.ts:631

getAssetDecimals

getAssetDecimals(
asset: AccountAddress,
rewardsControllerAddress: AccountAddress,
): Promise<number>
Gets the number of decimals for a specific asset.
Parameters
- asset: AccountAddress
  The address of the asset.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<number>
A promise that resolves to the number of decimals as a number.
- Defined in clients/rewardsControllerClient.ts:659

getAssetIndex

getAssetIndex(
    asset: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<[bigint, bigint]>
Gets the asset index for a specific asset and reward.
Parameters
- asset: AccountAddress
  The address of the asset.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<[bigint, bigint]>
A promise that resolves to a tuple containing the current asset index and new asset index as u256 values. If no rewards data exists, returns [0, 0].
- Defined in clients/rewardsControllerClient.ts:474

getClaimer

getClaimer(
user: AccountAddress,
rewardsControllerAddress: AccountAddress,
): Promise<AccountAddress>
Gets the claimer for a user
Parameters
- user: AccountAddress
  The user address
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<AccountAddress>
The claimer address if one exists
- Defined in clients/rewardsControllerClient.ts:179

getDistributionEnd

getDistributionEnd(
    asset: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<bigint>
Gets the distribution end timestamp for a specific asset and reward.
Parameters
- asset: AccountAddress
  The address of the asset.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<bigint>
A promise that resolves to the distribution end timestamp as a u256 value.
- Defined in clients/rewardsControllerClient.ts:497

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

getPullRewardsTransferStrategy

getPullRewardsTransferStrategy(
reward: AccountAddress,
rewardsControllerAddress: AccountAddress,
): Promise<PullRewardsTransferStrategy>
Gets the pull rewards transfer strategy for a reward
Parameters
- reward: AccountAddress
  The reward address
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<PullRewardsTransferStrategy>
The pull rewards transfer strategy if one exists
- Defined in clients/rewardsControllerClient.ts:205

getRewardOracle

getRewardOracle(): Promise<AccountAddress>
Returns Promise<AccountAddress>
- Defined in clients/rewardsControllerClient.ts:190

getRewardsByAsset

getRewardsByAsset(
asset: AccountAddress,
rewardsControllerAddress: AccountAddress,
): Promise<AccountAddress[]>
Gets all rewards for a specific asset.
Parameters
- asset: AccountAddress
  The address of the asset.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<AccountAddress[]>
A promise that resolves to an array of reward token addresses. If no rewards data exists for the asset, returns an empty array.
- Defined in clients/rewardsControllerClient.ts:519

getRewardsData

getRewardsData(
    asset: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<RewardData>
Retrieves the global reward data for a given asset and reward token from the Rewards Controller contract.
Parameters
- asset: AccountAddress
  The address of the asset for which to fetch reward data.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<RewardData>
A promise that resolves to a RewardData object containing the global reward data. The usersData field will be an empty map.
- Defined in clients/rewardsControllerClient.ts:417

getRewardsList

getRewardsList(
rewardsControllerAddress: AccountAddress,
): Promise<AccountAddress[]>
Gets all available rewards from the rewards controller.
Parameters
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<AccountAddress[]>
A promise that resolves to an array of reward token addresses. If no rewards controller data exists, returns an empty array.
- Defined in clients/rewardsControllerClient.ts:537

getSigner

getSigner(): Ed25519Account
Retrieves the current Ed25519Account signer.

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

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

getUserAccruedRewards

getUserAccruedRewards(
    user: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<bigint>
Gets the total accrued rewards for a specific user and reward across all assets.
Parameters
- user: AccountAddress
  The address of the user.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<bigint>
A promise that resolves to the total accrued rewards as a u256 value. If no rewards controller data exists, returns 0.
- Defined in clients/rewardsControllerClient.ts:580

getUserAssetIndex

getUserAssetIndex(
    user: AccountAddress,
    asset: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<bigint>
Gets the user asset index for a specific user, asset, and reward.
Parameters
- user: AccountAddress
  The address of the user.
- asset: AccountAddress
  The address of the asset.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<bigint>
A promise that resolves to the user's asset index as a u256 value.
- Defined in clients/rewardsControllerClient.ts:556

getUserData

getUserData(
    asset: AccountAddress,
    reward: AccountAddress,
    user: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<UserData>
Gets user data for a specific asset, reward, and user.
Parameters
- asset: AccountAddress
  The address of the asset.
- reward: AccountAddress
  The address of the reward token.
- user: AccountAddress
  The address of the user.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<UserData>
A promise that resolves to a UserData object containing the user's index and accrued rewards as u256 values. If no user data exists, returns {index: 0n, accrued: 0n}.
- Defined in clients/rewardsControllerClient.ts:448

getUserRewards

getUserRewards(
    assets: AccountAddress[],
    user: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<bigint>
Gets the total rewards for a user across multiple assets for a specific reward token.
Parameters
- assets: AccountAddress[]
  Array of asset addresses to check rewards for.
- user: AccountAddress
  The address of the user.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<bigint>
A promise that resolves to the total rewards as a u256 value.
- Defined in clients/rewardsControllerClient.ts:603

lookupAssetData

lookupAssetData(
reward: AccountAddress,
rewardsControllerAddress: AccountAddress,
): Promise<PullRewardsTransferStrategy>
Looks up asset data for a specific asset
Parameters
- reward: AccountAddress
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller
Returns Promise<PullRewardsTransferStrategy>
The asset data if it exists
- Defined in clients/rewardsControllerClient.ts:349

lookupRewardsData

lookupRewardsData(
    asset: AccountAddress,
    reward: AccountAddress,
    rewardsControllerAddress: AccountAddress,
): Promise<{ assetData?: AssetData; rewardData?: RewardData }>
Looks up rewards data for a specific asset and reward.
Parameters
- asset: AccountAddress
  The address of the asset.
- reward: AccountAddress
  The address of the reward token.
- rewardsControllerAddress: AccountAddress
  The address of the rewards controller.
Returns Promise<{ assetData?: AssetData; rewardData?: RewardData }>
A promise that resolves to an object containing: - assetData: Asset configuration data - rewardData: Reward configuration data Both fields will be undefined if their respective data doesn't exist.
- Defined in clients/rewardsControllerClient.ts:377

rewardsControllerAddress

rewardsControllerAddress(): Promise<AccountAddress>
Gets the address of the rewards controller

Returns Promise<AccountAddress>
The address of the rewards controller
- Defined in clients/rewardsControllerClient.ts:151

rewardsControllerObject

rewardsControllerObject(): Promise<AccountAddress>
Gets the rewards controller object

Returns Promise<AccountAddress>
The rewards controller object
- Defined in clients/rewardsControllerClient.ts:164

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

withModuleSigner

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

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

withSigner

withSigner(senderAccount: Ed25519Account): RewardsControllerClient
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 RewardsControllerClient
The current instance with the signer set.
Inherited from AptosContractWrapperBaseClass.withSigner
- Defined in clients/baseClass.ts:179

`Static`buildWithDefaultSigner

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

Class RewardsControllerClient

Remarks

Example

Param: provider

Param: signer

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RewardsControllerClient

Properties

peripheryContract

Methods

buildTx

Parameters

Returns Promise<SimpleTransaction>

callViewMethod

Type Parameters

Parameters

Returns Promise<T>

claimAllRewards

Parameters

Returns Promise<CommittedTransactionResponse>

claimAllRewardsOnBehalf

Parameters

Returns Promise<CommittedTransactionResponse>

claimAllRewardsToSelf

Parameters

Returns Promise<CommittedTransactionResponse>

claimRewards

Parameters

Returns Promise<CommittedTransactionResponse>

claimRewardsOnBehalf

Parameters

Returns Promise<CommittedTransactionResponse>

claimRewardsToSelf

Parameters

Returns Promise<CommittedTransactionResponse>

fundAccount

Parameters

Returns Promise<UserTransactionResponse>

getAccounAptBalance

Parameters

Returns Promise<bigint>

getAllUserRewards

Parameters

Returns Promise<[AccountAddress[], bigint[]]>

getAssetDecimals

Parameters

Returns Promise<number>

getAssetIndex

Parameters

Returns Promise<[bigint, bigint]>

getClaimer

Parameters

Returns Promise<AccountAddress>

getDistributionEnd

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; }[],>

getPullRewardsTransferStrategy

Parameters

Returns Promise<PullRewardsTransferStrategy>

getRewardOracle

Returns Promise<AccountAddress>

getRewardsByAsset

Parameters

Returns Promise<AccountAddress[]>

getRewardsData

Parameters

Returns Promise<RewardData>

getRewardsList

Parameters

Returns Promise<AccountAddress[]>

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