@aave/aave-v3-aptos-ts-sdk - v0.0.53
    Preparing search index...

    Class UiPoolDataProviderClient

    The UiPoolDataProviderClient class provides methods to interact with the UI Pool Data Provider contract on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for retrieving pool-related data in a format suitable for UI applications, including reserve data, user reserve data, and base currency information within the AAVE protocol.

    This client is designed to work with the UI Pool Data Provider contract and provides a high-level API for accessing pool-related data in a format optimized for user interfaces. 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
    // Using buildWithDefaultSigner
    const provider = new AptosProvider();
    const client = UiPoolDataProviderClient.buildWithDefaultSigner(provider);

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

    // Get reserves data including base currency information
    const { reservesData, baseCurrencyData } = await client.getReservesData();

    // Get user-specific reserve data
    const { userReserves, userEmodeCategoryId } = await client.getUserReserveData(userAddress);

    The AptosProvider instance used to interact with the Aptos blockchain.

    Optional Ed25519Account signer for transaction signing.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    uiPoolDataProviderContract

    Methods

    buildTx callViewMethod fundAccount getAccounAptBalance getEventsFromAccount getReservesData getReservesList getSigner getTxEvents getUserReserveData sendTxAndAwaitResponse setSigner withModuleSigner withSigner buildWithDefaultSigner

    Constructors

    Properties

    uiPoolDataProviderContract: UiPoolDataProviderContract

    Methods

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

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

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

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

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

    • Fetches and returns the reserves data and base currency data.

      Returns Promise<ReservesData>

      A promise that resolves to an object containing reserves data and base currency data.

      The reserves data includes:

      • underlyingAsset: The address of the underlying asset.
      • name: The name of the reserve.
      • symbol: The symbol of the reserve.
      • decimals: The number of decimals of the reserve.
      • baseLTVasCollateral: The base loan-to-value ratio as collateral.
      • reserveLiquidationThreshold: The reserve liquidation threshold.
      • reserveLiquidationBonus: The reserve liquidation bonus.
      • reserveFactor: The reserve factor.
      • usageAsCollateralEnabled: Whether usage as collateral is enabled.
      • borrowingEnabled: Whether borrowing is enabled.
      • isActive: Whether the reserve is active.
      • isFrozen: Whether the reserve is frozen.
      • liquidityIndex: The liquidity index.
      • variableBorrowIndex: The variable borrow index.
      • liquidityRate: The liquidity rate.
      • variableBorrowRate: The variable borrow rate.
      • lastUpdateTimestamp: The timestamp of the last update.
      • aTokenAddress: The address of the aToken.
      • variableDebtTokenAddress: The address of the variable debt token.
      • availableLiquidity: The available liquidity.
      • totalScaledVariableDebt: The total scaled variable debt.
      • priceInMarketReferenceCurrency: The price in market reference currency.
      • variableRateSlope1: The variable rate slope 1.
      • variableRateSlope2: The variable rate slope 2.
      • baseVariableBorrowRate: The base variable borrow rate.
      • optimalUsageRatio: The optimal usage ratio.
      • isPaused: Whether the reserve is paused.
      • isSiloedBorrowing: Whether siloed borrowing is enabled.
      • accruedToTreasury: The amount accrued to the treasury.
      • isolationModeTotalDebt: The total debt in isolation mode.
      • flashLoanEnabled: Whether flash loans are enabled.
      • debtCeiling: The debt ceiling.
      • debtCeilingDecimals: The number of decimals for the debt ceiling.
      • eModeCategoryId: The eMode category ID.
      • borrowCap: The borrow cap.
      • supplyCap: The supply cap.
      • eModeLtv: The eMode loan-to-value ratio.
      • eModeLiquidationThreshold: The eMode liquidation threshold.
      • eModeLiquidationBonus: The eMode liquidation bonus.
      • eModeLabel: The label for the eMode.
      • borrowableInIsolation: Whether borrowing in isolation is enabled.

      The base currency data includes:

      • marketReferenceCurrencyDecimals: The number of decimals for the market reference currency.
      • marketReferenceCurrencyPriceInUsd: The price of the market reference currency in USD.
      • networkBaseTokenPriceInUsd: The price of the network base token in USD.
      • networkBaseTokenPriceDecimals: The number of decimals for the network base token price.

    • Retrieves the list of reserve accounts.

      This method calls the getReservesList function on the uiPoolDataProviderContract and returns an array of AccountAddress objects.

      Returns Promise<AccountAddress[]>

      A promise that resolves to an array of AccountAddress objects.

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

      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.

    • Retrieves the reserve data for a specific user.

      Parameters

      • user: string

        The address of the user whose reserve data is being retrieved.

      Returns Promise<UserReservesData>

      A promise that resolves to an object containing the user's reserves data and eMode category ID.

      The returned object has the following structure:

      • userReserves: An array of objects representing the user's reserves. Each object contains:
        • underlyingAsset: The address of the underlying asset.
        • scaledATokenBalance: The scaled balance of A tokens.
        • usageAsCollateralEnabledOnUser: A boolean indicating if the asset is being used as collateral by the user.
        • scaledVariableDebt: The scaled variable debt of the user.
        • decimals: The number of decimals for the asset.
      • userEmodeCategoryId: The eMode category ID of the user.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods