Merge pull request #223 from aave/cesare/aave-3208-sdk-support-swap-position-adapters

feat: withdraw and swap on-the-fly

Author: cesarenaldi

.changeset/orange-zebras-brake.md

@@ -0,0 +1,7 @@
+---
+"@aave/graphql": patch
+"@aave/client": patch
+"@aave/react": patch
+---
+
+**feat:** `withdrawSwapQuote` action, `useWithdrawSwapQuote` and `useWithdrawSwap` hooks.

packages/client/src/actions/swap.ts

@@ -15,6 +15,8 @@ import type {
   PrepareSwapCancelResult,
   PrepareTokenSwapRequest,
   PrepareTokenSwapResult,
+  PrepareWithdrawSwapRequest,
+  PrepareWithdrawSwapResult,
   SwapCancelled,
   SwapExecutionPlan,
   SwapExpired,
@@ -42,6 +44,7 @@ import {
   SwapQuoteQuery,
   SwapStatusQuery,
   UserSwapsQuery,
+  WithdrawSwapQuoteQuery,
 } from '@aave/graphql';
 import { ResultAsync } from '@aave/types';
 import type { AaveClient } from '../AaveClient';
@@ -251,6 +254,38 @@ export function repayWithSupplyQuote(
   );
 }
 
+/**
+ * @experimental
+ * Fetches a withdraw swap quote for withdrawing deposits and swapping on the fly.
+ *
+ * ```ts
+ * const result = await withdrawSwapQuote(client, {
+ *   market: {
+ *     position: userSupplyItemId('position_123'),
+ *     buyReserve: reserveId('reserve_456'),
+ *     amount: bigDecimal('1000'),
+ *     user: evmAddress('0x742d35cc...'),
+ *   },
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The withdraw swap request parameters.
+ * @param options - The query options.
+ * @returns The withdraw swap result with quote, approvals, and preview.
+ */
+export function withdrawSwapQuote(
+  client: AaveClient,
+  request: PrepareWithdrawSwapRequest,
+  options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
+): ResultAsync<PrepareWithdrawSwapResult, UnexpectedError> {
+  return client.query(
+    WithdrawSwapQuoteQuery,
+    { request, currency: options.currency },
+    { batch: false },
+  );
+}
+
 /**
  * @experimental
  * Prepares a position swap by obtaining the typed data for signing.

packages/graphql/src/fragments/swaps.ts

@@ -482,6 +482,21 @@ export const PrepareRepayWithSupplyResultFragment: FragmentDocumentFor<
   [PositionSwapByIntentApprovalsRequiredFragment],
 );
 
+export type PrepareWithdrawSwapResult = PositionSwapByIntentApprovalsRequired;
+
+export const PrepareWithdrawSwapResultFragment: FragmentDocumentFor<
+  PrepareWithdrawSwapResult,
+  'PrepareWithdrawSwapResult'
+> = graphql(
+  `fragment PrepareWithdrawSwapResult on PrepareWithdrawSwapResult {
+    __typename
+    ... on PositionSwapByIntentApprovalsRequired {
+      ...PositionSwapByIntentApprovalsRequired
+    }
+  }`,
+  [PositionSwapByIntentApprovalsRequiredFragment],
+);
+
 export type PreparePositionSwapResult = SwapByIntent;
 
 export const PreparePositionSwapResultFragment: FragmentDocumentFor<

packages/graphql/src/swaps.ts

@@ -7,6 +7,7 @@ import {
   PrepareSupplySwapResultFragment,
   PrepareSwapCancelResultFragment,
   PrepareTokenSwapResultFragment,
+  PrepareWithdrawSwapResultFragment,
   SwapExecutionPlanFragment,
   SwapQuoteFragment,
   SwapStatusFragment,
@@ -159,6 +160,21 @@ export type PrepareRepayWithSupplyRequest = RequestOf<
   typeof RepayWithSupplyQuoteQuery
 >;
 
+/**
+ * @internal
+ */
+export const WithdrawSwapQuoteQuery = graphql(
+  `query WithdrawSwapQuote($request: PrepareWithdrawSwapRequest!, $currency: Currency!) {
+    value: withdrawSwapQuote(request: $request) {
+      ...PrepareWithdrawSwapResult
+    }
+  }`,
+  [PrepareWithdrawSwapResultFragment],
+);
+export type PrepareWithdrawSwapRequest = RequestOf<
+  typeof WithdrawSwapQuoteQuery
+>;
+
 /**
  * @internal
  */

packages/react/src/swap.test.ts

@@ -11,9 +11,11 @@ import {
   PreparePositionSwapQuery,
   type PrepareRepayWithSupplyRequest,
   type PrepareSupplySwapRequest,
+  type PrepareWithdrawSwapRequest,
   RepayWithSupplyQuoteQuery,
   SupplySwapQuoteQuery,
   SwapMutation,
+  WithdrawSwapQuoteQuery,
 } from '@aave/graphql';
 import {
   makePositionSwapAdapterContractApproval,
@@ -34,7 +36,12 @@ import {
   describe,
   it,
 } from 'vitest';
-import { useBorrowSwap, useRepayWithSupply, useSupplySwap } from './swap';
+import {
+  useBorrowSwap,
+  useRepayWithSupply,
+  useSupplySwap,
+  useWithdrawSwap,
+} from './swap';
 import { renderHookWithinContext } from './test-utils';
 import { useSendTransaction } from './viem';
 
@@ -303,4 +310,76 @@ describe('Given the swap hooks', () => {
       assertOk(result);
     });
   });
+
+  describe(`When using the '${useWithdrawSwap.name}' hook`, () => {
+    beforeEach(() => {
+      server.use(
+        api.query(WithdrawSwapQuoteQuery, () =>
+          msw.HttpResponse.json({
+            data: {
+              value: {
+                __typename: 'PositionSwapByIntentApprovalsRequired',
+                quote: makeSwapQuote(),
+                approvals: [
+                  makePositionSwapPositionManagerApproval({
+                    byTransaction: dummyTransactionRequest,
+                  }),
+                  makePositionSwapAdapterContractApproval({
+                    byTransaction: dummyTransactionRequest,
+                  }),
+                ],
+              },
+            },
+          }),
+        ),
+      );
+    });
+
+    it('Then it should support position swap with position manager and adapter contract approvals via signatures', async () => {
+      const {
+        result: {
+          current: [swap],
+        },
+      } = renderHookWithinContext(() =>
+        useWithdrawSwap((plan) => {
+          switch (plan.__typename) {
+            case 'PositionSwapPositionManagerApproval':
+            case 'PositionSwapAdapterContractApproval':
+              return signSwapTypedDataWith(walletClient, plan.bySignature);
+
+            case 'SwapByIntent':
+              return signSwapTypedDataWith(walletClient, plan.data);
+          }
+        }),
+      );
+
+      const result = await swap({} as PrepareWithdrawSwapRequest);
+
+      assertOk(result);
+    });
+
+    it('Then it should support position swap with position manager and adapter contract approvals via transactions', async () => {
+      const {
+        result: {
+          current: [swap],
+        },
+      } = renderHookWithinContext(() => {
+        const [sendTransaction] = useSendTransaction(walletClient);
+        return useWithdrawSwap((plan) => {
+          switch (plan.__typename) {
+            case 'PositionSwapPositionManagerApproval':
+            case 'PositionSwapAdapterContractApproval':
+              return sendTransaction(plan.byTransaction);
+
+            case 'SwapByIntent':
+              return signSwapTypedDataWith(walletClient, plan.data);
+          }
+        });
+      });
+
+      const result = await swap({} as PrepareWithdrawSwapRequest);
+
+      assertOk(result);
+    });
+  });
 });