@gearbox-protocol/sdk 10.2.10 → 10.3.0

package/dist/esm/abi/IWithdrawalCompressorV310.js

@@ -0,0 +1,160 @@
+const iWithdrawalCompressorV310Abi = [
+  {
+    type: "function",
+    inputs: [],
+    name: "contractType",
+    outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "creditAccount", internalType: "address", type: "address" }
+    ],
+    name: "getCurrentWithdrawals",
+    outputs: [
+      {
+        name: "",
+        internalType: "struct ClaimableWithdrawal[]",
+        type: "tuple[]",
+        components: [
+          { name: "token", internalType: "address", type: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            internalType: "address",
+            type: "address"
+          },
+          {
+            name: "withdrawalTokenSpent",
+            internalType: "uint256",
+            type: "uint256"
+          },
+          {
+            name: "outputs",
+            internalType: "struct WithdrawalOutput[]",
+            type: "tuple[]",
+            components: [
+              { name: "token", internalType: "address", type: "address" },
+              { name: "isDelayed", internalType: "bool", type: "bool" },
+              { name: "amount", internalType: "uint256", type: "uint256" }
+            ]
+          },
+          {
+            name: "claimCalls",
+            internalType: "struct MultiCall[]",
+            type: "tuple[]",
+            components: [
+              { name: "target", internalType: "address", type: "address" },
+              { name: "callData", internalType: "bytes", type: "bytes" }
+            ]
+          }
+        ]
+      },
+      {
+        name: "",
+        internalType: "struct PendingWithdrawal[]",
+        type: "tuple[]",
+        components: [
+          { name: "token", internalType: "address", type: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            internalType: "address",
+            type: "address"
+          },
+          {
+            name: "expectedOutputs",
+            internalType: "struct WithdrawalOutput[]",
+            type: "tuple[]",
+            components: [
+              { name: "token", internalType: "address", type: "address" },
+              { name: "isDelayed", internalType: "bool", type: "bool" },
+              { name: "amount", internalType: "uint256", type: "uint256" }
+            ]
+          },
+          { name: "claimableAt", internalType: "uint256", type: "uint256" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "creditManager", internalType: "address", type: "address" }
+    ],
+    name: "getWithdrawableAssets",
+    outputs: [
+      {
+        name: "",
+        internalType: "struct WithdrawableAsset[]",
+        type: "tuple[]",
+        components: [
+          { name: "token", internalType: "address", type: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            internalType: "address",
+            type: "address"
+          },
+          { name: "underlying", internalType: "address", type: "address" },
+          {
+            name: "withdrawalLength",
+            internalType: "uint256",
+            type: "uint256"
+          }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "creditAccount", internalType: "address", type: "address" },
+      { name: "token", internalType: "address", type: "address" },
+      { name: "amount", internalType: "uint256", type: "uint256" }
+    ],
+    name: "getWithdrawalRequestResult",
+    outputs: [
+      {
+        name: "",
+        internalType: "struct RequestableWithdrawal",
+        type: "tuple",
+        components: [
+          { name: "token", internalType: "address", type: "address" },
+          { name: "amountIn", internalType: "uint256", type: "uint256" },
+          {
+            name: "outputs",
+            internalType: "struct WithdrawalOutput[]",
+            type: "tuple[]",
+            components: [
+              { name: "token", internalType: "address", type: "address" },
+              { name: "isDelayed", internalType: "bool", type: "bool" },
+              { name: "amount", internalType: "uint256", type: "uint256" }
+            ]
+          },
+          {
+            name: "requestCalls",
+            internalType: "struct MultiCall[]",
+            type: "tuple[]",
+            components: [
+              { name: "target", internalType: "address", type: "address" },
+              { name: "callData", internalType: "bytes", type: "bytes" }
+            ]
+          },
+          { name: "claimableAt", internalType: "uint256", type: "uint256" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [],
+    name: "version",
+    outputs: [{ name: "", internalType: "uint256", type: "uint256" }],
+    stateMutability: "view"
+  }
+];
+export {
+  iWithdrawalCompressorV310Abi
+};

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

@@ -0,0 +1,85 @@
+import { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
+import {
+  AddressMap,
+  BasePlugin,
+  getWithdrawalCompressorAddress
+} from "../../sdk/index.js";
+const MAP_LABEL = "delayedWithdrawal";
+class DelayedWithdrawalPlugin extends BasePlugin {
+  #withdrawableAssets;
+  async load(force) {
+    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) => ({
+          abi: iWithdrawalCompressorV310Abi,
+          address: compressor,
+          functionName: "getWithdrawableAssets",
+          args: [cm.creditManager.address]
+        })
+      ) : [],
+      allowFailure: true
+    });
+    this.#withdrawableAssets = new AddressMap(void 0, MAP_LABEL);
+    resp.forEach((r, index) => {
+      const cm = creditManagers[index];
+      if (r.status === "success") {
+        this.#withdrawableAssets?.upsert(
+          cm.creditManager.address,
+          r.result.map((cfg) => ({
+            ...cfg,
+            creditManager: cm.creditManager.address
+          }))
+        );
+      } else {
+      }
+    });
+    return this.state;
+  }
+  get loaded() {
+    return !!this.#withdrawableAssets;
+  }
+  /**
+   * Returns a map of cmAddress -> array of delayed assets
+   * @throws if plugin is not attached
+   */
+  get withdrawableAssets() {
+    if (!this.#withdrawableAssets) {
+      throw new Error("withdrawable assets plugin not attached");
+    }
+    return this.#withdrawableAssets;
+  }
+  stateHuman(_) {
+    return this.withdrawableAssets.values().flatMap((cm) => {
+      const cmAssets = cm.map((a) => {
+        return {
+          address: a.creditManager,
+          version: this.version,
+          ...a
+        };
+      });
+      return cmAssets;
+    });
+  }
+  get state() {
+    return {
+      withdrawableAssets: this.withdrawableAssets.asRecord()
+    };
+  }
+  hydrate(state) {
+    this.#withdrawableAssets = new AddressMap(
+      Object.entries(state.withdrawableAssets),
+      MAP_LABEL
+    );
+  }
+}
+export {
+  DelayedWithdrawalPlugin
+};

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

@@ -0,0 +1,2 @@
+export * from "./DelayedWithdrawalPlugin.js";
+export * from "./types.js";

package/dist/esm/plugins/delayed-withdrawal/package.json

@@ -0,0 +1 @@
+{"type": "module","sideEffects":false}

package/dist/esm/sdk/accountMigration/AbstractMigrateCreditAccountsService.js

@@ -12,7 +12,7 @@ class AbstractMigrateCreditAccountsService extends SDKConstruct {
   #logger;
   #version;
   #service;
-  // TODO: any better way to handle this?
+  // TODO: HARDCODED
   static V300_TO_V310_TOKENS_OVERRIDES = {
     [CHAINS.Mainnet.id]: {
       // stkcvxRLUSD_USDC
@@ -23,17 +23,15 @@ class AbstractMigrateCreditAccountsService extends SDKConstruct {
       ["0xcB5D10A57Aeb622b92784D53F730eE2210ab370E".toLowerCase()]: "0x00F7C0d39B05089e93858A82439EA17dE7160B5a".toLowerCase()
     }
   };
+  // TODO: HARDCODED
   static accountMigratorBot = "0x286Fe53994f5668D56538Aa10eaa3Ac36f878e9C".toLowerCase();
-  // "0xc19ddEbDEB7Ba119eB9F23d079dcEaBC1B25B41f".toLowerCase() as Address;
+  // TODO: HARDCODED
   static accountMigratorPreviewer = "0x6523B8c9daB92eea7944a79b4Dbb598c7934DCca".toLowerCase();
-  // "0x5514de935f39AB0a137b4A1c984c872513C02f29".toLowerCase() as Address;
-  // "0xe6d2A2477722Af204899cfd3257A43aDAE1Ea264".toLowerCase() as Address;
-  // 0x99B63E7030e6f066731CF4e166e87D1D18e98B45.toLowerCase() as Address;
   constructor(sdk, version) {
     super(sdk);
     this.#version = version;
     this.#service = createCreditAccountService(this.sdk, version);
-    this.#logger = childLogger("CreditAccountsService", sdk.logger);
+    this.#logger = childLogger("MigrateCreditAccountsService", sdk.logger);
     this.#logger?.debug(
       `Created MigrateCreditAccountsService with version: ${this.#version}`
     );

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

@@ -3,6 +3,7 @@ import { iBotListV310Abi } from "../../abi/310/generated.js";
 import { creditAccountCompressorAbi } from "../../abi/compressors/creditAccountCompressor.js";
 import { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
 import { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
+import { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
 import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
 import {
   iBotListV300Abi,
@@ -22,10 +23,14 @@ import {
   RAY,
   VERSION_RANGE_310
 } from "../constants/index.js";
-import { BigIntMath } from "../index.js";
 import { assetsMap } from "../router/index.js";
+import { BigIntMath } from "../sdk-legacy/index.js";
 import { AddressMap, childLogger } from "../utils/index.js";
 import { simulateWithPriceUpdates } from "../utils/viem/index.js";
+function getWithdrawalCompressorAddress(chainId) {
+  const compressor = chainId === 1 ? "0xfB79b6713fe214B8748ED7b0db1f93E4f1aC9d29" : void 0;
+  return compressor;
+}
 class AbstractCreditAccountService extends SDKConstruct {
   #compressor;
   #batchSize;
@@ -478,34 +483,93 @@ class AbstractCreditAccountService extends SDKConstruct {
     const tx = cm.creditFacade.multicall(creditAccount.creditAccount, calls);
     return { tx, calls, creditFacade: cm.creditFacade };
   }
+  /**
+   * Preview delayed withdrawal for given token
+   * @param props - {@link PreviewDelayedWithdrawalProps}
+   * @returns
+   */
+  async previewDelayedWithdrawal({
+    creditAccount,
+    amount,
+    token
+  }) {
+    const compressor = getWithdrawalCompressorAddress(this.sdk.chainId);
+    if (!compressor)
+      throw new Error(
+        `No compressor for current chain ${this.sdk.networkType}`
+      );
+    const contract = getContract({
+      address: compressor,
+      abi: iWithdrawalCompressorV310Abi,
+      client: this.client
+    });
+    const resp = await contract.read.getWithdrawalRequestResult([
+      creditAccount,
+      token,
+      amount
+    ]);
+    return resp;
+  }
+  /**
+   * Get claimable and pending withdrawals of an account
+   * @param props - {@link GetPendingWithdrawalsProps}
+   * @returns
+   */
+  async getPendingWithdrawals({
+    creditAccount
+  }) {
+    const compressor = getWithdrawalCompressorAddress(this.sdk.chainId);
+    if (!compressor)
+      throw new Error(
+        `No compressor for current chain ${this.sdk.networkType}`
+      );
+    const contract = getContract({
+      address: compressor,
+      abi: iWithdrawalCompressorV310Abi,
+      client: this.client
+    });
+    const resp = await contract.read.getCurrentWithdrawals([creditAccount]);
+    const claimableNow = resp?.[0] || [];
+    const pendingResult = [...resp?.[1] || []].sort(
+      (a, b) => a.claimableAt < b.claimableAt ? -1 : 1
+    );
+    const respResult = {
+      claimableNow: [...claimableNow],
+      pending: pendingResult
+    };
+    return respResult;
+  }
   /**
    * Start delayed withdrawal for given token
      - Withdrawal is executed in the following order: price update -> execute withdraw calls -> update quotas
    * @param props - {@link StartDelayedWithdrawalProps}
    * @returns
   */
-  async startDelayedWithdrawal_Mellow({
+  async startDelayedWithdrawal({
     creditAccount,
     minQuota,
     averageQuota,
-    instantWithdrawals,
-    delayedWithdrawals,
-    sourceAmount,
-    sourceToken
+    preview
   }) {
     const cm = this.sdk.marketRegister.findCreditManager(
       creditAccount.creditManager
     );
-    const balances = [...instantWithdrawals, ...delayedWithdrawals].filter(
-      (a) => a.balance > 0
-    );
+    const record = preview.outputs.reduce((acc, o) => {
+      const token = o.token.toLowerCase();
+      acc[token] = (acc[token] || 0n) + o.amount;
+      return acc;
+    }, {});
+    const balances = Object.entries(record).filter(([, a]) => a > 10n);
     const storeExpectedBalances = {
       target: cm.creditFacade.address,
       callData: encodeFunctionData({
         abi: iCreditFacadeV300MulticallAbi,
         functionName: "storeExpectedBalances",
         args: [
-          balances.map((a) => ({ token: a.token, amount: a.balance - 10n }))
+          balances.map(([token, amount]) => ({
+            token,
+            amount: BigIntMath.max(0n, amount - 10n)
+          }))
         ]
       })
     };
@@ -522,38 +586,10 @@ class AbstractCreditAccountService extends SDKConstruct {
       creditAccount,
       desiredQuotas: averageQuota
     });
-    const mellowAdapter = cm.creditManager.adapters.mustGet(sourceToken);
-    const redeem = {
-      target: mellowAdapter.address,
-      callData: encodeFunctionData({
-        abi: ierc4626AdapterAbi,
-        functionName: "redeem",
-        args: [sourceAmount, ADDRESS_0X0, ADDRESS_0X0]
-      })
-    };
-    const CLAIMER = "0x25024a3017B8da7161d8c5DCcF768F8678fB5802";
-    const mellowClaimerAdapter = cm.creditManager.adapters.mustGet(CLAIMER);
-    const multiAcceptContract = getContract({
-      address: mellowClaimerAdapter.address,
-      abi: iMellowClaimerAdapterAbi,
-      client: this.client
-    });
-    const indices = await multiAcceptContract.read.getMultiVaultSubvaultIndices(
-      [sourceToken]
-    );
-    const multiaccept = {
-      target: mellowClaimerAdapter.address,
-      callData: encodeFunctionData({
-        abi: iMellowClaimerAdapterAbi,
-        functionName: "multiAccept",
-        args: [sourceToken, ...indices]
-      })
-    };
     const calls = [
       ...priceUpdatesCalls,
       storeExpectedBalances,
-      redeem,
-      multiaccept,
+      ...preview.requestCalls,
       compareBalances,
       ...this.prepareUpdateQuotas(creditAccount.creditFacade, {
         minQuota,
@@ -569,24 +605,35 @@ class AbstractCreditAccountService extends SDKConstruct {
    * @param props - {@link ClaimDelayedProps}
    * @returns
   */
-  async claimDelayed_Mellow({
+  async claimDelayed({
     creditAccount,
     minQuota,
     averageQuota,
-    sourceToken,
-    phantom,
-    target
+    claimableNow
   }) {
+    const zeroDebt = creditAccount.debt === 0n;
     const cm = this.sdk.marketRegister.findCreditManager(
       creditAccount.creditManager
     );
+    const record = claimableNow.outputs.reduce(
+      (acc, o) => {
+        const token = o.token.toLowerCase();
+        acc[token] = (acc[token] || 0n) + o.amount;
+        return acc;
+      },
+      {}
+    );
+    const balances = Object.entries(record).filter(([, a]) => a > 10n);
     const storeExpectedBalances = {
       target: cm.creditFacade.address,
       callData: encodeFunctionData({
         abi: iCreditFacadeV300MulticallAbi,
         functionName: "storeExpectedBalances",
         args: [
-          [target].map((a) => ({ token: a.token, amount: a.balance - 10n }))
+          balances.map(([token, amount]) => ({
+            token,
+            amount: BigIntMath.max(0n, amount - 10n)
+          }))
         ]
       })
     };
@@ -598,39 +645,21 @@ class AbstractCreditAccountService extends SDKConstruct {
         args: []
       })
     };
-    const priceUpdatesCalls = await this.getPriceUpdatesForFacade({
+    const priceUpdatesCalls = zeroDebt ? [] : await this.getPriceUpdatesForFacade({
       creditManager: creditAccount.creditManager,
       creditAccount,
       desiredQuotas: averageQuota
     });
-    const CLAIMER = "0x25024a3017B8da7161d8c5DCcF768F8678fB5802";
-    const mellowClaimerAdapter = cm.creditManager.adapters.mustGet(CLAIMER);
-    const multiAcceptContract = getContract({
-      address: mellowClaimerAdapter.address,
-      abi: iMellowClaimerAdapterAbi,
-      client: this.client
+    const quotaCalls = zeroDebt ? [] : this.prepareUpdateQuotas(creditAccount.creditFacade, {
+      minQuota,
+      averageQuota
     });
-    const indices = await multiAcceptContract.read.getUserSubvaultIndices([
-      sourceToken,
-      creditAccount.creditAccount
-    ]);
-    const multiaccept = {
-      target: mellowClaimerAdapter.address,
-      callData: encodeFunctionData({
-        abi: iMellowClaimerAdapterAbi,
-        functionName: "multiAcceptAndClaim",
-        args: [sourceToken, ...indices, ADDRESS_0X0, phantom.balance]
-      })
-    };
     const calls = [
       ...priceUpdatesCalls,
       storeExpectedBalances,
-      multiaccept,
+      ...claimableNow.claimCalls,
       compareBalances,
-      ...this.prepareUpdateQuotas(creditAccount.creditFacade, {
-        minQuota,
-        averageQuota
-      })
+      ...quotaCalls
     ];
     const tx = cm.creditFacade.multicall(creditAccount.creditAccount, calls);
     return { tx, calls, creditFacade: cm.creditFacade };
@@ -1134,19 +1163,7 @@ const iMellowClaimerAdapterAbi = [
     stateMutability: "nonpayable"
   }
 ];
-const ierc4626AdapterAbi = [
-  {
-    type: "function",
-    inputs: [
-      { name: "shares", internalType: "uint256", type: "uint256" },
-      { name: "", internalType: "address", type: "address" },
-      { name: "", internalType: "address", type: "address" }
-    ],
-    name: "redeem",
-    outputs: [{ name: "useSafePrices", internalType: "bool", type: "bool" }],
-    stateMutability: "nonpayable"
-  }
-];
 export {
-  AbstractCreditAccountService
+  AbstractCreditAccountService,
+  getWithdrawalCompressorAddress
 };