@gearbox-protocol/sdk 14.12.0-next.36 → 14.12.0-next.38

package/dist/cjs/sdk/accounts/withdrawal-compressor/createRedemptionLogger.js

@@ -0,0 +1,43 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var createRedemptionLogger_exports = {};
+__export(createRedemptionLogger_exports, {
+  createRedemptionLogger: () => createRedemptionLogger
+});
+module.exports = __toCommonJS(createRedemptionLogger_exports);
+var import_constants = require("../../constants/index.js");
+var import_RedemptionLoggerV310Contract = require("./RedemptionLoggerV310Contract.js");
+function createRedemptionLogger(sdk) {
+  const latest = sdk.addressProvider.getLatest(
+    import_constants.AP_REDEMPTION_LOGGER,
+    import_constants.VERSION_RANGE_310
+  );
+  if (!latest) {
+    return void 0;
+  }
+  const [address, version] = latest;
+  if ((0, import_constants.isV310)(version)) {
+    return new import_RedemptionLoggerV310Contract.RedemptionLoggerV310Contract(sdk, address, version);
+  }
+  throw new Error(`Unsupported redemption logger version: ${version}`);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createRedemptionLogger
+});

package/dist/cjs/sdk/accounts/withdrawal-compressor/errors.js

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var errors_exports = {};
+__export(errors_exports, {
+  InvalidDelayedIntentError: () => InvalidDelayedIntentError
+});
+module.exports = __toCommonJS(errors_exports);
+class InvalidDelayedIntentError extends Error {
+  /** Raw `extraData` that failed to decode. */
+  extraData;
+  constructor(extraData, cause) {
+    super(`cannot decode delayed intent from extraData ${extraData}`, {
+      cause
+    });
+    this.name = "InvalidDelayedIntentError";
+    this.extraData = extraData;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  InvalidDelayedIntentError
+});

package/dist/cjs/sdk/accounts/withdrawal-compressor/index.js

@@ -17,8 +17,11 @@ var withdrawal_compressor_exports = {};
 module.exports = __toCommonJS(withdrawal_compressor_exports);
 __reExport(withdrawal_compressor_exports, require("./AbstractWithdrawalCompressorContract.js"), module.exports);
 __reExport(withdrawal_compressor_exports, require("./addresses.js"), module.exports);
+__reExport(withdrawal_compressor_exports, require("./createRedemptionLogger.js"), module.exports);
 __reExport(withdrawal_compressor_exports, require("./createWithdrawalCompressor.js"), module.exports);
+__reExport(withdrawal_compressor_exports, require("./errors.js"), module.exports);
 __reExport(withdrawal_compressor_exports, require("./intent-codec.js"), module.exports);
+__reExport(withdrawal_compressor_exports, require("./RedemptionLoggerV310Contract.js"), module.exports);
 __reExport(withdrawal_compressor_exports, require("./types.js"), module.exports);
 __reExport(withdrawal_compressor_exports, require("./WithdrawalCompressorV310Contract.js"), module.exports);
 __reExport(withdrawal_compressor_exports, require("./WithdrawalCompressorV311Contract.js"), module.exports);
@@ -27,8 +30,11 @@ __reExport(withdrawal_compressor_exports, require("./WithdrawalCompressorV313Con
 0 && (module.exports = {
   ...require("./AbstractWithdrawalCompressorContract.js"),
   ...require("./addresses.js"),
+  ...require("./createRedemptionLogger.js"),
   ...require("./createWithdrawalCompressor.js"),
+  ...require("./errors.js"),
   ...require("./intent-codec.js"),
+  ...require("./RedemptionLoggerV310Contract.js"),
   ...require("./types.js"),
   ...require("./WithdrawalCompressorV310Contract.js"),
   ...require("./WithdrawalCompressorV311Contract.js"),

package/dist/cjs/sdk/constants/address-provider.js

@@ -43,6 +43,7 @@ __export(address_provider_exports, {
   AP_PRICE_FEED_COMPRESSOR: () => AP_PRICE_FEED_COMPRESSOR,
   AP_PRICE_FEED_STORE: () => AP_PRICE_FEED_STORE,
   AP_PRICE_ORACLE: () => AP_PRICE_ORACLE,
+  AP_REDEMPTION_LOGGER: () => AP_REDEMPTION_LOGGER,
   AP_REWARDS_COMPRESSOR: () => AP_REWARDS_COMPRESSOR,
   AP_ROUTER: () => AP_ROUTER,
   AP_RWA_COMPRESSOR: () => AP_RWA_COMPRESSOR,
@@ -89,6 +90,7 @@ const AP_WETH_TOKEN = "WETH_TOKEN";
 const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
 const AP_RWA_COMPRESSOR = "GLOBAL::RWA_COMPRESSOR";
+const AP_REDEMPTION_LOGGER = "LOCAL::REDEMPTION_LOGGER";
 const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -117,6 +119,7 @@ const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
   AP_PRICE_FEED_COMPRESSOR,
   AP_PRICE_FEED_STORE,
   AP_PRICE_ORACLE,
+  AP_REDEMPTION_LOGGER,
   AP_REWARDS_COMPRESSOR,
   AP_ROUTER,
   AP_RWA_COMPRESSOR,

package/dist/esm/abi/IWithdrawalCompressorV313.js

@@ -153,6 +153,84 @@ const iWithdrawalCompressorV313Abi = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "getExternalAccountCurrentWithdrawals",
+    inputs: [
+      {
+        name: "withdrawalTokens",
+        type: "address[]",
+        internalType: "address[]"
+      },
+      { name: "account", type: "address", internalType: "address" }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct ClaimableWithdrawal[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            type: "address",
+            internalType: "address"
+          },
+          {
+            name: "withdrawalTokenSpent",
+            type: "uint256",
+            internalType: "uint256"
+          },
+          {
+            name: "outputs",
+            type: "tuple[]",
+            internalType: "struct WithdrawalOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "isDelayed", type: "bool", internalType: "bool" },
+              { name: "amount", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          {
+            name: "claimCalls",
+            type: "tuple[]",
+            internalType: "struct MultiCall[]",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "extraData", type: "bytes", internalType: "bytes" }
+        ]
+      },
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct PendingWithdrawal[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            type: "address",
+            internalType: "address"
+          },
+          {
+            name: "expectedOutputs",
+            type: "tuple[]",
+            internalType: "struct WithdrawalOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "isDelayed", type: "bool", internalType: "bool" },
+              { name: "amount", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          { name: "claimableAt", type: "uint256", internalType: "uint256" },
+          { name: "extraData", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "getWithdrawalStatus",

package/dist/esm/abi/iRedemptionLoggerV310.js

@@ -0,0 +1,95 @@
+const iRedemptionLoggerV310Abi = [
+  {
+    type: "function",
+    name: "allowedGateways",
+    inputs: [{ name: "gateway", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "logRedemption",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "redeemer", type: "address", internalType: "address" },
+      { name: "extraData", type: "bytes", internalType: "bytes" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "redemptionLogs",
+    inputs: [{ name: "redeemer", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct IRedemptionLogger.RedemptionLog",
+        components: [
+          { name: "creditAccount", type: "address", internalType: "address" },
+          { name: "redeemer", type: "address", internalType: "address" },
+          { name: "extraData", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "setGatewayAllowed",
+    inputs: [
+      { name: "gateway", type: "address", internalType: "address" },
+      { name: "allowed", type: "bool", internalType: "bool" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "event",
+    name: "RedemptionLogged",
+    inputs: [
+      {
+        name: "creditAccount",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "redeemer",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "extraData",
+        type: "bytes",
+        indexed: false,
+        internalType: "bytes"
+      }
+    ],
+    anonymous: false
+  },
+  {
+    type: "error",
+    name: "GatewayNotAllowedException",
+    inputs: []
+  }
+];
+export {
+  iRedemptionLoggerV310Abi
+};

package/dist/esm/plugins/adapters/contracts/AbstractAdapter.js

@@ -162,6 +162,18 @@ class AbstractAdapterContract extends BaseContract {
   parseDelayedWithdrawalRequest(_calldata) {
     return void 0;
   }
+  /**
+   * When the given adapter calldata is a delayed-withdrawal claim (a call
+   * created by the withdrawal compressor that burns a withdrawal phantom
+   * token and receives the claim token from a redeemer), returns its
+   * descriptor; `undefined` for any other call.
+   *
+   * The base implementation returns `undefined`; adapters whose gateways log
+   * redemption intents (Securitize, Midas) override it.
+   */
+  parseDelayedWithdrawalClaim(_calldata) {
+    return void 0;
+  }
   /**
    * Diff-call semantics of a diff-style adapter call: the call spends the
    * consumed token down to the exact `leftoverAmount` encoded in its

package/dist/esm/plugins/adapters/contracts/MidasGatewayAdapterContract.js

@@ -99,6 +99,18 @@ class MidasGatewayAdapterContract extends AbstractAdapterContract {
       extraData
     };
   }
+  /**
+   * `withdrawFromRedeemer(address redeemer, uint256 amount)` claims a matured
+   * redemption from a redeemer contract.
+   */
+  parseDelayedWithdrawalClaim(calldata) {
+    const decoded = decodeFunctionData({ abi: this.abi, data: calldata });
+    if (decoded.functionName !== "withdrawFromRedeemer") {
+      return void 0;
+    }
+    const [redeemer] = decoded.args;
+    return { redeemer };
+  }
   async applyBalanceChanges(balances, decoded) {
     switch (decoded.functionName) {
       case "depositInstantDiff": {

package/dist/esm/plugins/adapters/contracts/SecuritizeRedemptionGatewayAdapterContract.js

@@ -72,6 +72,22 @@ class SecuritizeRedemptionGatewayAdapterContract extends AbstractAdapterContract
       extraData
     };
   }
+  /**
+   * `claim(address[] redeemers)` claims matured redemptions from redeemer
+   * contracts. Transactions built by the withdrawal compressor always claim
+   * from a single redeemer, so only the first one is reported.
+   */
+  parseDelayedWithdrawalClaim(calldata) {
+    const decoded = decodeFunctionData({ abi: this.abi, data: calldata });
+    if (decoded.functionName !== "claim") {
+      return void 0;
+    }
+    const [redeemers] = decoded.args;
+    if (redeemers.length === 0) {
+      return void 0;
+    }
+    return { redeemer: redeemers[0] };
+  }
   async applyBalanceChanges(balances, decoded) {
     switch (decoded.functionName) {
       // no-op:

package/dist/esm/preview/preview/detectDelayedClaim.js

@@ -0,0 +1,30 @@
+import {
+  AbstractAdapterContract
+} from "../../plugins/adapters/index.js";
+function detectDelayedClaim(sdk, multicall) {
+  for (const op of multicall) {
+    if (op.operation !== "Execute") {
+      continue;
+    }
+    const adapter = sdk.getContract(op.adapter);
+    if (!(adapter instanceof AbstractAdapterContract)) {
+      continue;
+    }
+    const claim = adapter.parseDelayedWithdrawalClaim(op.calldata);
+    if (claim) {
+      return { adapter: op.adapter, redeemer: claim.redeemer };
+    }
+  }
+  return void 0;
+}
+async function resolveDelayedClaimIntent(sdk, multicall, blockNumber) {
+  const claim = detectDelayedClaim(sdk, multicall);
+  if (!claim) {
+    return void 0;
+  }
+  return sdk.redemptionLogger?.getDelayedIntent(claim.redeemer, blockNumber);
+}
+export {
+  detectDelayedClaim,
+  resolveDelayedClaimIntent
+};

package/dist/esm/preview/preview/detectDelayedOperation.js

@@ -3,9 +3,9 @@ import {
   AbstractAdapterContract
 } from "../../plugins/adapters/index.js";
 import {
-  decodeDelayedIntent
+  decodeDelayedIntent,
+  InvalidDelayedIntentError
 } from "../../sdk/index.js";
-import { InvalidDelayedIntentError } from "./errors.js";
 function detectDelayedOperation(sdk, multicall) {
   let bracketDeltas = [];
   for (const op of multicall) {
@@ -39,7 +39,7 @@ function detectDelayedOperation(sdk, multicall) {
       try {
         intent = decodeDelayedIntent(request.extraData);
       } catch (e) {
-        throw new InvalidDelayedIntentError(op.adapter, request.extraData, e);
+        throw new InvalidDelayedIntentError(request.extraData, e);
       }
     }
     return { request, intent };

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

@@ -7,22 +7,6 @@ class UnsupportedOperationError extends Error {
     this.operation = operation;
   }
 }
-class InvalidDelayedIntentError extends Error {
-  /** Adapter the withdrawal request was addressed to. */
-  adapter;
-  /** Raw `extraData` that failed to decode. */
-  extraData;
-  constructor(adapter, extraData, cause) {
-    super(
-      `cannot decode delayed intent from extraData ${extraData} of withdrawal request to adapter ${adapter}`,
-      { cause }
-    );
-    this.name = "InvalidDelayedIntentError";
-    this.adapter = adapter;
-    this.extraData = extraData;
-  }
-}
 export {
-  InvalidDelayedIntentError,
   UnsupportedOperationError
 };

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

@@ -1,6 +1,7 @@
 export * from "./buildDelayedPreview.js";
 export * from "./CreditAccountState.js";
 export * from "./detectCloseOrRepay.js";
+export * from "./detectDelayedClaim.js";
 export * from "./detectDelayedOperation.js";
 export * from "./errors.js";
 export * from "./previewAdjustCreditAccount.js";

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

@@ -4,6 +4,7 @@ import {
 } from "../parse/index.js";
 import { buildDelayedPreview } from "./buildDelayedPreview.js";
 import { isCloseOrRepay } from "./detectCloseOrRepay.js";
+import { resolveDelayedClaimIntent } from "./detectDelayedClaim.js";
 import { detectDelayedOperation } from "./detectDelayedOperation.js";
 import { UnsupportedOperationError } from "./errors.js";
 import { previewAdjustCreditAccount } from "./previewAdjustCreditAccount.js";
@@ -23,7 +24,18 @@ async function previewOperation(input, options) {
   }
   if (operation.operation === "CloseCreditAccount") {
     const resolved = await resolveCreditAccount(input, operation, options);
-    return previewCloseOrRepayCreditAccount(input, operation, true, resolved);
+    const preview = await previewCloseOrRepayCreditAccount(
+      input,
+      operation,
+      true,
+      resolved
+    );
+    preview.intent = await resolveDelayedClaimIntent(
+      input.sdk,
+      operation.multicall,
+      options?.blockNumber
+    );
+    return preview;
   }
   if (operation.operation === "MultiCall" || operation.operation === "BotMulticall" || operation.operation === "RWAMulticall") {
     const resolved = await resolveCreditAccount(input, operation, options);
@@ -49,6 +61,11 @@ async function previewMulticallOperation(input, operation, options) {
   const instantPreview = isCloseOrRepay(operation.multicall) ? await previewCloseOrRepayCreditAccount(input, operation, false, options) : await previewAdjustCreditAccount(input, operation, options);
   const delayed = detectDelayedOperation(sdk, operation.multicall);
   if (!delayed) {
+    instantPreview.intent = await resolveDelayedClaimIntent(
+      sdk,
+      operation.multicall,
+      options?.blockNumber
+    );
     return instantPreview;
   }
   const { before, after } = await replayMulticall(sdk, operation, options);

package/dist/esm/sdk/OnchainSDK.js

@@ -6,6 +6,7 @@ import {
 } from "viem";
 import {
   CreditAccountsServiceV310,
+  createRedemptionLogger,
   createWithdrawalCompressor,
   LiquidationsService
 } from "./accounts/index.js";
@@ -69,6 +70,7 @@ class OnchainSDK extends ChainContractsRegister {
   #marketRegister;
   #priceFeeds;
   #withdrawalCompressor;
+  #redemptionLogger;
   /**
    * Gas limit applied to read-only `eth_call` requests.
    **/
@@ -554,6 +556,16 @@ class OnchainSDK extends ChainContractsRegister {
   get withdrawalCompressor() {
     return this.#withdrawalCompressor;
   }
+  /**
+   * `RedemptionLogger` contract for the current chain, or `undefined` when
+   * it is not deployed on it. Created lazily on first access: the contract
+   * is resolved from the address provider, which is only available after
+   * the SDK is attached or hydrated.
+   **/
+  get redemptionLogger() {
+    this.#redemptionLogger ??= createRedemptionLogger(this);
+    return this.#redemptionLogger;
+  }
 }
 export {
   OnchainSDK,

package/dist/esm/sdk/accounts/withdrawal-compressor/AbstractWithdrawalCompressorContract.js

@@ -164,7 +164,7 @@ class AbstractWithdrawalCompressorContract extends BaseContract {
   /**
    * {@inheritDoc IWithdrawalCompressorContract.getExternalAccountCurrentWithdrawals}
    **/
-  async getExternalAccountCurrentWithdrawals(_withdrawalToken, _account) {
+  async getExternalAccountCurrentWithdrawals(_account, ..._withdrawalTokens) {
     this.#reportUnsupported("external account withdrawals");
     return { claimable: [], pending: [] };
   }

package/dist/esm/sdk/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.js

@@ -0,0 +1,48 @@
+import { iRedemptionLoggerV310Abi } from "../../../abi/iRedemptionLoggerV310.js";
+import { BaseContract } from "../../base/index.js";
+import { InvalidDelayedIntentError } from "./errors.js";
+import { decodeDelayedIntent } from "./intent-codec.js";
+const abi = iRedemptionLoggerV310Abi;
+class RedemptionLoggerV310Contract extends BaseContract {
+  constructor(sdk, address, version) {
+    super(sdk, {
+      addr: address,
+      name: "RedemptionLogger",
+      abi,
+      version
+    });
+  }
+  /**
+   * Returns the redemption data logged for a redeemer; all-zero fields when
+   * nothing was logged for it.
+   **/
+  async getRedemptionLog(redeemer, blockNumber) {
+    return this.contract.read.redemptionLogs([redeemer], {
+      blockNumber
+    });
+  }
+  /**
+   * Reads the redemption log of a redeemer and decodes the recorded intent.
+   *
+   * @param redeemer - Redeemer contract the withdrawal is claimed from.
+   * @param blockNumber - Optional block number to read the log at.
+   * @returns The decoded intent, or `undefined` when the log carries none
+   * (including when nothing was logged for the redeemer).
+   * @throws InvalidDelayedIntentError when the logged `extraData` is
+   * non-empty but cannot be decoded as a `DelayedIntent`.
+   **/
+  async getDelayedIntent(redeemer, blockNumber) {
+    const log = await this.getRedemptionLog(redeemer, blockNumber);
+    if (!log.extraData || log.extraData === "0x") {
+      return void 0;
+    }
+    try {
+      return decodeDelayedIntent(log.extraData);
+    } catch (e) {
+      throw new InvalidDelayedIntentError(log.extraData, e);
+    }
+  }
+}
+export {
+  RedemptionLoggerV310Contract
+};