feat: allows to expand swap strategies without breaking changes

Author: cesarenaldi

.changeset/fluffy-drinks-dig.md

@@ -0,0 +1,7 @@
+---
+"@aave/graphql": patch
+"@aave/react": patch
+"@aave/client": patch
+---
+
+**feat:** allows to expand swap strategies without breaking changes.

packages/graphql/src/fragments/swaps.ts

@@ -1,7 +1,6 @@
 import type { ExtendWithOpaqueType } from '@aave/types';
 import type { FragmentOf } from 'gql.tada';
 import { type FragmentDocumentFor, graphql } from '../graphql';
-import type { SwapId } from '../id';
 import {
   DomainDataFragment,
   type Erc20Amount,
@@ -149,8 +148,8 @@ export const PrepareTokenSwapResultFragment = graphql(
     InsufficientBalanceErrorFragment,
   ],
 );
-export type PrepareTokenSwapResult = FragmentOf<
-  typeof PrepareTokenSwapResultFragment
+export type PrepareTokenSwapResult = ExtendWithOpaqueType<
+  FragmentOf<typeof PrepareTokenSwapResultFragment>
 >;
 
 export const SwapTransactionRequestFragment = graphql(
@@ -185,11 +184,12 @@ export type SwapApprovalRequired = FragmentOf<
   typeof SwapApprovalRequiredFragment
 >;
 
-export type SwapExecutionPlan =
+export type SwapExecutionPlan = ExtendWithOpaqueType<
   | SwapTransactionRequest
   | SwapApprovalRequired
   | InsufficientBalanceError
-  | SwapReceipt;
+  | SwapReceipt
+>;
 
 export const SwapExecutionPlanFragment: FragmentDocumentFor<
   SwapExecutionPlan,
@@ -357,7 +357,6 @@ export const SwapStatusFragment = graphql(
 export type SwapStatus = ExtendWithOpaqueType<
   FragmentOf<typeof SwapStatusFragment>,
   {
-    swapId: SwapId;
     createdAt: Date;
     explorerLink: string;
   }
@@ -538,7 +537,7 @@ export const PrepareWithdrawSwapResultFragment: FragmentDocumentFor<
   [PositionSwapByIntentApprovalsRequiredFragment],
 );
 
-export type PreparePositionSwapResult = SwapByIntent;
+export type PreparePositionSwapResult = ExtendWithOpaqueType<SwapByIntent>;
 
 export const PreparePositionSwapResultFragment: FragmentDocumentFor<
   PreparePositionSwapResult,

packages/react/src/swap.ts

@@ -1152,7 +1152,13 @@ export function useWithdrawSwapQuote({
       request,
       currency,
     },
-    selector: (data) => data.quote,
+    selector: (data) => {
+      invariant(
+        data.__typename === 'PositionSwapByIntentApprovalsRequired',
+        `Unsupported swap plan: ${data.__typename}. Upgrade to a newer version of the @aave/react package.`,
+      );
+      return data.quote;
+    },
     suspense,
     pause,
   });
@@ -1320,6 +1326,7 @@ export function useTokenSwap(
       | SendTransactionError
       | PendingTransactionError
       | ValidationError<InsufficientBalanceError>
+      | UnexpectedError
     > => {
       switch (plan.__typename) {
         case 'SwapTransactionRequest':
@@ -1329,6 +1336,7 @@ export function useTokenSwap(
             .andThen(() => {
               return okAsync(plan.orderReceipt);
             });
+
         case 'SwapApprovalRequired':
           return handler(plan, { cancel })
             .map(PendingTransaction.ensure)
@@ -1339,10 +1347,17 @@ export function useTokenSwap(
             .andThen(() => {
               return okAsync(plan.originalTransaction.orderReceipt);
             });
+
         case 'InsufficientBalanceError':
           return ValidationError.fromGqlNode(plan).asResultAsync();
+
         case 'SwapReceipt':
           return okAsync(plan);
+
+        default:
+          return new UnexpectedError(
+            `Unsupported swap plan: ${plan.__typename}. Upgrade to a newer version of the @aave/react package.`,
+          ).asResultAsync();
       }
     },
     [handler],
@@ -1399,6 +1414,11 @@ export function useTokenSwap(
 
           case 'InsufficientBalanceError':
             return ValidationError.fromGqlNode(preparePlan).asResultAsync();
+
+          default:
+            return new UnexpectedError(
+              `Unsupported swap plan: ${preparePlan.__typename}. Upgrade to a newer version of the @aave/react package.`,
+            ).asResultAsync();
         }
       }),
     [client, handler, executeSwap],