@gearbox-protocol/sdk 14.12.0-next.32 → 14.12.0-next.34

package/dist/esm/plugins/adapters/abi/adapters/iMidasGatewayAdapterV311.js

@@ -1,43 +1,4 @@
 const iMidasGatewayAdapterV311Abi = [
-  {
-    type: "function",
-    name: "allowedInputTokens",
-    inputs: [],
-    outputs: [
-      {
-        name: "",
-        type: "address[]",
-        internalType: "address[]"
-      }
-    ],
-    stateMutability: "view"
-  },
-  {
-    type: "function",
-    name: "allowedOutputTokens",
-    inputs: [],
-    outputs: [
-      {
-        name: "",
-        type: "address[]",
-        internalType: "address[]"
-      }
-    ],
-    stateMutability: "view"
-  },
-  {
-    type: "function",
-    name: "allowedPhantomTokens",
-    inputs: [],
-    outputs: [
-      {
-        name: "",
-        type: "address[]",
-        internalType: "address[]"
-      }
-    ],
-    stateMutability: "view"
-  },
   {
     type: "function",
     name: "contractType",
@@ -68,11 +29,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "depositInstant",
     inputs: [
-      {
-        name: "tokenIn",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amountToken",
         type: "uint256",
@@ -102,11 +58,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "depositInstantDiff",
     inputs: [
-      {
-        name: "tokenIn",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "leftoverAmount",
         type: "uint256",
@@ -164,44 +115,6 @@ const iMidasGatewayAdapterV311Abi = [
     ],
     stateMutability: "view"
   },
-  {
-    type: "function",
-    name: "isInputTokenAllowed",
-    inputs: [
-      {
-        name: "token",
-        type: "address",
-        internalType: "address"
-      }
-    ],
-    outputs: [
-      {
-        name: "",
-        type: "bool",
-        internalType: "bool"
-      }
-    ],
-    stateMutability: "view"
-  },
-  {
-    type: "function",
-    name: "isOutputTokenAllowed",
-    inputs: [
-      {
-        name: "token",
-        type: "address",
-        internalType: "address"
-      }
-    ],
-    outputs: [
-      {
-        name: "",
-        type: "bool",
-        internalType: "bool"
-      }
-    ],
-    stateMutability: "view"
-  },
   {
     type: "function",
     name: "mToken",
@@ -217,14 +130,8 @@ const iMidasGatewayAdapterV311Abi = [
   },
   {
     type: "function",
-    name: "outputTokenToPhantomToken",
-    inputs: [
-      {
-        name: "outputToken",
-        type: "address",
-        internalType: "address"
-      }
-    ],
+    name: "phantomToken",
+    inputs: [],
     outputs: [
       {
         name: "",
@@ -236,14 +143,8 @@ const iMidasGatewayAdapterV311Abi = [
   },
   {
     type: "function",
-    name: "phantomTokenToOutputToken",
-    inputs: [
-      {
-        name: "phantomToken",
-        type: "address",
-        internalType: "address"
-      }
-    ],
+    name: "quoteToken",
+    inputs: [],
     outputs: [
       {
         name: "",
@@ -257,11 +158,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "redeemInstant",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amountMTokenIn",
         type: "uint256",
@@ -286,11 +182,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "redeemInstantDiff",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "leftoverAmount",
         type: "uint256",
@@ -315,20 +206,10 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "redeemRequest",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amountMTokenIn",
         type: "uint256",
         internalType: "uint256"
-      },
-      {
-        name: "extraData",
-        type: "bytes",
-        internalType: "bytes"
       }
     ],
     outputs: [
@@ -344,15 +225,15 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "redeemRequest",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amountMTokenIn",
         type: "uint256",
         internalType: "uint256"
+      },
+      {
+        name: "extraData",
+        type: "bytes",
+        internalType: "bytes"
       }
     ],
     outputs: [
@@ -368,11 +249,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "redeemRequestDiff",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "leftoverAmount",
         type: "uint256",
@@ -392,11 +268,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "redeemRequestDiff",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "leftoverAmount",
         type: "uint256",
@@ -443,54 +314,6 @@ const iMidasGatewayAdapterV311Abi = [
     ],
     stateMutability: "view"
   },
-  {
-    type: "function",
-    name: "setInputTokenAllowedStatusBatch",
-    inputs: [
-      {
-        name: "tokens",
-        type: "address[]",
-        internalType: "address[]"
-      },
-      {
-        name: "allowed",
-        type: "bool[]",
-        internalType: "bool[]"
-      }
-    ],
-    outputs: [],
-    stateMutability: "nonpayable"
-  },
-  {
-    type: "function",
-    name: "setOutputTokenAllowedStatusBatch",
-    inputs: [
-      {
-        name: "configs",
-        type: "tuple[]",
-        internalType: "struct IMidasGatewayAdapter.MidasAllowedTokenStatus[]",
-        components: [
-          {
-            name: "token",
-            type: "address",
-            internalType: "address"
-          },
-          {
-            name: "phantomToken",
-            type: "address",
-            internalType: "address"
-          },
-          {
-            name: "allowed",
-            type: "bool",
-            internalType: "bool"
-          }
-        ]
-      }
-    ],
-    outputs: [],
-    stateMutability: "nonpayable"
-  },
   {
     type: "function",
     name: "targetContract",
@@ -545,11 +368,6 @@ const iMidasGatewayAdapterV311Abi = [
     type: "function",
     name: "withdraw",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amount",
         type: "uint256",
@@ -574,11 +392,6 @@ const iMidasGatewayAdapterV311Abi = [
         type: "address",
         internalType: "address"
       },
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amount",
         type: "uint256",
@@ -618,55 +431,6 @@ const iMidasGatewayAdapterV311Abi = [
     ],
     stateMutability: "nonpayable"
   },
-  {
-    type: "event",
-    name: "SetInputTokenAllowedStatus",
-    inputs: [
-      {
-        name: "token",
-        type: "address",
-        indexed: true,
-        internalType: "address"
-      },
-      {
-        name: "allowed",
-        type: "bool",
-        indexed: false,
-        internalType: "bool"
-      }
-    ],
-    anonymous: false
-  },
-  {
-    type: "event",
-    name: "SetOutputTokenAllowedStatus",
-    inputs: [
-      {
-        name: "token",
-        type: "address",
-        indexed: true,
-        internalType: "address"
-      },
-      {
-        name: "phantomToken",
-        type: "address",
-        indexed: true,
-        internalType: "address"
-      },
-      {
-        name: "allowed",
-        type: "bool",
-        indexed: false,
-        internalType: "bool"
-      }
-    ],
-    anonymous: false
-  },
-  {
-    type: "error",
-    name: "IncorrectArrayLengthException",
-    inputs: []
-  },
   {
     type: "error",
     name: "IncorrectStakedPhantomTokenException",
@@ -674,12 +438,7 @@ const iMidasGatewayAdapterV311Abi = [
   },
   {
     type: "error",
-    name: "PhantomTokenTokenOutMismatchException",
-    inputs: []
-  },
-  {
-    type: "error",
-    name: "TokenNotAllowedException",
+    name: "PhantomTokenNotSetException",
     inputs: []
   }
 ];
@@ -714,11 +473,6 @@ const iMidasGatewayV311Abi = [
     type: "function",
     name: "depositInstant",
     inputs: [
-      {
-        name: "tokenIn",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amountToken",
         type: "uint256",
@@ -759,11 +513,6 @@ const iMidasGatewayV311Abi = [
         name: "account",
         type: "address",
         internalType: "address"
-      },
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
       }
     ],
     outputs: [
@@ -801,13 +550,34 @@ const iMidasGatewayV311Abi = [
   },
   {
     type: "function",
-    name: "redeemInstant",
-    inputs: [
+    name: "phantomToken",
+    inputs: [],
+    outputs: [
       {
-        name: "tokenOut",
+        name: "",
         type: "address",
         internalType: "address"
-      },
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "quoteToken",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "redeemInstant",
+    inputs: [
       {
         name: "amountMTokenIn",
         type: "uint256",
@@ -839,11 +609,6 @@ const iMidasGatewayV311Abi = [
     type: "function",
     name: "requestRedeem",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amountMTokenIn",
         type: "uint256",
@@ -906,11 +671,6 @@ const iMidasGatewayV311Abi = [
     type: "function",
     name: "withdraw",
     inputs: [
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amount",
         type: "uint256",
@@ -929,11 +689,6 @@ const iMidasGatewayV311Abi = [
         type: "address",
         internalType: "address"
       },
-      {
-        name: "tokenOut",
-        type: "address",
-        internalType: "address"
-      },
       {
         name: "amount",
         type: "uint256",
@@ -953,6 +708,11 @@ const iMidasGatewayV311Abi = [
     name: "CreditAccountNotEligibleException",
     inputs: []
   },
+  {
+    type: "error",
+    name: "IncompatibleAccessControlsException",
+    inputs: []
+  },
   {
     type: "error",
     name: "IncompatibleIssuanceAndRedemptionVaultsException",

package/dist/esm/plugins/adapters/contracts/MidasGatewayAdapterContract.js

@@ -1,7 +1,8 @@
 import {
   decodeAbiParameters,
   decodeFunctionData,
-  isAddressEqual
+  isAddressEqual,
+  zeroAddress
 } from "viem";
 import {
   MissingSerializedParamsError
@@ -16,9 +17,9 @@ const protocolAbi = iMidasGatewayV311Abi;
 class MidasGatewayAdapterContract extends AbstractAdapterContract {
   #gateway;
   #mToken;
+  #quoteToken;
+  #phantomToken;
   #referrerId;
-  #allowedInputTokens;
-  #allowedOutputTokens;
   constructor(sdk, args) {
     super(sdk, { ...args, abi, protocolAbi });
     if (args.baseParams.serializedParams) {
@@ -28,21 +29,17 @@ class MidasGatewayAdapterContract extends AbstractAdapterContract {
           { type: "address", name: "targetContract" },
           { type: "address", name: "gateway" },
           { type: "address", name: "mToken" },
-          { type: "bytes32", name: "referrerId" },
-          { type: "address[]", name: "allowedInputTokens" },
-          { type: "address[]", name: "allowedOutputTokens" },
-          { type: "address[]", name: "allowedPhantomTokens" }
+          { type: "address", name: "quoteToken" },
+          { type: "address", name: "phantomToken" },
+          { type: "bytes32", name: "referrerId" }
         ],
         args.baseParams.serializedParams
       );
       this.#gateway = decoded[2];
       this.#mToken = decoded[3];
-      this.#referrerId = decoded[4];
-      this.#allowedInputTokens = [...decoded[5]];
-      this.#allowedOutputTokens = decoded[6].map((token, index) => ({
-        token,
-        phantomToken: decoded[7][index]
-      }));
+      this.#quoteToken = decoded[4];
+      this.#phantomToken = decoded[5];
+      this.#referrerId = decoded[6];
     }
   }
   get gateway() {
@@ -53,67 +50,72 @@ class MidasGatewayAdapterContract extends AbstractAdapterContract {
     if (!this.#mToken) throw new MissingSerializedParamsError("mToken");
     return this.#mToken;
   }
+  get quoteToken() {
+    if (!this.#quoteToken) throw new MissingSerializedParamsError("quoteToken");
+    return this.#quoteToken;
+  }
+  /**
+   * Redemption phantom token; `zeroAddress` when the gateway was deployed
+   * without delayed withdrawals
+   */
+  get phantomToken() {
+    if (!this.#phantomToken)
+      throw new MissingSerializedParamsError("phantomToken");
+    return this.#phantomToken;
+  }
   get referrerId() {
     if (this.#referrerId === void 0)
       throw new MissingSerializedParamsError("referrerId");
     return this.#referrerId;
   }
-  get allowedInputTokens() {
-    if (!this.#allowedInputTokens)
-      throw new MissingSerializedParamsError("allowedInputTokens");
-    return this.#allowedInputTokens;
-  }
-  get allowedOutputTokens() {
-    if (!this.#allowedOutputTokens)
-      throw new MissingSerializedParamsError("allowedOutputTokens");
-    return this.#allowedOutputTokens;
-  }
   stateHuman(raw) {
     return {
       ...super.stateHuman(raw),
       gateway: this.#gateway ? this.labelAddress(this.#gateway) : void 0,
       mToken: this.#mToken ? this.labelAddress(this.#mToken) : void 0,
-      referrerId: this.#referrerId,
-      allowedInputTokens: this.#allowedInputTokens?.map(
-        (t) => this.labelAddress(t)
-      ),
-      allowedOutputTokens: this.#allowedOutputTokens?.map((t) => ({
-        token: this.labelAddress(t.token),
-        phantomToken: this.labelAddress(t.phantomToken)
-      }))
+      quoteToken: this.#quoteToken ? this.labelAddress(this.#quoteToken) : void 0,
+      phantomToken: this.#phantomToken ? this.labelAddress(this.#phantomToken) : void 0,
+      referrerId: this.#referrerId
     };
   }
   /**
    * `redeemRequest` (the only request call the withdrawal compressor emits)
-   * spends the mToken and mints the phantom token of the requested
-   * `tokenOut`, which is received when the redemption is claimed. The 3-arg
-   * overload carries the intent `extraData`.
+   * spends the mToken and mints the redemption phantom token; the quote token
+   * is received when the redemption is claimed. The 2-arg overload carries
+   * the intent `extraData`.
    */
   parseDelayedWithdrawalRequest(calldata) {
     const decoded = decodeFunctionData({ abi: this.abi, data: calldata });
     if (decoded.functionName !== "redeemRequest") {
       return void 0;
     }
-    const [tokenOut, , extraData] = decoded.args;
-    const phantomToken = this.allowedOutputTokens.find(
-      (t) => isAddressEqual(t.token, tokenOut)
-    )?.phantomToken;
-    if (!phantomToken) {
+    if (isAddressEqual(this.phantomToken, zeroAddress)) {
       return void 0;
     }
-    return { phantomToken, claimToken: tokenOut, extraData };
+    const [, extraData] = decoded.args;
+    return {
+      phantomToken: this.phantomToken,
+      claimToken: this.quoteToken,
+      extraData
+    };
   }
   async applyBalanceChanges(balances, decoded) {
     switch (decoded.functionName) {
       case "depositInstantDiff": {
-        const [tokenIn, leftoverAmount] = decoded.args;
-        this.setLeftover(balances, tokenIn, leftoverAmount);
+        const [leftoverAmount] = decoded.args;
+        this.setLeftover(balances, this.quoteToken, leftoverAmount);
         break;
       }
-      // instant redemption spends the mToken down to the leftover, tokenOut
-      // arg is the received token
+      // instant redemption spends the mToken down to the leftover
       case "redeemInstantDiff": {
-        const [, leftoverAmount] = decoded.args;
+        const [leftoverAmount] = decoded.args;
+        this.setLeftover(balances, this.mToken, leftoverAmount);
+        break;
+      }
+      // delayed redemption also spends the mToken down to the leftover (the
+      // minted phantom token is accounted for elsewhere)
+      case "redeemRequestDiff": {
+        const [leftoverAmount] = decoded.args;
         this.setLeftover(balances, this.mToken, leftoverAmount);
         break;
       }

package/dist/esm/preview/prerequisites/buildCollateralPrerequisites.js

@@ -1,9 +1,15 @@
+import { isAddressEqual } from "viem";
 import {
-  AssetsMap
+  AP_WETH_TOKEN,
+  AssetsMap,
+  NATIVE_ADDRESS,
+  NO_VERSION
 } from "../../sdk/index.js";
+import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
+import { BalancePrerequisite } from "./BalancePrerequisite.js";
 import { allowanceAndBalance } from "./helpers.js";
 async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
-  const { sdk, wallet } = ctx;
+  const { sdk, wallet, value = 0n } = ctx;
   const required = new AssetsMap();
   for (const op of multicall) {
     if (op.operation !== "AddCollateral" || op.amount === 0n) {
@@ -11,12 +17,45 @@ async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
     }
     required.inc(op.token, op.amount);
   }
-  if (required.size === 0) {
+  if (required.size === 0 && value === 0n) {
     return [];
   }
-  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
   const prereqs = [];
+  if (value > 0n) {
+    prereqs.push(
+      new BalancePrerequisite({
+        token: NATIVE_ADDRESS,
+        owner: wallet,
+        required: value
+      })
+    );
+  }
+  if (required.size === 0) {
+    return prereqs;
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const weth = sdk.addressProvider.getAddress(AP_WETH_TOKEN, NO_VERSION);
   for (const [token, amount] of required.entries()) {
+    if (value > 0n && isAddressEqual(token, weth)) {
+      prereqs.push(
+        new AllowancePrerequisite({
+          token,
+          owner: wallet,
+          spender,
+          required: amount
+        })
+      );
+      if (amount > value) {
+        prereqs.push(
+          new BalancePrerequisite({
+            token,
+            owner: wallet,
+            required: amount - value
+          })
+        );
+      }
+      continue;
+    }
     prereqs.push(
       ...allowanceAndBalance({
         token,

package/dist/esm/preview/prerequisites/checkPrerequisites.js

@@ -9,7 +9,8 @@ async function checkPrerequisites(input, options) {
   const ctx = {
     sdk,
     wallet,
-    blockNumber: options?.blockNumber
+    blockNumber: options?.blockNumber,
+    value: input.value ?? 0n
   };
   const prereqs = await buildPrerequisites(tx, ctx);
   return Promise.all(prereqs.map((p) => p.verify(ctx)));