Merge pull request #28 from aave/feat/vault-preview-methods

feat: support new vault preview queries

Author: cesarenaldi

packages/client/src/actions/vaults.ts

@@ -1,8 +1,17 @@
 import {
   type PaginatedVaultsResult,
+  type TokenAmount,
   UserVaultsQuery,
   type UserVaultsRequest,
   type Vault,
+  VaultPreviewDepositQuery,
+  type VaultPreviewDepositRequest,
+  VaultPreviewMintQuery,
+  type VaultPreviewMintRequest,
+  VaultPreviewRedeemQuery,
+  type VaultPreviewRedeemRequest,
+  VaultPreviewWithdrawQuery,
+  type VaultPreviewWithdrawRequest,
   VaultQuery,
   type VaultRequest,
   VaultsQuery,
@@ -102,3 +111,119 @@ export function userVaults(
     request,
   });
 }
+
+/**
+ * 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.
+ */
+export function vaultPreviewDeposit(
+  client: AaveClient,
+  request: VaultPreviewDepositRequest,
+): ResultAsync<TokenAmount, UnexpectedError> {
+  return client.query(VaultPreviewDepositQuery, {
+    request,
+  });
+}
+
+/**
+ * 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.
+ */
+export function vaultPreviewMint(
+  client: AaveClient,
+  request: VaultPreviewMintRequest,
+): ResultAsync<TokenAmount, UnexpectedError> {
+  return client.query(VaultPreviewMintQuery, {
+    request,
+  });
+}
+
+/**
+ * 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.
+ */
+export function vaultPreviewWithdraw(
+  client: AaveClient,
+  request: VaultPreviewWithdrawRequest,
+): ResultAsync<TokenAmount, UnexpectedError> {
+  return client.query(VaultPreviewWithdrawQuery, {
+    request,
+  });
+}
+
+/**
+ * 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.
+ */
+export function vaultPreviewRedeem(
+  client: AaveClient,
+  request: VaultPreviewRedeemRequest,
+): ResultAsync<TokenAmount, UnexpectedError> {
+  return client.query(VaultPreviewRedeemQuery, {
+    request,
+  });
+}

packages/graphql/src/vaults.ts

@@ -1,3 +1,4 @@
+import { TokenAmountFragment } from './fragments/common';
 import {
   PaginatedVaultsResultFragment,
   VaultFragment,
@@ -42,3 +43,61 @@ export const UserVaultsQuery = graphql(
   [PaginatedVaultsResultFragment],
 );
 export type UserVaultsRequest = RequestOf<typeof UserVaultsQuery>;
+
+/**
+ * @internal
+ */
+export const VaultPreviewDepositQuery = graphql(
+  `query VaultPreviewDeposit($request: VaultOperationPreviewRequest!) {
+    value: vaultPreviewDeposit(request: $request) {
+      ...TokenAmount
+    }
+  }`,
+  [TokenAmountFragment],
+);
+export type VaultPreviewDepositRequest = RequestOf<
+  typeof VaultPreviewDepositQuery
+>;
+
+/**
+ * @internal
+ */
+export const VaultPreviewMintQuery = graphql(
+  `query VaultPreviewMint($request: VaultOperationPreviewRequest!) {
+    value: vaultPreviewMint(request: $request) {
+      ...TokenAmount
+    }
+  }`,
+  [TokenAmountFragment],
+);
+export type VaultPreviewMintRequest = RequestOf<typeof VaultPreviewMintQuery>;
+
+/**
+ * @internal
+ */
+export const VaultPreviewWithdrawQuery = graphql(
+  `query VaultPreviewWithdraw($request: VaultOperationPreviewRequest!) {
+    value: vaultPreviewWithdraw(request: $request) {
+      ...TokenAmount
+    }
+  }`,
+  [TokenAmountFragment],
+);
+export type VaultPreviewWithdrawRequest = RequestOf<
+  typeof VaultPreviewWithdrawQuery
+>;
+
+/**
+ * @internal
+ */
+export const VaultPreviewRedeemQuery = graphql(
+  `query VaultPreviewRedeem($request: VaultOperationPreviewRequest!) {
+    value: vaultPreviewRedeem(request: $request) {
+      ...TokenAmount
+    }
+  }`,
+  [TokenAmountFragment],
+);
+export type VaultPreviewRedeemRequest = RequestOf<
+  typeof VaultPreviewRedeemQuery
+>;