@gearbox-protocol/sdk 14.12.0-next.2 → 14.12.0-next.20

package/dist/esm/sdk/accounts/withdrawal-compressor/intent-codec.js

@@ -0,0 +1,91 @@
+import { decodeAbiParameters, encodeAbiParameters } from "viem";
+const DELAYED_INTENT_VERSION = 1;
+const DELAYED_INTENT_TYPES = {
+  INCREASE_LEVERAGE: 1,
+  DEPOSIT: 2,
+  DEPOSIT_AND_INCREASE_LEVERAGE: 3,
+  WITHDRAW_COLLATERAL: 4,
+  CLOSE_ACCOUNT: 5,
+  ADD_COLLATERAL: 6,
+  DECREASE_LEVERAGE: 7
+};
+const HEADER_PARAMS = [
+  { type: "uint8", name: "version" },
+  { type: "uint8", name: "intentType" }
+];
+const TO_PARAMS = [...HEADER_PARAMS, { type: "address", name: "to" }];
+const WITHDRAW_COLLATERAL_PARAMS = [
+  ...TO_PARAMS,
+  { type: "address", name: "withdrawToken" },
+  { type: "uint256", name: "withdrawAmount" }
+];
+function encodeDelayedIntent(intent) {
+  const version = DELAYED_INTENT_VERSION;
+  const intentType = DELAYED_INTENT_TYPES[intent.type];
+  switch (intent.type) {
+    case "INCREASE_LEVERAGE":
+    case "CLOSE_ACCOUNT":
+      return encodeAbiParameters(TO_PARAMS, [version, intentType, intent.to]);
+    case "WITHDRAW_COLLATERAL":
+      return encodeAbiParameters(WITHDRAW_COLLATERAL_PARAMS, [
+        version,
+        intentType,
+        intent.to,
+        intent.withdrawToken,
+        intent.withdrawAmount
+      ]);
+    case "DEPOSIT":
+    case "DEPOSIT_AND_INCREASE_LEVERAGE":
+    case "ADD_COLLATERAL":
+    case "DECREASE_LEVERAGE":
+      return encodeAbiParameters(HEADER_PARAMS, [version, intentType]);
+    default: {
+      const t = intent;
+      throw new Error(`unknown delayed intent: ${JSON.stringify(t)}`);
+    }
+  }
+}
+function decodeDelayedIntent(data) {
+  const [version, intentType] = decodeAbiParameters(HEADER_PARAMS, data);
+  if (version !== DELAYED_INTENT_VERSION) {
+    throw new Error(`unsupported delayed intent version: ${version}`);
+  }
+  switch (intentType) {
+    case DELAYED_INTENT_TYPES.INCREASE_LEVERAGE: {
+      const [, , to] = decodeAbiParameters(TO_PARAMS, data);
+      return { type: "INCREASE_LEVERAGE", to };
+    }
+    case DELAYED_INTENT_TYPES.DEPOSIT:
+      return { type: "DEPOSIT" };
+    case DELAYED_INTENT_TYPES.DEPOSIT_AND_INCREASE_LEVERAGE:
+      return { type: "DEPOSIT_AND_INCREASE_LEVERAGE" };
+    case DELAYED_INTENT_TYPES.WITHDRAW_COLLATERAL: {
+      const [, , to, withdrawToken, withdrawAmount] = decodeAbiParameters(
+        WITHDRAW_COLLATERAL_PARAMS,
+        data
+      );
+      return {
+        type: "WITHDRAW_COLLATERAL",
+        to,
+        withdrawToken,
+        withdrawAmount
+      };
+    }
+    case DELAYED_INTENT_TYPES.CLOSE_ACCOUNT: {
+      const [, , to] = decodeAbiParameters(TO_PARAMS, data);
+      return { type: "CLOSE_ACCOUNT", to };
+    }
+    case DELAYED_INTENT_TYPES.ADD_COLLATERAL:
+      return { type: "ADD_COLLATERAL" };
+    case DELAYED_INTENT_TYPES.DECREASE_LEVERAGE:
+      return { type: "DECREASE_LEVERAGE" };
+    default:
+      throw new Error(`unknown delayed intent type: ${intentType}`);
+  }
+}
+export {
+  DELAYED_INTENT_TYPES,
+  DELAYED_INTENT_VERSION,
+  decodeDelayedIntent,
+  encodeDelayedIntent
+};

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/market/rwa/securitize/SecuritizeRWAFactory.js

@@ -1,4 +1,6 @@
-import { decodeAbiParameters } from "viem";
+import {
+  decodeAbiParameters
+} from "viem";
 import { iSecuritizeRWAFactoryAbi } from "../../../../abi/rwa/iSecuritizeRWAFactory.js";
 import { BaseContract } from "../../../base/index.js";
 import { AddressMap, AddressSet } from "../../../utils/index.js";
@@ -49,6 +51,30 @@ class SecuritizeRWAFactory extends BaseContract {
       operators: [...t.operators]
     }));
   }
+  parseFunctionParamsV2(params, strict) {
+    switch (params.functionName) {
+      case "openCreditAccount": {
+        const [creditManager, calls, tokensToRegister, signaturesToCache] = params.args;
+        return {
+          creditManager,
+          calls: this.register.parseMultiCallV2([...calls], strict),
+          tokensToRegister,
+          signaturesToCache
+        };
+      }
+      case "multicall": {
+        const [creditAccount, calls, tokensToRegister, signaturesToCache] = params.args;
+        return {
+          creditAccount,
+          calls: this.register.parseMultiCallV2([...calls], strict),
+          tokensToRegister,
+          signaturesToCache
+        };
+      }
+      default:
+        return super.parseFunctionParamsV2(params, strict);
+    }
+  }
   /**
    * {@inheritDoc IRWAFactory.decodeInvestorData}
    */
@@ -104,6 +130,12 @@ class SecuritizeRWAFactory extends BaseContract {
       })
     };
   }
+  /**
+   * {@inheritDoc IRWAFactory.getTokens}
+   */
+  getTokens() {
+    return this.dsTokens.map((t) => t.address);
+  }
   /**
    * {@inheritDoc IRWAFactory.getInvestor}
    */
@@ -138,8 +170,8 @@ class SecuritizeRWAFactory extends BaseContract {
   /**
    * {@inheritDoc IRWAFactory.multicall}
    */
-  multicall(creditAccount, calls, options) {
-    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
+  multicall(creditAccount, calls, args) {
+    const { tokensToRegister = [], signaturesToCache = [] } = args ?? {};
     return this.createRawTx({
       functionName: "multicall",
       args: [creditAccount, calls, tokensToRegister, signaturesToCache]
@@ -169,11 +201,33 @@ class SecuritizeRWAFactory extends BaseContract {
       requiredSignatures
     };
   }
+  /**
+   * {@inheritDoc IRWAFactory.getMissingRequirements}
+   *
+   * A required signature is omitted when `providedArgs.signaturesToCache`
+   * already carries a signature for the same token: the transaction caches it
+   * on-chain as part of the operation.
+   */
+  getMissingRequirements(requirements, providedArgs) {
+    const providedTokens = new AddressSet(
+      (providedArgs?.signaturesToCache ?? []).map((s) => s.token)
+    );
+    const requiredSignatures = requirements.requiredSignatures.filter(
+      (message) => !providedTokens.has(message.message.token)
+    );
+    if (requiredSignatures.length === 0) {
+      return void 0;
+    }
+    return {
+      type: RWA_FACTORY_SECURITIZE,
+      requiredSignatures
+    };
+  }
   /**
    * {@inheritDoc IRWAFactory.openCreditAccount}
    */
-  openCreditAccount(creditManager, calls, options) {
-    const { tokensToRegister = [], signaturesToCache = [] } = options ?? {};
+  openCreditAccount(creditManager, calls, args) {
+    const { tokensToRegister = [], signaturesToCache = [] } = args ?? {};
     return this.createRawTx({
       functionName: "openCreditAccount",
       args: [creditManager, calls, tokensToRegister, signaturesToCache]

package/dist/esm/sdk/market/rwa/types.js

@@ -1,7 +1,10 @@
 import { RWA_FACTORY_SECURITIZE } from "./securitize/index.js";
 const RWA_FACTORY_TYPES = [RWA_FACTORY_SECURITIZE];
-function isRWAFactory(factory, type) {
-  return factory.contractType === type;
+function isRWAFactory(contract, type) {
+  if (type) {
+    return contract.contractType === type;
+  }
+  return contract.contractType.startsWith("RWA_FACTORY::");
 }
 export {
   RWA_FACTORY_TYPES,

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

@@ -32,7 +32,6 @@ class ZapperContract extends 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")) {
@@ -42,7 +41,6 @@ class ZapperContract extends BaseContract {
         zapper,
         receiver,
         assets: rawArgs.tokenInAmount ?? value ?? 0n,
-        token,
         underlying,
         referralCode: rawArgs.referralCode
       };
@@ -54,7 +52,6 @@ class ZapperContract extends BaseContract {
         zapper,
         receiver,
         shares: rawArgs.tokenOutAmount,
-        token,
         underlying
       };
     }

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/AddressSet.js

@@ -15,6 +15,13 @@ class AddressSet extends Set {
   has(value) {
     return super.has(getAddress(value));
   }
+  difference(other) {
+    const result = new AddressSet(this.keys());
+    for (const key of other) {
+      result.delete(getAddress(key));
+    }
+    return result;
+  }
   /**
    * Returns all addresses as an array.
    **/

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

@@ -0,0 +1,73 @@
+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
+    );
+  }
+  /**
+   * Looks up a token balance, treating a missing key as `0n`.
+   */
+  getOrZero(address) {
+    return this.get(address) ?? 0n;
+  }
+  /**
+   * Adds `amount` to the token balance, treating a missing key as `0n`.
+   */
+  inc(address, amount) {
+    this.upsert(address, this.getOrZero(address) + amount);
+  }
+  /**
+   * Subtracts `amount` from the token balance, treating a missing key as `0n`.
+   */
+  dec(address, amount) {
+    this.inc(address, -amount);
+  }
+  /**
+   * Per-token difference `this - before`, non-zero entries only.
+   *
+   * Assumes this map's keys are a superset of `before`'s keys; tokens present
+   * only in `before` are not reported.
+   */
+  difference(before) {
+    const result = new AssetsMap();
+    for (const [token, balance] of this.entries()) {
+      const change = balance - before.getOrZero(token);
+      if (change !== 0n) {
+        result.upsert(token, change);
+      }
+    }
+    return result;
+  }
+  /**
+   * Sums `fn` over all entries.
+   */
+  sum(fn) {
+    return this.entries().reduce(
+      (acc, [token, balance]) => acc + fn(token, balance),
+      0n
+    );
+  }
+  /**
+   * Converts the map to an array of {@link Asset} objects.
+   * @param minBalance - If provided, keeps only entries with a balance
+   * strictly greater than this threshold (e.g. `1n` to filter out dust).
+   */
+  toAssets(minBalance) {
+    const abs = (balance) => balance > 0n ? balance : -balance;
+    return this.entries().filter(
+      ([, balance]) => minBalance === void 0 || abs(balance) > minBalance
+    ).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";