@morpho-org/bundler-sdk-viem 3.0.0-next.1 → 3.0.0-next.11

package/lib/actions.d.ts

@@ -1,14 +1,12 @@
 import { type Address } from "viem";
-import { ChainId } from "@morpho-org/blue-sdk";
 import { type MaybeDraft, type SimulationState } from "@morpho-org/simulation-sdk";
-import type { Action, ActionBundle, BundlerOperation, TransactionRequirement } from "./types/index.js";
-export declare const APPROVE_ONLY_ONCE_TOKENS: Partial<Record<ChainId, Address[]>>;
+import { ActionBundle, ActionBundleRequirements } from "./ActionBundle.js";
+import type { Action, BundlerOperation, TransactionRequirement } from "./types/index.js";
+export declare const APPROVE_ONLY_ONCE_TOKENS: Partial<Record<number, Address[]>>;
+export declare const MAX_TOKEN_APPROVALS: Partial<Record<number, Record<Address, bigint>>>;
 export declare const encodeOperation: (operation: BundlerOperation, dataBefore: MaybeDraft<SimulationState>, supportsSignature?: boolean, index?: number) => {
     dataAfter: MaybeDraft<SimulationState>;
     actions: Action[];
-    requirements: {
-        signatures: import("./types/actions.js").SignatureRequirement[];
-        txs: TransactionRequirement[];
-    };
+    requirements: ActionBundleRequirements<TransactionRequirement, import("./types/actions.js").SignatureRequirement>;
 };
-export declare function encodeBundle(operations: BundlerOperation[], startData: MaybeDraft<SimulationState>, supportsSignature?: boolean): ActionBundle;
+export declare function encodeBundle(operations: BundlerOperation[], startData: MaybeDraft<SimulationState>, supportsSignature?: boolean): ActionBundle<TransactionRequirement, import("./types/actions.js").SignatureRequirement>;

package/lib/actions.js

@@ -1,17 +1,17 @@
 import { encodeFunctionData, erc20Abi, maxUint256, verifyTypedData, zeroAddress, } from "viem";
-import { ChainId, MathLib, NATIVE_ADDRESS, convexWrapperTokens, erc20WrapperTokens, getChainAddresses, getUnwrappedToken, } from "@morpho-org/blue-sdk";
+import { ChainId, DEFAULT_SLIPPAGE_TOLERANCE, MathLib, NATIVE_ADDRESS, convexWrapperTokens, erc20WrapperTokens, getChainAddresses, getUnwrappedToken, } from "@morpho-org/blue-sdk";
 import { Time, getValue } from "@morpho-org/morpho-ts";
-import { simulateOperation, } from "@morpho-org/simulation-sdk";
+import { getCurrent, simulateOperation, } from "@morpho-org/simulation-sdk";
 import { blueAbi, getAuthorizationTypedData, getDaiPermitTypedData, getPermit2PermitTypedData, getPermitTypedData, } from "@morpho-org/blue-sdk-viem";
 import { signTypedData } from "viem/actions";
-import BundlerAction from "./BundlerAction.js";
+import { ActionBundle, ActionBundleRequirements } from "./ActionBundle.js";
 export const APPROVE_ONLY_ONCE_TOKENS = {
     [ChainId.EthMainnet]: [
         "0xdAC17F958D2ee523a2206206994597C13D831ec7", // USDT
         "0xD533a949740bb3306d119CC777fa900bA034cd52", // CRV
     ],
 };
-const MAX_TOKEN_APPROVALS = {
+export const MAX_TOKEN_APPROVALS = {
     [ChainId.EthMainnet]: {
         "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984": MathLib.maxUint(96), // UNI --> see https://github.com/Uniswap/governance/blob/eabd8c71ad01f61fb54ed6945162021ee419998e/contracts/Uni.sol#L154
     },
@@ -67,10 +67,7 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
     const deadline = Time.timestamp() + Time.s.from.h(24n);
     const { morpho, bundler3: { bundler3, generalAdapter1 }, permit2, wNative, dai, wstEth, stEth, } = getChainAddresses(chainId);
     const actions = [];
-    const requirements = {
-        signatures: [],
-        txs: [],
-    };
+    const requirements = new ActionBundleRequirements();
     let callbackBundle;
     const callback = getValue(operation.args, "callback");
     const simulatedOperation = {
@@ -79,7 +76,7 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
             ...operation.args,
             ...(callback && {
                 callback: (dataBefore) => {
-                    callbackBundle = encodeBundle(callback, dataBefore, supportsSignature);
+                    callbackBundle = encodeBundle(callback, getCurrent(dataBefore), supportsSignature);
                     return callback;
                 },
             }),
@@ -94,19 +91,19 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
     const { sender, address } = operation;
     switch (operation.type) {
         case "Blue_SetAuthorization": {
-            const { owner } = operation.args;
+            const { owner, isAuthorized, authorized } = operation.args;
             if (supportsSignature) {
                 const ownerData = dataBefore.getUser(owner);
                 const authorization = {
                     authorizer: owner,
-                    authorized: generalAdapter1,
-                    isAuthorized: true,
+                    authorized,
+                    isAuthorized,
                     deadline,
                     nonce: ownerData.morphoNonce,
                 };
                 const action = {
                     type: "morphoSetAuthorizationWithSig",
-                    args: [authorization, null],
+                    args: [authorization, null, operation.skipRevert],
                 };
                 actions.push(action);
                 requirements.signatures.push({
@@ -133,13 +130,13 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
             // Signatures are not supported, fallback to standard approval.
             requirements.txs.push({
                 type: "morphoSetAuthorization",
-                args: [generalAdapter1, true],
+                args: [authorized, isAuthorized],
                 tx: {
                     to: morpho,
                     data: encodeFunctionData({
                         abi: blueAbi,
                         functionName: "setAuthorization",
-                        args: [generalAdapter1, true],
+                        args: [authorized, isAuthorized],
                     }),
                 },
             });
@@ -165,11 +162,27 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
                 const action = address === dai
                     ? {
                         type: "permitDai",
-                        args: [sender, nonce, deadline, true, null, spender],
+                        args: [
+                            sender,
+                            nonce,
+                            deadline,
+                            true,
+                            null,
+                            spender,
+                            operation.skipRevert,
+                        ],
                     }
                     : {
                         type: "permit",
-                        args: [sender, address, amount, deadline, null, spender],
+                        args: [
+                            sender,
+                            address,
+                            amount,
+                            deadline,
+                            null,
+                            spender,
+                            operation.skipRevert,
+                        ],
                     };
                 actions.push(action);
                 const tokenData = dataBefore.getToken(address);
@@ -246,6 +259,7 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
                             sigDeadline: deadline,
                         },
                         null,
+                        operation.skipRevert,
                     ],
                 };
                 actions.push(action);
@@ -287,7 +301,7 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
             if (address === NATIVE_ADDRESS) {
                 actions.push({
                     type: "nativeTransfer",
-                    args: [from, to, amount],
+                    args: [from, to, amount, operation.skipRevert],
                 });
                 break;
             }
@@ -295,13 +309,13 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
             if (from === generalAdapter1) {
                 actions.push({
                     type: "erc20Transfer",
-                    args: [address, to, amount],
+                    args: [address, to, amount, undefined, operation.skipRevert],
                 });
                 break;
             }
             actions.push({
                 type: "erc20TransferFrom",
-                args: [address, amount, to],
+                args: [address, amount, to, operation.skipRevert],
             });
             break;
         }
@@ -310,14 +324,14 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
             if (supportsSignature) {
                 actions.push({
                     type: "transferFrom2",
-                    args: [address, from, amount, to],
+                    args: [address, from, amount, to, operation.skipRevert],
                 });
                 break;
             }
             // Signatures are not supported, fallback to standard transfer.
             actions.push({
                 type: "erc20TransferFrom",
-                args: [address, amount, to],
+                args: [address, amount, to, operation.skipRevert],
             });
             break;
         }
@@ -327,37 +341,43 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
                 case wNative: {
                     actions.push({
                         type: "wrapNative",
-                        args: [amount],
+                        args: [amount, undefined, operation.skipRevert],
                     });
                     break;
                 }
                 case wstEth: {
                     actions.push({
                         type: "wrapStEth",
-                        args: [amount],
+                        args: [amount, undefined, operation.skipRevert],
                     });
                     break;
                 }
                 case stEth: {
                     actions.push({
                         type: "stakeEth",
-                        args: [amount, MathLib.MAX_UINT_256, zeroAddress],
+                        args: [
+                            amount,
+                            MathLib.MAX_UINT_256,
+                            zeroAddress,
+                            undefined,
+                            operation.skipRevert,
+                        ],
                     });
                     break;
                 }
                 default: {
-                    if (erc20WrapperTokens[chainId].has(address)) {
+                    if (erc20WrapperTokens[chainId]?.has(address)) {
                         const underlying = getUnwrappedToken(address, chainId);
                         if (underlying == null)
                             throw Error(`unknown wrapped token: ${address}`);
                         actions.push({
                             type: "erc20WrapperDepositFor",
-                            args: [address, underlying, amount],
+                            args: [address, underlying, amount, operation.skipRevert],
                         });
                         break;
                     }
                     // Convex token wrapping is executed onchain along with supplyCollateral, via depositFor.
-                    if (!convexWrapperTokens[chainId].has(address))
+                    if (!convexWrapperTokens[chainId]?.has(address))
                         throw Error(`unexpected token wrap: ${address}`);
                 }
             }
@@ -369,82 +389,94 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
                 case wNative: {
                     actions.push({
                         type: "unwrapNative",
-                        args: [amount],
+                        args: [amount, undefined, operation.skipRevert],
                     });
                     break;
                 }
                 case wstEth: {
                     actions.push({
                         type: "unwrapStEth",
-                        args: [amount],
+                        args: [amount, undefined, operation.skipRevert],
                     });
                     break;
                 }
                 default: {
-                    if (!erc20WrapperTokens[chainId].has(address))
+                    if (!erc20WrapperTokens[chainId]?.has(address))
                         throw Error(`unexpected token unwrap: ${address}`);
                     actions.push({
                         type: "erc20WrapperWithdrawTo",
-                        args: [address, receiver, amount],
+                        args: [address, receiver, amount, operation.skipRevert],
                     });
                 }
             }
             break;
         }
         case "Blue_Supply": {
-            const { id, assets = 0n, shares = 0n, onBehalf, slippage = 0n, } = operation.args;
-            const { params, totalSupplyAssets, totalSupplyShares } = dataBefore.getMarket(id);
-            const maxSharePrice = (totalSupplyAssets * MathLib.wToRay(MathLib.WAD + slippage)) /
-                totalSupplyShares;
+            const { id, assets = 0n, shares = 0n, onBehalf, slippage = DEFAULT_SLIPPAGE_TOLERANCE, } = operation.args;
+            const market = dataBefore.getMarket(id);
+            const maxSharePrice = market.toSupplyAssets(MathLib.wToRay(MathLib.WAD + slippage));
             actions.push({
                 type: "morphoSupply",
                 args: [
-                    params,
+                    market.params,
                     assets,
                     shares,
                     maxSharePrice,
                     onBehalf,
                     callbackBundle?.actions ?? [],
+                    operation.skipRevert,
                 ],
             });
             break;
         }
         case "Blue_Withdraw": {
-            const { id, assets = 0n, shares = 0n, receiver, slippage = 0n, } = operation.args;
-            const { params, totalSupplyAssets, totalSupplyShares } = dataBefore.getMarket(id);
-            const minSharePrice = (totalSupplyAssets * MathLib.wToRay(MathLib.WAD - slippage)) /
-                totalSupplyShares;
+            const { id, assets = 0n, shares = 0n, receiver, slippage = DEFAULT_SLIPPAGE_TOLERANCE, } = operation.args;
+            const market = dataBefore.getMarket(id);
+            const minSharePrice = market.toSupplyAssets(MathLib.wToRay(MathLib.WAD - slippage));
             actions.push({
                 type: "morphoWithdraw",
-                args: [params, assets, shares, minSharePrice, receiver],
+                args: [
+                    market.params,
+                    assets,
+                    shares,
+                    minSharePrice,
+                    receiver,
+                    operation.skipRevert,
+                ],
             });
             break;
         }
         case "Blue_Borrow": {
-            const { id, assets = 0n, shares = 0n, receiver, slippage = 0n, } = operation.args;
-            const { params, totalBorrowAssets, totalBorrowShares } = dataBefore.getMarket(id);
-            const minSharePrice = (totalBorrowAssets * MathLib.wToRay(MathLib.WAD - slippage)) /
-                totalBorrowShares;
+            const { id, assets = 0n, shares = 0n, receiver, slippage = DEFAULT_SLIPPAGE_TOLERANCE, } = operation.args;
+            const market = dataBefore.getMarket(id);
+            const minSharePrice = market.toBorrowAssets(MathLib.wToRay(MathLib.WAD - slippage));
             actions.push({
                 type: "morphoBorrow",
-                args: [params, assets, shares, minSharePrice, receiver],
+                args: [
+                    market.params,
+                    assets,
+                    shares,
+                    minSharePrice,
+                    receiver,
+                    operation.skipRevert,
+                ],
             });
             break;
         }
         case "Blue_Repay": {
-            const { id, assets = 0n, shares = 0n, onBehalf, slippage = 0n, } = operation.args;
-            const { params, totalBorrowAssets, totalBorrowShares } = dataBefore.getMarket(id);
-            const maxSharePrice = (totalBorrowAssets * MathLib.wToRay(MathLib.WAD + slippage)) /
-                totalBorrowShares;
+            const { id, assets = 0n, shares = 0n, onBehalf, slippage = DEFAULT_SLIPPAGE_TOLERANCE, } = operation.args;
+            const market = dataBefore.getMarket(id);
+            const maxSharePrice = market.toBorrowAssets(MathLib.wToRay(MathLib.WAD + slippage));
             actions.push({
                 type: "morphoRepay",
                 args: [
-                    params,
+                    market.params,
                     assets,
                     shares,
                     maxSharePrice,
                     onBehalf,
                     callbackBundle?.actions ?? [],
+                    operation.skipRevert,
                 ],
             });
             break;
@@ -452,19 +484,30 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
         case "Blue_SupplyCollateral": {
             const { id, assets, onBehalf } = operation.args;
             const { params } = dataBefore.getMarket(id);
-            if (convexWrapperTokens[chainId].has(params.collateralToken)) {
+            if (convexWrapperTokens[chainId]?.has(params.collateralToken)) {
                 const underlying = getUnwrappedToken(address, chainId);
                 if (underlying == null)
                     throw Error(`unknown wrapped token: ${address}`);
                 actions.push({
                     type: "erc20WrapperDepositFor",
-                    args: [params.collateralToken, underlying, assets],
+                    args: [
+                        params.collateralToken,
+                        underlying,
+                        assets,
+                        operation.skipRevert,
+                    ],
                 });
                 break;
             }
             actions.push({
                 type: "morphoSupplyCollateral",
-                args: [params, assets, onBehalf, callbackBundle?.actions ?? []],
+                args: [
+                    params,
+                    assets,
+                    onBehalf,
+                    callbackBundle?.actions ?? [],
+                    operation.skipRevert,
+                ],
             });
             break;
         }
@@ -473,41 +516,53 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
             const { params } = dataBefore.getMarket(id);
             actions.push({
                 type: "morphoWithdrawCollateral",
-                args: [params, assets, receiver],
+                args: [params, assets, receiver, operation.skipRevert],
             });
             break;
         }
         case "MetaMorpho_Deposit": {
-            const { assets = 0n, shares = 0n, owner, slippage = 0n } = operation.args;
+            const { assets = 0n, shares = 0n, owner, slippage = DEFAULT_SLIPPAGE_TOLERANCE, } = operation.args;
             const vault = dataBefore.getVault(address);
-            const maxSharePrice = (vault.totalAssets * MathLib.wToRay(MathLib.WAD + slippage)) /
-                vault.totalSupply;
+            const maxSharePrice = vault.toAssets(MathLib.wToRay(MathLib.WAD + slippage));
             if (shares === 0n)
                 actions.push({
                     type: "erc4626Deposit",
-                    args: [address, assets, maxSharePrice, owner],
+                    args: [address, assets, maxSharePrice, owner, operation.skipRevert],
                 });
             else
                 actions.push({
                     type: "erc4626Mint",
-                    args: [address, shares, maxSharePrice, owner],
+                    args: [address, shares, maxSharePrice, owner, operation.skipRevert],
                 });
             break;
         }
         case "MetaMorpho_Withdraw": {
-            const { assets = 0n, shares = 0n, owner, receiver, slippage = 0n, } = operation.args;
+            const { assets = 0n, shares = 0n, owner, receiver, slippage = DEFAULT_SLIPPAGE_TOLERANCE, } = operation.args;
             const vault = dataBefore.getVault(address);
-            const minSharePrice = (vault.totalAssets * MathLib.wToRay(MathLib.WAD - slippage)) /
-                vault.totalSupply;
+            const minSharePrice = vault.toAssets(MathLib.wToRay(MathLib.WAD - slippage));
             if (assets > 0n)
                 actions.push({
                     type: "erc4626Withdraw",
-                    args: [address, assets, minSharePrice, receiver, owner],
+                    args: [
+                        address,
+                        assets,
+                        minSharePrice,
+                        receiver,
+                        owner,
+                        operation.skipRevert,
+                    ],
                 });
             else
                 actions.push({
                     type: "erc4626Redeem",
-                    args: [address, shares, minSharePrice, receiver, owner],
+                    args: [
+                        address,
+                        shares,
+                        minSharePrice,
+                        receiver,
+                        owner,
+                        operation.skipRevert,
+                    ],
                 });
             break;
         }
@@ -525,6 +580,7 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
                         amount: assets,
                     })),
                     dataBefore.getMarket(supplyMarketId).params,
+                    operation.skipRevert,
                 ],
             });
             break;
@@ -537,24 +593,13 @@ export const encodeOperation = (operation, dataBefore, supportsSignature = true,
     };
 };
 export function encodeBundle(operations, startData, supportsSignature = true) {
-    const { chainId } = startData;
-    const actions = [];
-    const requirements = {
-        signatures: [],
-        txs: [],
-    };
-    const steps = [startData];
+    const bundle = new ActionBundle([startData]);
     for (let index = 0; index < operations.length; ++index) {
-        const bundle = encodeOperation(operations[index], steps[index], supportsSignature, index);
-        steps.push(bundle.dataAfter);
-        actions.push(...bundle.actions);
-        requirements.signatures.push(...bundle.requirements.signatures);
-        requirements.txs.push(...bundle.requirements.txs);
+        const { dataAfter, actions, requirements } = encodeOperation(operations[index], bundle.steps[index], supportsSignature, index);
+        bundle.steps.push(dataAfter);
+        bundle.actions.push(...actions);
+        bundle.requirements.signatures.push(...requirements.signatures);
+        bundle.requirements.txs.push(...requirements.txs);
     }
-    return {
-        steps,
-        actions,
-        requirements,
-        tx: () => BundlerAction.encodeBundle(chainId, actions),
-    };
+    return bundle;
 }

package/lib/bundle.d.ts

@@ -0,0 +1,12 @@
+import type { SimulationState } from "@morpho-org/simulation-sdk";
+import type { Address } from "viem";
+import { type BundlingOptions } from "./operations.js";
+import type { InputBundlerOperation } from "./types/index.js";
+export declare const setupBundle: (inputOperations: InputBundlerOperation[], startData: SimulationState, receiver: Address, { supportsSignature, unwrapTokens, unwrapSlippage, ...options }?: BundlingOptions & {
+    supportsSignature?: boolean;
+    unwrapTokens?: Set<Address>;
+    unwrapSlippage?: bigint;
+}) => {
+    operations: import("./types/operations.js").BundlerOperation[];
+    bundle: import("./ActionBundle.js").ActionBundle<import("./types/actions.js").TransactionRequirement, import("./types/actions.js").SignatureRequirement>;
+};

package/lib/bundle.js

@@ -0,0 +1,11 @@
+import { encodeBundle } from "./actions.js";
+import { finalizeBundle, populateBundle, } from "./operations.js";
+export const setupBundle = (inputOperations, startData, receiver, { supportsSignature, unwrapTokens, unwrapSlippage, ...options } = {}) => {
+    let { operations } = populateBundle(inputOperations, startData, options);
+    operations = finalizeBundle(operations, startData, receiver, unwrapTokens, unwrapSlippage);
+    const bundle = encodeBundle(operations, startData, supportsSignature);
+    return {
+        operations,
+        bundle,
+    };
+};

package/lib/index.d.ts

@@ -2,3 +2,7 @@ export * from "./actions.js";
 export * from "./operations.js";
 export * from "./errors.js";
 export * from "./types/index.js";
+export * from "./BundlerAction.js";
+export * from "./bundle.js";
+export * from "./ActionBundle.js";
+export * from "./abis.js";

package/lib/index.js

@@ -2,3 +2,7 @@ export * from "./actions.js";
 export * from "./operations.js";
 export * from "./errors.js";
 export * from "./types/index.js";
+export * from "./BundlerAction.js";
+export * from "./bundle.js";
+export * from "./ActionBundle.js";
+export * from "./abis.js";

package/lib/operations.js

@@ -45,8 +45,8 @@ export const populateInputTransfer = ({ address, args: { amount, from } }, data,
             hasSimplePermit);
     const useSimpleTransfer = permit2 == null ||
         // Token is permissioned and Permit2 may not be authorized so Permit2 cannot be used.
-        permissionedWrapperTokens[data.chainId].has(address) ||
-        permissionedBackedTokens[data.chainId].has(address);
+        !!permissionedWrapperTokens[data.chainId]?.has(address) ||
+        !!permissionedBackedTokens[data.chainId]?.has(address);
     if (useSimplePermit)
         operations.push({
             type: "Erc20_Permit",
@@ -138,7 +138,7 @@ export const populateSubBundle = (inputOperation, data, options = {}) => {
         ? data.getWrappedToken(inputOperation.address)
         : undefined;
     const isErc20Wrapper = !!wrappedToken &&
-        erc20WrapperTokens[data.chainId].has(wrappedToken.address);
+        !!erc20WrapperTokens[data.chainId]?.has(wrappedToken.address);
     // Transform input operation to act on behalf of the sender, via the bundler.
     const mainOperation = produceImmutable(inputOperation, (draft) => {
         draft.sender = generalAdapter1;
@@ -179,7 +179,8 @@ export const populateSubBundle = (inputOperation, data, options = {}) => {
             address: morpho,
             args: {
                 owner: sender,
-                isBundlerAuthorized: true,
+                isAuthorized: true,
+                authorized: generalAdapter1,
             },
         });
     // Reallocate liquidity if necessary.
@@ -394,7 +395,7 @@ export const finalizeBundle = (operations, startData, receiver, unwrapTokens = n
                 const { address, sender, args: { amount, from, to }, } = operation;
                 if (from !== generalAdapter1 &&
                     to === generalAdapter1 &&
-                    !erc20WrapperTokens[startData.chainId].has(address)) {
+                    !erc20WrapperTokens[startData.chainId]?.has(address)) {
                     const duplicateTransfer = inputTransfers.find((transfer) => transfer.address === address &&
                         transfer.sender === sender &&
                         transfer.args.from === from);