@gearbox-protocol/sdk 14.12.0-next.4 → 14.12.0-next.5

package/dist/cjs/preview/simulate/simulatePoolOperation.js

@@ -18,16 +18,12 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var simulatePoolOperation_exports = {};
 __export(simulatePoolOperation_exports, {
-  computePoolOpBalanceChanges: () => computePoolOpBalanceChanges,
   simulatePoolOperation: () => simulatePoolOperation
 });
 module.exports = __toCommonJS(simulatePoolOperation_exports);
 var import_generated = require("../../abi/310/generated.js");
-var import_iERC20 = require("../../abi/iERC20.js");
 var import_iZapper = require("../../abi/iZapper.js");
-var import_sdk = require("../../sdk/index.js");
 var import_errors = require("./errors.js");
-var import_holders = require("./holders.js");
 function previewRead(operation) {
   switch (operation.operation) {
     case "Deposit":
@@ -40,16 +36,6 @@ function previewRead(operation) {
       return { functionName: "previewRedeem", amount: operation.shares };
   }
 }
-function outsideToken(operation) {
-  switch (operation.operation) {
-    case "Deposit":
-    case "Mint":
-      return operation.tokenIn;
-    case "Withdraw":
-    case "Redeem":
-      return operation.tokenOut;
-  }
-}
 function previewContract(operation) {
   const { functionName, amount } = previewRead(operation);
   if (operation.zapper) {
@@ -67,60 +53,31 @@ function previewContract(operation) {
     args: [amount]
   };
 }
+function amountsInOut(operation, previewAmount) {
+  switch (operation.operation) {
+    case "Deposit":
+      return { amountIn: operation.assets, amountOut: previewAmount };
+    case "Mint":
+      return { amountIn: previewAmount, amountOut: operation.shares };
+    case "Withdraw":
+      return { amountIn: previewAmount, amountOut: operation.assets };
+    case "Redeem":
+      return { amountIn: operation.shares, amountOut: previewAmount };
+  }
+}
 async function simulatePoolOperation(input, options = {}) {
-  const { sdk, operation, wallet } = input;
+  const { sdk, operation } = input;
   const { blockNumber, logger } = options;
-  const { pool } = operation;
   try {
-    const holders = (0, import_holders.watchedHolders)(operation, wallet);
-    const tokens = [outsideToken(operation), pool];
-    const balanceCalls = holders.flatMap(
-      (holder) => tokens.map((token) => ({ holder, token }))
-    );
-    const balanceContracts = balanceCalls.map(
-      ({ holder, token }) => ({
-        address: token,
-        abi: import_iERC20.ierc20Abi,
-        functionName: "balanceOf",
-        args: [holder]
-      })
-    );
-    const preview = previewContract(operation);
-    let results;
-    try {
-      results = await sdk.client.multicall({
-        allowFailure: false,
-        // `undefined` lets viem read at `latest`; `blockNumber` is only set for
-        // testnet forks pinned to a specific block.
-        blockNumber,
-        contracts: [...balanceContracts, preview]
-      });
-    } catch (cause) {
-      throw new import_errors.PreviewSimulationError([
-        {
-          source: "multicall",
-          detail: (0, import_errors.decodeSimulationError)({
-            error: cause instanceof Error ? cause : new Error(String(cause))
-          })
-        }
-      ]);
-    }
-    const previewAmount = results[balanceContracts.length];
-    const balances = new import_sdk.AddressMap();
-    for (const [i, { holder, token }] of balanceCalls.entries()) {
-      const tokenBalances = balances.get(holder) ?? new import_sdk.AddressMap();
-      tokenBalances.upsert(token, results[i]);
-      balances.upsert(holder, tokenBalances);
-    }
-    const before = (token, holder) => balances.get(holder)?.get(token) ?? 0n;
+    const previewAmount = await sdk.client.readContract({
+      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
+      // testnet forks pinned to a specific block.
+      blockNumber,
+      ...previewContract(operation)
+    });
     return {
       status: "success",
-      balanceChanges: computePoolOpBalanceChanges(
-        operation,
-        wallet,
-        previewAmount,
-        before
-      )
+      ...amountsInOut(operation, previewAmount)
     };
   } catch (cause) {
     const error = (0, import_errors.asPreviewSimulationError)(cause, "multicall");
@@ -128,60 +85,7 @@ async function simulatePoolOperation(input, options = {}) {
     return { status: "failure", error };
   }
 }
-function balanceLegs(operation, wallet, previewAmount) {
-  const { pool, receiver } = operation;
-  switch (operation.operation) {
-    case "Deposit":
-      return [
-        { address: wallet, token: operation.tokenIn, delta: -operation.assets },
-        { address: receiver, token: pool, delta: previewAmount }
-      ];
-    case "Mint":
-      return [
-        { address: wallet, token: operation.tokenIn, delta: -previewAmount },
-        { address: receiver, token: pool, delta: operation.shares }
-      ];
-    case "Withdraw":
-      return [
-        { address: operation.owner, token: pool, delta: -previewAmount },
-        {
-          address: receiver,
-          token: operation.tokenOut,
-          delta: operation.assets
-        }
-      ];
-    case "Redeem":
-      return [
-        { address: operation.owner, token: pool, delta: -operation.shares },
-        { address: receiver, token: operation.tokenOut, delta: previewAmount }
-      ];
-  }
-}
-function computePoolOpBalanceChanges(operation, wallet, previewAmount, before) {
-  const byAddress = new import_sdk.AddressMap();
-  for (const { address, token, delta } of balanceLegs(
-    operation,
-    wallet,
-    previewAmount
-  )) {
-    const beforeBalance = before(token, address);
-    const change = {
-      token,
-      before: beforeBalance,
-      after: beforeBalance + delta,
-      delta
-    };
-    const existing = byAddress.get(address);
-    if (existing) {
-      existing.changes.push(change);
-    } else {
-      byAddress.upsert(address, { address, changes: [change] });
-    }
-  }
-  return byAddress.values();
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  computePoolOpBalanceChanges,
   simulatePoolOperation
 });

package/dist/cjs/sdk/market/zapper/ZapperContract.js

@@ -55,7 +55,6 @@ class ZapperContract extends import_base.BaseContract {
     const { rawArgs } = parsed;
     const pool = this.pool;
     const zapper = this.address;
-    const token = this.tokenIn.addr;
     const underlying = this.sdk.marketRegister.findByPool(pool).underlying;
     const receiver = rawArgs.receiver;
     if (parsed.functionName.startsWith("deposit")) {
@@ -65,7 +64,6 @@ class ZapperContract extends import_base.BaseContract {
         zapper,
         receiver,
         assets: rawArgs.tokenInAmount ?? value ?? 0n,
-        token,
         underlying,
         referralCode: rawArgs.referralCode
       };
@@ -77,7 +75,6 @@ class ZapperContract extends import_base.BaseContract {
         zapper,
         receiver,
         shares: rawArgs.tokenOutAmount,
-        token,
         underlying
       };
     }

package/dist/esm/preview/index.js

@@ -1,4 +1,3 @@
-export * from "./parse/index.js";
 export * from "./prerequisites/index.js";
-export * from "./simulate/index.js";
+export * from "./preview/index.js";
 export * from "./trace/index.js";

package/dist/esm/preview/parse/index.js

@@ -1,6 +1,5 @@
 export * from "./classifyInnerOperations.js";
 export * from "./errors.js";
-export * from "./extractExpectedBalanceChanges.js";
 export * from "./parseFacadeOperationCalldata.js";
 export * from "./parseOperationCalldata.js";
 export * from "./parsePoolOperationCalldata.js";

package/dist/esm/preview/parse/parseFacadeOperationCalldata.js

@@ -1,6 +1,5 @@
 import { isAddressEqual, zeroAddress } from "viem";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
 function parseFacadeOperationCalldata(props) {
   const { sdk, facade, calldata } = props;
   const parsed = sdk.parseFunctionDataV2(facade.address, calldata);
@@ -21,23 +20,20 @@ function parseFacadeOperationCalldata(props) {
     sdk,
     underlying: suite.underlying
   });
-  const expectedBalanceChanges = extractExpectedBalanceChanges(innerCalls);
   switch (functionName) {
     case "multicall":
       return {
         ...metadata,
         operation: "MultiCall",
         creditAccount: rawArgs.creditAccount,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "botMulticall":
       return {
         ...metadata,
         operation: "BotMulticall",
         creditAccount: rawArgs.creditAccount,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "openCreditAccount":
       return {
@@ -46,16 +42,14 @@ function parseFacadeOperationCalldata(props) {
         creditAccount: zeroAddress,
         onBehalfOf: rawArgs.onBehalfOf,
         referralCode: rawArgs.referralCode,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "closeCreditAccount":
       return {
         ...metadata,
         operation: "CloseCreditAccount",
         creditAccount: rawArgs.creditAccount,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "liquidateCreditAccount":
       return {
@@ -67,8 +61,7 @@ function parseFacadeOperationCalldata(props) {
         // liquidation, so they are not recoverable from raw calldata.
         token: zeroAddress,
         remainingFunds: 0n,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "partiallyLiquidateCreditAccount":
       return {

package/dist/esm/preview/parse/parseOperationCalldata.js

@@ -23,7 +23,8 @@ function parseOperationCalldata(input) {
         receiver: parsed.receiver,
         assets: parsed.assets,
         underlying: parsed.underlying,
-        tokenIn: parsed.token,
+        tokenIn: contract.tokenIn.addr,
+        tokenOut: contract.tokenOut.addr,
         zapper: parsed.zapper,
         referralCode: parsed.referralCode
       };
@@ -33,12 +34,13 @@ function parseOperationCalldata(input) {
       operation: "Redeem",
       pool: parsed.pool,
       receiver: parsed.receiver,
-      // The zapper burns the caller's pool shares, so the share owner is the
+      // The zapper burns the caller's share tokens, so the share owner is the
       // transaction sender.
       owner: sender,
       shares: parsed.shares,
       underlying: parsed.underlying,
-      tokenOut: parsed.token,
+      tokenIn: contract.tokenOut.addr,
+      tokenOut: contract.tokenIn.addr,
       zapper: parsed.zapper
     };
     return op;

package/dist/esm/preview/parse/parsePoolOperationCalldata.js

@@ -15,6 +15,7 @@ function parsePoolOperationCalldata(props) {
         assets: rawArgs.assets,
         underlying,
         tokenIn: underlying,
+        tokenOut: pool.address,
         zapper: void 0,
         referralCode: functionName === "depositWithReferral" ? rawArgs.referralCode : void 0
       };
@@ -27,6 +28,7 @@ function parsePoolOperationCalldata(props) {
         shares: rawArgs.shares,
         underlying,
         tokenIn: underlying,
+        tokenOut: pool.address,
         zapper: void 0,
         referralCode: functionName === "mintWithReferral" ? rawArgs.referralCode : void 0
       };
@@ -38,6 +40,7 @@ function parsePoolOperationCalldata(props) {
         owner: rawArgs.owner,
         assets: rawArgs.assets,
         underlying,
+        tokenIn: pool.address,
         tokenOut: underlying,
         zapper: void 0
       };
@@ -49,6 +52,7 @@ function parsePoolOperationCalldata(props) {
         owner: rawArgs.owner,
         shares: rawArgs.shares,
         underlying,
+        tokenIn: pool.address,
         tokenOut: underlying,
         zapper: void 0
       };

package/dist/esm/preview/parse/parseRWAFactoryOperationCalldata.js

@@ -6,7 +6,6 @@ import {
   RWA_FACTORY_SECURITIZE
 } from "../../sdk/index.js";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
 function parseRWAFactoryOperationCalldata(props) {
   const { contractType, address } = props.factory;
   if (isRWAFactory(props.factory, RWA_FACTORY_SECURITIZE)) {
@@ -38,14 +37,12 @@ function parseSecuritizeOperationCalldata(props) {
     sdk,
     underlying: suite.underlying
   });
-  const expectedBalanceChanges = extractExpectedBalanceChanges(innerCalls);
   switch (functionName) {
     case "openCreditAccount":
       return {
         ...metadata,
         operation: "SecuritizeOpenCreditAccount",
         multicall,
-        expectedBalanceChanges,
         tokensToRegister,
         signaturesToCache
       };
@@ -55,7 +52,6 @@ function parseSecuritizeOperationCalldata(props) {
         operation: "SecuritizeMulticall",
         creditAccount: rawArgs.creditAccount,
         multicall,
-        expectedBalanceChanges,
         tokensToRegister,
         signaturesToCache
       };

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

@@ -1,4 +1,6 @@
 import { erc20Abi } from "viem";
+import { iMulticall3Abi } from "../../abi/iMulticall3.js";
+import { hexEq, NATIVE_ADDRESS } from "../../sdk/index.js";
 import {
   Prerequisite,
   toPrerequisiteError
@@ -29,7 +31,23 @@ class BalancePrerequisite extends Prerequisite {
   get detail() {
     return this.#detail;
   }
-  calls() {
+  calls(ctx) {
+    if (hexEq(this.#detail.token, NATIVE_ADDRESS)) {
+      const multicall3 = ctx.sdk.client.chain.contracts?.multicall3?.address;
+      if (!multicall3) {
+        throw new Error(
+          "multicall3 is not configured for this chain, cannot read native balance"
+        );
+      }
+      return [
+        {
+          address: multicall3,
+          abi: iMulticall3Abi,
+          functionName: "getEthBalance",
+          args: [this.#detail.owner]
+        }
+      ];
+    }
     return [
       {
         address: this.#detail.token,

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

@@ -1,12 +1,18 @@
 import { isAddressEqual } from "viem";
 import {
-  AddressSet
+  AddressSet,
+  NATIVE_ADDRESS
 } from "../../sdk/index.js";
+import {
+  parseOperationCalldata
+} from "../parse/parseOperationCalldata.js";
 import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
 import { BalancePrerequisite } from "./BalancePrerequisite.js";
 import { RWAOpenRequirementsPrerequisite } from "./RWAOpenRequirementsPrerequisite.js";
-async function buildPrerequisites(tx, ctx) {
-  const { wallet } = ctx;
+async function buildPrerequisites(input) {
+  const { sdk, sender: wallet, blockNumber } = input;
+  const tx = parseOperationCalldata(input);
+  const ctx = { sdk, wallet, blockNumber };
   switch (tx.operation) {
     // Deposit and Mint both pull the underlying from the caller into the pool;
     // they only differ in which side (assets vs shares) the caller specifies.
@@ -16,21 +22,27 @@ async function buildPrerequisites(tx, ctx) {
     // not knowable from calldata alone).
     case "Deposit":
       if (tx.zapper) {
-        return [
-          new AllowancePrerequisite({
-            token: tx.tokenIn,
-            owner: wallet,
-            spender: tx.zapper,
-            required: tx.assets,
-            title: "Token approved to zapper"
-          }),
+        const prereqs = [];
+        if (!isAddressEqual(tx.tokenIn, NATIVE_ADDRESS)) {
+          prereqs.push(
+            new AllowancePrerequisite({
+              token: tx.tokenIn,
+              owner: wallet,
+              spender: tx.zapper,
+              required: tx.assets,
+              title: "Token approved to zapper"
+            })
+          );
+        }
+        prereqs.push(
           new BalancePrerequisite({
             token: tx.tokenIn,
             owner: wallet,
             required: tx.assets,
             title: "Sufficient token balance"
           })
-        ];
+        );
+        return prereqs;
       }
       return [
         new AllowancePrerequisite({
@@ -69,17 +81,17 @@ async function buildPrerequisites(tx, ctx) {
       if (tx.zapper) {
         return [
           new BalancePrerequisite({
-            token: tx.pool,
+            token: tx.tokenIn,
             owner: wallet,
             required: tx.shares,
-            title: "Sufficient LP token balance"
+            title: "Sufficient share token balance"
           }),
           new AllowancePrerequisite({
-            token: tx.pool,
+            token: tx.tokenIn,
             owner: wallet,
             spender: tx.zapper,
             required: tx.shares,
-            title: "LP token approved to zapper"
+            title: "Share token approved to zapper"
           })
         ];
       }

package/dist/esm/preview/preview/errors.js

@@ -0,0 +1,12 @@
+class UnsupportedOperationError extends Error {
+  /** The parsed operation kind (the `operation` discriminant). */
+  operation;
+  constructor(operation) {
+    super(`operation "${operation}" is not supported by previewOperation`);
+    this.name = "UnsupportedOperationError";
+    this.operation = operation;
+  }
+}
+export {
+  UnsupportedOperationError
+};

package/dist/esm/preview/{parse → preview}/extractExpectedBalanceChanges.js

@@ -14,7 +14,7 @@ function extractExpectedBalanceChanges(innerCalls) {
   if (!balanceDeltas) {
     return void 0;
   }
-  return balanceDeltas.map(({ token, amount }) => ({ token, delta: amount }));
+  return balanceDeltas.map(({ token, amount }) => ({ token, balance: amount }));
 }
 function functionName(call) {
   return call.functionName.split("(")[0];

package/dist/esm/preview/preview/index.js

@@ -0,0 +1,3 @@
+export * from "./errors.js";
+export * from "./previewOperation.js";
+export * from "./types.js";

package/dist/esm/preview/preview/previewOpenCreditAccount.js

@@ -0,0 +1,77 @@
+import {
+  AddressMap
+} from "../../sdk/index.js";
+import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
+function previewOpenCreditAccount(input, operation) {
+  const { sdk, to, calldata } = input;
+  const market = sdk.marketRegister.findByCreditManager(
+    operation.creditManager
+  );
+  const collateralByToken = new AddressMap();
+  const balances = new AddressMap();
+  const addBalance = (token, amount) => {
+    balances.upsert(token, (balances.get(token) ?? 0n) + amount);
+  };
+  let debt = 0n;
+  const quotas = [];
+  for (const op of operation.multicall) {
+    switch (op.operation) {
+      case "AddCollateral": {
+        const balance = collateralByToken.get(op.token)?.balance ?? 0n;
+        collateralByToken.upsert(op.token, {
+          token: op.token,
+          balance: balance + op.amount
+        });
+        addBalance(op.token, op.amount);
+        break;
+      }
+      case "WithdrawCollateral":
+        addBalance(op.token, -op.amount);
+        break;
+      case "IncreaseBorrowedAmount":
+        debt += op.amount;
+        addBalance(op.token, op.amount);
+        break;
+      case "DecreaseBorrowedAmount":
+        debt -= op.amount;
+        addBalance(op.token, -op.amount);
+        break;
+      case "UpdateQuota":
+        quotas.push({ token: op.token, balance: op.change });
+        break;
+    }
+  }
+  const collateral = collateralByToken.values();
+  const collateralValue = collateral.reduce(
+    (acc, { token, balance }) => acc + market.priceOracle.convert(token, market.underlying, balance),
+    0n
+  );
+  const parsed = sdk.parseFunctionDataV2(to, calldata);
+  const innerCalls = parsed.rawArgs.calls ?? [];
+  const deltas = extractExpectedBalanceChanges(innerCalls) ?? [];
+  for (const { token, balance } of deltas) {
+    addBalance(token, balance);
+  }
+  const assets = balances.entries().filter(([, balance]) => balance > 1n).map(([token, balance]) => ({ token, balance }));
+  return {
+    operation: operation.operation,
+    target: inferTargetAsset(operation.multicall, balances),
+    collateral,
+    collateralValue,
+    debt,
+    quotas,
+    assets
+  };
+}
+function inferTargetAsset(multicall, balances) {
+  for (const op of multicall) {
+    if (op.operation === "UpdateQuota" && op.change > 0n) {
+      const balance = balances.get(op.token);
+      return balance ? { token: op.token, balance } : void 0;
+    }
+  }
+  return void 0;
+}
+export {
+  previewOpenCreditAccount
+};

package/dist/esm/preview/preview/previewOperation.js

@@ -0,0 +1,17 @@
+import { isPoolOperation, parseOperationCalldata } from "../parse/index.js";
+import { UnsupportedOperationError } from "./errors.js";
+import { previewOpenCreditAccount } from "./previewOpenCreditAccount.js";
+import { previewPoolOperation } from "./previewPoolOperation.js";
+async function previewOperation(input, options) {
+  const operation = parseOperationCalldata(input);
+  if (isPoolOperation(operation)) {
+    return previewPoolOperation(input, operation, options);
+  }
+  if (operation.operation === "OpenCreditAccount" || operation.operation === "SecuritizeOpenCreditAccount") {
+    return previewOpenCreditAccount(input, operation);
+  }
+  throw new UnsupportedOperationError(operation.operation);
+}
+export {
+  previewOperation
+};

package/dist/esm/preview/preview/previewPoolOperation.js

@@ -0,0 +1,53 @@
+import {
+  simulatePoolOperation
+} from "../simulate/index.js";
+async function previewPoolOperation(input, operation, options) {
+  const { sdk, to, calldata } = input;
+  const { tokenIn, tokenOut } = operation;
+  const sim = await simulatePoolOperation(
+    { sdk, operation, to, calldata },
+    options
+  );
+  if (sim.status === "success") {
+    return {
+      operation: operation.operation,
+      pool: operation.pool,
+      tokenIn: { token: tokenIn, balance: sim.amountIn },
+      tokenOut: { token: tokenOut, balance: sim.amountOut }
+    };
+  }
+  const { error } = sim;
+  switch (operation.operation) {
+    case "Deposit":
+      return {
+        operation: "Deposit",
+        pool: operation.pool,
+        tokenIn: { token: tokenIn, balance: operation.assets },
+        tokenOut: { token: tokenOut, error }
+      };
+    case "Mint":
+      return {
+        operation: "Mint",
+        pool: operation.pool,
+        tokenIn: { token: tokenIn, error },
+        tokenOut: { token: tokenOut, balance: operation.shares }
+      };
+    case "Withdraw":
+      return {
+        operation: "Withdraw",
+        pool: operation.pool,
+        tokenIn: { token: tokenIn, error },
+        tokenOut: { token: tokenOut, balance: operation.assets }
+      };
+    case "Redeem":
+      return {
+        operation: "Redeem",
+        pool: operation.pool,
+        tokenIn: { token: tokenIn, balance: operation.shares },
+        tokenOut: { token: tokenOut, error }
+      };
+  }
+}
+export {
+  previewPoolOperation
+};