@gearbox-protocol/sdk 14.12.0-next.7 → 14.12.0-next.9

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

@@ -1,3 +1,17 @@
+class InvalidTransactionValueError extends Error {
+  /** Transaction `msg.value`. */
+  value;
+  /** Amount of wrapped native token added as collateral. */
+  wethCollateral;
+  constructor(value, wethCollateral) {
+    super(
+      `transaction value ${value} exceeds WETH collateral ${wethCollateral}`
+    );
+    this.name = "InvalidTransactionValueError";
+    this.value = value;
+    this.wethCollateral = wethCollateral;
+  }
+}
 class UnsupportedOperationError extends Error {
   /** The parsed operation kind (the `operation` discriminant). */
   operation;
@@ -8,5 +22,6 @@ class UnsupportedOperationError extends Error {
   }
 }
 export {
+  InvalidTransactionValueError,
   UnsupportedOperationError
 };

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

@@ -1,60 +1,93 @@
+import { AbstractAdapterContract } from "../../plugins/adapters/index.js";
 import {
-  AddressMap
+  AP_WETH_TOKEN,
+  AssetsMap,
+  NO_VERSION
 } from "../../sdk/index.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
+import { unwrapNativeCollateral } from "./unwrapNativeCollateral.js";
 function previewOpenCreditAccount(input, operation) {
-  const { sdk, to, calldata } = input;
+  const { sdk, value = 0n } = 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);
-  };
+  const collateralBalances = new AssetsMap();
+  const balances = new AssetsMap();
   let debt = 0n;
   const quotas = [];
+  let inBracket = false;
+  let storeSeen = false;
   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);
+      case "AddCollateral":
+        collateralBalances.inc(op.token, op.amount);
+        balances.inc(op.token, op.amount);
         break;
-      }
       case "WithdrawCollateral":
-        addBalance(op.token, -op.amount);
+        balances.dec(op.token, op.amount);
         break;
       case "IncreaseBorrowedAmount":
         debt += op.amount;
-        addBalance(op.token, op.amount);
+        balances.inc(op.token, op.amount);
         break;
       case "DecreaseBorrowedAmount":
         debt -= op.amount;
-        addBalance(op.token, -op.amount);
+        balances.dec(op.token, op.amount);
         break;
       case "UpdateQuota":
         quotas.push({ token: op.token, balance: op.change });
         break;
+      case "StoreExpectedBalances":
+        if (storeSeen) {
+          throw new Error(
+            "malformed multicall: duplicate storeExpectedBalances call"
+          );
+        }
+        storeSeen = true;
+        inBracket = true;
+        for (const { token, balance } of op.deltas) {
+          balances.inc(token, balance);
+        }
+        break;
+      case "CompareBalances":
+        if (!inBracket) {
+          throw new Error(
+            "malformed multicall: compareBalances without a preceding storeExpectedBalances"
+          );
+        }
+        inBracket = false;
+        break;
+      case "Execute":
+        if (inBracket) {
+          const adapter = sdk.getContract(op.adapter);
+          if (!(adapter instanceof AbstractAdapterContract)) {
+            throw new Error(
+              `call to ${op.adapter} between storeExpectedBalances and compareBalances is not an adapter call`
+            );
+          }
+          adapter.previewBalanceChanges(balances, op.calldata);
+        }
+        break;
     }
   }
-  const collateral = collateralByToken.values();
+  if (inBracket) {
+    throw new Error(
+      "malformed multicall: storeExpectedBalances without a matching compareBalances"
+    );
+  }
+  let collateral = collateralBalances.toAssets();
   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);
-  }
+  collateral = unwrapNativeCollateral(
+    collateral,
+    value,
+    sdk.addressProvider.getAddress(AP_WETH_TOKEN, NO_VERSION)
+  );
   const assets = balances.entries().filter(([, balance]) => balance > 1n).map(([token, balance]) => ({ token, balance }));
   return {
     operation: operation.operation,
+    creditManager: operation.creditManager,
     target: inferTargetAsset(operation.multicall, balances),
     collateral,
     collateralValue,

package/dist/esm/preview/preview/unwrapNativeCollateral.js

@@ -0,0 +1,21 @@
+import { AssetsMap, NATIVE_ADDRESS } from "../../sdk/index.js";
+import { InvalidTransactionValueError } from "./errors.js";
+function unwrapNativeCollateral(collateral, nativeAmount, wethToken) {
+  if (nativeAmount === 0n) {
+    return collateral;
+  }
+  const balances = new AssetsMap(collateral);
+  const wethBalance = balances.get(wethToken) ?? 0n;
+  if (wethBalance < nativeAmount) {
+    throw new InvalidTransactionValueError(nativeAmount, wethBalance);
+  }
+  balances.upsert(
+    wethToken,
+    wethBalance === nativeAmount ? void 0 : wethBalance - nativeAmount
+  );
+  balances.inc(NATIVE_ADDRESS, nativeAmount);
+  return balances.toAssets();
+}
+export {
+  unwrapNativeCollateral
+};

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -27,8 +27,7 @@ import {
 import {
   getRawPriceUpdates
 } from "../market/index.js";
-import { assetsMap } from "../router/index.js";
-import { AddressMap, AddressSet, hexEq } from "../utils/index.js";
+import { AddressMap, AddressSet, AssetsMap, hexEq } from "../utils/index.js";
 import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 import {
   extractPriceUpdates,
@@ -1718,10 +1717,10 @@ class CreditAccountsServiceV310 extends SDKConstruct {
     return calls;
   }
   #prepareUpdateQuotas(creditFacade, { averageQuota, minQuota }) {
-    const minRecord = assetsMap(minQuota);
+    const minRecord = new AssetsMap(minQuota);
     const calls = averageQuota.map((q) => {
-      const minAsset = minRecord.get(q.token);
-      const min = minAsset && minAsset?.balance > 0 ? minAsset.balance : 0n;
+      const minBalance = minRecord.get(q.token);
+      const min = minBalance && minBalance > 0n ? minBalance : 0n;
       return {
         target: creditFacade,
         callData: encodeFunctionData({

package/dist/esm/sdk/base/BaseContract.js

@@ -234,6 +234,7 @@ class BaseContract extends Construct {
       const functionName = getFunctionSignature(this.abi, calldata);
       return this.wrapParseCallV2(
         functionName,
+        calldata,
         this.parseFunctionParamsV2(decoded, strict)
       );
     } catch (e) {
@@ -247,7 +248,7 @@ class BaseContract extends Construct {
       this.logger?.warn(e);
       const selector = calldata.slice(0, 10);
       const data = `0x${calldata.slice(10)}`;
-      return this.wrapParseCallV2(`unknown function ${selector}`, {
+      return this.wrapParseCallV2(`unknown function ${selector}`, calldata, {
         _data: data
       });
     }
@@ -260,7 +261,7 @@ class BaseContract extends Construct {
   parseFunctionParamsV2(params, _strict) {
     return functionArgsToRecord(this.abi, params.functionName, params.args);
   }
-  wrapParseCallV2(functionName, rawArgs) {
+  wrapParseCallV2(functionName, calldata, rawArgs) {
     return {
       chainId: this.chainId,
       target: this.address,
@@ -268,6 +269,7 @@ class BaseContract extends Construct {
       label: this.labelAddress(this.address, true),
       version: this.version,
       functionName,
+      calldata,
       rawArgs
     };
   }

package/dist/esm/sdk/base/ChainContractsRegister.js

@@ -161,6 +161,7 @@ class ChainContractsRegister {
       label: this.labelAddress(address, true),
       version: 0,
       functionName: `unknown function ${selector}`,
+      calldata,
       rawArgs: { _data: data }
     };
   }

package/dist/esm/sdk/router/AbstractRouterContract.js

@@ -1,6 +1,8 @@
-import { BaseContract } from "../base/index.js";
+import {
+  BaseContract
+} from "../base/index.js";
 import { PERCENTAGE_FACTOR } from "../constants/math.js";
-import { AddressMap, AddressSet, formatBN, isDust } from "../utils/index.js";
+import { AddressSet, AssetsMap, formatBN, isDust } from "../utils/index.js";
 import { limitLeftover } from "./helpers.js";
 class AbstractRouterContract extends BaseContract {
   /**
@@ -18,15 +20,15 @@ class AbstractRouterContract extends BaseContract {
       options.debtOnly
     );
     const { leftoverBalances, expectedBalances, tokensToClaim } = b;
-    const expected = new AddressMap();
-    const leftover = new AddressMap();
+    const expected = new AssetsMap();
+    const leftover = new AssetsMap();
     for (const token of cm.collateralTokens) {
-      const actual = expectedBalances.get(token)?.balance || 0n;
-      expected.upsert(token, { token, balance: actual > 10n ? actual : 0n });
-      leftover.upsert(token, {
+      const actual = expectedBalances.get(token) || 0n;
+      expected.upsert(token, actual > 10n ? actual : 0n);
+      leftover.upsert(
         token,
-        balance: limitLeftover(leftoverBalances.get(token)?.balance || 1n, token) ?? 1n
-      });
+        limitLeftover(leftoverBalances.get(token) || 1n, token) ?? 1n
+      );
     }
     return {
       expectedBalances: expected,
@@ -35,8 +37,8 @@ class AbstractRouterContract extends BaseContract {
     };
   }
   getDefaultExpectedAndLeftover(ca, keepAssets, debtOnly) {
-    const expectedBalances = new AddressMap();
-    const leftoverBalances = new AddressMap();
+    const expectedBalances = new AssetsMap();
+    const leftoverBalances = new AssetsMap();
     const keepAssetsSet = new AddressSet(keepAssets);
     if (debtOnly) {
       const result = this.getLeftoversAfterBuyingDebt(ca, keepAssetsSet);
@@ -48,23 +50,23 @@ class AbstractRouterContract extends BaseContract {
     }
     for (const { token, balance, mask } of ca.tokens) {
       const isEnabled = (mask & ca.enabledTokensMask) !== 0n;
-      expectedBalances.upsert(token, { token, balance });
+      expectedBalances.upsert(token, balance);
       if (keepAssetsSet.has(token) || !isEnabled || isDust({
         sdk: this.sdk,
         token,
         balance,
         creditManager: ca.creditManager
       })) {
-        leftoverBalances.upsert(token, {
+        leftoverBalances.upsert(
           token,
-          balance: limitLeftover(balance, token) ?? balance
-        });
+          limitLeftover(balance, token) ?? balance
+        );
       }
     }
     return {
       expectedBalances,
       leftoverBalances,
-      tokensToClaim: new AddressMap()
+      tokensToClaim: new AssetsMap()
     };
   }
   /**
@@ -77,16 +79,13 @@ class AbstractRouterContract extends BaseContract {
     const { priceOracle } = this.sdk.marketRegister.findByCreditManager(
       ca.creditManager
     );
-    const expectedBalances = new AddressMap();
-    const leftoverBalances = new AddressMap();
+    const expectedBalances = new AssetsMap();
+    const leftoverBalances = new AssetsMap();
     const usdBalances = [];
     for (const { token, balance, mask } of ca.tokens) {
       const isEnabled = (mask & ca.enabledTokensMask) !== 0n;
-      expectedBalances.upsert(token, { token, balance });
-      leftoverBalances.upsert(token, {
-        token,
-        balance: limitLeftover(balance, token) ?? balance
-      });
+      expectedBalances.upsert(token, balance);
+      leftoverBalances.upsert(token, limitLeftover(balance, token) ?? balance);
       if (isEnabled && !keepAssets.has(token)) {
         usdBalances.push({
           token,
@@ -116,15 +115,12 @@ class AbstractRouterContract extends BaseContract {
     if (tokenAmount === 0n) {
       return void 0;
     }
-    let leftoverBalance = leftoverBalances.get(highestToken.token)?.balance ?? 0n;
+    let leftoverBalance = leftoverBalances.get(highestToken.token) ?? 0n;
     leftoverBalance -= tokenAmount;
     if (leftoverBalance < 0n) {
       return void 0;
     }
-    leftoverBalances.upsert(highestToken.token, {
-      token: highestToken.token,
-      balance: leftoverBalance
-    });
+    leftoverBalances.upsert(highestToken.token, leftoverBalance);
     const tokenAmountStr = this.sdk.tokensMeta.formatBN(
       highestToken.token,
       tokenAmount,
@@ -137,7 +133,7 @@ class AbstractRouterContract extends BaseContract {
     return {
       expectedBalances,
       leftoverBalances,
-      tokensToClaim: new AddressMap()
+      tokensToClaim: new AssetsMap()
     };
   }
   safeConvertToUSD(priceOracle, token, balance) {

package/dist/esm/sdk/router/RouterV310Contract.js

@@ -1,10 +1,9 @@
 import { getAddress } from "viem";
 import { gearboxRouterAbi } from "../../abi/router/gearboxRouter.js";
-import { AddressMap } from "../utils/AddressMap.js";
 import { formatBN } from "../utils/formatter.js";
-import { isDust } from "../utils/index.js";
+import { AddressMap, AssetsMap, isDust } from "../utils/index.js";
 import { AbstractRouterContract } from "./AbstractRouterContract.js";
-import { assetsMap, balancesMap, limitLeftover } from "./helpers.js";
+import { limitLeftover } from "./helpers.js";
 const abi = gearboxRouterAbi;
 class RouterV310Contract extends AbstractRouterContract {
   #numSplits = new AddressMap();
@@ -71,8 +70,8 @@ class RouterV310Contract extends AbstractRouterContract {
       slippage
     } = props;
     const [expectedMap, leftoverMap] = [
-      balancesMap(expectedBalances),
-      balancesMap(leftoverBalances)
+      new AssetsMap(expectedBalances),
+      new AssetsMap(leftoverBalances)
     ];
     const getNumSplits = this.#numSplitsGetter(cm, expectedBalances);
     const tData = cm.collateralTokens.map(
@@ -157,22 +156,22 @@ class RouterV310Contract extends AbstractRouterContract {
     } = props;
     const { expectedBalances, leftoverBalances, tokensToClaim } = this.getExpectedAndLeftover(ca, cm, {
       balances: balances ? {
-        expectedBalances: assetsMap(balances.expectedBalances),
-        leftoverBalances: assetsMap(balances.leftoverBalances),
-        tokensToClaim: assetsMap(balances.tokensToClaim || [])
+        expectedBalances: new AssetsMap(balances.expectedBalances),
+        leftoverBalances: new AssetsMap(balances.leftoverBalances),
+        tokensToClaim: new AssetsMap(balances.tokensToClaim || [])
       } : void 0,
       keepAssets: balances ? void 0 : keepAssets,
       debtOnly
     });
-    const getNumSplits = this.#numSplitsGetter(cm, expectedBalances.values());
+    const getNumSplits = this.#numSplitsGetter(cm, expectedBalances.toAssets());
     const tData = [];
     for (const token of cm.collateralTokens) {
       tData.push({
         token,
-        balance: expectedBalances.get(token)?.balance || 0n,
-        leftoverBalance: limitLeftover(leftoverBalances.get(token)?.balance, token) ?? 0n,
+        balance: expectedBalances.get(token) || 0n,
+        leftoverBalance: limitLeftover(leftoverBalances.get(token), token) ?? 0n,
         numSplits: getNumSplits(token),
-        claimRewards: !!tokensToClaim.get(token)
+        claimRewards: tokensToClaim.has(token)
       });
     }
     this.logger?.debug(

package/dist/esm/sdk/router/helpers.js

@@ -1,7 +1,4 @@
 import { AddressMap } from "../utils/index.js";
-function balancesMap(assets) {
-  return new AddressMap(assets.map(({ token, balance }) => [token, balance]));
-}
 function assetsMap(assets) {
   return new AddressMap(assets.map((a) => [a.token, a]));
 }
@@ -16,6 +13,5 @@ function limitLeftover(balance, token) {
 }
 export {
   assetsMap,
-  balancesMap,
   limitLeftover
 };

package/dist/esm/sdk/utils/AddressMap.js

@@ -113,6 +113,12 @@ class AddressMap {
   keys() {
     return Array.from(this.#map.keys());
   }
+  /**
+   * Returns an unfrozen shallow copy of the map.
+   **/
+  clone() {
+    return new AddressMap(this.entries(), this.name);
+  }
   /**
    * Converts the map to a plain `Record<Address, T>` object.
    **/

package/dist/esm/sdk/utils/AssetsMap.js

@@ -0,0 +1,37 @@
+import { AddressMap } from "./AddressMap.js";
+class AssetsMap extends AddressMap {
+  /**
+   * @param entries - Optional initial entries as `[address, balance]` tuples or {@link Asset} objects.
+   * @param name - Optional label used in error messages when a lookup fails.
+   */
+  constructor(entries, name) {
+    super(
+      entries?.map((e) => Array.isArray(e) ? e : [e.token, e.balance]),
+      name
+    );
+  }
+  /**
+   * Adds `amount` to the token balance, treating a missing key as `0n`.
+   */
+  inc(address, amount) {
+    this.upsert(address, (this.get(address) ?? 0n) + amount);
+  }
+  /**
+   * Subtracts `amount` from the token balance, treating a missing key as `0n`.
+   */
+  dec(address, amount) {
+    this.inc(address, -amount);
+  }
+  /**
+   * Converts the map to an array of {@link Asset} objects.
+   */
+  toAssets() {
+    return this.entries().map(([token, balance]) => ({ token, balance }));
+  }
+  clone() {
+    return new AssetsMap(this.entries(), this.name);
+  }
+}
+export {
+  AssetsMap
+};

package/dist/esm/sdk/utils/index.js

@@ -1,5 +1,6 @@
 export * from "./AddressMap.js";
 export * from "./AddressSet.js";
+export * from "./AssetsMap.js";
 export * from "./abi-decode.js";
 export * from "./bytes32ToString.js";
 export * from "./childLogger.js";

package/dist/types/common-utils/utils/strategies/assets/assets.d.ts

@@ -1,3 +1,3 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 export declare function getDefaultAsset(token: Address): Omit<Asset, "balance">;

package/dist/types/common-utils/utils/strategies/credit-managers/get-wallet-balances-allowed-on-cm.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { TokenSlice } from "../strategy-info/types.js";
 export interface GetWalletBalancesAllowedOnCMProps {
     walletBalances: Record<Address, bigint> | undefined;

package/dist/types/common-utils/utils/strategies/strategy-info/calculate-total-apy.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { QuotaSlice, TokenSlice } from "./types.js";
 export interface TotalAPY {
     overallAPY: number | undefined | null;

package/dist/types/common-utils/utils/strategies/strategy-info/calculate-total-points.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { LocalDebtReward, LocalPointsInfo, LocalPointsReward } from "../types/points-slices.js";
 import type { TokenSlice } from "./types.js";
 export interface PointsData {

package/dist/types/common-utils/utils/strategies/tokens/add-amount-in-target.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { TokenSlice } from "../strategy-info/types.js";
 export declare function addAmountInTarget<T extends Asset>(asset: T, tokensList: Record<Address, TokenSlice>, prices: Record<Address, bigint>, toPrice: bigint, toDecimals: number): T & {
     amountInTarget: bigint;

package/dist/types/common-utils/utils/strategies/tokens/get-list-with-amount-in-target.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { TokenSlice } from "../strategy-info/types.js";
 export interface AddAmountInTargetProps<T> {
     assets: Array<T>;

package/dist/types/common-utils/utils/strategies/types/strategy-earnings.d.ts

@@ -1,4 +1,4 @@
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { calculateEarnings } from "../../apy/calculate-earnings.js";
 import type { Strategy } from "../../strategies/types/strategy.js";
 import type { calculateTotalAPY } from "../strategy-info/calculate-total-apy.js";

package/dist/types/common-utils/utils/validation/validate-balances.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 import type { ValidateBalanceResult } from "./validate-balance.js";
 export interface ValidateBalancesProps {
     balances: Record<Address, bigint>;

package/dist/types/common-utils/utils/validation/validate-open-account.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 import type { CreditManagerSlice } from "../strategies/strategy-info/types.js";
 import type { ValidateQuotaResult } from "./validate-quota.js";
 export interface ValidateOpenAccountProps {

package/dist/types/common-utils/utils/validation/validate-quota.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 import type { CreditManagerSlice } from "../strategies/strategy-info/types.js";
 export interface ValidateQuotaProps {
     desiredQuota: Record<Address, Asset>;

package/dist/types/common-utils/utils/validation/validate-token-to-obtain.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 export interface ValidateTokenToObtainProps {
     targetToken: Address | Array<Asset> | null;
     creditManager: {