@cowprotocol/sdk-flash-loans 3.0.3 → 3.0.5

package/dist/index.d.mts

@@ -66,9 +66,25 @@ interface CollateralSwapTradeParams {
     hooksGasLimit?: CollateralSwapHooksGasLimit;
 }
 interface CollateralSwapOrder {
-    sellAmount: bigint;
-    buyAmount: bigint;
+    /**
+     * Gross amount borrowed via the Aave flash loan, in the underlying token's unit.
+     * Populates {@link FlashLoanHookAmounts.flashLoanAmount} on the resulting hooks.
+     * Includes the portion that gets repaid as the flash loan fee — i.e. `orderToSign.sellAmount + flashLoanFeeAmount`
+     * for a standard collateral swap, since aTokens are 1:1 with the underlying.
+     */
+    flashLoanAmount: bigint;
+    /**
+     * The unsigned CoW Protocol order that will be signed via EIP-1271. The order's `sellAmount`,
+     * `buyAmount`, `sellToken`, `buyToken`, `kind`, and `validTo` are the source of truth for the
+     * hooks — flash loan amount and hook buy/sell amounts are derived from this order to guarantee
+     * the generated hooks match the order they get attached to.
+     */
     orderToSign: UnsignedOrder;
+    /**
+     * Optional EIP-2612 permit signature authorizing the adapter to spend the collateral aToken.
+     * When provided, the SDK uses permit-based approval instead of a separate `approve` tx. Leave
+     * undefined to fall back to the standard ERC-20 approval flow.
+     */
     collateralPermit?: CollateralPermitData;
 }
 interface CollateralSwapQuoteParams extends Omit<TradeParameters, 'owner' | 'validTo'>, CollateralSwapTradeParams {
@@ -238,6 +254,9 @@ declare class AaveCollateralSwapSdk {
      *          and token amounts required for execution. The hooks enable the order to trigger
      *          flash loan deployment (pre-hook) and collateral swap execution (post-hook).
      *
+     * @param {AaveFlashLoanType} flashLoanType - The flash loan flow to configure (CollateralSwap,
+     *                                              DebtSwap, or RepayCollateral). Selects which Aave
+     *                                              hook adapter and post-hook call data are used.
      * @param {CollateralSwapTradeParams} params - Trade parameters including chain ID, validity period,
      *                                              owner address, and flash loan fee amount.
      * @param {CollateralSwapOrder} settings - Order configuration including sell/buy amounts, the

package/dist/index.d.ts

@@ -66,9 +66,25 @@ interface CollateralSwapTradeParams {
     hooksGasLimit?: CollateralSwapHooksGasLimit;
 }
 interface CollateralSwapOrder {
-    sellAmount: bigint;
-    buyAmount: bigint;
+    /**
+     * Gross amount borrowed via the Aave flash loan, in the underlying token's unit.
+     * Populates {@link FlashLoanHookAmounts.flashLoanAmount} on the resulting hooks.
+     * Includes the portion that gets repaid as the flash loan fee — i.e. `orderToSign.sellAmount + flashLoanFeeAmount`
+     * for a standard collateral swap, since aTokens are 1:1 with the underlying.
+     */
+    flashLoanAmount: bigint;
+    /**
+     * The unsigned CoW Protocol order that will be signed via EIP-1271. The order's `sellAmount`,
+     * `buyAmount`, `sellToken`, `buyToken`, `kind`, and `validTo` are the source of truth for the
+     * hooks — flash loan amount and hook buy/sell amounts are derived from this order to guarantee
+     * the generated hooks match the order they get attached to.
+     */
     orderToSign: UnsignedOrder;
+    /**
+     * Optional EIP-2612 permit signature authorizing the adapter to spend the collateral aToken.
+     * When provided, the SDK uses permit-based approval instead of a separate `approve` tx. Leave
+     * undefined to fall back to the standard ERC-20 approval flow.
+     */
     collateralPermit?: CollateralPermitData;
 }
 interface CollateralSwapQuoteParams extends Omit<TradeParameters, 'owner' | 'validTo'>, CollateralSwapTradeParams {
@@ -238,6 +254,9 @@ declare class AaveCollateralSwapSdk {
      *          and token amounts required for execution. The hooks enable the order to trigger
      *          flash loan deployment (pre-hook) and collateral swap execution (post-hook).
      *
+     * @param {AaveFlashLoanType} flashLoanType - The flash loan flow to configure (CollateralSwap,
+     *                                              DebtSwap, or RepayCollateral). Selects which Aave
+     *                                              hook adapter and post-hook call data are used.
      * @param {CollateralSwapTradeParams} params - Trade parameters including chain ID, validity period,
      *                                              owner address, and flash loan fee amount.
      * @param {CollateralSwapOrder} settings - Order configuration including sell/buy amounts, the

package/dist/index.js

@@ -487,15 +487,14 @@ var AaveCollateralSwapSdk = class {
       tradeParameters: { amount },
       settings
     } = params;
-    const sellAmount = BigInt(amount);
+    const flashLoanAmount = BigInt(amount);
     const quoteAndPost = await tradingSdk.getQuote(quoteParams);
     const { quoteResults, postSwapOrderFromQuote } = quoteAndPost;
     const { swapSettings, instanceAddress } = await this.getOrderPostingSettings(
       "CollateralSwap" /* CollateralSwap */,
       quoteParams,
       {
-        sellAmount,
-        buyAmount: quoteResults.amountsAndCosts.afterSlippage.buyAmount,
+        flashLoanAmount,
         orderToSign: quoteResults.orderToSign,
         collateralPermit: settings?.collateralPermit
       }
@@ -504,10 +503,10 @@ var AaveCollateralSwapSdk = class {
       instanceAddress,
       trader: quoteParams.owner,
       collateralToken,
-      amount: sellAmount
+      amount: flashLoanAmount
     };
     if (!settings?.preventApproval && !settings?.collateralPermit) {
-      await this.approveCollateralIfNeeded(collateralParams, sellAmount);
+      await this.approveCollateralIfNeeded(collateralParams);
     }
     return postSwapOrderFromQuote(swapSettings);
   }
@@ -567,6 +566,9 @@ var AaveCollateralSwapSdk = class {
    *          and token amounts required for execution. The hooks enable the order to trigger
    *          flash loan deployment (pre-hook) and collateral swap execution (post-hook).
    *
+   * @param {AaveFlashLoanType} flashLoanType - The flash loan flow to configure (CollateralSwap,
+   *                                              DebtSwap, or RepayCollateral). Selects which Aave
+   *                                              hook adapter and post-hook call data are used.
    * @param {CollateralSwapTradeParams} params - Trade parameters including chain ID, validity period,
    *                                              owner address, and flash loan fee amount.
    * @param {CollateralSwapOrder} settings - Order configuration including sell/buy amounts, the
@@ -579,9 +581,10 @@ var AaveCollateralSwapSdk = class {
    * ```
    */
   async getOrderPostingSettings(flashLoanType, params, settings) {
-    const { sellAmount, buyAmount, orderToSign, collateralPermit } = settings;
+    const { flashLoanAmount, orderToSign, collateralPermit } = settings;
     const { chainId, flashLoanFeeAmount, validTo, owner: trader } = params;
-    const amount = sellAmount.toString();
+    const amount = flashLoanAmount.toString();
+    const buyAmount = orderToSign.buyAmount;
     const encodedOrder = {
       ...import_sdk_order_signing.OrderSigningUtils.encodeUnsignedOrder(orderToSign),
       appData: HASH_ZERO,
@@ -591,7 +594,7 @@ var AaveCollateralSwapSdk = class {
       flashLoanAmount: amount,
       flashLoanFeeAmount: flashLoanFeeAmount.toString(),
       sellAssetAmount: amount,
-      buyAssetAmount: buyAmount.toString()
+      buyAssetAmount: buyAmount
     };
     const instanceAddress = await this.getExpectedInstanceAddress(
       flashLoanType,
@@ -723,12 +726,12 @@ var AaveCollateralSwapSdk = class {
       abi: aaveAdapterFactoryAbi
     });
   }
-  async approveCollateralIfNeeded(collateralParams, sellAmount) {
+  async approveCollateralIfNeeded(collateralParams) {
     const allowance = await this.getCollateralAllowance(collateralParams).catch((error) => {
       console.error("[AaveCollateralSwapSdk] Could not get allowance for collateral token", error);
       return null;
     });
-    if (!allowance || allowance < sellAmount) {
+    if (!allowance || allowance < collateralParams.amount) {
       await this.approveCollateral(collateralParams);
     }
   }

package/dist/index.mjs

@@ -450,15 +450,14 @@ var AaveCollateralSwapSdk = class {
       tradeParameters: { amount },
       settings
     } = params;
-    const sellAmount = BigInt(amount);
+    const flashLoanAmount = BigInt(amount);
     const quoteAndPost = await tradingSdk.getQuote(quoteParams);
     const { quoteResults, postSwapOrderFromQuote } = quoteAndPost;
     const { swapSettings, instanceAddress } = await this.getOrderPostingSettings(
       "CollateralSwap" /* CollateralSwap */,
       quoteParams,
       {
-        sellAmount,
-        buyAmount: quoteResults.amountsAndCosts.afterSlippage.buyAmount,
+        flashLoanAmount,
         orderToSign: quoteResults.orderToSign,
         collateralPermit: settings?.collateralPermit
       }
@@ -467,10 +466,10 @@ var AaveCollateralSwapSdk = class {
       instanceAddress,
       trader: quoteParams.owner,
       collateralToken,
-      amount: sellAmount
+      amount: flashLoanAmount
     };
     if (!settings?.preventApproval && !settings?.collateralPermit) {
-      await this.approveCollateralIfNeeded(collateralParams, sellAmount);
+      await this.approveCollateralIfNeeded(collateralParams);
     }
     return postSwapOrderFromQuote(swapSettings);
   }
@@ -530,6 +529,9 @@ var AaveCollateralSwapSdk = class {
    *          and token amounts required for execution. The hooks enable the order to trigger
    *          flash loan deployment (pre-hook) and collateral swap execution (post-hook).
    *
+   * @param {AaveFlashLoanType} flashLoanType - The flash loan flow to configure (CollateralSwap,
+   *                                              DebtSwap, or RepayCollateral). Selects which Aave
+   *                                              hook adapter and post-hook call data are used.
    * @param {CollateralSwapTradeParams} params - Trade parameters including chain ID, validity period,
    *                                              owner address, and flash loan fee amount.
    * @param {CollateralSwapOrder} settings - Order configuration including sell/buy amounts, the
@@ -542,9 +544,10 @@ var AaveCollateralSwapSdk = class {
    * ```
    */
   async getOrderPostingSettings(flashLoanType, params, settings) {
-    const { sellAmount, buyAmount, orderToSign, collateralPermit } = settings;
+    const { flashLoanAmount, orderToSign, collateralPermit } = settings;
     const { chainId, flashLoanFeeAmount, validTo, owner: trader } = params;
-    const amount = sellAmount.toString();
+    const amount = flashLoanAmount.toString();
+    const buyAmount = orderToSign.buyAmount;
     const encodedOrder = {
       ...OrderSigningUtils.encodeUnsignedOrder(orderToSign),
       appData: HASH_ZERO,
@@ -554,7 +557,7 @@ var AaveCollateralSwapSdk = class {
       flashLoanAmount: amount,
       flashLoanFeeAmount: flashLoanFeeAmount.toString(),
       sellAssetAmount: amount,
-      buyAssetAmount: buyAmount.toString()
+      buyAssetAmount: buyAmount
     };
     const instanceAddress = await this.getExpectedInstanceAddress(
       flashLoanType,
@@ -686,12 +689,12 @@ var AaveCollateralSwapSdk = class {
       abi: aaveAdapterFactoryAbi
     });
   }
-  async approveCollateralIfNeeded(collateralParams, sellAmount) {
+  async approveCollateralIfNeeded(collateralParams) {
     const allowance = await this.getCollateralAllowance(collateralParams).catch((error) => {
       console.error("[AaveCollateralSwapSdk] Could not get allowance for collateral token", error);
       return null;
     });
-    if (!allowance || allowance < sellAmount) {
+    if (!allowance || allowance < collateralParams.amount) {
       await this.approveCollateral(collateralParams);
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-flash-loans",
-  "version": "3.0.3",
+  "version": "3.0.5",
   "description": "Flash loans for CoW Protocol",
   "repository": {
     "type": "git",
@@ -19,12 +19,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@cowprotocol/sdk-common": "0.10.2",
-    "@cowprotocol/sdk-order-signing": "1.0.1",
-    "@cowprotocol/sdk-app-data": "5.1.0",
-    "@cowprotocol/sdk-order-book": "3.0.0",
-    "@cowprotocol/sdk-config": "2.0.0",
-    "@cowprotocol/sdk-trading": "2.0.3"
+    "@cowprotocol/sdk-trading": "2.0.5",
+    "@cowprotocol/sdk-common": "0.10.3",
+    "@cowprotocol/sdk-order-signing": "1.0.3",
+    "@cowprotocol/sdk-app-data": "5.1.2",
+    "@cowprotocol/sdk-order-book": "3.1.0",
+    "@cowprotocol/sdk-config": "2.1.0"
   },
   "devDependencies": {
     "ethers-v5": "npm:ethers@^5.7.2",
@@ -40,9 +40,9 @@
     "ethers": "^5.7.2",
     "viem": "2.30.5",
     "@cow-sdk/typescript-config": "0.0.0-beta.0",
-    "@cowprotocol/sdk-ethers-v5-adapter": "0.4.4",
-    "@cowprotocol/sdk-ethers-v6-adapter": "0.4.4",
-    "@cowprotocol/sdk-viem-adapter": "0.3.18"
+    "@cowprotocol/sdk-ethers-v5-adapter": "0.4.6",
+    "@cowprotocol/sdk-ethers-v6-adapter": "0.4.6",
+    "@cowprotocol/sdk-viem-adapter": "0.3.20"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",