@morpho-org/bundler-sdk-viem 3.2.7 → 3.3.0

package/lib/errors.d.ts

@@ -1,4 +1,4 @@
-import type { SimulationResult } from "@morpho-org/simulation-sdk";
+import type { OperationType, SimulationResult } from "@morpho-org/simulation-sdk";
 import type { Address } from "viem";
 import type { ActionType, InputBundlerOperation } from "./types/index.js";
 export declare namespace BundlerErrors {
@@ -21,4 +21,10 @@ export declare namespace BundlerErrors {
     class UnexpectedSignature extends Error {
         constructor(spender: Address);
     }
+    class MissingSkimHandler extends Error {
+        constructor(type: OperationType);
+    }
+    class UnskimedToken extends Error {
+        constructor(token: Address);
+    }
 }

package/lib/errors.js

@@ -42,4 +42,16 @@ var BundlerErrors;
         }
     }
     BundlerErrors.UnexpectedSignature = UnexpectedSignature;
+    class MissingSkimHandler extends Error {
+        constructor(type) {
+            super(`missing skim handler for operation "${type}"`);
+        }
+    }
+    BundlerErrors.MissingSkimHandler = MissingSkimHandler;
+    class UnskimedToken extends Error {
+        constructor(token) {
+            super(`missing final skim for token "${token}"`);
+        }
+    }
+    BundlerErrors.UnskimedToken = UnskimedToken;
 })(BundlerErrors || (exports.BundlerErrors = BundlerErrors = {}));

package/lib/operations.js

@@ -614,29 +614,57 @@ const finalizeBundle = (operations, startData, receiver, unwrapTokens = new Set(
     }
     // Skim any token expected to be left on the bundler.
     const skims = [];
-    const startBundlerTokenData = steps[0].holdings[generalAdapter1] ?? {};
-    const uniqueSkimTokens = new Set((0, morpho_ts_1.entries)(endBundlerTokenData)
-        .filter(([token, holding]) => holding != null &&
-        holding.balance - (startBundlerTokenData[token]?.balance ?? 0n) > 5n)
-        .map(([address]) => address));
-    const pushCustomSkim = (operation) => {
+    const uniqueSkimTokens = new Set();
+    const pushSkim = (operation) => {
         // Paraswap does not guarantee that the amount effectively bought (resp. sold) corresponds to
         // the requested amount to buy (resp. sell), so we force skim the possible surplus of bought (resp. sold) token.
         switch (operation.type) {
+            case "Blue_Borrow":
+            case "Blue_Repay":
+            case "Blue_Supply":
+            case "Blue_Withdraw":
+            case "Blue_Paraswap_BuyDebt":
+                uniqueSkimTokens.add(startData.getMarket(operation.args.id).params.loanToken);
+                break;
+            case "Blue_WithdrawCollateral":
+            case "Blue_SupplyCollateral":
+                uniqueSkimTokens.add(startData.getMarket(operation.args.id).params.collateralToken);
+                break;
+            case "Blue_FlashLoan":
+                uniqueSkimTokens.add(operation.args.token);
+                break;
             case "Paraswap_Buy":
             case "Paraswap_Sell":
+            case "Erc20_Transfer":
+            case "Erc20_Transfer2":
                 uniqueSkimTokens.add(operation.address);
                 break;
-            case "Blue_Paraswap_BuyDebt":
-                uniqueSkimTokens.add(startData.getMarket(operation.args.id).params.loanToken);
+            case "Blue_SetAuthorization":
+            case "Erc20_Approve":
+            case "Erc20_Permit":
+            case "Erc20_Permit2":
                 break;
-            default:
+            case "Erc20_Wrap":
+            case "Erc20_Unwrap":
+                uniqueSkimTokens.add(operation.address);
+                uniqueSkimTokens.add(startData.getWrappedToken(operation.address).underlying);
                 break;
+            case "MetaMorpho_Deposit":
+            case "MetaMorpho_Withdraw":
+                uniqueSkimTokens.add(operation.address);
+                uniqueSkimTokens.add(startData.getVault(operation.address).asset);
+                break;
+            case "MetaMorpho_PublicReallocate":
+                uniqueSkimTokens.add(blue_sdk_1.NATIVE_ADDRESS);
+                break;
+            default:
+                //@ts-ignore This is dead code but acts as a guard in case a new operation is added
+                throw new errors_js_1.BundlerErrors.MissingSkimHandler(operation.type);
         }
         if ("callback" in operation.args)
-            operation.args.callback?.forEach(pushCustomSkim);
+            operation.args.callback?.forEach(pushSkim);
     };
-    operations.forEach(pushCustomSkim);
+    operations.concat(unwraps).forEach(pushSkim);
     skims.push(...Array.from(uniqueSkimTokens, (address) => ({
         type: "Erc20_Transfer",
         address,
@@ -647,7 +675,15 @@ const finalizeBundle = (operations, startData, receiver, unwrapTokens = new Set(
             to: receiver,
         },
     })));
-    return operations.concat(unwraps, skims);
+    const finalizedOperations = operations.concat(unwraps, skims);
+    const finalizedSteps = (0, exports.simulateBundlerOperations)(finalizedOperations, startData);
+    for (const holding of (0, morpho_ts_1.values)((0, morpho_ts_1.getLast)(finalizedSteps).holdings[generalAdapter1])) {
+        if (!holding)
+            continue;
+        if (holding.balance > 0n)
+            throw new errors_js_1.BundlerErrors.UnskimedToken(holding.token);
+    }
+    return finalizedOperations;
 };
 exports.finalizeBundle = finalizeBundle;
 const populateBundle = (inputOperations, data, options) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/bundler-sdk-viem",
   "description": "Viem-based extension of `@morpho-org/simulation-sdk` that exports utilities to transform simple interactions on Morpho (such as `Blue_Borrow`) and Morpho Vaults (such as `MetaMorpho_Deposit`) into the required bundles (with ERC20 approvals, transfers, etc) to submit to the bundler onchain.",
-  "version": "3.2.7",
+  "version": "3.3.0",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Rubilmax <rmilon@gmail.com>"
@@ -19,10 +19,10 @@
   ],
   "peerDependencies": {
     "viem": "^2.0.0",
-    "@morpho-org/blue-sdk": "^4.9.0",
-    "@morpho-org/blue-sdk-viem": "^3.1.1",
+    "@morpho-org/blue-sdk-viem": "^3.1.2",
     "@morpho-org/morpho-ts": "^2.4.1",
-    "@morpho-org/simulation-sdk": "^3.1.3"
+    "@morpho-org/simulation-sdk": "^3.1.3",
+    "@morpho-org/blue-sdk": "^4.9.1"
   },
   "devDependencies": {
     "@tanstack/query-core": "^5.62.16",
@@ -34,14 +34,14 @@
     "typescript": "^5.7.2",
     "viem": "^2.23.0",
     "vitest": "^3.0.5",
-    "@morpho-org/blue-sdk-viem": "^3.1.1",
-    "@morpho-org/blue-sdk": "^4.9.0",
+    "@morpho-org/blue-sdk": "^4.9.1",
     "@morpho-org/morpho-ts": "^2.4.1",
-    "@morpho-org/morpho-test": "^2.4.0",
+    "@morpho-org/blue-sdk-viem": "^3.1.2",
     "@morpho-org/simulation-sdk": "^3.1.3",
+    "@morpho-org/morpho-test": "^2.4.0",
     "@morpho-org/simulation-sdk-wagmi": "^3.0.3",
-    "@morpho-org/test": "^2.1.5",
-    "@morpho-org/test-wagmi": "^2.0.4"
+    "@morpho-org/test-wagmi": "^2.0.4",
+    "@morpho-org/test": "^2.1.5"
   },
   "scripts": {
     "prepublish": "$npm_execpath build",