@aave/client 4.0.0-next.0 → 4.0.0-next.1

package/dist/actions/index.d.cts

@@ -1,1033 +0,0 @@
-import { UnexpectedError, TimeoutError } from '@aave/core';
-import { HubRequest, Hub, HubsRequest, HubAssetsRequest, HubAsset, ChainRequest, Chain, ChainsFilter, HasProcessedKnownTransactionRequest, ExchangeRateRequest, FiatAmount, PermitRequest, PermitTypedDataResponse, AssetRequest, Asset, AssetPriceHistoryRequest, AssetPriceSample, AssetSupplyHistoryRequest, AssetSupplySample, AssetBorrowHistoryRequest, AssetBorrowSample, ReserveRequest, Reserve, ReservesRequest, BorrowAPYHistoryRequest, APYSample, SupplyAPYHistoryRequest, SpokeRequest, Spoke, SpokesRequest, SpokePositionManagersRequest, PaginatedSpokePositionManagerResult, SpokeUserPositionManagersRequest, PaginatedSpokeUserPositionManagerResult, SwapQuoteRequest, SwapQuote, SwappableTokensRequest, Token, PrepareSwapRequest, PrepareSwapResult, SwapStatusRequest, SwapStatus, SwapCancelled, SwapExpired, SwapFulfilled, SwapReceipt, SwapRequest, SwapExecutionPlan, PrepareSwapCancelRequest, PrepareSwapCancelResult, CancelSwapRequest, CancelSwapExecutionPlan, UserSwapsRequest, PaginatedUserSwapsResult, BorrowRequest, ExecutionPlan, SupplyRequest, RepayRequest, WithdrawRequest, RenounceSpokeUserPositionManagerRequest, TransactionRequest, UpdateUserDynamicConfigRequest, UpdateUserRiskPremiumRequest, LiquidatePositionRequest, SetSpokeUserPositionManagerRequest, PreviewRequest, PreviewUserPosition, SetUserSupplyAsCollateralRequest, ActivitiesRequest, PaginatedActivitiesResult, UserSuppliesRequest, UserSupplyItem, UserBorrowsRequest, UserBorrowItem, UserSummaryRequest, UserSummary, UserPositionsRequest, UserPosition, UserPositionRequest, UserBalancesRequest, UserBalance, UserSummaryHistoryRequest, UserSummaryHistoryItem } from '@aave/graphql';
-import { ResultAsync, Prettify } from '@aave/types';
-import { A as AaveClient } from '../AaveClient-L3v8kWvn.cjs';
-import { C as CurrencyQueryOptions, R as RequestPolicyOptions, T as TimeWindowQueryOptions } from '../options-vB2peXdE.cjs';
-import '@urql/core';
-import '../types-Bu63z0x6.cjs';
-
-/**
- * Fetches a specific hub by ID or by address and chain ID.
- *
- * ```ts
- * const result = await hub(client, {
- *   query: { hubId: hubId('SGVsbG8h') }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The hub request parameters.
- * @param options - The query options.
- * @returns The hub data, or null if not found.
- */
-declare function hub(client: AaveClient, request: HubRequest, options?: CurrencyQueryOptions & RequestPolicyOptions): ResultAsync<Hub | null, UnexpectedError>;
-/**
- * Fetches multiple hubs based on specified criteria.
- *
- * ```ts
- * const result = await hubs(client, {
- *   query: {
- *     chainIds: [chainId(1)]
- *   }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The hubs request parameters (either tokens or chainIds).
- * @param options - The query options.
- * @returns Array of hub data.
- */
-declare function hubs(client: AaveClient, request: HubsRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<Hub[], UnexpectedError>;
-/**
- * Fetches hub assets for a specific hub by ID or by address and chain ID.
- *
- * ```ts
- * const result = await hubAssets(client, {
- *   query: { hubId: hubId('SGVsbG8h') },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The hub assets request parameters.
- * @param options - The query options.
- * @returns The hub assets array.
- */
-declare function hubAssets(client: AaveClient, request: HubAssetsRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<HubAsset[], UnexpectedError>;
-
-/**
- * Fetches a specific chain by chain ID.
- *
- * ```ts
- * const result = await chain(client, {
- *   chainId: chainId(1),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The chain request parameters.
- * @returns The chain data, or null if not found.
- */
-declare function chain(client: AaveClient, request: ChainRequest): ResultAsync<Chain | null, UnexpectedError>;
-/**
- * Fetches the list of supported chains.
- *
- * ```ts
- * const chains = await chains(client, { filter: ChainsFilter.ALL });
- * ```
- *
- * @param client - Aave client.
- * @param filter - The filter for chains.
- * @returns Array of supported chains.
- */
-declare function chains(client: AaveClient, filter?: ChainsFilter): ResultAsync<Chain[], UnexpectedError>;
-/**
- * Check if a transaction has been processed by the Aave API.
- *
- * @param client - Aave client.
- * @param request - The request containing transaction hash and operations to check.
- * @returns True if the transaction has been processed, false otherwise.
- */
-declare function hasProcessedKnownTransaction(client: AaveClient, request: HasProcessedKnownTransactionRequest): ResultAsync<boolean, UnexpectedError>;
-/**
- * Fetches the exchange rate between tokens and fiat currencies.
- *
- * ```ts
- * const result = await exchangeRate(client, {
- *   from: { erc20: { chainId: chainId(1), address: evmAddress('0xA0b86a33E6...') } },
- *   to: Currency.Usd,
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The exchange rate request parameters.
- * @returns The exchange rate information as a fiat amount.
- */
-declare function exchangeRate(client: AaveClient, request: ExchangeRateRequest): ResultAsync<FiatAmount, UnexpectedError>;
-
-/**
- * Generates EIP-712 typed data for permit signatures.
- *
- * ```ts
- * const result = await permitTypedData(client, {
- *   spender: evmAddress('0x87870bca…'),
- *   currency: evmAddress('0xa0b86991c431c924b2047c7094daf21b77e…'),
- *   amount: '1000.5',
- * });
- *
- * if (result.isOk()) {
- *   // Use the typed data to create a signature
- *   const signature = await wallet.signTypedData(result.value);
- * }
- * ```
- *
- * @param client - Aave client.
- * @param request - The permit request parameters.
- * @returns The EIP-712 typed data for permit signature.
- */
-declare function permitTypedData(client: AaveClient, request: PermitRequest): ResultAsync<PermitTypedDataResponse, UnexpectedError>;
-
-/**
- * Fetches information about a specific asset (ERC20 token) in the protocol by ID or by token.
- *
- * ```ts
- * const result = await asset(client, {
- *   query: { assetId: assetId('SGVsbG8h') }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The asset request parameters.
- * @param options - The query options including currency and time window.
- * @returns The asset data, or null if not found.
- */
-declare function asset(client: AaveClient, request: AssetRequest, options?: CurrencyQueryOptions & TimeWindowQueryOptions & RequestPolicyOptions): ResultAsync<Asset | null, UnexpectedError>;
-/**
- * Fetches historical price data for a specific asset.
- *
- * ```ts
- * const result = await assetPriceHistory(client, {
- *   token: { chainId: chainId(1), address: evmAddress('0x123…') },
- *   currency: Currency.Usd,
- *   window: TimeWindow.LastWeek,
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The asset price history request parameters.
- * @param options - The query options.
- * @returns Array of asset price samples over time.
- */
-declare function assetPriceHistory(client: AaveClient, request: AssetPriceHistoryRequest, options?: Required<RequestPolicyOptions>): ResultAsync<AssetPriceSample[], UnexpectedError>;
-/**
- * Fetches historical supply data for a specific asset.
- *
- * ```ts
- * const result = await assetSupplyHistory(client, {
- *   token: { chainId: chainId(1), address: evmAddress('0x123…') },
- *   window: TimeWindow.LastWeek,
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The asset supply history request parameters.
- * @param options - The query options.
- * @returns Array of asset supply samples over time.
- */
-declare function assetSupplyHistory(client: AaveClient, request: AssetSupplyHistoryRequest, options?: Required<RequestPolicyOptions>): ResultAsync<AssetSupplySample[], UnexpectedError>;
-/**
- * Fetches historical borrow data for a specific asset.
- *
- * ```ts
- * const result = await assetBorrowHistory(client, {
- *   token: { chainId: chainId(1), address: evmAddress('0x123…') },
- *   window: TimeWindow.LastWeek,
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The asset borrow history request parameters.
- * @param options - The query options.
- * @returns Array of asset borrow samples over time.
- */
-declare function assetBorrowHistory(client: AaveClient, request: AssetBorrowHistoryRequest, options?: Required<RequestPolicyOptions>): ResultAsync<AssetBorrowSample[], UnexpectedError>;
-
-/**
- * Fetches a specific reserve by reserve ID, spoke, and chain.
- *
- * ```ts
- * const result = await reserve(client, {
- *   reserve: reserveId('SGVsbG8h'),
- *   user: evmAddress('0x742d35cc…'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The reserve request parameters.
- * @param options - The query options.
- * @returns The reserve data, or null if not found.
- */
-declare function reserve(client: AaveClient, request: ReserveRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<Reserve | null, UnexpectedError>;
-/**
- * Fetches reserves based on specified criteria.
- *
- * ```ts
- * const result = await reserves(client, {
- *   query: {
- *     spoke: {
- *       address: evmAddress('0x123...'),
- *       chainId: chainId(1)
- *     }
- *   },
- *   filter: ReservesRequestFilter.All,
- *   orderBy: { name: 'ASC' }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The reserves request parameters.
- * @param options - The query options.
- * @returns Array of reserves matching the criteria.
- */
-declare function reserves(client: AaveClient, request: ReservesRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<Reserve[], UnexpectedError>;
-/**
- * Fetches borrow APY history for a specific reserve over time.
- *
- * ```ts
- * const result = await borrowApyHistory(client, {
- *   reserve: reserveId('SGVsbG8h'),
- *   window: TimeWindow.LastWeek
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The borrow APY history request parameters.
- * @returns The borrow APY history samples.
- */
-declare function borrowApyHistory(client: AaveClient, request: BorrowAPYHistoryRequest): ResultAsync<APYSample[], UnexpectedError>;
-/**
- * Fetches supply APY history for a specific reserve over time.
- *
- * ```ts
- * const result = await supplyApyHistory(client, {
- *   reserve: reserveId('SGVsbG8h'),
- *   window: TimeWindow.LastWeek
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The supply APY history request parameters.
- * @returns The supply APY history samples.
- */
-declare function supplyApyHistory(client: AaveClient, request: SupplyAPYHistoryRequest): ResultAsync<APYSample[], UnexpectedError>;
-
-/**
- * Fetches a specific spoke.
- *
- * ```ts
- * const result = await spoke(client, {
- *   query: { spokeId: spokeId('SGVsbG8h') }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The spoke request parameters.
- * @returns The spoke data, or null if not found.
- */
-declare function spoke(client: AaveClient, request: SpokeRequest): ResultAsync<Spoke | null, UnexpectedError>;
-/**
- * Fetches spokes based on specified criteria.
- *
- * ```ts
- * const result = await spokes(client, {
- *   query: { chainIds: [chainId(1)] }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The spokes request parameters.
- * @returns Array of spokes matching the criteria.
- */
-declare function spokes(client: AaveClient, request: SpokesRequest): ResultAsync<Spoke[], UnexpectedError>;
-/**
- * Fetches all positions manager for a specific spoke.
- *
- * ```ts
- * const result = await spokePositionManagers(client, {
- *   spoke: spokeId('SGVsbG8h'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The spokes request parameters.
- * @returns Array of spokes matching the criteria.
- */
-declare function spokePositionManagers(client: AaveClient, request: SpokePositionManagersRequest): ResultAsync<PaginatedSpokePositionManagerResult, UnexpectedError>;
-/**
- * Fetches all the positions managers of a user for a specific spoke.
- *
- * ```ts
- * const result = await spokeUserPositionManagers(client, {
- *   spoke: spokeId('SGVsbG8h'),
- *   user: evmAddress('0x123...'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The spokes and pagination request parameters.
- * @returns Array of position managers of a user for a specific spoke.
- */
-declare function spokeUserPositionManagers(client: AaveClient, request: SpokeUserPositionManagersRequest): ResultAsync<PaginatedSpokeUserPositionManagerResult, UnexpectedError>;
-
-/**
- * @internal
- * Fetches a swap quote for the specified trade parameters.
- *
- * ```ts
- * const result = await swapQuote(client, {
- *   chainId: chainId(1),
- *   buy: { erc20: evmAddress('0xA0b86a33E6...') },
- *   sell: { erc20: evmAddress('0x6B175474E...') },
- *   amount: bigDecimal('1000'),
- *   kind: SwapKind.SELL,
- *   from: evmAddress('0x742d35cc...'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The swap quote request parameters.
- * @param options - The query options.
- * @returns The swap quote including pricing and cost information.
- */
-declare function swapQuote(client: AaveClient, request: SwapQuoteRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<SwapQuote, UnexpectedError>;
-/**
- * @internal
- * Fetches the list of tokens available for swapping on a specific chain.
- *
- * ```ts
- * const result = await swappableTokens(client, {
- *   query: { chainIds: [chainId(1)] },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The swappable tokens request parameters.
- * @returns The list of tokens available for swapping.
- */
-declare function swappableTokens(client: AaveClient, request: SwappableTokensRequest): ResultAsync<Token[], UnexpectedError>;
-/**
- * @internal
- * Prepares a swap for the specified trade parameters.
- *
- * ```ts
- * const result = await prepareSwap(client, {
- *   market: {
- *     chainId: chainId(1),
- *     buy: { erc20: evmAddress('0xA0b86a33E6...') },
- *     sell: { erc20: evmAddress('0x6B175474E...') },
- *     amount: bigDecimal('1000'),
- *     kind: SwapKind.SELL,
- *     user: evmAddress('0x742d35cc...'),
- *   },
- * }).andThen(plan => {
- *   switch (plan.__typename) {
- *     case 'SwapByIntent':
- *       return signSwapByIntentWith(plan.data)
- *         .andThen((signature) => swap({ intent: { quoteId: quote.quoteId, signature } }))
- *         .andThen((plan) => {
- *           // …
- *         });
- *       );
- *
- *     case 'SwapByIntentWithApprovalRequired':
- *       return sendTransaction(plan.transaction)
- *         .andThen(signSwapByIntentWith(plan.data))
- *         .andThen((signature) => swap({ intent: { quoteId: quote.quoteId, signature } }))
- *         .andThen((plan) => {
- *         // …
- *         });
- *       );
- *
- *     case 'SwapByTransaction':
- *       return swap({ transaction: { quoteId: quote.quoteId } })
- *         .andThen((plan) => {
- *           // …
- *         });
- *       );
- *
- *     case 'InsufficientBalanceError':
- *       return errAsync(new Error(`Insufficient balance: ${plan.required.value} required.`));
- *   }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The prepare swap request parameters.
- * @param options - The query options.
- * @returns The prepared swap result containing details of the swap.
- */
-declare function prepareSwap(client: AaveClient, request: PrepareSwapRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PrepareSwapResult, UnexpectedError>;
-/**
- * @internal
- * Fetches the status of a specific swap.
- *
- * ```ts
- * const result = await swapStatus(client, {
- *   id: swapId('swap_123'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The swap status request parameters.
- * @param options - The query options.
- * @returns The current status of the swap.
- */
-declare function swapStatus(client: AaveClient, request: SwapStatusRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<SwapStatus, UnexpectedError>;
-type SwapOutcome = SwapCancelled | SwapExpired | SwapFulfilled;
-/**
- * @internal
- * Waits for a swap to reach a final outcome (cancelled, expired, or fulfilled).
- *
- * ```ts
- * const result = waitForSwapOutcome(client)(swapReceipt);
- *
- * if (result.isOk()) {
- *   const outcome = result.value;
- *   switch (outcome.__typename) {
- *     case 'SwapFulfilled':
- *       console.log('Swap completed successfully:', outcome.txHash);
- *       break;
- *     case 'SwapCancelled':
- *       console.log('Swap was cancelled:', outcome.cancelledAt);
- *       break;
- *     case 'SwapExpired':
- *       console.log('Swap expired:', outcome.expiredAt);
- *       break;
- *   }
- * }
- * ```
- *
- * @param client - Aave client configured with polling settings.
- * @returns A function that takes a SwapReceipt and returns a ResultAsync with the final outcome.
- */
-declare function waitForSwapOutcome(client: AaveClient): (receipt: SwapReceipt) => ResultAsync<SwapOutcome, TimeoutError | UnexpectedError>;
-/**
- * @internal
- * Executes a swap for the specified request parameters.
- *
- * ```ts
- * const result = await swap(client, {
- *   intent: {
- *     quoteId: swapQuoteId('123...'),
- *     signature: {
- *       value: signature('0x456...'),
- *       deadline: 1234567890,
- *     },
- *   },
- * }).andThen((plan) => {
- *   switch (plan.__typename) {
- *     case 'SwapTransactionRequest':
- *       return sendTransaction(plan.transaction)
- *         .map(() => plan.orderReceipt);
- *
- *     case 'SwapApprovalRequired':
- *       return sendTransaction(plan.transaction)
- *         .andThen(() => sendTransaction(plan.originalTransaction))
- *         .map(() => plan.originalTransaction.orderReceipt);
- *
- *     case 'SwapReceipt':
- *       return okAsync(plan.orderReceipt);
- *
- *     case 'InsufficientBalanceError':
- *       return errAsync(new Error(`Insufficient balance: ${plan.required.value} required.`));
- *   }
- * });
- *
- * if (result.isErr()) {
- *   console.error(result.error);
- *   return;
- * }
- *
- * console.log('Order receipt:', result.value);
- * ```
- *
- * @param client - Aave client.
- * @param request - The swap request parameters.
- * @returns The swap execution plan containing transaction details or receipt.
- */
-declare function swap(client: AaveClient, request: SwapRequest): ResultAsync<SwapExecutionPlan, UnexpectedError>;
-/**
- * @internal
- * Prepares a swap cancellation for the specified swap ID.
- *
- * ```ts
- * const result = await prepareSwapCancel(client, {
- *   id: swapId('123...'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The prepare swap cancel request parameters.
- * @returns The prepared swap cancel result containing typed data for signing.
- */
-declare function prepareSwapCancel(client: AaveClient, request: PrepareSwapCancelRequest): ResultAsync<PrepareSwapCancelResult, UnexpectedError>;
-/**
- * @internal
- * Executes a swap cancellation for the specified request parameters.
- *
- * ```ts
- * const result = await cancelSwap(client, {
- *   intent: {
- *     id: swapId('123...'),
- *     signature: {
- *       value: signature('0x456...'),
- *       deadline: 1234567890,
- *     },
- *   },
- * }).andThen((plan) => {
- *   switch (plan.__typename) {
- *     case 'TransactionRequest':
- *       return sendTransaction(plan)
- *         .map(() => ({ success: true }));
- *
- *     case 'SwapCancelled':
- *       return okAsync(plan);
- *   }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The cancel swap request parameters.
- * @returns The cancel swap execution plan containing transaction details or cancellation receipt.
- */
-declare function cancelSwap(client: AaveClient, request: CancelSwapRequest): ResultAsync<CancelSwapExecutionPlan, UnexpectedError>;
-/**
- * @internal
- * Fetches the user's swap history for a specific chain.
- *
- * ```ts
- * const result = await userSwaps(client, {
- *   chainId: chainId(1),
- *   user: evmAddress('0x742d35cc...'),
- *   filterBy: [SwapStatusFilter.FULFILLED, SwapStatusFilter.OPEN],
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user swaps request parameters.
- * @param options - The query options.
- * @returns The paginated list of user swaps with their status information.
- */
-declare function userSwaps(client: AaveClient, request: UserSwapsRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PaginatedUserSwapsResult, UnexpectedError>;
-
-/**
- * Creates a transaction to borrow from a market.
- *
- * ```ts
- * const result = await borrow(client, {
- *   amount: {
- *     erc20: {
- *       value: bigDecimal('1000'),
- *     },
- *   },
- *   reserve: reserveId('SGVsbG8h'),
- *   sender: evmAddress('0x9abc…'),
- * }).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, {
- *   reserve: {
- *     reserveId: "1234567890",
- *     spoke: evmAddress('0x8787…'),
- *     chainId: chainId(1),
- *   },
- *   amount: {
- *     erc20: {
- *       value: bigDecimal('1000'),
- *     },
- *   },
- *   enableCollateral: true, // Optional, defaults to true
- *   sender: evmAddress('0x9abc…'),
- * });
- *
- * 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, {
- *   amount: {
- *     erc20: {
- *       value: {
- *         exact: bigDecimal('500'),
- *       },
- *     },
- *   },
- *   sender: evmAddress('0x9abc…'),
- *   reserve: reserveId('SGVsbG8h'),
- * }).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 reserve.
- *
- * ```ts
- * const result = await withdraw(client, {
- *   reserve: reserveId('SGVsbG8h'),
- *   amount: {
- *     erc20: {
- *       exact: bigDecimal('750.5'),
- *     },
- *   },
- *   sender: evmAddress('0x9abc…'),
- * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
- *
- * if (result.isErr()) {
- *   // Handle error, e.g. insufficient balance, signing error, etc.
- *   return;
- * }
- *
- * // result.value: TxHash
- * ```
- *
- * **Withdraw specific amount:**
- * ```ts
- * amount: {
- *   erc20: {
- *     exact: bigDecimal('100.5'), // Exact amount to withdraw
- *   }
- * }
- * ```
- *
- * **Withdraw all available:**
- * ```ts
- * amount: {
- *   erc20: {
- *     max: true, // Withdraw the full position
- *   }
- * }
- * ```
- *
- * **Withdraw native token:**
- * ```ts
- * amount: {
- *   native: bigDecimal('0.5'), // For ETH on Ethereum
- * }
- * ```
- *
- * @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 renounce a position manager of a user in a specific spoke.
- *
- * ```ts
- * const result = await renounceSpokeUserPositionManager(client, {
- *   manager: evmAddress('0x9abc…'),
- *   managing: evmAddress('0xdef0…'),
- *   spoke: spokeId('SGVsbG8h'),
- * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
- *
- * if (result.isErr()) {
- *   // Handle error
- *   return;
- * }
- *
- * // result.value: TxHash
- * ```
- *
- *
- * @param client - Aave client.
- * @param request - The renounce spoke user position manager request parameters.
- * @returns The transaction data.
- */
-declare function renounceSpokeUserPositionManager(client: AaveClient, request: RenounceSpokeUserPositionManagerRequest): ResultAsync<TransactionRequest, UnexpectedError>;
-/**
- * Creates a transaction to update user dynamic config for a specific spoke.
- *
- * ```ts
- * const result = await updateUserDynamicConfig(client, {
- *   sender: evmAddress('0x9abc…'),
- *   spoke: spokeId('SGVsbG8h'),
- * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
- *
- * if (result.isErr()) {
- *   // Handle error
- *   return;
- * }
- *
- * // result.value: TxHash
- * ```
- *
- *
- * @param client - Aave client.
- * @param request - The update user dynamic config request parameters.
- * @returns The transaction data.
- */
-declare function updateUserDynamicConfig(client: AaveClient, request: UpdateUserDynamicConfigRequest): ResultAsync<TransactionRequest, UnexpectedError>;
-/**
- * Creates a transaction to update user risk premium for a specific spoke.
- *
- * ```ts
- * const result = await updateUserRiskPremium(client, {
- *   sender: evmAddress('0x9abc…'),
- *   spoke: spokeId('SGVsbG8h'),
- * }).andThen(sendWith(wallet)).andThen(client.waitForTransaction);
- *
- * if (result.isErr()) {
- *   // Handle error
- *   return;
- * }
- *
- * // result.value: TxHash
- * ```
- *
- *
- * @param client - Aave client.
- * @param request - The update user risk premium request parameters.
- * @returns The transaction data.
- */
-declare function updateUserRiskPremium(client: AaveClient, request: UpdateUserRiskPremiumRequest): ResultAsync<TransactionRequest, UnexpectedError>;
-/**
- * Creates a transaction to liquidate a user's position.
- *
- * ```ts
- * const result = await liquidatePosition(client, {
- *   collateral: reserveId('SGVsbG8h'),
- *   debt: reserveId('Q2lhbyE= '),
- *   amount: {
- *     exact: bigDecimal('1000'),
- *   },
- *   liquidator: evmAddress('0x9abc…'),
- *   user: evmAddress('0xdef0…'),
- * }).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 position request parameters.
- * @returns The transaction data, approval requirements, or insufficient balance error.
- */
-declare function liquidatePosition(client: AaveClient, request: LiquidatePositionRequest): ResultAsync<ExecutionPlan, UnexpectedError>;
-/**
- * Sets or removes a position manager for a user on a specific spoke.
- *
- * **Position managers** can perform transactions on behalf of other users, including:
- * - Supply assets
- * - Borrow assets
- * - Withdraw assets
- * - Enable/disable collateral
- *
- * The `signature` parameter is an **ERC712 signature** that must be signed by the **user**
- * (the account granting permissions) to authorize the position manager. The signature contains:
- * - `value`: The actual cryptographic signature
- * - `deadline`: Unix timestamp when the authorization expires
- *
- * ```ts
- * const result = await setSpokeUserPositionManager(client, {
- *   spoke: spokeId('SGVsbG8h'),
- *   manager: evmAddress('0x9abc…'), // Address that will become the position manager
- *   approve: true, // true to approve, false to remove the manager
- *   user: evmAddress('0xdef0…'), // User granting the permission (must sign the signature)
- *   signature: {
- *     value: '0x1234...', // ERC712 signature signed by the user
- *     deadline: 1735689600, // Unix timestamp when signature expires
- *   },
- * }).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 spoke set for the position manager request parameters.
- * @returns The transaction request data to set position manager.
- */
-declare function setSpokeUserPositionManager(client: AaveClient, request: SetSpokeUserPositionManagerRequest): ResultAsync<TransactionRequest, UnexpectedError>;
-/**
- * Previews the impact of a potential action on a user's position.
- *
- * ```ts
- * const result = await preview(client, {
- *   action: {
- *     supply: {
- *       reserve: reserveId('SGVsbG8h'),
- *       amount: {
- *         erc20: {
- *           value: '1000',
- *         },
- *       },
- *       sender: evmAddress('0x9abc…'),
- *     },
- *   },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The preview request parameters containing the action to preview.
- * @param options - The query options.
- * @returns The preview result showing position changes.
- */
-declare function preview(client: AaveClient, request: PreviewRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<PreviewUserPosition, UnexpectedError>;
-/**
- * Sets whether a user's supply should be used as collateral.
- *
- * ```ts
- * const result = await setUserSupplyAsCollateral(client, {
- *   reserve: reserveId('SGVsbG8h'),
- *   sender: evmAddress('0x456...'),
- *   enableCollateral: true
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The set user supply as collateral request parameters.
- * @returns The transaction request to set collateral status.
- */
-declare function setUserSupplyAsCollateral(client: AaveClient, request: SetUserSupplyAsCollateralRequest): ResultAsync<TransactionRequest, UnexpectedError>;
-/**
- * Fetches paginated list of activities.
- *
- * ```ts
- * const result = await activities(client, {
- *   query: {
- *     chainIds: [chainId(1)],
- *   },
- *   user: evmAddress('0x742d35cc…'), // Optional
- *   types: [ActivityType.Supply, ActivityType.Borrow, ActivityType.Withdraw, ActivityType.Repay],
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The activities request parameters.
- * @param options - The query options.
- * @returns The paginated list of activities.
- */
-declare function activities(client: AaveClient, request: ActivitiesRequest, options?: CurrencyQueryOptions & RequestPolicyOptions): ResultAsync<PaginatedActivitiesResult, UnexpectedError>;
-
-/**
- * Fetches all user supply positions across the specified spoke.
- *
- * ```ts
- * const result = await userSupplies(client, {
- *   query: {
- *     userSpoke: {
- *       spoke: { address: evmAddress('0x87870bca…'), chainId: chainId(1) },
- *       user: evmAddress('0x742d35cc…'),
- *     },
- *   },
- *   orderBy: { name: 'ASC' },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user supplies request parameters.
- * @param options - The query options.
- * @returns The user's supply positions.
- */
-declare function userSupplies(client: AaveClient, request: UserSuppliesRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<UserSupplyItem[], UnexpectedError>;
-/**
- * Fetches all user borrow positions across the specified spoke.
- *
- * ```ts
- * const result = await userBorrows(client, {
- *   query: {
- *     userSpoke: {
- *       spoke: { address: evmAddress('0x87870bca…'), chainId: chainId(1) },
- *       user: evmAddress('0x742d35cc…'),
- *     },
- *   },
- *   orderBy: { name: 'ASC' },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user borrows request parameters.
- * @param options - The query options.
- * @returns The user's borrow positions.
- */
-declare function userBorrows(client: AaveClient, request: UserBorrowsRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<UserBorrowItem[], UnexpectedError>;
-type UserSummaryQueryOptions = Prettify<CurrencyQueryOptions & TimeWindowQueryOptions>;
-/**
- * Fetches a user's summary across all positions.
- *
- * ```ts
- * const result = await userSummary(client, {
- *   user: evmAddress('0x742d35cc…'),
- *   filter: {
- *     spoke: { address: evmAddress('0x87870bca…'), chainId: chainId(1) },
- *   },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user summary request parameters.
- * @param options - The query options.
- * @returns The user's financial summary.
- */
-declare function userSummary(client: AaveClient, request: UserSummaryRequest, { currency, timeWindow, }?: UserSummaryQueryOptions): ResultAsync<UserSummary, UnexpectedError>;
-type UserPositionQueryOptions = CurrencyQueryOptions & TimeWindowQueryOptions;
-/**
- * Fetches all user positions across specified chains.
- *
- * ```ts
- * const result = await userPositions(client, {
- *   user: evmAddress('0x742d35cc…'),
- *   filter: {
- *     chainIds: [chainId(1), chainId(137)],
- *   },
- *   orderBy: { balance: 'DESC' },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user positions request parameters.
- * @param options - The query options.
- * @returns The user's positions across all specified chains.
- */
-declare function userPositions(client: AaveClient, request: UserPositionsRequest, { currency, timeWindow, }?: UserPositionQueryOptions): ResultAsync<UserPosition[], UnexpectedError>;
-/**
- * Fetches a specific user position by ID.
- *
- * ```ts
- * const result = await userPosition(client, {
- *   id: userPositionId('SGVsbG8h'),
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user position request parameters.
- * @param options - The query options.
- * @returns The specific user position or null if not found.
- */
-declare function userPosition(client: AaveClient, request: UserPositionRequest, { currency, timeWindow, }?: UserPositionQueryOptions): ResultAsync<UserPosition | null, UnexpectedError>;
-/**
- * Fetches all user balances across specified chains.
- *
- * ```ts
- * const result = await userBalances(client, {
- *   user: evmAddress('0x742d35cc…'),
- *   filter: {
- *     chainIds: [chainId(1), chainId(137)],
- *   },
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user balances request parameters.
- * @param options - The query options.
- * @returns The user's balances across all specified chains.
- **/
-declare function userBalances(client: AaveClient, request: UserBalancesRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<UserBalance[], UnexpectedError>;
-/**
- * Fetches user summary history over time.
- *
- * ```ts
- * const result = await userSummaryHistory(client, {
- *   user: evmAddress('0x742d35cc…'),
- *   window: TimeWindow.LastWeek,
- *   filter: {
- *     chainIds: [chainId(1)]
- *   }
- * });
- * ```
- *
- * @param client - Aave client.
- * @param request - The user summary history request parameters.
- * @param options - The query options.
- * @returns The user summary history items.
- */
-declare function userSummaryHistory(client: AaveClient, request: UserSummaryHistoryRequest, options?: Required<CurrencyQueryOptions>): ResultAsync<UserSummaryHistoryItem[], UnexpectedError>;
-
-export { type SwapOutcome, type UserPositionQueryOptions, type UserSummaryQueryOptions, activities, asset, assetBorrowHistory, assetPriceHistory, assetSupplyHistory, borrow, borrowApyHistory, cancelSwap, chain, chains, exchangeRate, hasProcessedKnownTransaction, hub, hubAssets, hubs, liquidatePosition, permitTypedData, prepareSwap, prepareSwapCancel, preview, renounceSpokeUserPositionManager, repay, reserve, reserves, setSpokeUserPositionManager, setUserSupplyAsCollateral, spoke, spokePositionManagers, spokeUserPositionManagers, spokes, supply, supplyApyHistory, swap, swapQuote, swapStatus, swappableTokens, updateUserDynamicConfig, updateUserRiskPremium, userBalances, userBorrows, userPosition, userPositions, userSummary, userSummaryHistory, userSupplies, userSwaps, waitForSwapOutcome, withdraw };