@aave/client 0.6.0 → 0.6.1

package/dist/actions/index.d.cts

@@ -0,0 +1,1087 @@
+import * as _aave_graphql from '@aave/graphql';
+import { SavingsGhoBalanceRequest, TokenAmount, SavingsGhoWithdrawRequest, ExecutionPlan, SavingsGhoDepositRequest, UserMeritRewardsRequest, MarketReservesRequestOrderBy, Market, UserMarketStateRequest, MarketUserState, ChainsFilter, Chain, UsdExchangeRatesRequest, UsdExchangeRate, HasProcessedKnownTransactionRequest, HealthFactorPreviewRequest, HealthFactorPreviewResponse, PermitTypedDataRequest, PermitTypedDataResponse, ReserveRequest, Reserve, BorrowAPYHistoryRequest, APYSample, SupplyAPYHistoryRequest, BorrowRequest, SupplyRequest, RepayRequest, WithdrawRequest, UserSetEmodeRequest, TransactionRequest, VaultDepositRequest, VaultRedeemSharesRequest, VaultDeployRequest, VaultSetFeeRequest, VaultWithdrawFeesRequest, VaultWithdrawRequest, VaultMintSharesRequest, CollateralToggleRequest, LiquidateRequest, ApproveBorrowCreditDelegatorRequest, CreditDelegateeAmountRequest, UserSuppliesRequest, MarketUserReserveSupplyPosition, UserBorrowsRequest, MarketUserReserveBorrowPosition, UserTransactionHistoryRequest, PaginatedUserTransactionHistoryResult, VaultRequest, Vault, VaultsRequest, PaginatedVaultsResult, UserVaultsRequest, VaultPreviewDepositRequest, VaultPreviewMintRequest, VaultPreviewWithdrawRequest, VaultPreviewRedeemRequest, VaultUserTransactionHistoryRequest, PaginatedVaultUserTransactionHistoryResult, VaultUserActivityRequest, VaultUserActivityResult } from '@aave/graphql';
+import * as _aave_types from '@aave/types';
+import { ResultAsync, ChainId, EvmAddress } from '@aave/types';
+import { AaveClient } from '../index.cjs';
+import { U as UnexpectedError } from '../types-DwXCLJq5.cjs';
+import '@urql/core';
+
+/**
+ * Fetches the current sGHO balance for a user.
+ *
+ * ```ts
+ * const result = await savingsGhoBalance(client, {
+ *   user: evmAddress('0x742d35cc…'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The sGHO balance request parameters.
+ * @returns The user's sGHO balance.
+ */
+declare function savingsGhoBalance(client: AaveClient, request: SavingsGhoBalanceRequest): ResultAsync<TokenAmount, UnexpectedError>;
+/**
+ * Creates a transaction to withdraw sGHO.
+ *
+ * ```ts
+ * const result = await savingsGhoWithdraw(client, {
+ *   amount: {
+ *     exact: '1000',
+ *   },
+ *   sharesOwner: evmAddress('0x9abc…'),
+ * }).andThen(sendWith(wallet))
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The sGHO withdraw request parameters.
+ * @returns The transaction request data to withdraw sGHO.
+ */
+declare function savingsGhoWithdraw(client: AaveClient, request: SavingsGhoWithdrawRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to deposit GHO into sGHO.
+ *
+ * ```ts
+ * const result = await savingsGhoDeposit(client, {
+ *   amount: {
+ *     value: '1000',
+ *   },
+ *   depositor: evmAddress('0x9abc…'),
+ * }).andThen(sendWith(wallet))
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. insufficient balance, signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The sGHO deposit request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function savingsGhoDeposit(client: AaveClient, request: SavingsGhoDepositRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+
+/**
+ * Fetches Merit rewards for a user with the transaction request to claim them.
+ *
+ * ```ts
+ * const result = await userMeritRewards(client, {
+ *   user: evmAddress('0x742d35cc…'),
+ *   chainId: chainId(1),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The merit claim rewards request parameters.
+ * @returns The rewards with the transaction request.
+ */
+declare function userMeritRewards(client: AaveClient, request: UserMeritRewardsRequest): _aave_types.ResultAsync<{
+    __typename: "UserMeritRewards";
+    chain: _aave_types.ChainId;
+    claimable: {
+        __typename: "ClaimableMeritReward";
+        amount: {
+            __typename: "TokenAmount";
+            usdPerToken: _aave_types.BigDecimal;
+            amount: {
+                __typename: "DecimalValue";
+                raw: _aave_types.BigIntString;
+                decimals: number;
+                value: _aave_types.BigDecimal;
+            };
+            usd: _aave_types.BigDecimal;
+        };
+        currency: {
+            __typename: "Currency";
+            address: _aave_types.EvmAddress;
+            imageUrl: string;
+            name: string;
+            symbol: string;
+            decimals: number;
+            chainId: _aave_types.ChainId;
+        };
+    }[];
+    transaction: {
+        __typename: "TransactionRequest";
+        to: _aave_types.EvmAddress;
+        from: _aave_types.EvmAddress;
+        data: _aave_types.BlockchainData;
+        value: _aave_types.BigIntString;
+        chainId: _aave_types.ChainId;
+        operation: _aave_graphql.OperationType | null;
+    };
+} | null, UnexpectedError>;
+
+declare const defaultMarketReservesRequestOrderBy: MarketReservesRequestOrderBy;
+type MarketsRequest = {
+    /**
+     * The markets you want to see based on the chain ids.
+     */
+    chainIds: ChainId[];
+    /**
+     * The user viewing the market (e.g., the connected wallet).
+     *
+     * If not provided, user fields will not be included.
+     */
+    user?: EvmAddress;
+    /**
+     * The order by clause for the borrow reserves in the market.
+     *
+     * @defaultValue { tokenName: OrderDirection.Asc }
+     */
+    borrowsOrderBy?: MarketReservesRequestOrderBy;
+    /**
+     * The order by clause for the supply reserves in the market.
+     *
+     * @defaultValue { tokenName: OrderDirection.Asc }
+     */
+    suppliesOrderBy?: MarketReservesRequestOrderBy;
+};
+/**
+ * Fetches all markets for the specified chain IDs.
+ *
+ * ```ts
+ * const result = await markets(client, {
+ *   chainIds: [chainId(1), chainId(8453)],
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The markets request parameters.
+ * @returns The list of markets.
+ */
+declare function markets(client: AaveClient, { chainIds, borrowsOrderBy, suppliesOrderBy, user, }: MarketsRequest): ResultAsync<Market[], UnexpectedError>;
+type MarketRequest = {
+    /**
+     * The pool address for the market.
+     */
+    address: EvmAddress;
+    /**
+     * The chain id the market pool address is deployed on.
+     */
+    chainId: ChainId;
+    /**
+     * The user viewing the market (e.g., the connected wallet).
+     *
+     * If not provided, user fields will not be included.
+     */
+    user?: EvmAddress;
+    /**
+     * The order by clause for the borrow reserves in the market.
+     *
+     * @defaultValue { tokenName: OrderDirection.Asc }
+     */
+    borrowsOrderBy?: MarketReservesRequestOrderBy;
+    /**
+     * The order by clause for the supply reserves in the market.
+     *
+     * @defaultValue { tokenName: OrderDirection.Asc }
+     */
+    suppliesOrderBy?: MarketReservesRequestOrderBy;
+};
+/**
+ * Fetches a specific market by address and chain ID.
+ *
+ * ```ts
+ * const result = await market(client, {
+ *   address: evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2'),
+ *   chainId: chainId(1),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The market request parameters.
+ * @returns The market data, or null if not found.
+ */
+declare function market(client: AaveClient, { address, chainId, user, borrowsOrderBy, suppliesOrderBy, }: MarketRequest): ResultAsync<Market | null, UnexpectedError>;
+/**
+ * Fetches user account market data across all reserves.
+ *
+ * ```ts
+ * const result = await userMarketState(client, {
+ *   market: evmAddress('0x1234…'),
+ *   user: evmAddress('0x5678…'),
+ *   chainId: chainId(1)
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user market state request parameters.
+ * @returns The user's market state.
+ */
+declare function userMarketState(client: AaveClient, request: UserMarketStateRequest): ResultAsync<MarketUserState, UnexpectedError>;
+
+/**
+ * Health check query.
+ *
+ * ```ts
+ * const result = await health(client);
+ * ```
+ *
+ * @param client - Aave client.
+ * @returns True or false
+ */
+declare function health(client: AaveClient): ResultAsync<boolean, UnexpectedError>;
+/**
+ * Fetches the list of supported chains.
+ *
+ * ```ts
+ * const result = await chains(client, ChainsFilter.MAINNET_ONLY);
+ * ```
+ *
+ * @param client - Aave client.
+ * @param filter - The filter for the chains.
+ * @returns The list of supported chains.
+ */
+declare function chains(client: AaveClient, filter?: ChainsFilter): ResultAsync<Chain[], UnexpectedError>;
+/**
+ * Fetches USD exchange rates for different tokens on a given market.
+ *
+ * ```ts
+ * const result = await usdExchangeRates(client, {
+ *   market: evmAddress('0x1234…'),
+ *   underlyingTokens: [evmAddress('0x5678…'), evmAddress('0x90ab…')],
+ *   chainId: chainId(1),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The USD exchange rates request parameters.
+ * @returns The list of USD exchange rates.
+ */
+declare function usdExchangeRates(client: AaveClient, request: UsdExchangeRatesRequest): ResultAsync<UsdExchangeRate[], UnexpectedError>;
+/**
+ * Checks if the API has processed a known transaction hash.
+ *
+ * This is useful to know when cached data has been invalidated after
+ * a transaction is complete, as the API uses caching and has an
+ * invalidation task that may take 100-200ms longer.
+ *
+ * ```ts
+ * const result = await borrow(client, request)
+ *   .andThen(sendWith(wallet))
+ *   .andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error
+ *   return;
+ * }
+ *
+ * // Check if the transaction has been processed by the API
+ * const processed = await hasProcessedKnownTransaction(client, {
+ *   txHash: result.value,
+ *   operation: OperationType.Borrow
+ * });
+ *
+ * if (processed.isErr()) {
+ *   // Handle error
+ *   return;
+ * }
+ *
+ * if (processed.value) {
+ *   // Transaction processed, cached data is up to date
+ *   console.log('Transaction processed, data is fresh');
+ * } else {
+ *   // Transaction not yet processed, may need to wait
+ *   console.log('Transaction not yet processed');
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The request containing transaction hash and operation type to check.
+ * @returns True if the transaction has been processed, false otherwise.
+ */
+declare function hasProcessedKnownTransaction(client: AaveClient, request: HasProcessedKnownTransactionRequest): ResultAsync<boolean, UnexpectedError>;
+/**
+ * Fetches health factor preview for a given market action.
+ *
+ * ```ts
+ * const result = await healthFactorPreview(client, {
+ *   action: {
+ *     borrow: {
+ *       market: market.address,
+ *       amount: {
+ *         erc20: {
+ *           currency: evmAddress('0x5678…'),
+ *           value: '1000',
+ *         },
+ *       },
+ *       borrower: evmAddress('0x9abc…'),
+ *       chainId: market.chain.chainId,
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The health factor preview request parameters.
+ * @returns The health factor preview response with before and after values.
+ */
+declare function healthFactorPreview(client: AaveClient, request: HealthFactorPreviewRequest): ResultAsync<HealthFactorPreviewResponse, UnexpectedError>;
+
+/**
+ * Generates EIP-712 typed data for ERC-20 permit signature.
+ *
+ * ```ts
+ * const result = await permitTypedData(client, {
+ *   market: evmAddress('0x87870bca...'),
+ *   underlyingToken: evmAddress('0xa0b86a33...'),
+ *   amount: '1.5',
+ *   chainId: chainId(1),
+ *   spender: evmAddress('0x123...'),
+ *   owner: evmAddress('0x456...'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   const typedData = result.value;
+ *   // Use typedData for permit signing
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The permit typed data request parameters.
+ * @returns The EIP-712 typed data for permit signature.
+ */
+declare function permitTypedData(client: AaveClient, request: PermitTypedDataRequest): ResultAsync<PermitTypedDataResponse, UnexpectedError>;
+
+/**
+ * Fetches a specific reserve by market address, token address, and chain ID.
+ *
+ * ```ts
+ * const result = await reserve(client, {
+ *   market: evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2'),
+ *   underlyingToken: evmAddress('0xa0b86a33e6441c8c5f0bb9b7e5e1f8bbf5b78b5c'),
+ *   chainId: chainId(1),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The reserve request parameters.
+ * @returns The reserve data, or null if not found.
+ */
+declare function reserve(client: AaveClient, request: ReserveRequest): ResultAsync<Reserve | null, UnexpectedError>;
+/**
+ * Fetches historical borrow APY data for a given underlying asset on a specific market,
+ * within a defined time window.
+ *
+ * The returned data represents APY samples over time, or `null` if unavailable.
+ *
+ * @param client - The Aave client instance used to perform the query.
+ * @param request - The borrow APY history request parameters.
+ * @returns A `ResultAsync` containing an array of APY samples, or `null` if not found.
+ */
+declare function borrowAPYHistory(client: AaveClient, request: BorrowAPYHistoryRequest): ResultAsync<APYSample[] | null, UnexpectedError>;
+/**
+ * Fetches historical supply APY data for a given underlying asset on a specific market,
+ * within a defined time window.
+ *
+ * The returned data represents APY samples over time, or `null` if unavailable.
+ *
+ * @param client - The Aave client instance used to perform the query.
+ * @param request - The supply APY history request parameters.
+ * @returns A `ResultAsync` containing an array of APY samples, or `null` if not found.
+ */
+declare function supplyAPYHistory(client: AaveClient, request: SupplyAPYHistoryRequest): ResultAsync<APYSample[] | null, UnexpectedError>;
+
+/**
+ * Creates a transaction to borrow from a market.
+ *
+ * ```ts
+ * const result = await borrow(client, {
+ *   market: market.address,
+ *   amount: {
+ *     erc20: {
+ *       currency: evmAddress('0x5678…'),
+ *       value: '1000',
+ *     },
+ *   },
+ *   borrower: evmAddress('0x9abc…'),
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The borrow request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function borrow(client: AaveClient, request: BorrowRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to supply to a market.
+ *
+ * ```ts
+ * const result = await supply(client, {
+ *   market: market.address,
+ *   amount: {
+ *     erc20: {
+ *       currency: evmAddress('0x5678…'),
+ *       value: '1000',
+ *     },
+ *   },
+ *   supplier: evmAddress('0x9abc…'),
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. insufficient balance, signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The supply request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function supply(client: AaveClient, request: SupplyRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to repay to a market.
+ *
+ * ```ts
+ * const result = await repay(client, {
+ *   market: market.address,
+ *   amount: {
+ *     erc20: {
+ *       currency: evmAddress('0x5678…'),
+ *       value: {
+ *         exact: '500',
+ *       },
+ *     },
+ *   },
+ *   borrower: evmAddress('0x9abc…'),
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. insufficient balance, signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The repay request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function repay(client: AaveClient, request: RepayRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to withdraw from a market.
+ *
+ * ```ts
+ * const result = await withdraw(client, {
+ *   market: market.address,
+ *   amount: {
+ *     erc20: {
+ *       currency: evmAddress('0x5678…'),
+ *       value: { exact: '750' },
+ *     },
+ *   },
+ *   supplier: evmAddress('0x9abc…'),
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. insufficient balance, signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The withdraw request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function withdraw(client: AaveClient, request: WithdrawRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to enable/disable the user's eMode for a market.
+ *
+ * **Example: Enable a Specific eMode**
+ * ```ts
+ * const result = await userSetEmode(client, {
+ *   market: market.address,
+ *   user: evmAddress('0x5678…'),
+ *   categoryId: market.eModeCategories[0].id,
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * **Example: Disable eMode**
+ * ```ts
+ * const result = await userSetEmode(client, {
+ *   market: market.address,
+ *   user: evmAddress('0x5678…'),
+ *   categoryId: null,
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user set eMode request parameters.
+ * @returns The transaction request data to set eMode.
+ */
+declare function userSetEmode(client: AaveClient, request: UserSetEmodeRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates a transaction to deposit assets into a vault and mint shares.
+ *
+ * ```ts
+ * const result = await vaultDeposit(client, {
+ *   vault: evmAddress('0x1234…'),
+ *   amount: {
+ *     value: '1000',
+ *   },
+ *   depositor: evmAddress('0x9abc…'),
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. insufficient balance, signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault deposit request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function vaultDeposit(client: AaveClient, request: VaultDepositRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to redeem vault shares for underlying assets.
+ *
+ * ```ts
+ * const result = await vaultRedeemShares(client, {
+ *   vault: evmAddress('0x1234…'),
+ *   shares: {
+ *     amount: '500',
+ *     asAToken: false,
+ *   },
+ *   sharesOwner: evmAddress('0x9abc…'),
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The redeem vault shares request parameters.
+ * @returns The transaction request data to redeem shares.
+ */
+declare function vaultRedeemShares(client: AaveClient, request: VaultRedeemSharesRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates an execution plan to deploy a new vault.
+ *
+ * ```ts
+ * const result = await vaultDeploy(client, {
+ *   underlyingToken: evmAddress('0x1234…'),
+ *   market: evmAddress('0x5678…'),
+ *   deployer: evmAddress('0x9abc…'),
+ *   initialFee: '0.1',
+ *   shareName: 'Aave Vault Shares',
+ *   shareSymbol: 'avs',
+ *   initialLockDeposit: '1000',
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, insufficient balance, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The deploy vault request parameters.
+ * @returns The execution plan data to deploy a vault. May require approval transactions.
+ */
+declare function vaultDeploy(client: AaveClient, request: VaultDeployRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to set the vault fee (owner only).
+ *
+ * ```ts
+ * const result = await vaultSetFee(client, {
+ *   vault: evmAddress('0x1234…'),
+ *   newFee: '0.2',
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The set vault fee request parameters.
+ * @returns The transaction request data to set vault fee.
+ */
+declare function vaultSetFee(client: AaveClient, request: VaultSetFeeRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates a transaction to withdraw accumulated fees from a vault (owner only).
+ *
+ * ```ts
+ * const result = await vaultWithdrawFees(client, {
+ *   vault: evmAddress('0x1234…'),
+ *   amount: '100',
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The withdraw vault fees request parameters.
+ * @returns The transaction request data to withdraw vault fees.
+ */
+declare function vaultWithdrawFees(client: AaveClient, request: VaultWithdrawFeesRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates a transaction to withdraw assets from a vault, burning shares.
+ *
+ * ```ts
+ * const result = await vaultWithdraw(client, {
+ *   vault: evmAddress('0x1234…'),
+ *   amount: {
+ *     value: '500',
+ *   },
+ *   sharesOwner: evmAddress('0x9abc…'),
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The withdraw vault request parameters.
+ * @returns The transaction request data to withdraw from vault.
+ */
+declare function vaultWithdraw(client: AaveClient, request: VaultWithdrawRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates a transaction to mint exact amount of vault shares by depositing calculated assets.
+ *
+ * ```ts
+ * const result = await vaultMintShares(client, {
+ *   vault: evmAddress('0x1234…'),
+ *   shares: {
+ *     amount: '1000',
+ *     asAToken: false,
+ *   },
+ *   minter: evmAddress('0x9abc…'),
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. insufficient balance, signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The mint vault shares request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+declare function vaultMintShares(client: AaveClient, request: VaultMintSharesRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
+/**
+ * Creates a transaction to enable/disable a specific supplied asset as collateral.
+ *
+ * ```ts
+ * const result = await collateralToggle(client, {
+ *   market: market.address,
+ *   underlyingToken: market.supplyReserves[n].underlyingToken.address,
+ *   user: evmAddress('0x9abc…'),
+ *   chainId: market.chain.chainId,
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The collateral toggle request parameters.
+ * @returns The transaction request data to toggle collateral.
+ */
+declare function collateralToggle(client: AaveClient, request: CollateralToggleRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates a transaction to liquidate a non-healthy position with Health Factor below 1.
+ *
+ * ```ts
+ * const result = await liquidate(client, {
+ *   collateralToken: evmAddress('0x1234…'),
+ *   debtToken: evmAddress('0x5678…'),
+ *   user: evmAddress('0x9abc…'),
+ *   debtToCover: { max: true },
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The liquidate request parameters.
+ * @returns The transaction request data to liquidate position.
+ */
+declare function liquidate(client: AaveClient, request: LiquidateRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Creates a transaction to approve a credit borrow delegator to be able to borrow on your behalf.
+ *
+ * ```ts
+ * const result = await approveBorrowCreditDelegation(client, {
+ *   market: evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2'),
+ *   underlyingToken: evmAddress('0xa0b86a33e6441c8c5f0bb9b7e5e1f8bbf5b78b5c'),
+ *   amount: '1000',
+ *   user: evmAddress('0x742d35cc6e5c4ce3b69a2a8c7c8e5f7e9a0b1234'),
+ *   delegatee: evmAddress('0x5678…'),
+ *   chainId: chainId(1),
+ * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
+ *
+ * if (result.isErr()) {
+ *   // Handle error, e.g. signing error, etc.
+ *   return;
+ * }
+ *
+ * // result.value: TxHash
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The approve borrow credit delegation request parameters.
+ * @returns The transaction request data to approve credit delegation.
+ */
+declare function approveBorrowCreditDelegation(client: AaveClient, request: ApproveBorrowCreditDelegatorRequest): ResultAsync<TransactionRequest, UnexpectedError>;
+/**
+ * Gets the amount delegated to the credit delegatee that can borrow on your behalf.
+ *
+ * ```ts
+ * const result = await creditDelegateeAllowance(client, {
+ *   market: evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2'),
+ *   underlyingToken: evmAddress('0xa0b86a33e6441c8c5f0bb9b7e5e1f8bbf5b78b5c'),
+ *   user: evmAddress('0x742d35cc6e5c4ce3b69a2a8c7c8e5f7e9a0b1234'),
+ *   delegatee: evmAddress('0x5678…'),
+ *   chainId: chainId(1),
+ * });
+ *
+ * if (result.isErr()) {
+ *   // Handle error
+ *   return;
+ * }
+ *
+ * // result.value: TokenAmount with credit delegation allowance
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The credit delegatee allowance request parameters.
+ * @returns The token amount representing the credit delegation allowance.
+ */
+declare function creditDelegateeAllowance(client: AaveClient, request: CreditDelegateeAmountRequest): ResultAsync<TokenAmount, UnexpectedError>;
+
+/**
+ * Fetches all user supply positions across the specified markets.
+ *
+ * ```ts
+ * const result = await userSupplies(client, {
+ *   markets: [{ address: evmAddress('0x87870bca…'), chainId: chainId(1) }],
+ *   user: evmAddress('0x742d35cc…'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user supplies request parameters.
+ * @returns The user's supply positions.
+ */
+declare function userSupplies(client: AaveClient, request: UserSuppliesRequest): ResultAsync<MarketUserReserveSupplyPosition[], UnexpectedError>;
+/**
+ * Fetches all user borrow positions.
+ *
+ * ```ts
+ * const result = await userBorrows(client, {
+ *   markets: [{ address: evmAddress('0x87870bca…'), chainId: chainId(1) }],
+ *   user: evmAddress('0x742d35cc…'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user borrows request parameters.
+ * @returns The user's borrow positions.
+ */
+declare function userBorrows(client: AaveClient, request: UserBorrowsRequest): ResultAsync<MarketUserReserveBorrowPosition[], UnexpectedError>;
+/**
+ * Fetches the user's transaction history for a given market.
+ *
+ * ```ts
+ * const result = await userTransactionHistory(client, {
+ *   chainId: chainId(1),
+ *   market: evmAddress('0x87870bca…'),
+ *   user: evmAddress('0x742d35cc…'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user transaction history request parameters.
+ * @returns The user's paginated transaction history.
+ */
+declare function userTransactionHistory(client: AaveClient, request: UserTransactionHistoryRequest): ResultAsync<PaginatedUserTransactionHistoryResult, UnexpectedError>;
+
+/**
+ * Fetches a specific vault by address and chain ID.
+ *
+ * **Example: By Address**
+ * ```ts
+ * const result = await vault(client, {
+ *   by: {
+ *     address: evmAddress('0x1234…'),
+ *   },
+ *   chainId: chainId(1),
+ *   user: evmAddress('0x5678…'),
+ * });
+ * ```
+ *
+ * **Example: Tx Hash**
+ * ```ts
+ * const result = await vault(client, {
+ *   by: {
+ *     txHash: txHash('0x1234…'),
+ *   },
+ *   chainId: chainId(1),
+ *   user: evmAddress('0x5678…'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault request parameters.
+ * @returns The vault data, or null if not found.
+ */
+declare function vault(client: AaveClient, request: VaultRequest): ResultAsync<Vault | null, UnexpectedError>;
+/**
+ * Fetches vaults based on filter criteria.
+ *
+ * ```ts
+ * const result = await vaults(client, {
+ *   criteria: {
+ *     ownedBy: [evmAddress('0x1234…')]
+ *   },
+ *   pageSize: PageSize.Ten,
+ *   user: evmAddress('0x5678…'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vaults request parameters.
+ * @returns The paginated vaults result.
+ */
+declare function vaults(client: AaveClient, request: VaultsRequest): ResultAsync<PaginatedVaultsResult, UnexpectedError>;
+/**
+ * Fetches vaults that a user has shares in.
+ *
+ * ```ts
+ * const result = await userVaults(client, {
+ *   user: evmAddress('0x1234…'),
+ *   filters: {
+ *     markets: [evmAddress('0x5678…')]
+ *   },
+ *   orderBy: { shares: OrderDirection.Desc },
+ *   pageSize: PageSize.Fifty,
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user vaults request parameters.
+ * @returns The paginated user vaults result.
+ */
+declare function userVaults(client: AaveClient, request: UserVaultsRequest): ResultAsync<PaginatedVaultsResult, UnexpectedError>;
+/**
+ * Determines the amount of shares that would be received for a deposit.
+ *
+ * ```ts
+ * const result = await vaultPreviewDeposit(client, {
+ *   vault: evmAddress('0x1234567890abcdef1234567890abcdef12345678'),
+ *   chainId: chainId(1),
+ *   amount: bigDecimal('1000'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   console.log('Shares to receive:', result.value.amount.value);
+ *   console.log('USD value:', result.value.usd);
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault preview deposit request parameters.
+ * @returns The simulated shares amount that would be received.
+ */
+declare function vaultPreviewDeposit(client: AaveClient, request: VaultPreviewDepositRequest): ResultAsync<TokenAmount, UnexpectedError>;
+/**
+ * Determines the amount of assets that would be required to mint a specific amount of vault shares.
+ *
+ * ```ts
+ * const result = await vaultPreviewMint(client, {
+ *   vault: evmAddress('0x1234567890abcdef1234567890abcdef12345678'),
+ *   chainId: chainId(1),
+ *   amount: bigDecimal('500'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   console.log('Assets required:', result.value.amount.value);
+ *   console.log('USD value:', result.value.usd);
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault preview mint request parameters.
+ * @returns The simulated assets amount that would be required.
+ */
+declare function vaultPreviewMint(client: AaveClient, request: VaultPreviewMintRequest): ResultAsync<TokenAmount, UnexpectedError>;
+/**
+ * Determines the amount of shares that would be burned for a withdrawal.
+ *
+ * ```ts
+ * const result = await vaultPreviewWithdraw(client, {
+ *   vault: evmAddress('0x1234567890abcdef1234567890abcdef12345678'),
+ *   chainId: chainId(1),
+ *   amount: bigDecimal('750'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   console.log('Shares to burn:', result.value.amount.value);
+ *   console.log('USD value:', result.value.usd);
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault preview withdraw request parameters.
+ * @returns The simulated shares amount that would be burned.
+ */
+declare function vaultPreviewWithdraw(client: AaveClient, request: VaultPreviewWithdrawRequest): ResultAsync<TokenAmount, UnexpectedError>;
+/**
+ * Determines the amount of assets that would be received for redeeming a specific amount of vault shares.
+ *
+ * ```ts
+ * const result = await vaultPreviewRedeem(client, {
+ *   vault: evmAddress('0x1234567890abcdef1234567890abcdef12345678'),
+ *   chainId: chainId(1),
+ *   amount: bigDecimal('200'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   console.log('Assets to receive:', result.value.amount.value);
+ *   console.log('USD value:', result.value.usd);
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault preview redeem request parameters.
+ * @returns The simulated assets amount that would be received.
+ */
+declare function vaultPreviewRedeem(client: AaveClient, request: VaultPreviewRedeemRequest): ResultAsync<TokenAmount, UnexpectedError>;
+/**
+ * Fetches the user transaction history for a vault.
+ *
+ * ```ts
+ * const result = await vaultUserTransactionHistory(client, {
+ *   vault: evmAddress('0x1234567890abcdef1234567890abcdef12345678'),
+ *   chainId: chainId(1),
+ *   user: evmAddress('0x5678901234567890abcdef1234567890abcdef12'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   console.log('Transaction count:', result.value.items.length);
+ *   result.value.items.forEach(tx => {
+ *     if (tx.__typename === 'VaultUserDepositItem') {
+ *       console.log('Deposit:', tx.asset.amount.value, 'shares:', tx.shares.amount.value);
+ *     } else if (tx.__typename === 'VaultUserWithdrawItem') {
+ *       console.log('Withdraw:', tx.asset.amount.value, 'shares:', tx.shares.amount.value);
+ *     }
+ *   });
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault user transaction history request parameters.
+ * @returns The paginated vault user transaction history result.
+ */
+declare function vaultUserTransactionHistory(client: AaveClient, request: VaultUserTransactionHistoryRequest): ResultAsync<PaginatedVaultUserTransactionHistoryResult, UnexpectedError>;
+/**
+ * Fetches the user activity data for a vault, including earnings breakdown over time.
+ *
+ * ```ts
+ * const result = await vaultUserActivity(client, {
+ *   vault: evmAddress('0x1234567890abcdef1234567890abcdef12345678'),
+ *   chainId: chainId(1),
+ *   user: evmAddress('0x5678901234567890abcdef1234567890abcdef12'),
+ * });
+ *
+ * if (result.isOk()) {
+ *   console.log('Total earned:', result.value.earned.amount.value);
+ *   console.log('Activity breakdown count:', result.value.breakdown.length);
+ *   result.value.breakdown.forEach(activity => {
+ *     console.log('Date:', activity.date);
+ *     console.log('Balance:', activity.balance.amount.value);
+ *     console.log('Earned:', activity.earned.amount.value);
+ *   });
+ * }
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The vault user activity request parameters.
+ * @returns The vault user activity result.
+ */
+declare function vaultUserActivity(client: AaveClient, request: VaultUserActivityRequest): ResultAsync<VaultUserActivityResult, UnexpectedError>;
+
+export { type MarketRequest, type MarketsRequest, approveBorrowCreditDelegation, borrow, borrowAPYHistory, chains, collateralToggle, creditDelegateeAllowance, defaultMarketReservesRequestOrderBy, hasProcessedKnownTransaction, health, healthFactorPreview, liquidate, market, markets, permitTypedData, repay, reserve, savingsGhoBalance, savingsGhoDeposit, savingsGhoWithdraw, supply, supplyAPYHistory, usdExchangeRates, userBorrows, userMarketState, userMeritRewards, userSetEmode, userSupplies, userTransactionHistory, userVaults, vault, vaultDeploy, vaultDeposit, vaultMintShares, vaultPreviewDeposit, vaultPreviewMint, vaultPreviewRedeem, vaultPreviewWithdraw, vaultRedeemShares, vaultSetFee, vaultUserActivity, vaultUserTransactionHistory, vaultWithdraw, vaultWithdrawFees, vaults, withdraw };