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

feat: support swap position adapters

Author: cesarenaldi

.changeset/fair-tables-arrive.md

@@ -0,0 +1,7 @@
+---
+"@aave/graphql": patch
+"@aave/client": patch
+"@aave/types": patch
+---
+
+**feat:** `preparePositionSwap` and `supplySwapQuote` actions.

.changeset/quick-cities-listen.md

@@ -0,0 +1,7 @@
+---
+"@aave/graphql": patch
+"@aave/react": patch
+"@aave/types": patch
+---
+
+**feat:** `useSupplySwap` and `useSupplySwapQuote` hooks.

.changeset/sour-plants-dig.md

@@ -0,0 +1,6 @@
+---
+"@aave/graphql": patch
+"@aave/types": patch
+---
+
+**feat:** support latest GQL schema.

package.json

@@ -29,6 +29,7 @@
     "test:client:viem": "vitest --project client packages/client/src/viem.test.ts",
     "test:core": "vitest --project core",
     "test:react": "vitest --project react",
+    "test:react:swap": "vitest --project react packages/react/src/swap.test.ts",
     "test:react:viem": "vitest --project react packages/react/src/viem/*.test.ts",
     "test:types": "vitest --project types",
     "test": "pnpm test:types && pnpm test:core && pnpm test:client && pnpm test:cli && pnpm test:react"
@@ -52,6 +53,9 @@
     "overrides": {
       "react": "^19.1.0",
       "react-dom": "^19.1.0"
+    },
+    "patchedDependencies": {
+      "[email protected]": "patches/[email protected]"
     }
   },
   "packageManager": "[email protected]"

packages/client/src/actions/swap.ts

@@ -3,10 +3,14 @@ import type {
   CancelSwapExecutionPlan,
   CancelSwapRequest,
   PaginatedUserSwapsResult,
+  PreparePositionSwapRequest,
+  PreparePositionSwapResult,
+  PrepareSupplySwapRequest,
+  PrepareSupplySwapResult,
   PrepareSwapCancelRequest,
   PrepareSwapCancelResult,
-  PrepareSwapRequest,
-  PrepareSwapResult,
+  PrepareTokenSwapRequest,
+  PrepareTokenSwapResult,
   SwapCancelled,
   SwapExecutionPlan,
   SwapExpired,
@@ -23,10 +27,12 @@ import type {
 } from '@aave/graphql';
 import {
   CancelSwapQuery,
+  PreparePositionSwapQuery,
   PrepareSwapCancelQuery,
-  PrepareSwapQuery,
+  PrepareTokenSwapQuery,
+  SupplySwapQuoteQuery,
+  SwapMutation,
   SwappableTokensQuery,
-  SwapQuery,
   SwapQuoteQuery,
   SwapStatusQuery,
   UserSwapsQuery,
@@ -36,7 +42,7 @@ import type { AaveClient } from '../AaveClient';
 import { type CurrencyQueryOptions, DEFAULT_QUERY_OPTIONS } from '../options';
 
 /**
- * @internal
+ * @experimental
  * Fetches a swap quote for the specified trade parameters.
  *
  * ```ts
@@ -64,7 +70,7 @@ export function swapQuote(
 }
 
 /**
- * @internal
+ * @experimental
  * Fetches the list of tokens available for swapping on a specific chain.
  *
  * ```ts
@@ -85,11 +91,11 @@ export function swappableTokens(
 }
 
 /**
- * @internal
+ * @experimental
  * Prepares a swap for the specified trade parameters.
  *
  * ```ts
- * const result = await prepareSwap(client, {
+ * const result = await prepareTokenSwap(client, {
  *   market: {
  *     chainId: chainId(1),
  *     buy: { erc20: evmAddress('0xA0b86a33E6...') },
@@ -135,16 +141,77 @@ export function swappableTokens(
  * @param options - The query options.
  * @returns The prepared swap result containing details of the swap.
  */
-export function prepareSwap(
+export function prepareTokenSwap(
   client: AaveClient,
-  request: PrepareSwapRequest,
+  request: PrepareTokenSwapRequest,
   options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
-): ResultAsync<PrepareSwapResult, UnexpectedError> {
-  return client.query(PrepareSwapQuery, { request, ...options });
+): ResultAsync<PrepareTokenSwapResult, UnexpectedError> {
+  return client.query(PrepareTokenSwapQuery, { request, ...options });
 }
 
 /**
- * @internal
+ * @experimental
+ * Fetches a supply swap quote for swapping supplied collateral.
+ *
+ * ```ts
+ * const result = await supplySwapQuote(client, {
+ *   market: {
+ *     sellPosition: userSupplyItemId('position_123'),
+ *     buyReserve: reserveId('reserve_456'),
+ *     amount: bigDecimal('1000'),
+ *     user: evmAddress('0x742d35cc...'),
+ *   },
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The supply swap request parameters.
+ * @param options - The query options.
+ * @returns The supply swap result with quote, approvals, and preview.
+ */
+export function supplySwapQuote(
+  client: AaveClient,
+  request: PrepareSupplySwapRequest,
+  options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
+): ResultAsync<PrepareSupplySwapResult, UnexpectedError> {
+  return client.query(
+    SupplySwapQuoteQuery,
+    { request, currency: options.currency },
+    { batch: false },
+  );
+}
+
+/**
+ * @experimental
+ * Prepares a position swap by obtaining the typed data for signing.
+ *
+ * ```ts
+ * const result = await preparePositionSwap(client, {
+ *   quoteId: swapQuoteId('quote_123'),
+ *   adapterContractSignature: signature('0x456...'),
+ *   positionManagerSignature: signature('0x789...'),
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The position swap request with quote ID and signatures.
+ * @param options - The query options.
+ * @returns The position swap result with intent data for execution.
+ */
+export function preparePositionSwap(
+  client: AaveClient,
+  request: PreparePositionSwapRequest,
+  options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
+): ResultAsync<PreparePositionSwapResult, UnexpectedError> {
+  return client.query(
+    PreparePositionSwapQuery,
+    { request, currency: options.currency },
+    { batch: false },
+  );
+}
+
+/**
+ * @experimental
  * Fetches the status of a specific swap.
  *
  * ```ts
@@ -169,7 +236,7 @@ export function swapStatus(
 export type SwapOutcome = SwapCancelled | SwapExpired | SwapFulfilled;
 
 /**
- * @internal
+ * @experimental
  * Waits for a swap to reach a final outcome (cancelled, expired, or fulfilled).
  *
  * ```ts
@@ -246,7 +313,7 @@ export function waitForSwapOutcome(
 }
 
 /**
- * @internal
+ * @experimental
  * Executes a swap for the specified request parameters.
  *
  * ```ts
@@ -293,11 +360,11 @@ export function swap(
   client: AaveClient,
   request: SwapRequest,
 ): ResultAsync<SwapExecutionPlan, UnexpectedError> {
-  return client.query(SwapQuery, { request });
+  return client.mutation(SwapMutation, { request });
 }
 
 /**
- * @internal
+ * @experimental
  * Prepares a swap cancellation for the specified swap ID.
  *
  * ```ts
@@ -318,7 +385,7 @@ export function prepareSwapCancel(
 }
 
 /**
- * @internal
+ * @experimental
  * Executes a swap cancellation for the specified request parameters.
  *
  * ```ts
@@ -354,7 +421,7 @@ export function cancelSwap(
 }
 
 /**
- * @internal
+ * @experimental
  * Fetches the user's swap history for a specific chain.
  *
  * ```ts

packages/client/src/cache.ts

@@ -1,5 +1,6 @@
 import {
   type ActivitiesQuery,
+  type Asset,
   type BorrowActivity,
   type Chain,
   type Erc20Token,
@@ -16,9 +17,6 @@ import {
   type ReserveInfo,
   type Spoke,
   type SupplyActivity,
-  type SwapByIntent,
-  type SwapByIntentWithApprovalRequired,
-  type SwapByTransaction,
   type TokenInfo,
   type UpdatedDynamicConfigActivity,
   type UpdatedRiskPremiumActivity,
@@ -118,12 +116,6 @@ export const exchange = cacheExchange({
     AssetBorrowSample: {
       date: transformToDate,
     },
-    AssetCategoryBorrowSample: {
-      date: transformToDate,
-    },
-    AssetCategorySupplySample: {
-      date: transformToDate,
-    },
     AssetSupplySample: {
       date: transformToDate,
     },
@@ -268,30 +260,24 @@ export const exchange = cacheExchange({
     },
   },
   keys: {
-    // Entitied with composite key
+    // Entities with id field as key
+    Asset: (data: Asset) => data.id,
+    BorrowActivity: (data: BorrowActivity) => data.id,
     Hub: (data: Hub) => data.id,
     HubAsset: (data: HubAsset) => data.id,
+    LiquidatedActivity: (data: LiquidatedActivity) => data.id,
+    RepayActivity: (data: RepayActivity) => data.id,
     Reserve: (data: Reserve) => data.id,
     ReserveInfo: (data: ReserveInfo) => data.id,
     Spoke: (data: Spoke) => data.id,
-
-    // Entities with id field as key
-    BorrowActivity: (data: BorrowActivity) => data.id,
-    LiquidatedActivity: (data: LiquidatedActivity) => data.id,
     SupplyActivity: (data: SupplyActivity) => data.id,
-    SwapByIntent: (data: SwapByIntent) => data.quote.quoteId,
-    SwapByIntentWithApprovalRequired: (
-      data: SwapByIntentWithApprovalRequired,
-    ) => data.quote.quoteId,
-    SwapByTransaction: (data: SwapByTransaction) => data.quote.quoteId,
+    TokenInfo: (data: TokenInfo) => data.id,
     UserPosition: (data: UserPosition) => data.id,
+    UsingAsCollateralActivity: (data: UsingAsCollateralActivity) => data.id,
+    WithdrawActivity: (data: WithdrawActivity) => data.id,
     UpdatedDynamicConfigActivity: (data: UpdatedDynamicConfigActivity) =>
       data.id,
     UpdatedRiskPremiumActivity: (data: UpdatedRiskPremiumActivity) => data.id,
-    UsingAsCollateralActivity: (data: UsingAsCollateralActivity) => data.id,
-    WithdrawActivity: (data: WithdrawActivity) => data.id,
-    RepayActivity: (data: RepayActivity) => data.id,
-    TokenInfo: (data: TokenInfo) => data.id,
 
     // Entities with address field as key
     Erc20Token: (data: Erc20Token) => data.address,
@@ -300,29 +286,13 @@ export const exchange = cacheExchange({
     Chain: (data: Chain) => data.chainId.toString(),
     NativeToken: (data: NativeToken) => data.chain.chainId.toString(),
 
-    // Entities without keys will be embedded directly on the parent entity
-    PaginatedActivitiesResult: () => null,
-    PaginatedResultInfo: () => null,
-    PaginatedSpokePositionManagerResult: () => null,
-    PaginatedSpokeUserPositionManagerResult: () => null,
-    PaginatedUserSwapsResult: () => null,
-    SpokePositionManger: () => null,
-    SpokeUserPositionManager: () => null,
-    SwapReceipt: () => null,
-    SwapTransactionRequest: () => null,
-
     // Value objects and result types
     ApySample: () => null,
-    Asset: () => null,
     AssetAmountWithChange: () => null,
     AssetBorrowSample: () => null,
-    AssetCategoryBorrowSample: () => null,
-    AssetCategorySupplySample: () => null,
     AssetPriceSample: () => null,
     AssetSummary: () => null,
     AssetSupplySample: () => null,
-    CancelSwapTypedData: () => null,
-    CancelSwapTypeDefinition: () => null,
     DecimalNumber: () => null,
     DecimalNumberWithChange: () => null,
     DomainData: () => null,
@@ -342,11 +312,19 @@ export const exchange = cacheExchange({
     HubSummarySample: () => null,
     InsufficientBalanceError: () => null,
     NativeAmount: () => null,
+    PaginatedActivitiesResult: () => null,
+    PaginatedResultInfo: () => null,
+    PaginatedSpokePositionManagerResult: () => null,
+    PaginatedSpokeUserPositionManagerResult: () => null,
+    PaginatedUserSwapsResult: () => null,
     PercentNumber: () => null,
     PercentNumberVariation: () => null,
     PercentNumberWithChange: () => null,
     PermitMessageData: () => null,
     PermitTypedDataResponse: () => null,
+    PositionSwapAdapterContractApproval: () => null,
+    PositionSwapByIntentApprovalsRequired: () => null,
+    PositionSwapPositionManagerApproval: () => null,
     PreContractActionRequired: () => null,
     PrepareSwapCancelResult: () => null,
     PreviewUserPosition: () => null,
@@ -355,16 +333,22 @@ export const exchange = cacheExchange({
     ReserveStatus: () => null,
     ReserveSummary: () => null,
     ReserveUserState: () => null,
+    SpokePositionManger: () => null,
+    SpokeUserPositionManager: () => null,
     SwapApprovalRequired: () => null,
-    SwapByIntentTypedData: () => null,
-    SwapByIntentTypeDefinition: () => null,
+    SwapByIntent: () => null,
+    SwapByIntentWithApprovalRequired: () => null,
+    SwapByTransaction: () => null,
     SwapCancelled: () => null,
     SwapExpired: () => null,
     SwapFulfilled: () => null,
     SwapOpen: () => null,
     SwapPendingSignature: () => null,
     SwapQuote: () => null,
     SwapQuoteCosts: () => null,
+    SwapReceipt: () => null,
+    SwapTransactionRequest: () => null,
+    SwapTypedData: () => null,
     TransactionRequest: () => null,
     TypeDefinition: () => null,
     TypeField: () => null,