Class PoolClient

The PoolClient class provides methods to interact with the Aave protocol's pool contracts on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for managing reserves, configuring pool parameters, handling user positions, and managing protocol fees.

Remarks

This client is designed to work with the core pool contracts and provides a high-level API for pool 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 = PoolClient.buildWithDefaultSigner(provider);

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

// Get reserve data
const reserveData = await client.getReserveData(assetAddress);

Param: provider

The AptosProvider instance used to interact with the Aptos blockchain.

Param: signer

Optional Ed25519Account signer for transaction signing.

Hierarchy (View Summary)

AptosContractWrapperBaseClass
- PoolClient

Index

Constructors

constructor

new PoolClient(provider: AptosProvider, signer?: Ed25519Account): PoolClient
Parameters
- provider: AptosProvider
- Optionalsigner: Ed25519Account
Returns PoolClient
Overrides AptosContractWrapperBaseClass.constructor
- Defined in clients/poolClient.ts:225

Properties

poolContract

poolContract: PoolContract

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

collectorWithdraw

collectorWithdraw(
    asset: AccountAddress,
    receiver: AccountAddress,
    amount: bigint,
): Promise<CommittedTransactionResponse>
Transfers the collected fees by the collector to a given account.
Parameters
- asset: AccountAddress
  The asset address.
- receiver: AccountAddress
  The account address to whom to transfer the collected fees.
- amount: bigint
  The collected fee amount to transfer.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:1987

configureReserveAsCollateral

configureReserveAsCollateral(
    asset: AccountAddress,
    ltv: bigint,
    liquidationThreshold: bigint,
    liquidationBonus: bigint,
): Promise<CommittedTransactionResponse>
Configures a reserve as collateral by setting the loan-to-value (LTV), liquidation threshold, and liquidation bonus for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset to be configured as collateral.
- ltv: bigint
  The loan-to-value ratio for the asset, represented as a bigint.
- liquidationThreshold: bigint
  The threshold at which the asset will be liquidated, represented as a bigint.
- liquidationBonus: bigint
  The bonus applied during liquidation, represented as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse once the transaction is committed.
- Defined in clients/poolClient.ts:1036

disableLiquidationdNoGracePeriod

disableLiquidationdNoGracePeriod(
asset: AccountAddress,
): Promise<CommittedTransactionResponse>
Disables the liquidation with no grace period.
Parameters
- asset: AccountAddress
  The address of the asset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1161

dropReserve

dropReserve(asset: AccountAddress): Promise<CommittedTransactionResponse>
Drops a reserve from the pool.
Parameters
- asset: AccountAddress
  The account address of the asset to be dropped.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the committed transaction response.
- Defined in clients/poolClient.ts:843

feeManagerSetAptFee

feeManagerSetAptFee(newAptFee: bigint): Promise<CommittedTransactionResponse>
Sets a new apt fee to the fee manager.
Parameters
- newAptFee: bigint
  The new apt fee to apply.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:1867

feeManagerTransferAptFee

feeManagerTransferAptFee(
to: AccountAddress,
amount: bigint,
): Promise<CommittedTransactionResponse>
Transfers the collected fees by the fee manager to a given account.
Parameters
- to: AccountAddress
  The account address to whom to transfer the collected fees.
- amount: bigint
  The collected fee amount to transfer.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:1883

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

getAllATokens

getAllATokens(): Promise<TokenData[]>
Retrieves all AToken data from the pool contract.

Returns Promise<TokenData[]>
A promise that resolves to an array of TokenData objects.
Example
```
const aTokens = await poolClient.getAllATokens();
console.log(aTokens);
```
- Defined in clients/poolClient.ts:1411

getAllReservesTokens

getAllReservesTokens(): Promise<TokenData[]>
Retrieves all reserve tokens from the pool contract.

Returns Promise<TokenData[]>
A promise that resolves to an array of TokenData objects.

Throws
If the call to the view method fails or returns an unexpected result.
- Defined in clients/poolClient.ts:1384

getAllVariableTokens

getAllVariableTokens(): Promise<TokenData[]>
Retrieves all variable tokens from the pool contract.

Returns Promise<TokenData[]>
A promise that resolves to an array of TokenData objects.
Remarks
This method calls the GetAllVariableTokensFuncAddr function of the pool contract to fetch the variable tokens. The response is then mapped to an array of TokenData objects, each containing the token symbol and token address.
Example
```
const variableTokens = await poolClient.getAllVariableTokens();
console.log(variableTokens);
```
- Defined in clients/poolClient.ts:1442

getATokenTotalSupply

getATokenTotalSupply(asset: AccountAddress): Promise<bigint>
Retrieves the total supply of AToken for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset.
Returns Promise<bigint>
A promise that resolves to the total supply of the AToken as a bigint.
- Defined in clients/poolClient.ts:1670

getBridgeProtocolFee

getBridgeProtocolFee(): Promise<bigint>
Retrieves the bridge protocol fee from the pool contract.

Returns Promise<bigint>
A promise that resolves to the bridge protocol fee as a bigint.
- Defined in clients/poolClient.ts:729

getCollectorAddress

getCollectorAddress(): Promise<AccountAddress>
Retrieves the collector address.

Returns Promise<AccountAddress>
A promise that resolves to the collector address.
- Defined in clients/poolClient.ts:2003

getCollectorCollectedFees

getCollectorCollectedFees(): Promise<bigint>
Retrieves the total fees collected by the collector.

Returns Promise<bigint>
A promise that resolves to the fee collector total collected fees.
- Defined in clients/poolClient.ts:2016

getCollectorIsFundsAdmin

getCollectorIsFundsAdmin(account: AccountAddress): Promise<boolean>
Returns if the address is the funds admin of the collector.
Parameters
- account: AccountAddress
Returns Promise<boolean>
A promise that resolves to a boolean.
- Defined in clients/poolClient.ts:1969

getDebtCeiling

getDebtCeiling(asset: AccountAddress): Promise<bigint>
Retrieves the debt ceiling for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset for which to get the debt ceiling.
Returns Promise<bigint>
A promise that resolves to the debt ceiling as a bigint.
- Defined in clients/poolClient.ts:1593

getDebtCeilingDecimals

getDebtCeilingDecimals(): Promise<bigint>
Retrieves the debt ceiling decimals from the pool contract.

Returns Promise<bigint>
A promise that resolves to the debt ceiling decimals as a bigint.
- Defined in clients/poolClient.ts:1607

getEmodeCategoryData

getEmodeCategoryData(id: number): Promise<number>
Retrieves the eMode category data for a given category ID.
Parameters
- id: number
  The ID of the eMode category to retrieve data for.
Returns Promise<number>
A promise that resolves to the eMode category data as a number.
- Defined in clients/poolClient.ts:1285

getEmodeEmodeLabel

getEmodeEmodeLabel(emodeCategory: number): Promise<string>
Retrieves the eMode (efficiency mode) label from the pool contract.
Parameters
- emodeCategory: number
  The emode cateogory number.
Returns Promise<string>
A promise that resolves to the emode label as a sting.
- Defined in clients/poolClient.ts:1313

getEmodeEmodeLiquidationBonus

getEmodeEmodeLiquidationBonus(userEmodeCategory: number): Promise<number>
Retrieves the eMode (efficiency mode) liquidation bonus from the pool contract.
Parameters
- userEmodeCategory: number
  The emode cateogory of the user.
Returns Promise<number>
A promise that resolves to the emode liquidation bonus as a number.
- Defined in clients/poolClient.ts:1327

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

getFeeManagerCollectorAddress

getFeeManagerCollectorAddress(): Promise<AccountAddress>
Retrieves the fee collector address.

Returns Promise<AccountAddress>
A promise that resolves to the fee collector address.
- Defined in clients/poolClient.ts:1913

getFeeManagerCollectorAptBalance

getFeeManagerCollectorAptBalance(): Promise<bigint>
Retrieves the fee collector apt balance.

Returns Promise<bigint>
A promise that resolves to the fee collector apt balance.
- Defined in clients/poolClient.ts:1926

getFeeManagerGetAptFee

getFeeManagerGetAptFee(): Promise<bigint>
Retrieves the apt fee of the manager.

Returns Promise<bigint>
A promise that resolves to the apt fee as a bigint.
- Defined in clients/poolClient.ts:1898

getFeeManagerGetFeeConfigObjectAddress

getFeeManagerGetFeeConfigObjectAddress(): Promise<AccountAddress>
Retrieves the fee manager object address.

Returns Promise<AccountAddress>
A promise that resolves to the fee manager object address.
- Defined in clients/poolClient.ts:1956

getFeeManagerTotalFees

getFeeManagerTotalFees(): Promise<bigint>
Retrieves the total fees collected by the fee manager.

Returns Promise<bigint>
A promise that resolves to the fee collector total collected fees.
- Defined in clients/poolClient.ts:1941

getFlashloanEnabled

getFlashloanEnabled(asset: AccountAddress): Promise<boolean>
Checks if flash loans are enabled for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset to check.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether flash loans are enabled for the specified asset.
- Defined in clients/poolClient.ts:1761

getFlashloanPremiumToProtocol

getFlashloanPremiumToProtocol(): Promise<bigint>
Retrieves the flashloan premium to the protocol.

This method calls a view function on the pool contract to get the flashloan premium that is allocated to the protocol. The result is mapped to a bigint and returned.

Returns Promise<bigint>
A promise that resolves to the flashloan premium as a bigint.
- Defined in clients/poolClient.ts:765

getFlashloanPremiumTotal

getFlashloanPremiumTotal(): Promise<bigint>
Retrieves the total flashloan premium from the pool contract.

This method calls the PoolGetFlashloanPremiumTotalFuncAddr function on the pool contract and maps the response to a bigint.

Returns Promise<bigint>
A promise that resolves to the total flashloan premium as a bigint.
- Defined in clients/poolClient.ts:747

getLiquidationGracePeriodUntil

getLiquidationGracePeriodUntil(object: AccountAddress): Promise<number>
Parameters
- object: AccountAddress
Returns Promise<number>
- Defined in clients/poolClient.ts:468

getLiquidationProtocolFee

getLiquidationProtocolFee(asset: AccountAddress): Promise<bigint>
Retrieves the liquidation protocol fee for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset for which to retrieve the liquidation protocol fee.
Returns Promise<bigint>
A promise that resolves to the liquidation protocol fee as a bigint.
- Defined in clients/poolClient.ts:1575

getMaxNumberReserves

getMaxNumberReserves(): Promise<bigint>
Retrieves the maximum number of reserves allowed in the pool.

Returns Promise<bigint>
A promise that resolves to the maximum number of reserves as a bigint.
- Defined in clients/poolClient.ts:780

getNormalizedDebtByReserveData

getNormalizedDebtByReserveData(reserveData: AccountAddress): Promise<bigint>
Retrieves the normalized debt by reserve data.
Parameters
- reserveData: AccountAddress
  The address of the reserve data.
Returns Promise<bigint>
A promise that resolves to the normalized debt as a bigint.
- Defined in clients/poolClient.ts:652

getPaused

getPaused(asset: AccountAddress): Promise<boolean>
Checks if the specified asset is paused.
Parameters
- asset: AccountAddress
  The address of the asset to check.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the asset is paused.
- Defined in clients/poolClient.ts:1547

getPendingLtv

getPendingLtv(asset: AccountAddress): Promise<bigint>
Retrieves the pending ltv for an asset from the pool contract.
Parameters
- asset: AccountAddress
Returns Promise<bigint>
A promise that resolves to the pending ltv as a bigint.
- Defined in clients/poolClient.ts:1075

getReserveAccruedToTreasury

getReserveAccruedToTreasury(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:516

getReserveAddressById

getReserveAddressById(id: number): Promise<AccountAddress>
Retrieves the reserve address associated with a given ID.
Parameters
- id: number
  The ID of the reserve to retrieve the address for.
Returns Promise<AccountAddress>
A promise that resolves to the AccountAddress of the reserve.
- Defined in clients/poolClient.ts:620

getReserveATokenAddress

getReserveATokenAddress(object: AccountAddress): Promise<AccountAddress>
Parameters
- object: AccountAddress
Returns Promise<AccountAddress>
- Defined in clients/poolClient.ts:496

getReserveCaps

getReserveCaps(
asset: AccountAddress,
): Promise<{ borrowCap: bigint; supplyCap: bigint }>
Retrieves the reserve caps for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset account.
Returns Promise<{ borrowCap: bigint; supplyCap: bigint }>
A promise that resolves to an object containing the borrow cap and supply cap as big integers.
- Defined in clients/poolClient.ts:1527

getReserveConfiguration

getReserveConfiguration(asset: AccountAddress): Promise<ReserveConfigurationMap>
Retrieves the reserve configuration for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset for which to get the reserve configuration.
Returns Promise<ReserveConfigurationMap>
A promise that resolves to the reserve configuration map of the specified asset.
- Defined in clients/poolClient.ts:364

getReserveConfigurationByReserveData

getReserveConfigurationByReserveData(
object: AccountAddress,
): Promise<ReserveConfigurationMap>
Parameters
- object: AccountAddress
Returns Promise<ReserveConfigurationMap>
- Defined in clients/poolClient.ts:408

getReserveConfigurationData

getReserveConfigurationData(
asset: AccountAddress,
): Promise<ReserveConfigurationData>
Retrieves the reserve configuration data for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset.
Returns Promise<ReserveConfigurationData>
A promise that resolves to an object containing the reserve configuration data.

The returned object includes the following properties:
- decimals: The number of decimals for the asset.
- ltv: The loan-to-value ratio.
- liquidationThreshold: The liquidation threshold.
- liquidationBonus: The liquidation bonus.
- reserveFactor: The reserve factor.
- usageAsCollateralEnabled: A boolean indicating if the asset can be used as collateral.
- borrowingEnabled: A boolean indicating if borrowing is enabled for the asset.
- isActive: A boolean indicating if the asset is active.
- isFrozen: A boolean indicating if the asset is frozen.
- Defined in clients/poolClient.ts:1477

getReserveCurrentLiquidityRate

getReserveCurrentLiquidityRate(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:428

getReserveCurrentVariableBorrowRate

getReserveCurrentVariableBorrowRate(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:448

getReserveData

getReserveData(asset: AccountAddress): Promise<ReserveData>
Retrieves the reserve data for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset for which to retrieve reserve data.
Returns Promise<ReserveData>
A promise that resolves to the reserve data of the specified asset.
- Defined in clients/poolClient.ts:380

getReserveData2

getReserveData2(asset: AccountAddress): Promise<ReserveData2>
Retrieves reserve data for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset to retrieve reserve data for.
Returns Promise<ReserveData2>
A promise that resolves to an object containing reserve data.

The returned object includes the following properties:
- reserveUnbacked: The amount of unbacked reserve.
- reserveAccruedToTreasury: The amount accrued to the treasury.
- aTokenSupply: The total supply of aTokens.
- varTokenSupply: The total supply of variable tokens.
- reserveCurrentLiquidityRate: The current liquidity rate of the reserve.
- reserveCurrentVariableBorrowRate: The current variable borrow rate of the reserve.
- reserveLiquidityIndex: The liquidity index of the reserve.
- reserveVarBorrowIndex: The variable borrow index of the reserve.
- reserveLastUpdateTimestamp: The timestamp of the last update to the reserve data.
- Defined in clients/poolClient.ts:1634

getReserveDataAndReservesCount

getReserveDataAndReservesCount(
asset: AccountAddress,
): Promise<{ count: number; reserveData: ReserveData }>
Retrieves reserve data and the count of reserves for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset.
Returns Promise<{ count: number; reserveData: ReserveData }>
A promise that resolves to an object containing the reserve data and the count of reserves.

Throws
Will throw an error if the view method call fails.
- Defined in clients/poolClient.ts:543

getReserveDeficit

getReserveDeficit(asset: AccountAddress): Promise<bigint>
Retrieves the reserve deficit for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset to check.
Returns Promise<bigint>
A promise that resolves to a bigint.
- Defined in clients/poolClient.ts:1775

getReserveEmodeCategory

getReserveEmodeCategory(asset: AccountAddress): Promise<number>
Retrieves the eMode category for a given reserve asset.
Parameters
- asset: AccountAddress
  The account address of the reserve asset.
Returns Promise<number>
A promise that resolves to the eMode category number of the specified asset.
- Defined in clients/poolClient.ts:1513

getReserveId

getReserveId(object: AccountAddress): Promise<number>
Parameters
- object: AccountAddress
Returns Promise<number>
- Defined in clients/poolClient.ts:488

getReserveIsolationModeTotalDebt

getReserveIsolationModeTotalDebt(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:526

getReserveLastUpdateTimestamp

getReserveLastUpdateTimestamp(object: AccountAddress): Promise<number>
Parameters
- object: AccountAddress
Returns Promise<number>
- Defined in clients/poolClient.ts:458

getReserveLiquidityIndex

getReserveLiquidityIndex(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:418

getReserveNormalizedIncome

getReserveNormalizedIncome(asset: AccountAddress): Promise<bigint>
Retrieves the normalized income for a given reserve asset.
Parameters
- asset: AccountAddress
  The address of the reserve asset.
Returns Promise<bigint>
A promise that resolves to the normalized income of the reserve asset as a bigint.
- Defined in clients/poolClient.ts:670

getReserveNormalizedVariableDebt

getReserveNormalizedVariableDebt(asset: AccountAddress): Promise<bigint>
Retrieves the normalized variable debt for a given reserve asset.
Parameters
- asset: AccountAddress
  The address of the reserve asset.
Returns Promise<bigint>
A promise that resolves to the normalized variable debt as a bigint.
- Defined in clients/poolClient.ts:634

getReservesCount

getReservesCount(): Promise<bigint>
Retrieves the count of reserves from the pool contract.

Returns Promise<bigint>
A promise that resolves to the count of reserves as a bigint.
- Defined in clients/poolClient.ts:587

getReservesList

getReservesList(): Promise<AccountAddress[]>
Retrieves the list of reserve accounts from the pool contract.

Returns Promise<AccountAddress[]>
A promise that resolves to an array of AccountAddress objects representing the reserve accounts.
- Defined in clients/poolClient.ts:602

getReserveTokensAddresses

getReserveTokensAddresses(
    asset: AccountAddress,
): Promise<
    {
        reserveATokenAddress: AccountAddress;
        reserveVariableDebtTokenAddress: AccountAddress;
    },
>
Retrieves the addresses of the reserve tokens for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset for which to get the reserve token addresses.
Returns Promise<
    {
        reserveATokenAddress: AccountAddress;
        reserveVariableDebtTokenAddress: AccountAddress;
    },
>
A promise that resolves to an object containing the addresses of the reserve AToken and the reserve Variable Debt Token.
- Defined in clients/poolClient.ts:1736

getReserveVariableBorrowIndex

getReserveVariableBorrowIndex(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:438

getReserveVariableDebtTokenAddress

getReserveVariableDebtTokenAddress(
object: AccountAddress,
): Promise<AccountAddress>
Parameters
- object: AccountAddress
Returns Promise<AccountAddress>
- Defined in clients/poolClient.ts:506

getScaledATokenBalanceOf

getScaledATokenBalanceOf(
owner: AccountAddress,
aTokenAddress: AccountAddress,
): Promise<bigint>
Retrieves the scaled AToken balance of a specified owner.
Parameters
- owner: AccountAddress
  The address of the account owner whose balance is being queried.
- aTokenAddress: AccountAddress
  The address of the AToken contract.
Returns Promise<bigint>
A promise that resolves to the scaled AToken balance as a bigint.
- Defined in clients/poolClient.ts:1810

getScaledATokenTotalSupply

getScaledATokenTotalSupply(aTokenAddress: AccountAddress): Promise<bigint>
Retrieves the scaled total supply of an AToken.
Parameters
- aTokenAddress: AccountAddress
  The address of the AToken.
Returns Promise<bigint>
A promise that resolves to the scaled total supply of the AToken as a bigint.
- Defined in clients/poolClient.ts:1791

getScaledVariableTokenBalanceOf

getScaledVariableTokenBalanceOf(
owner: AccountAddress,
varTokenAddress: AccountAddress,
): Promise<bigint>
Retrieves the scaled variable token balance of a specified owner for a given variable token address.
Parameters
- owner: AccountAddress
  The account address of the token owner.
- varTokenAddress: AccountAddress
  The account address of the variable token.
Returns Promise<bigint>
A promise that resolves to the scaled variable token balance as a bigint.
- Defined in clients/poolClient.ts:1848

getScaledVariableTokenTotalSupply

getScaledVariableTokenTotalSupply(
aTokenAddress: AccountAddress,
): Promise<bigint>
Retrieves the scaled total supply of variable tokens for a given aToken address.
Parameters
- aTokenAddress: AccountAddress
  The address of the aToken whose scaled variable token total supply is to be fetched.
Returns Promise<bigint>
A promise that resolves to the scaled total supply of variable tokens as a bigint.
- Defined in clients/poolClient.ts:1829

getSigner

getSigner(): Ed25519Account
Retrieves the current Ed25519Account signer.

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

getSiloedBorrowing

getSiloedBorrowing(asset: AccountAddress): Promise<boolean>
Retrieves the siloed borrowing status for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset to check.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the asset has siloed borrowing enabled.
- Defined in clients/poolClient.ts:1561

getTotalDebt

getTotalDebt(asset: AccountAddress): Promise<bigint>
Retrieves the total debt for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset account.
Returns Promise<bigint>
A promise that resolves to the total debt as a bigint.
- Defined in clients/poolClient.ts:1686

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

getUserAccountData

getUserAccountData(
userEmodeCategory: number,
): Promise<{ liquidationThreshold: bigint; ltv: bigint }>
Retrieves the user account data by user emode category from the pool contract.
Parameters
- userEmodeCategory: number
  The emode cateogory of the user.
Returns Promise<{ liquidationThreshold: bigint; ltv: bigint }>
A promise that resolves to the emode ltv and liquidation threshold as a number.
- Defined in clients/poolClient.ts:1361

getUserConfiguration

getUserConfiguration(account: AccountAddress): Promise<UserConfigurationMap>
Retrieves the user configuration for a given account.
Parameters
- account: AccountAddress
  The address of the account to retrieve the configuration for.
Returns Promise<UserConfigurationMap>
A promise that resolves to the user's configuration map.
- Defined in clients/poolClient.ts:688

getUserEmode

getUserEmode(user: AccountAddress): Promise<number>
Retrieves the eMode (efficiency mode) of a user from the pool contract.
Parameters
- user: AccountAddress
  The account address of the user.
Returns Promise<number>
A promise that resolves to the eMode of the user as a number.
- Defined in clients/poolClient.ts:1299

getUserReserveData

getUserReserveData(
asset: AccountAddress,
user: AccountAddress,
): Promise<UserReserveData>
Retrieves the reserve data for a specific user and asset.
Parameters
- asset: AccountAddress
  The address of the asset.
- user: AccountAddress
  The address of the user.
Returns Promise<UserReserveData>
A promise that resolves to an object containing the user's reserve data.

The returned object includes the following properties:
- currentATokenBalance: The current balance of A tokens held by the user.
- currentVariableDebt: The current variable debt of the user.
- scaledVariableDebt: The scaled variable debt of the user.
- liquidityRate: The liquidity rate of the reserve.
- usageAsCollateralEnabled: A boolean indicating if the asset is being used as collateral.
- Defined in clients/poolClient.ts:1707

getVirtualUnderlyingBalance

getVirtualUnderlyingBalance(object: AccountAddress): Promise<bigint>
Parameters
- object: AccountAddress
Returns Promise<bigint>
- Defined in clients/poolClient.ts:478

initReserves

initReserves(
    underlyingAsset: AccountAddress[],
    treasury: AccountAddress[],
    aTokenName: string[],
    aTokenSymbol: string[],
    variableDebtTokenName: string[],
    variableDebtTokenSymbol: string[],
    incentivesController: MoveOption<AccountAddress>[],
    optimalUsageRatio: bigint[],
    baseVariableBorrowRate: bigint[],
    variableRateSlope1: bigint[],
    variableRateSlope2: bigint[],
): Promise<CommittedTransactionResponse>
Initializes the reserves in the pool.
Parameters
- underlyingAsset: AccountAddress[]
  An array of account addresses representing the underlying assets.
- treasury: AccountAddress[]
  An array of account addresses representing the treasury.
- aTokenName: string[]
  An array of strings representing the names of the aTokens.
- aTokenSymbol: string[]
  An array of strings representing the symbols of the aTokens.
- variableDebtTokenName: string[]
  An array of strings representing the names of the variable debt tokens.
- variableDebtTokenSymbol: string[]
  An array of strings representing the symbols of the variable debt tokens.
- incentivesController: MoveOption<AccountAddress>[]
  An array of addresses representing the incentives controllers.
- optimalUsageRatio: bigint[]
  An array of numbers representing the optimal usage ratios.
- baseVariableBorrowRate: bigint[]
  An array of numbers representing the base variable borrow rates.
- variableRateSlope1: bigint[]
  An array of numbers representing the variable rate slopes 1.
- variableRateSlope2: bigint[]
  An array of numbers representing the variable rate slopes 2.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:806

isInEmodeCategory

isInEmodeCategory(
emodeUserCategory: number,
emodeAssetCategory: number,
): Promise<boolean>
Checks if the combination user and asset categories are an emode or not.
Parameters
- emodeUserCategory: number
  The emode cateogory of the user.
- emodeAssetCategory: number
  The emode cateogory of the asset.
Returns Promise<boolean>
A promise that resolves to a boolean.
- Defined in clients/poolClient.ts:1344

mintToTreasury

mintToTreasury(assets: AccountAddress[]): Promise<CommittedTransactionResponse>
Mints the assets accrued through the reserve factor to the treasury in the form of aTokens.
Parameters
- assets: AccountAddress[]
  An array of account addresses representing the assets to be minted to the treasury.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:247

numberOfActiveAndDroppedReserves

numberOfActiveAndDroppedReserves(): Promise<number>
Retrieves the number of active and dropped reserves.

Returns Promise<number>
A promise that resolves to the number of active and dropped reserves.
- Defined in clients/poolClient.ts:716

numberOfActiveReserves

numberOfActiveReserves(): Promise<number>
Retrieves the number of active reserves.

Returns Promise<number>
A promise that resolves to the number of active reserves.
- Defined in clients/poolClient.ts:703

rescueTokens

rescueTokens(
    token: AccountAddress,
    to: AccountAddress,
    amount: bigint,
): Promise<CommittedTransactionResponse>
Rescues tokens from the pool 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.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the response of the committed transaction.
- Defined in clients/poolClient.ts:315

resetIsolationModeTotalDebt

resetIsolationModeTotalDebt(
asset: AccountAddress,
): Promise<CommittedTransactionResponse>
Resets the total debt for an asset in isolation mode.
Parameters
- asset: AccountAddress
  The account address of the asset for which the total debt is to be reset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:298

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

setAssetEmodeCategory

setAssetEmodeCategory(
asset: AccountAddress,
newCategoryId: number,
): Promise<CommittedTransactionResponse>
Sets the eMode category for a specific asset.
Parameters
- asset: AccountAddress
  The address of the asset for which the eMode category is being set.
- newCategoryId: number
  The new eMode category ID to be assigned to the asset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the response of the committed transaction.
- Defined in clients/poolClient.ts:859

setBorrowableInIsolation

setBorrowableInIsolation(
asset: AccountAddress,
borrowable: boolean,
): Promise<CommittedTransactionResponse>
Sets whether a specific asset is borrowable in isolation mode.
Parameters
- asset: AccountAddress
  The address of the asset to be configured.
- borrowable: boolean
  A boolean indicating if the asset should be borrowable in isolation.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:893

setBorrowCap

setBorrowCap(
asset: AccountAddress,
newBorrowCap: bigint,
): Promise<CommittedTransactionResponse>
Sets the borrow cap for a specific asset.
Parameters
- asset: AccountAddress
  The address of the asset for which the borrow cap is being set.
- newBorrowCap: bigint
  The new borrow cap value to be set for the asset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the response of the committed transaction.
- Defined in clients/poolClient.ts:876

setBridgeProtocolFee

setBridgeProtocolFee(protocolFee: bigint): Promise<CommittedTransactionResponse>
Sets the bridge protocol fee for the pool.
Parameters
- protocolFee: bigint
  The new protocol fee to be set, represented as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse once the transaction is committed.
- Defined in clients/poolClient.ts:332

setDebtCeiling

setDebtCeiling(
asset: AccountAddress,
newDebtCeiling: bigint,
): Promise<CommittedTransactionResponse>
Sets the debt ceiling for a specific asset.
Parameters
- asset: AccountAddress
  The account address of the asset for which the debt ceiling is being set.
- newDebtCeiling: bigint
  The new debt ceiling value to be set, represented as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse once the transaction is committed.
- Defined in clients/poolClient.ts:1016

setEmodeCategory

setEmodeCategory(
    categoryId: number,
    ltv: number,
    liquidationThreshold: number,
    liquidationBonus: number,
    label: string,
): Promise<CommittedTransactionResponse>
Sets the eMode category for the pool.
Parameters
- categoryId: number
  The ID of the eMode category.
- ltv: number
  The loan-to-value ratio for the category.
- liquidationThreshold: number
  The liquidation threshold for the category.
- liquidationBonus: number
  The liquidation bonus for the category.
- label: string
  The label for the eMode category.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to the committed transaction response.
- Defined in clients/poolClient.ts:913

setFlashloanPremiums

setFlashloanPremiums(
flashloanPremiumTotal: bigint,
flashloanPremiumToProtocol: bigint,
): Promise<CommittedTransactionResponse>
Sets the flashloan premiums for the pool.
Parameters
- flashloanPremiumTotal: bigint
  The total premium for the flashloan as a bigint.
- flashloanPremiumToProtocol: bigint
  The portion of the premium that goes to the protocol as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:348

setIncentivesControllers

setIncentivesControllers(
underlyingAssets: AccountAddress[],
incentivesControllers: MoveOption<AccountAddress>[],
): Promise<CommittedTransactionResponse>
Sets the incentives controllers.
Parameters
- underlyingAssets: AccountAddress[]
  An array of account addresses representing the assets on which to set incentives controllers.
- incentivesControllers: MoveOption<AccountAddress>[]
  An array of account addresses representing the addresses of the incentives controllers.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:282

setLiquidationProtocolFee

setLiquidationProtocolFee(
asset: AccountAddress,
newFee: bigint,
): Promise<CommittedTransactionResponse>
Sets the liquidation protocol fee for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset for which the liquidation protocol fee is being set.
- newFee: bigint
  The new liquidation protocol fee to be set, represented as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse once the transaction is committed.
- Defined in clients/poolClient.ts:933

setPoolPause

setPoolPause(
paused: boolean,
gracePeriod: bigint,
): Promise<CommittedTransactionResponse>
Pauses or unpauses the pool.
Parameters
- paused: boolean
  A boolean indicating whether to pause (true) or unpause (false) the pool.
- gracePeriod: bigint
  The grace period the pause is applied for.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:950

setPoolPauseNoGracePeriod

setPoolPauseNoGracePeriod(
paused: boolean,
): Promise<CommittedTransactionResponse>
Pauses or unpauses the pool without setting any grace period.
Parameters
- paused: boolean
  A boolean indicating whether to pause (true) or unpause (false) the pool.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:966

setReserveActive

setReserveActive(
asset: AccountAddress,
active: boolean,
): Promise<CommittedTransactionResponse>
Sets the active status of a reserve.
Parameters
- asset: AccountAddress
  The address of the asset's account.
- active: boolean
  A boolean indicating whether the reserve should be active (true) or inactive (false).
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:982

setReserveBorrowing

setReserveBorrowing(
asset: AccountAddress,
enabled: boolean,
): Promise<CommittedTransactionResponse>
Sets the borrowing status for a specific reserve asset.
Parameters
- asset: AccountAddress
  The address of the asset for which borrowing is being enabled or disabled.
- enabled: boolean
  A boolean indicating whether borrowing should be enabled (true) or disabled (false) for the specified asset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object once the transaction is committed.
- Defined in clients/poolClient.ts:999

setReserveFactor

setReserveFactor(
asset: AccountAddress,
newReserveFactor: bigint,
): Promise<CommittedTransactionResponse>
Sets the reserve factor for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset for which the reserve factor is being set.
- newReserveFactor: bigint
  The new reserve factor to be set, represented as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse once the transaction is committed.
- Defined in clients/poolClient.ts:1060

setReserveFlashLoaning

setReserveFlashLoaning(
asset: AccountAddress,
enabled: boolean,
): Promise<CommittedTransactionResponse>
Enables or disables flash loaning for a specific reserve asset.
Parameters
- asset: AccountAddress
  The address of the reserve asset.
- enabled: boolean
  A boolean indicating whether flash loaning should be enabled (true) or disabled (false).
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1092

setReserveFreeze

setReserveFreeze(
asset: AccountAddress,
freeze: boolean,
): Promise<CommittedTransactionResponse>
Sets the freeze status of a reserve asset.
Parameters
- asset: AccountAddress
  The address of the reserve asset to be frozen or unfrozen.
- freeze: boolean
  A boolean indicating whether to freeze (true) or unfreeze (false) the reserve asset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1109

setReservePaused

setReservePaused(
    asset: AccountAddress,
    paused: boolean,
    gracePeriod?: bigint,
): Promise<CommittedTransactionResponse>
Sets the paused state of a reserve with a grace period.
Parameters
- asset: AccountAddress
  The address of the asset to be paused or unpaused.
- paused: boolean
  A boolean indicating whether to pause (true) or unpause (false) the reserve.
- gracePeriod: bigint = 0n
  A number indicationg the grace period.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1127

setReservePausedNoGracePeriod

setReservePausedNoGracePeriod(
asset: AccountAddress,
paused: boolean,
): Promise<CommittedTransactionResponse>
Sets the paused state of a reserve without a grace period.
Parameters
- asset: AccountAddress
  The address of the asset to be paused or unpaused.
- paused: boolean
  A boolean indicating whether to pause (true) or unpause (false) the reserve.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1145

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

setSiloedBorrowing

setSiloedBorrowing(
asset: AccountAddress,
newSiloed: boolean,
): Promise<CommittedTransactionResponse>
Sets the siloed borrowing status for a given asset.
Parameters
- asset: AccountAddress
  The address of the asset for which to set the siloed borrowing status.
- newSiloed: boolean
  A boolean indicating the new siloed borrowing status.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1177

setSupplyCap

setSupplyCap(
asset: AccountAddress,
newSupplyCap: bigint,
): Promise<CommittedTransactionResponse>
Sets the supply cap for a given asset.
Parameters
- asset: AccountAddress
  The account address of the asset for which the supply cap is being set.
- newSupplyCap: bigint
  The new supply cap value to be set for the asset.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1194

setUserEmode

setUserEmode(categoryId: number): Promise<CommittedTransactionResponse>
Sets the user's eMode category.
Parameters
- categoryId: number
  The ID of the eMode category to set for the user.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:1270

transfer

transfer(
    recipient: AccountAddress,
    amount: bigint,
    aTokenAddress: AccountAddress,
): Promise<CommittedTransactionResponse>
Transfers aTokens from the user to the recipient.
Parameters
- recipient: AccountAddress
  The recipient of the aTokens
- amount: bigint
  The amount of aTokens to transfer
- aTokenAddress: AccountAddress
  The Metadata of the aToken
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse object.
- Defined in clients/poolClient.ts:264

updateFloashloanPremiumToProtocol

updateFloashloanPremiumToProtocol(
newFlashloanPremiumToProtocol: bigint,
): Promise<CommittedTransactionResponse>
Updates the flashloan premium to protocol.
Parameters
- newFlashloanPremiumToProtocol: bigint
  The new flashloan premium to be set, represented as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:1239

updateFloashloanPremiumTotal

updateFloashloanPremiumTotal(
newFlashloanPremiumTotal: bigint,
): Promise<CommittedTransactionResponse>
Updates the flashloan premium total in the pool configurator.
Parameters
- newFlashloanPremiumTotal: bigint
  The new flashloan premium total as a bigint.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:1255

updateInterestRateStrategy

updateInterestRateStrategy(
    asset: AccountAddress,
    optimalUsageRatio: bigint,
    baseVariableBorrowRate: bigint,
    variableRateSlope1: bigint,
    variableRateSlope2: bigint,
): Promise<CommittedTransactionResponse>
Updates the interest rate strategy.
Parameters
- asset: AccountAddress
  The account address of the asset for which the interest rate strategy is to be applied.
- optimalUsageRatio: bigint
  The optimal usage ratio of the interest rate strategy which is to be applied.
- baseVariableBorrowRate: bigint
  The base variable borrow rate for which the interest rate strategy is to be applied.
- variableRateSlope1: bigint
  The variable rate slope 1 of the interest rate strategy which is to be applied.
- variableRateSlope2: bigint
  The variable rate slope 2 of the interest rate strategy which is to be applied.
Returns Promise<CommittedTransactionResponse>
A promise that resolves to a CommittedTransactionResponse.
- Defined in clients/poolClient.ts:1214

withModuleSigner

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

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

withSigner

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

`Static`buildWithDefaultSigner

buildWithDefaultSigner(provider: AptosProvider): PoolClient
Creates an instance of PoolClient using the default signer provided by the AptosProvider.
Parameters
- provider: AptosProvider
  An instance of AptosProvider which provides the necessary configurations and signer.
Returns PoolClient
A new instance of PoolClient initialized with the default signer.
- Defined in clients/poolClient.ts:236

Class PoolClient

Remarks

Example

Param: provider

Param: signer

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PoolClient

Properties

poolContract

Methods

buildTx

Parameters

Returns Promise<SimpleTransaction>

callViewMethod

Type Parameters

Parameters

Returns Promise<T>

collectorWithdraw

Parameters

Returns Promise<CommittedTransactionResponse>

configureReserveAsCollateral

Parameters

Returns Promise<CommittedTransactionResponse>

disableLiquidationdNoGracePeriod

Parameters

Returns Promise<CommittedTransactionResponse>

dropReserve

Parameters

Returns Promise<CommittedTransactionResponse>

feeManagerSetAptFee

Parameters

Returns Promise<CommittedTransactionResponse>

feeManagerTransferAptFee

Parameters

Returns Promise<CommittedTransactionResponse>

fundAccount

Parameters

Returns Promise<UserTransactionResponse>

getAccounAptBalance

Parameters

Returns Promise<bigint>

getAllATokens

Returns Promise<TokenData[]>

Example

getAllReservesTokens

Returns Promise<TokenData[]>

Throws

getAllVariableTokens

Returns Promise<TokenData[]>

Remarks

Example

getATokenTotalSupply

Parameters

Returns Promise<bigint>

getBridgeProtocolFee

Returns Promise<bigint>

getCollectorAddress

Returns Promise<AccountAddress>

getCollectorCollectedFees

Returns Promise<bigint>

getCollectorIsFundsAdmin

Parameters

Returns Promise<boolean>

getDebtCeiling

Parameters

Returns Promise<bigint>

getDebtCeilingDecimals

Returns Promise<bigint>

getEmodeCategoryData

Parameters

Returns Promise<number>

getEmodeEmodeLabel

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