@gearbox-protocol/sdk 14.12.0-next.33 → 14.12.0-next.35

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

@@ -18,11 +18,16 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var AbstractWithdrawalCompressorContract_exports = {};
 __export(AbstractWithdrawalCompressorContract_exports, {
-  AbstractWithdrawalCompressorContract: () => AbstractWithdrawalCompressorContract
+  AbstractWithdrawalCompressorContract: () => AbstractWithdrawalCompressorContract,
+  iCreditAccountAbi: () => iCreditAccountAbi,
+  toClaimableWithdrawal: () => toClaimableWithdrawal,
+  toPendingWithdrawal: () => toPendingWithdrawal,
+  toRequestableWithdrawal: () => toRequestableWithdrawal
 });
 module.exports = __toCommonJS(AbstractWithdrawalCompressorContract_exports);
 var import_viem = require("viem");
 var import_base = require("../../base/index.js");
+var import_utils = require("../../utils/index.js");
 var import_intent_codec = require("./intent-codec.js");
 const iCreditAccountAbi = [
   {
@@ -33,12 +38,23 @@ const iCreditAccountAbi = [
     stateMutability: "view"
   }
 ];
+const MAP_LABEL = "withdrawableAssets";
 class AbstractWithdrawalCompressorContract extends import_base.BaseContract {
   #sdk;
+  #withdrawableAssets;
   constructor(sdk, args) {
     super(sdk, args);
     this.#sdk = sdk;
   }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.hydrate}
+   **/
+  hydrate(state) {
+    this.#withdrawableAssets = new import_utils.AddressMap(
+      Object.entries(state.withdrawableAssets),
+      MAP_LABEL
+    );
+  }
   /**
    * The contract is instantiated with the actual versioned ABI,
    * this cast is type-level only (see {@link CommonAbi}).
@@ -46,18 +62,35 @@ class AbstractWithdrawalCompressorContract extends import_base.BaseContract {
   get common() {
     return this.contract;
   }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.state}
+   **/
+  get state() {
+    return this.#withdrawableAssets ? { withdrawableAssets: this.#withdrawableAssets.asRecord() } : void 0;
+  }
   /**
    * {@inheritDoc IWithdrawalCompressorContract.getWithdrawableAssets}
    **/
-  async getWithdrawableAssets(creditManager) {
-    const resp = await this.common.read.getWithdrawableAssets([creditManager]);
-    return resp.map((a) => toWithdrawableAsset(a, creditManager));
+  getWithdrawableAssets(...creditManagers) {
+    const cache = this.#withdrawableAssets;
+    if (!cache) {
+      throw new Error(
+        "withdrawable assets are not loaded, call loadWithdrawableAssets first"
+      );
+    }
+    if (creditManagers.length === 0) {
+      return cache.values().flat();
+    }
+    return creditManagers.flatMap((cm) => cache.get(cm) ?? []);
   }
   /**
-   * {@inheritDoc IWithdrawalCompressorContract.getWithdrawableAssetsBatch}
+   * {@inheritDoc IWithdrawalCompressorContract.loadWithdrawableAssets}
    **/
-  async getWithdrawableAssetsBatch(creditManagers) {
-    const cms = creditManagers ?? this.#sdk.marketRegister.creditManagers.map(
+  async loadWithdrawableAssets(force) {
+    if (this.#withdrawableAssets && !force) {
+      return this.getWithdrawableAssets();
+    }
+    const cms = this.#sdk.marketRegister.creditManagers.map(
       (cm) => cm.creditManager.address
     );
     const resp = await this.client.multicall({
@@ -72,22 +105,48 @@ class AbstractWithdrawalCompressorContract extends import_base.BaseContract {
       allowFailure: true,
       batchSize: 0
     });
-    return resp.flatMap((r, i) => {
+    const cache = new import_utils.AddressMap(void 0, MAP_LABEL);
+    for (let i = 0; i < resp.length; i++) {
+      const r = resp[i];
       if (r.status !== "success") {
         this.logger?.warn(
           `failed to get withdrawable assets of credit manager ${cms[i]}: ${r.error}`
         );
-        return [];
+        continue;
       }
-      return r.result.map((a) => toWithdrawableAsset(a, cms[i]));
-    });
+      if (r.result.length > 0) {
+        cache.upsert(
+          cms[i],
+          r.result.map((a) => toWithdrawableAsset(a, cms[i]))
+        );
+      }
+    }
+    this.#withdrawableAssets = cache;
+    return this.getWithdrawableAssets();
+  }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.findWithdrawableAssets}
+   **/
+  async findWithdrawableAssets(creditManager, token) {
+    await this.loadWithdrawableAssets();
+    return this.getWithdrawableAssets(creditManager).filter(
+      (a) => (0, import_viem.isAddressEqual)(a.token, token)
+    );
+  }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.findWithdrawableAssetsByPhantomToken}
+   **/
+  async findWithdrawableAssetsByPhantomToken(withdrawalPhantomToken) {
+    await this.loadWithdrawableAssets();
+    return this.getWithdrawableAssets().filter(
+      (a) => (0, import_viem.isAddressEqual)(a.withdrawalPhantomToken, withdrawalPhantomToken)
+    );
   }
   /**
    * {@inheritDoc IWithdrawalCompressorContract.getWithdrawalPhantomToken}
    **/
   async getWithdrawalPhantomToken(creditManager, token) {
-    const assets = await this.getWithdrawableAssets(creditManager);
-    const asset = assets.find((a) => (0, import_viem.isAddressEqual)(a.token, token));
+    const [asset] = await this.findWithdrawableAssets(creditManager, token);
     if (!asset) {
       throw new Error(
         `token ${token} is not withdrawable from credit manager ${creditManager}`
@@ -95,6 +154,14 @@ class AbstractWithdrawalCompressorContract extends import_base.BaseContract {
     }
     return asset.withdrawalPhantomToken;
   }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.getWithdrawalSourceToken}
+   **/
+  getWithdrawalSourceToken(withdrawalPhantomToken) {
+    return this.getWithdrawableAssets().find(
+      (a) => (0, import_viem.isAddressEqual)(a.withdrawalPhantomToken, withdrawalPhantomToken)
+    )?.token;
+  }
   /**
    * {@inheritDoc IWithdrawalCompressorContract.getCurrentWithdrawals}
    **/
@@ -117,83 +184,80 @@ class AbstractWithdrawalCompressorContract extends import_base.BaseContract {
       batchSize: 0
     });
     return {
-      claimable: claimable.map(
-        (w) => toClaimableWithdrawal(w, creditManager, this.version >= 313)
-      ),
-      pending: pending.map((w) => toPendingWithdrawal(w, creditManager, this.version >= 313)).sort((a, b) => a.claimableAt < b.claimableAt ? -1 : 1)
+      claimable: claimable.map((w) => toClaimableWithdrawal(w, creditManager)),
+      pending: pending.map((w) => toPendingWithdrawal(w, creditManager)).sort((a, b) => a.claimableAt < b.claimableAt ? -1 : 1)
     };
   }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.getExternalAccountCurrentWithdrawals}
+   **/
+  async getExternalAccountCurrentWithdrawals(_withdrawalToken, _account) {
+    this.#reportUnsupported("external account withdrawals");
+    return { claimable: [], pending: [] };
+  }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.getWithdrawalStatus}
+   **/
+  async getWithdrawalStatus(...redeemers) {
+    if (redeemers.length === 0) {
+      return [];
+    }
+    this.#reportUnsupported("withdrawal status");
+    return redeemers.map(() => "NULL");
+  }
   /**
    * {@inheritDoc IWithdrawalCompressorContract.getWithdrawalRequestResult}
+   *
+   * Legacy compressors only support the 3-arg overload: `intent` and
+   * `withdrawalPhantomToken` are reported as unsupported (in non-strict mode
+   * the request is previewed without them).
    **/
-  async getWithdrawalRequestResult(creditAccount, token, amount, intent) {
-    const resp = intent ? await this.#getWithdrawalRequestResultWithIntent(
-      creditAccount,
-      token,
-      amount,
-      intent
-    ) : await this.common.read.getWithdrawalRequestResult([
+  async getWithdrawalRequestResult({
+    creditAccount,
+    token,
+    amount,
+    withdrawalPhantomToken,
+    intent
+  }) {
+    if (intent) {
+      this.#reportUnsupported("withdrawal intents");
+    } else if (withdrawalPhantomToken) {
+      this.#reportUnsupported("withdrawal config selection");
+    }
+    const resp = await this.common.read.getWithdrawalRequestResult([
       creditAccount,
       token,
       amount
     ]);
-    return {
-      token: resp.token,
-      amountIn: resp.amountIn,
-      outputs: [...resp.outputs],
-      requestCalls: [...resp.requestCalls],
-      claimableAt: resp.claimableAt
-    };
+    return toRequestableWithdrawal(resp);
   }
   /**
-   * Previews a delayed withdrawal request with an intent attached as
-   * `extraData`. Only supported on v313+ compressors; on older versions,
-   * throws if `sdk.strictContractTypes` is `true`, otherwise logs a warning
-   * and previews the request without the intent.
-   *
-   * The contract overload accepting `extraData` also requires the withdrawal
-   * phantom token, which is resolved here the same way the 3-arg overload
-   * does it internally: via `getWithdrawableAssets` of the account's credit
-   * manager.
+   * Reports that a feature is not supported by this compressor version:
+   * throws if `sdk.strictContractTypes` is `true`, otherwise logs a warning.
    **/
-  async #getWithdrawalRequestResultWithIntent(creditAccount, token, amount, intent) {
-    if (this.version < 313) {
-      const message = `withdrawal intents are not supported by ${this.name} v${this.version}`;
-      if (this.#sdk.strictContractTypes) {
-        throw new Error(message);
-      }
-      this.logger?.warn(`${message}, requesting withdrawal without intent`);
-      return this.common.read.getWithdrawalRequestResult([
-        creditAccount,
-        token,
-        amount
-      ]);
+  #reportUnsupported(feature) {
+    const message = `${feature} is not supported by ${this.name} v${this.version}`;
+    if (this.#sdk.strictContractTypes) {
+      throw new Error(message);
     }
-    const extraData = (0, import_intent_codec.encodeDelayedIntent)(intent);
-    const creditManager = await this.client.readContract({
-      address: creditAccount,
-      abi: iCreditAccountAbi,
-      functionName: "creditManager"
-    });
-    const withdrawalPhantomToken = await this.getWithdrawalPhantomToken(
-      creditManager,
-      token
-    );
-    return this.common.read.getWithdrawalRequestResult([
-      creditAccount,
-      token,
-      withdrawalPhantomToken,
-      amount,
-      extraData
-    ]);
+    this.logger?.warn(message);
   }
 }
 function toWithdrawableAsset(a, creditManager) {
   return { creditManager, ...a };
 }
-function toClaimableWithdrawal(w, creditManager, decodeIntent) {
+function toRequestableWithdrawal(resp) {
+  return {
+    token: resp.token,
+    amountIn: resp.amountIn,
+    outputs: [...resp.outputs],
+    requestCalls: [...resp.requestCalls],
+    claimableAt: resp.claimableAt
+  };
+}
+function toClaimableWithdrawal(w, creditManager) {
   let intent;
-  if (decodeIntent && w.extraData && w.extraData !== "0x") {
+  if (creditManager && w.extraData && w.extraData !== "0x") {
     intent = { ...(0, import_intent_codec.decodeDelayedIntent)(w.extraData), creditManager };
   }
   return {
@@ -205,9 +269,9 @@ function toClaimableWithdrawal(w, creditManager, decodeIntent) {
     intent
   };
 }
-function toPendingWithdrawal(w, creditManager, decodeIntent) {
+function toPendingWithdrawal(w, creditManager) {
   let intent;
-  if (decodeIntent && w.extraData && w.extraData !== "0x") {
+  if (creditManager && w.extraData && w.extraData !== "0x") {
     intent = { ...(0, import_intent_codec.decodeDelayedIntent)(w.extraData), creditManager };
   }
   return {
@@ -220,5 +284,9 @@ function toPendingWithdrawal(w, creditManager, decodeIntent) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  AbstractWithdrawalCompressorContract
+  AbstractWithdrawalCompressorContract,
+  iCreditAccountAbi,
+  toClaimableWithdrawal,
+  toPendingWithdrawal,
+  toRequestableWithdrawal
 });

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

@@ -23,7 +23,22 @@ __export(WithdrawalCompressorV313Contract_exports, {
 module.exports = __toCommonJS(WithdrawalCompressorV313Contract_exports);
 var import_IWithdrawalCompressorV313 = require("../../../abi/IWithdrawalCompressorV313.js");
 var import_AbstractWithdrawalCompressorContract = require("./AbstractWithdrawalCompressorContract.js");
+var import_intent_codec = require("./intent-codec.js");
+var import_types = require("./types.js");
 const abi = import_IWithdrawalCompressorV313.iWithdrawalCompressorV313Abi;
+const iWithdrawalStatusBatchAbi = [
+  {
+    type: "function",
+    name: "getWithdrawalStatus",
+    inputs: [
+      { name: "redeemers", type: "address[]", internalType: "address[]" }
+    ],
+    outputs: [
+      { name: "", type: "uint8[]", internalType: "enum WithdrawalStatus[]" }
+    ],
+    stateMutability: "view"
+  }
+];
 class WithdrawalCompressorV313Contract extends import_AbstractWithdrawalCompressorContract.AbstractWithdrawalCompressorContract {
   constructor(sdk, address) {
     super(sdk, {
@@ -33,6 +48,88 @@ class WithdrawalCompressorV313Contract extends import_AbstractWithdrawalCompress
       version: 313
     });
   }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.getExternalAccountCurrentWithdrawals}
+   **/
+  async getExternalAccountCurrentWithdrawals(withdrawalToken, account) {
+    const [claimable, pending] = await this.contract.read.getExternalAccountCurrentWithdrawals([
+      withdrawalToken,
+      account
+    ]);
+    return {
+      claimable: claimable.map((w) => (0, import_AbstractWithdrawalCompressorContract.toClaimableWithdrawal)(w, void 0)),
+      pending: pending.map((w) => (0, import_AbstractWithdrawalCompressorContract.toPendingWithdrawal)(w, void 0)).sort((a, b) => a.claimableAt < b.claimableAt ? -1 : 1)
+    };
+  }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.getWithdrawalStatus}
+   **/
+  async getWithdrawalStatus(...redeemers) {
+    if (redeemers.length === 0) {
+      return [];
+    }
+    const resp = await this.client.readContract({
+      address: this.address,
+      abi: iWithdrawalStatusBatchAbi,
+      functionName: "getWithdrawalStatus",
+      args: [redeemers]
+    });
+    return resp.map((s) => (0, import_types.toWithdrawalStatus)(s));
+  }
+  /**
+   * {@inheritDoc IWithdrawalCompressorContract.getWithdrawalRequestResult}
+   *
+   * When an intent is provided, it is abi-encoded and attached to the request
+   * as `extraData`. The contract overload accepting `extraData` also requires
+   * the withdrawal phantom token; when not provided by the caller, it is
+   * resolved the same way the 3-arg overload does it internally: via the
+   * withdrawable assets of the account's credit manager.
+   **/
+  async getWithdrawalRequestResult({
+    creditAccount,
+    token,
+    amount,
+    withdrawalPhantomToken,
+    intent
+  }) {
+    let resp;
+    if (intent) {
+      const extraData = (0, import_intent_codec.encodeDelayedIntent)(intent);
+      let phantomToken = withdrawalPhantomToken;
+      if (!phantomToken) {
+        const creditManager = await this.client.readContract({
+          address: creditAccount,
+          abi: import_AbstractWithdrawalCompressorContract.iCreditAccountAbi,
+          functionName: "creditManager"
+        });
+        phantomToken = await this.getWithdrawalPhantomToken(
+          creditManager,
+          token
+        );
+      }
+      resp = await this.contract.read.getWithdrawalRequestResult([
+        creditAccount,
+        token,
+        phantomToken,
+        amount,
+        extraData
+      ]);
+    } else if (withdrawalPhantomToken) {
+      resp = await this.contract.read.getWithdrawalRequestResult([
+        creditAccount,
+        token,
+        withdrawalPhantomToken,
+        amount
+      ]);
+    } else {
+      resp = await this.contract.read.getWithdrawalRequestResult([
+        creditAccount,
+        token,
+        amount
+      ]);
+    }
+    return (0, import_AbstractWithdrawalCompressorContract.toRequestableWithdrawal)(resp);
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

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

@@ -28,13 +28,7 @@ var import_WithdrawalCompressorV313Contract = require("./WithdrawalCompressorV31
 function createWithdrawalCompressor(sdk) {
   const location = (0, import_addresses.getWithdrawalCompressorAddress)(sdk.networkType);
   if (!location) {
-    throw new Error(`no withdrawal compressor on ${sdk.networkType}`);
-  }
-  const cached = sdk.getContract(
-    location.address
-  );
-  if (cached) {
-    return cached;
+    return void 0;
   }
   switch (location.version) {
     case 310:

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

@@ -3,6 +3,10 @@ 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))
@@ -13,4 +17,20 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var types_exports = {};
+__export(types_exports, {
+  toWithdrawalStatus: () => toWithdrawalStatus
+});
 module.exports = __toCommonJS(types_exports);
+const WITHDRAWAL_STATUSES = [
+  "NULL",
+  "PENDING",
+  "CLAIMABLE",
+  "CLAIMED"
+];
+function toWithdrawalStatus(status) {
+  return WITHDRAWAL_STATUSES[status] ?? "NULL";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  toWithdrawalStatus
+});

package/dist/esm/abi/IWithdrawalCompressorV313.js

@@ -79,6 +79,100 @@ const iWithdrawalCompressorV313Abi = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "getExternalAccountCurrentWithdrawals",
+    inputs: [
+      { name: "withdrawalToken", 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",
+    inputs: [{ name: "redeemer", type: "address", internalType: "address" }],
+    outputs: [
+      { name: "", type: "uint8", internalType: "enum WithdrawalStatus" }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getWithdrawalStatus",
+    inputs: [
+      { name: "redeemers", type: "address[]", internalType: "address[]" }
+    ],
+    outputs: [
+      { name: "", type: "uint8[]", internalType: "enum WithdrawalStatus[]" }
+    ],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "getWithdrawableAssets",
@@ -152,6 +246,48 @@ const iWithdrawalCompressorV313Abi = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "getWithdrawalRequestResult",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "token", type: "address", internalType: "address" },
+      { name: "withdrawalToken", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct RequestableWithdrawal",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          { name: "amountIn", 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: "requestCalls",
+            type: "tuple[]",
+            internalType: "struct MultiCall[]",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "claimableAt", type: "uint256", internalType: "uint256" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "getWithdrawalRequestResult",