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

    Class UiIncentiveDataProviderClient

    The UiIncentiveDataProviderClient class provides methods to interact with the UI Incentive Data Provider contract on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities for retrieving incentive data for reserves and users, including reward information, emission rates, and user-specific incentive data within the AAVE protocol.

    This client is designed to work with the UI Incentive Data Provider contract and provides a high-level API for accessing incentive-related data in a format suitable for UI applications. 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 = UiIncentiveDataProviderClient.buildWithDefaultSigner(provider);

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

    // Get full reserves incentive data
    const { aggregatedReservesIncentivesData, userReserveIncentiveData } =
      await client.getFullReservesIncentiveData();

    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 getFullReservesIncentiveData getReservesIncentivesData getSigner getTxEvents getUserReservesIncentivesData sendTxAndAwaitResponse setSigner withModuleSigner withSigner buildWithDefaultSigner

    Constructors

    Properties

    uiPoolDataProviderContract: UiIncentiveDataProviderContract

    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.

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

    • 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