feat(flash-loans): support debtSwap and repayCollateral (#616)

* chore: rename collateralSwap integration

* feat(flash-loans): support debtSwap and repayCollateral

* chore: fix typo

Author: shoom3301

packages/flash-loans/package.json

@@ -20,7 +20,9 @@
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && npx coveralls < ./coverage/lcov.info",
     "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
-    "test:aave-collateral-integration": "npx jest --testNamePattern=^AaveFlashLoanIntegration",
+    "test:integration:aave-collateral-swap": "npx jest --testNamePattern=^AaveFlashLoanIntegration.collateralSwap",
+    "test:integration:aave-debt-swap": "npx jest --testNamePattern=^AaveFlashLoanIntegration.debtSwap",
+    "test:integration:aave-repay-collateral": "npx jest --testNamePattern=^AaveFlashLoanIntegration.repayCollateral",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build"
   },

packages/flash-loans/src/aave/AaveCollateralSwapSdk.ts

@@ -17,19 +17,20 @@ import {
   CollateralOrderData,
   CollateralParameters,
   CollateralPermitData,
+  CollateralSwapOrder,
   CollateralSwapParams,
   CollateralSwapPostParams,
   CollateralSwapQuoteParams,
-  CollateralSwapOrder,
   CollateralSwapTradeParams,
   EncodedOrder,
   FlashLoanHint,
   FlashLoanHookAmounts,
 } from './types'
 import {
   AAVE_ADAPTER_FACTORY,
-  AAVE_COLLATERAL_SWAP_ADAPTER_HOOK,
+  AAVE_HOOK_ADAPTER_PER_TYPE,
   AAVE_POOL_ADDRESS,
+  AaveFlashLoanType,
   ADAPTER_DOMAIN_NAME,
   ADAPTER_DOMAIN_VERSION,
   ADAPTER_SIGNATURE_TYPES,
@@ -42,6 +43,8 @@ import {
 import { aaveAdapterFactoryAbi } from './abi/AaveAdapterFactory'
 import { collateralSwapAdapterHookAbi } from './abi/CollateralSwapAdapterHook'
 import { SupportedChainId } from '@cowprotocol/sdk-config'
+import { debtSwapAdapterAbi } from './abi/DebtSwapAdapter'
+import { repayWithCollateralAdapterAbi } from './abi/RepayWithCollateralAdapter'
 
 /**
  * SDK for executing Aave flash loan operations, particularly collateral swaps.
@@ -86,12 +89,16 @@ export class AaveCollateralSwapSdk {
 
     const { quoteResults, postSwapOrderFromQuote } = quoteAndPost
 
-    const { swapSettings, instanceAddress } = await this.getOrderPostingSettings(quoteParams, {
-      sellAmount,
-      buyAmount: quoteResults.amountsAndCosts.afterSlippage.buyAmount,
-      orderToSign: quoteResults.orderToSign,
-      collateralPermit: settings?.collateralPermit,
-    })
+    const { swapSettings, instanceAddress } = await this.getOrderPostingSettings(
+      AaveFlashLoanType.CollateralSwap,
+      quoteParams,
+      {
+        sellAmount,
+        buyAmount: quoteResults.amountsAndCosts.afterSlippage.buyAmount,
+        orderToSign: quoteResults.orderToSign,
+        collateralPermit: settings?.collateralPermit,
+      },
+    )
 
     const collateralParams: CollateralParameters = {
       instanceAddress,
@@ -178,6 +185,7 @@ export class AaveCollateralSwapSdk {
    * ```
    */
   async getOrderPostingSettings(
+    flashLoanType: AaveFlashLoanType,
     params: CollateralSwapTradeParams,
     settings: CollateralSwapOrder,
   ): Promise<CollateralSwapPostParams> {
@@ -199,7 +207,13 @@ export class AaveCollateralSwapSdk {
       buyAssetAmount: buyAmount.toString(),
     }
 
-    const instanceAddress = await this.getExpectedInstanceAddress(chainId, trader, hookAmounts, encodedOrder)
+    const instanceAddress = await this.getExpectedInstanceAddress(
+      flashLoanType,
+      chainId,
+      trader,
+      hookAmounts,
+      encodedOrder,
+    )
 
     const flashLoanHint: FlashLoanHint = {
       amount, // this is actually in UNDERLYING but aave tokens are 1:1
@@ -210,6 +224,7 @@ export class AaveCollateralSwapSdk {
     }
 
     const hooks = await this.getOrderHooks(
+      flashLoanType,
       chainId,
       trader,
       instanceAddress,
@@ -322,6 +337,7 @@ export class AaveCollateralSwapSdk {
   }
 
   async getExpectedInstanceAddress(
+    flashLoanType: AaveFlashLoanType,
     chainId: SupportedChainId,
     trader: AccountAddress,
     hookAmounts: FlashLoanHookAmounts,
@@ -331,7 +347,7 @@ export class AaveCollateralSwapSdk {
 
     return (await getGlobalAdapter().readContract({
       address: AAVE_ADAPTER_FACTORY[chainId],
-      args: [AAVE_COLLATERAL_SWAP_ADAPTER_HOOK[chainId], hookData],
+      args: [AAVE_HOOK_ADAPTER_PER_TYPE[flashLoanType][chainId], hookData],
       functionName: 'getInstanceDeterministicAddress',
       abi: aaveAdapterFactoryAbi,
     })) as AccountAddress
@@ -363,14 +379,15 @@ export class AaveCollateralSwapSdk {
   }
 
   private getPreHookCallData(
+    flashLoanType: AaveFlashLoanType,
     chainId: SupportedChainId,
     trader: AccountAddress,
     hookAmounts: FlashLoanHookAmounts,
     order: EncodedOrder,
     instanceAddress: AccountAddress,
   ): string {
     const hookData = this.buildHookOrderData(trader, hookAmounts, order)
-    const adapterImplementation = AAVE_COLLATERAL_SWAP_ADAPTER_HOOK[chainId]
+    const adapterImplementation = AAVE_HOOK_ADAPTER_PER_TYPE[flashLoanType][chainId]
 
     return getGlobalAdapter().utils.encodeFunction(aaveAdapterFactoryAbi, 'deployAndTransferFlashLoan', [
       adapterImplementation,
@@ -402,22 +419,52 @@ export class AaveCollateralSwapSdk {
     }
   }
 
-  private getPostHookCallData(collateralPermit: CollateralPermitData = EMPTY_PERMIT): string {
+  private getFlashLoanPostHook(flashLoanType: AaveFlashLoanType, collateralPermit?: CollateralPermitData): string {
+    if (flashLoanType === AaveFlashLoanType.DebtSwap) {
+      return this.getDebtSwapPostHookCallData(collateralPermit)
+    }
+
+    if (flashLoanType === AaveFlashLoanType.RepayCollateral) {
+      return this.getRepayPostHookCallData(collateralPermit)
+    }
+
+    return this.getCollateralSwapPostHookCallData(collateralPermit)
+  }
+
+  private getCollateralSwapPostHookCallData(collateralPermit: CollateralPermitData = EMPTY_PERMIT): string {
     return getGlobalAdapter().utils.encodeFunction(collateralSwapAdapterHookAbi, 'collateralSwapWithFlashLoan', [
       collateralPermit,
     ])
   }
 
+  private getDebtSwapPostHookCallData(collateralPermit: CollateralPermitData = EMPTY_PERMIT): string {
+    return getGlobalAdapter().utils.encodeFunction(debtSwapAdapterAbi, 'debtSwapWithFlashLoan', [collateralPermit])
+  }
+
+  private getRepayPostHookCallData(collateralPermit: CollateralPermitData = EMPTY_PERMIT): string {
+    return getGlobalAdapter().utils.encodeFunction(repayWithCollateralAdapterAbi, 'repayDebtWithFlashLoan', [
+      collateralPermit,
+    ])
+  }
+
   private async getOrderHooks(
+    flashLoanType: AaveFlashLoanType,
     chainId: SupportedChainId,
     trader: AccountAddress,
     expectedInstanceAddress: AccountAddress,
     hookAmounts: FlashLoanHookAmounts,
     order: EncodedOrder,
     collateralPermit?: CollateralPermitData,
   ): Promise<LatestAppDataDocVersion['metadata']['hooks']> {
-    const preHookCallData = this.getPreHookCallData(chainId, trader, hookAmounts, order, expectedInstanceAddress)
-    const postHookCallData = this.getPostHookCallData(collateralPermit)
+    const preHookCallData = this.getPreHookCallData(
+      flashLoanType,
+      chainId,
+      trader,
+      hookAmounts,
+      order,
+      expectedInstanceAddress,
+    )
+    const postHookCallData = this.getFlashLoanPostHook(flashLoanType, collateralPermit)
 
     return {
       pre: [

packages/flash-loans/src/aave/abi/DebtSwapAdapter.ts

@@ -0,0 +1,42 @@
+export const debtSwapAdapterAbi = [
+  {
+    type: 'function',
+    name: 'debtSwapWithFlashLoan',
+    inputs: [
+      {
+        name: 'creditDelegationSig',
+        type: 'tuple',
+        internalType: 'struct DataTypes.CreditDelegationSig',
+        components: [
+          {
+            name: 'amount',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          {
+            name: 'deadline',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          {
+            name: 'v',
+            type: 'uint8',
+            internalType: 'uint8',
+          },
+          {
+            name: 'r',
+            type: 'bytes32',
+            internalType: 'bytes32',
+          },
+          {
+            name: 's',
+            type: 'bytes32',
+            internalType: 'bytes32',
+          },
+        ],
+      },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+]

packages/flash-loans/src/aave/abi/RepayWithCollateralAdapter.ts

@@ -0,0 +1,42 @@
+export const repayWithCollateralAdapterAbi = [
+  {
+    type: 'function',
+    name: 'repayDebtWithFlashLoan',
+    inputs: [
+      {
+        name: 'erc20Permit',
+        type: 'tuple',
+        internalType: 'struct DataTypes.Permit',
+        components: [
+          {
+            name: 'amount',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          {
+            name: 'deadline',
+            type: 'uint256',
+            internalType: 'uint256',
+          },
+          {
+            name: 'v',
+            type: 'uint8',
+            internalType: 'uint8',
+          },
+          {
+            name: 'r',
+            type: 'bytes32',
+            internalType: 'bytes32',
+          },
+          {
+            name: 's',
+            type: 'bytes32',
+            internalType: 'bytes32',
+          },
+        ],
+      },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+]

packages/flash-loans/src/aave/integration.test.ts renamed to packages/flash-loans/src/aave/collateralSwap.integration.test.ts

@@ -9,14 +9,14 @@ import { OrderKind } from '@cowprotocol/sdk-order-book'
 
 import { AaveCollateralSwapSdk } from './AaveCollateralSwapSdk'
 import { AccountAddress } from '@cowprotocol/sdk-common'
-import { HASH_ZERO } from './const'
+import { AaveFlashLoanType, HASH_ZERO } from './const'
 
 // =================== Config ===================
 const RPC_URL = 'https://rpc.gnosis.gateway.fm'
 const PRIVATE_KEY = process.env.PRIVATE_KEY
 // ===============================================================
 
-describe('AaveFlashLoanIntegration', () => {
+describe('AaveFlashLoanIntegration.collateralSwap', () => {
   it.skip('Test AaveFlashLoanSdk collateralSwap on Gnosis Chain with swap', async () => {
     const chainId = SupportedChainId.GNOSIS_CHAIN
 
@@ -136,6 +136,7 @@ describe('AaveFlashLoanIntegration', () => {
     )
 
     const orderPostParams = await flashLoanSdk.getOrderPostingSettings(
+      AaveFlashLoanType.CollateralSwap,
       {
         chainId,
         validTo,

packages/flash-loans/src/aave/const.ts

@@ -3,15 +3,24 @@ import { CollateralPermitData } from './types'
 
 export const HASH_ZERO = '0x0000000000000000000000000000000000000000000000000000000000000000'
 
+export enum AaveFlashLoanType {
+  CollateralSwap = 'CollateralSwap',
+  DebtSwap = 'DebtSwap',
+  RepayCollateral = 'RepayCollateral',
+}
+
 // See https://search.onaave.com/?q=sepolia
 export const AAVE_POOL_ADDRESS = mapAddressToSupportedNetworks('0xb50201558B00496A145fE76f7424749556E326D8')
-export const AAVE_ADAPTER_FACTORY = {
-  ...mapAddressToSupportedNetworks('0x1186B5ad42E3e6d6c6901FC53b4A367540E6EcFE'),
-  [SupportedChainId.GNOSIS_CHAIN]: '0x889ee28C0a8a41a312546A8eeD77b4b097C84016',
-}
-export const AAVE_COLLATERAL_SWAP_ADAPTER_HOOK = {
-  ...mapAddressToSupportedNetworks('0xe80eE1e73f120b1106179Ae3D582CA4Fd768d517'),
-  [SupportedChainId.GNOSIS_CHAIN]: '0x0aeC794e544B81D96149a4C8C1cC57c6F31A978A',
+export const AAVE_ADAPTER_FACTORY = mapAddressToSupportedNetworks('0x889ee28C0a8a41a312546A8eeD77b4b097C84016')
+
+const AAVE_COLLATERAL_SWAP_ADAPTER_HOOK = mapAddressToSupportedNetworks('0x0aeC794e544B81D96149a4C8C1cC57c6F31A978A')
+const AAVE_DEBT_SWAP_ADAPTER_HOOK = mapAddressToSupportedNetworks('0x2d13ADCFa398073d7406e5e1aF3dD14663cdBF30')
+const AAVE_REPAY_COLLATERAL_ADAPTER_HOOK = mapAddressToSupportedNetworks('0x193fd444802D6BC18a9AE0613D33C024F16A9dDC')
+
+export const AAVE_HOOK_ADAPTER_PER_TYPE: Record<AaveFlashLoanType, Record<SupportedChainId, string>> = {
+  [AaveFlashLoanType.CollateralSwap]: AAVE_COLLATERAL_SWAP_ADAPTER_HOOK,
+  [AaveFlashLoanType.DebtSwap]: AAVE_DEBT_SWAP_ADAPTER_HOOK,
+  [AaveFlashLoanType.RepayCollateral]: AAVE_REPAY_COLLATERAL_ADAPTER_HOOK,
 }
 
 export const DEFAULT_HOOK_GAS_LIMIT = {