@gearbox-protocol/sdk 14.12.0-next.3 → 14.12.0-next.30

package/dist/esm/plugins/delayed-withdrawal/DelayedWithdrawalPlugin.js

@@ -1,10 +1,4 @@
-import { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
-import { iWithdrawalCompressorV311Abi } from "../../abi/IWithdrawalCompressorV311.js";
-import {
-  AddressMap,
-  BasePlugin,
-  getWithdrawalCompressorAddress
-} from "../../sdk/index.js";
+import { AddressMap, BasePlugin } from "../../sdk/index.js";
 const MAP_LABEL = "delayedWithdrawal";
 class DelayedWithdrawalPlugin extends BasePlugin {
   #withdrawableAssets;
@@ -12,44 +6,25 @@ class DelayedWithdrawalPlugin extends BasePlugin {
     if (!force && this.loaded) {
       return this.state;
     }
-    const compressor = getWithdrawalCompressorAddress(this.sdk.chainId);
-    this.sdk.logger?.debug(
-      `loading delayed withdrawal plugin with compressor ${compressor}`
-    );
-    const creditManagers = this.sdk.marketRegister.creditManagers;
-    const resp = await this.client.multicall({
-      contracts: compressor ? creditManagers.map(
-        (cm) => ({
-          address: compressor.address,
-          abi: compressor.version === 310 ? iWithdrawalCompressorV310Abi : iWithdrawalCompressorV311Abi,
-          functionName: "getWithdrawableAssets",
-          args: [cm.creditManager.address]
-        })
-      ) : [],
-      allowFailure: true,
-      batchSize: 0
-    });
     this.#withdrawableAssets = new AddressMap(void 0, MAP_LABEL);
-    resp.forEach((r, index) => {
-      const cm = creditManagers[index];
-      if (r.status === "success" && r.result?.length > 0) {
-        const configsToShow = r.result;
-        this.#withdrawableAssets?.upsert(
-          cm.creditManager.address,
-          configsToShow.map((cfg) => ({
-            ...cfg,
-            creditManager: cm.creditManager.address,
-            disabled: isConfigToOmit({
-              creditManager: cm.creditManager.address,
-              token: cfg.token,
-              withdrawalPhantomToken: cfg.withdrawalPhantomToken,
-              underlying: cfg.underlying
-            })
-          }))
-        );
-      } else {
-      }
-    });
+    const resp = await this.sdk.withdrawalCompressor.getWithdrawableAssetsBatch();
+    const byCreditManager = /* @__PURE__ */ new Map();
+    for (const cfg of resp) {
+      const assets = byCreditManager.get(cfg.creditManager) ?? [];
+      assets.push({
+        ...cfg,
+        disabled: isConfigToOmit({
+          creditManager: cfg.creditManager,
+          token: cfg.token,
+          withdrawalPhantomToken: cfg.withdrawalPhantomToken,
+          underlying: cfg.underlying
+        })
+      });
+      byCreditManager.set(cfg.creditManager, assets);
+    }
+    for (const [creditManager, assets] of byCreditManager) {
+      this.#withdrawableAssets.upsert(creditManager, assets);
+    }
     return this.state;
   }
   get loaded() {

package/dist/esm/preview/index.js

@@ -1,4 +1,5 @@
 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";
+export * from "./types.js";

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

@@ -12,7 +12,8 @@ function classifyInnerOperations(calls, props) {
         version: call.version,
         label: call.label,
         adapterFunctionName: call.functionName,
-        adapterArgs: call.rawArgs
+        adapterArgs: call.rawArgs,
+        calldata: call.calldata
       });
       continue;
     }
@@ -59,6 +60,18 @@ function classifyFacadeInnerCall(call, underlying) {
         token: rawArgs.token,
         change: rawArgs.quotaChange
       };
+    case "storeExpectedBalances": {
+      const balanceDeltas = rawArgs.balanceDeltas;
+      return {
+        operation: "StoreExpectedBalances",
+        deltas: balanceDeltas.map(({ token, amount }) => ({
+          token,
+          balance: amount
+        }))
+      };
+    }
+    case "compareBalances":
+      return { operation: "CompareBalances" };
     default:
       return null;
   }

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,8 +1,6 @@
 import { isAddressEqual, zeroAddress } from "viem";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
-function parseFacadeOperationCalldata(props) {
-  const { sdk, facade, calldata } = props;
+function parseFacadeOperationCalldata(sdk, facade, calldata) {
   const parsed = sdk.parseFunctionDataV2(facade.address, calldata);
   const functionName = parsed.functionName.split("(")[0];
   const { rawArgs } = parsed;
@@ -21,23 +19,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 +41,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 +60,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

@@ -1,7 +1,7 @@
 import {
   CreditFacadeV310Contract,
+  isRWAFactory,
   PoolV310Contract,
-  SecuritizeRWAFactory,
   ZapperContract
 } from "../../sdk/index.js";
 import { UnsupportedTargetError } from "./errors.js";
@@ -12,7 +12,7 @@ function parseOperationCalldata(input) {
   const { sdk, to, calldata, value, sender } = input;
   const contract = sdk.getContract(to);
   if (contract instanceof PoolV310Contract) {
-    return parsePoolOperationCalldata({ sdk, pool: contract, calldata });
+    return parsePoolOperationCalldata(sdk, contract, calldata);
   }
   if (contract instanceof ZapperContract) {
     const parsed = contract.parseOperation(calldata, value);
@@ -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,29 +34,22 @@ 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;
   }
   if (contract instanceof CreditFacadeV310Contract) {
-    return parseFacadeOperationCalldata({
-      sdk,
-      facade: contract,
-      calldata
-    });
+    return parseFacadeOperationCalldata(sdk, contract, calldata);
   }
-  if (contract instanceof SecuritizeRWAFactory) {
-    return parseRWAFactoryOperationCalldata({
-      sdk,
-      factory: contract,
-      calldata
-    });
+  if (contract && isRWAFactory(contract)) {
+    return parseRWAFactoryOperationCalldata(sdk, contract, calldata);
   }
   throw new UnsupportedTargetError(to);
 }

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

@@ -1,6 +1,5 @@
 import { UnsupportedPoolFunctionError } from "./errors.js";
-function parsePoolOperationCalldata(props) {
-  const { sdk, pool, calldata } = props;
+function parsePoolOperationCalldata(sdk, pool, calldata) {
   const parsed = sdk.parseFunctionDataV2(pool.address, calldata);
   const functionName = parsed.functionName.split("(")[0];
   const { rawArgs } = parsed;
@@ -15,6 +14,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 +27,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 +39,7 @@ function parsePoolOperationCalldata(props) {
         owner: rawArgs.owner,
         assets: rawArgs.assets,
         underlying,
+        tokenIn: pool.address,
         tokenOut: underlying,
         zapper: void 0
       };
@@ -49,6 +51,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

@@ -1,19 +1,37 @@
-import { zeroAddress } from "viem";
 import { AbstractAdapterContract } from "../../plugins/adapters/index.js";
 import {
   CreditFacadeV310Contract,
-  hexEq
+  hexEq,
+  isRWAFactory,
+  RWA_FACTORY_SECURITIZE
 } from "../../sdk/index.js";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
-function parseRWAFactoryOperationCalldata(props) {
-  const { sdk, factory, calldata } = props;
+function parseRWAFactoryOperationCalldata(sdk, factory, calldata) {
+  const { contractType, address } = factory;
+  if (isRWAFactory(factory, RWA_FACTORY_SECURITIZE)) {
+    return parseSecuritizeOperationCalldata(sdk, factory, calldata);
+  }
+  throw new Error(
+    `unsupported RWA factory type "${contractType}" on ${address}`
+  );
+}
+function parseSecuritizeOperationCalldata(sdk, factory, calldata) {
   const parsed = sdk.parseFunctionDataV2(factory.address, calldata);
   const functionName = parsed.functionName.split("(")[0];
   const { rawArgs } = parsed;
   const innerCalls = rawArgs.calls ?? [];
+  const args = {
+    type: RWA_FACTORY_SECURITIZE,
+    tokensToRegister: [
+      ...rawArgs.tokensToRegister ?? []
+    ],
+    signaturesToCache: [
+      ...rawArgs.signaturesToCache ?? []
+    ]
+  };
   const suite = functionName === "openCreditAccount" ? sdk.marketRegister.findCreditManager(rawArgs.creditManager) : resolveSuiteForMulticall(sdk, factory, innerCalls);
   const metadata = {
+    factory: factory.address,
     creditManager: suite.creditManager.address,
     creditFacade: suite.creditFacade.address
   };
@@ -21,25 +39,21 @@ function parseRWAFactoryOperationCalldata(props) {
     sdk,
     underlying: suite.underlying
   });
-  const expectedBalanceChanges = extractExpectedBalanceChanges(innerCalls);
   switch (functionName) {
     case "openCreditAccount":
       return {
         ...metadata,
-        operation: "OpenCreditAccount",
-        creditAccount: zeroAddress,
-        onBehalfOf: zeroAddress,
-        referralCode: 0n,
+        operation: "RWAOpenCreditAccount",
         multicall,
-        expectedBalanceChanges
+        args
       };
     case "multicall":
       return {
         ...metadata,
-        operation: "MultiCall",
+        operation: "RWAMulticall",
         creditAccount: rawArgs.creditAccount,
         multicall,
-        expectedBalanceChanges
+        args
       };
     default:
       throw new Error(

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

@@ -1,9 +1,14 @@
 export * from "./types-adapters.js";
 export * from "./types-facades.js";
 export * from "./types-pools.js";
+export * from "./types-rwa.js";
 function isPoolOperation(tx) {
   return tx.operation === "Deposit" || tx.operation === "Mint" || tx.operation === "Withdraw" || tx.operation === "Redeem";
 }
+function isRWAOperation(tx) {
+  return tx.operation === "RWAOpenCreditAccount" || tx.operation === "RWAMulticall";
+}
 export {
-  isPoolOperation
+  isPoolOperation,
+  isRWAOperation
 };

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

@@ -1,55 +1,29 @@
 import { erc20Abi } from "viem";
-import {
-  Prerequisite,
-  toPrerequisiteError
-} from "./Prerequisite.js";
+import { Prerequisite } from "./Prerequisite.js";
 class AllowancePrerequisite extends Prerequisite {
-  _id;
-  _title;
-  _detail;
-  constructor(props) {
+  #detail;
+  constructor(detail) {
     super();
-    this._id = props.id ?? `allowance:${props.token}:${props.owner}:${props.spender}`;
-    this._title = props.title ?? "Token approval";
-    this._detail = {
-      token: props.token,
-      owner: props.owner,
-      spender: props.spender,
-      required: props.required
-    };
-  }
-  get id() {
-    return this._id;
-  }
-  get kind() {
-    return "allowance";
-  }
-  get title() {
-    return this._title;
+    this.#detail = { ...detail };
   }
-  get detail() {
-    return this._detail;
-  }
-  calls() {
-    return [
-      {
-        address: this._detail.token,
-        abi: erc20Abi,
-        functionName: "allowance",
-        args: [this._detail.owner, this._detail.spender]
-      }
-    ];
-  }
-  resolve(slice) {
-    const res = slice[0];
-    if (!res || res.status === "failure") {
-      return this.errorResult(toPrerequisiteError(res?.error));
-    }
-    const actual = res.result;
-    return this.satisfiedResult(actual >= this._detail.required, {
-      ...this._detail,
-      actual
+  async check(ctx) {
+    const actual = await ctx.sdk.client.readContract({
+      address: this.#detail.token,
+      abi: erc20Abi,
+      functionName: "allowance",
+      args: [this.#detail.owner, this.#detail.spender],
+      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
+      // testnet forks pinned to a specific block.
+      blockNumber: ctx.blockNumber
     });
+    return {
+      kind: "allowance",
+      detail: { ...this.#detail, actual },
+      satisfied: actual >= this.#detail.required
+    };
+  }
+  errorResult(error) {
+    return { kind: "allowance", detail: this.#detail, error };
   }
 }
 export {

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

@@ -1,53 +1,36 @@
 import { erc20Abi } from "viem";
-import {
-  Prerequisite,
-  toPrerequisiteError
-} from "./Prerequisite.js";
+import { hexEq, NATIVE_ADDRESS } from "../../sdk/index.js";
+import { Prerequisite } from "./Prerequisite.js";
 class BalancePrerequisite extends Prerequisite {
-  _id;
-  _title;
-  _detail;
-  constructor(props) {
+  #detail;
+  constructor(detail) {
     super();
-    this._id = props.id ?? `balance:${props.token}:${props.owner}`;
-    this._title = props.title ?? "Sufficient balance";
-    this._detail = {
-      token: props.token,
-      owner: props.owner,
-      required: props.required
-    };
-  }
-  get id() {
-    return this._id;
-  }
-  get kind() {
-    return "balance";
+    this.#detail = { ...detail };
   }
-  get title() {
-    return this._title;
-  }
-  get detail() {
-    return this._detail;
+  async check(ctx) {
+    const actual = await this.#readBalance(ctx);
+    return {
+      kind: "balance",
+      detail: { ...this.#detail, actual },
+      satisfied: actual >= this.#detail.required
+    };
   }
-  calls() {
-    return [
-      {
-        address: this._detail.token,
-        abi: erc20Abi,
-        functionName: "balanceOf",
-        args: [this._detail.owner]
-      }
-    ];
+  errorResult(error) {
+    return { kind: "balance", detail: this.#detail, error };
   }
-  resolve(slice) {
-    const res = slice[0];
-    if (!res || res.status === "failure") {
-      return this.errorResult(toPrerequisiteError(res?.error));
+  async #readBalance(ctx) {
+    if (hexEq(this.#detail.token, NATIVE_ADDRESS)) {
+      return ctx.sdk.client.getBalance({
+        address: this.#detail.owner,
+        blockNumber: ctx.blockNumber
+      });
     }
-    const actual = res.result;
-    return this.satisfiedResult(actual >= this._detail.required, {
-      ...this._detail,
-      actual
+    return ctx.sdk.client.readContract({
+      address: this.#detail.token,
+      abi: erc20Abi,
+      functionName: "balanceOf",
+      args: [this.#detail.owner],
+      blockNumber: ctx.blockNumber
     });
   }
 }

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

@@ -1,7 +1,4 @@
-import {
-  BaseError,
-  ContractFunctionRevertedError
-} from "viem";
+import { BaseError, ContractFunctionRevertedError } from "viem";
 function toPrerequisiteError(cause) {
   if (cause instanceof BaseError) {
     const reverted = cause.walk(
@@ -22,42 +19,18 @@ function toPrerequisiteError(cause) {
 }
 class Prerequisite {
   /**
-   * Verifies this prerequisite on its own using an `allowFailure` multicall.
-   * Prefer `verifyPrerequisites` to batch several checks into one round-trip.
+   * Verifies this prerequisite. Never rejects: any error thrown by
+   * {@link check} (revert, RPC/network failure, compressor error) is
+   * normalized into an `error` result.
    */
   async verify(ctx) {
-    const calls = this.calls(ctx);
-    const results = await ctx.sdk.client.multicall({
-      allowFailure: true,
-      contracts: calls,
-      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
-      // testnet forks pinned to a specific block.
-      blockNumber: ctx.blockNumber
-    });
-    return this.resolve(results);
-  }
-  /** Builds a successful result; `detail` carries the on-chain `actual`. */
-  satisfiedResult(satisfied, detail) {
-    return {
-      id: this.id,
-      kind: this.kind,
-      title: this.title,
-      detail,
-      satisfied
-    };
-  }
-  /** Builds a failed result from a decoded read error. */
-  errorResult(error) {
-    return {
-      id: this.id,
-      kind: this.kind,
-      title: this.title,
-      detail: this.detail,
-      error
-    };
+    try {
+      return await this.check(ctx);
+    } catch (cause) {
+      return this.errorResult(toPrerequisiteError(cause));
+    }
   }
 }
 export {
-  Prerequisite,
-  toPrerequisiteError
+  Prerequisite
 };

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

@@ -0,0 +1,47 @@
+import { Prerequisite } from "./Prerequisite.js";
+class RWAOpenRequirementsPrerequisite extends Prerequisite {
+  #detail;
+  #providedArgs;
+  constructor(detail, providedArgs) {
+    super();
+    this.#detail = { ...detail };
+    this.#providedArgs = providedArgs;
+  }
+  async check(ctx) {
+    const requirements = await ctx.sdk.accounts.getOpenAccountRequirements(
+      ctx.wallet,
+      this.#detail.creditManager,
+      { tokenOutAddress: this.#detail.token }
+    );
+    if (!requirements) {
+      return {
+        kind: "rwaOpenRequirements",
+        detail: this.#detail,
+        satisfied: true
+      };
+    }
+    const { rwaFactory } = ctx.sdk.marketRegister.findByCreditManager(
+      this.#detail.creditManager
+    );
+    if (!rwaFactory) {
+      throw new Error(
+        `no RWA factory found for credit manager ${this.#detail.creditManager}`
+      );
+    }
+    const missing = rwaFactory.getMissingRequirements(
+      requirements,
+      this.#providedArgs
+    );
+    return {
+      kind: "rwaOpenRequirements",
+      detail: { ...this.#detail, requirements, missing },
+      satisfied: !missing && requirements.securitizeTokensToRegister.length === 0
+    };
+  }
+  errorResult(error) {
+    return { kind: "rwaOpenRequirements", detail: this.#detail, error };
+  }
+}
+export {
+  RWAOpenRequirementsPrerequisite
+};

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

@@ -0,0 +1,33 @@
+import {
+  AssetsMap
+} from "../../sdk/index.js";
+import { allowanceAndBalance } from "./helpers.js";
+async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
+  const { sdk, wallet } = ctx;
+  const required = new AssetsMap();
+  for (const op of multicall) {
+    if (op.operation !== "AddCollateral" || op.amount === 0n) {
+      continue;
+    }
+    required.inc(op.token, op.amount);
+  }
+  if (required.size === 0) {
+    return [];
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const prereqs = [];
+  for (const [token, amount] of required.entries()) {
+    prereqs.push(
+      ...allowanceAndBalance({
+        token,
+        owner: wallet,
+        spender,
+        required: amount
+      })
+    );
+  }
+  return prereqs;
+}
+export {
+  buildCollateralPrerequisites
+};