@gearbox-protocol/sdk 14.12.0-next.47 → 14.12.0-next.49

package/dist/cjs/sdk/accounts/liquidations/LiquidationsService.js

@@ -21,18 +21,17 @@ __export(LiquidationsService_exports, {
   LiquidationsService: () => LiquidationsService
 });
 module.exports = __toCommonJS(LiquidationsService_exports);
+var import_ILiquidationCompressorV313 = require("../../../abi/ILiquidationCompressorV313.js");
 var import_base = require("../../base/index.js");
 var import_constants = require("../../constants/index.js");
 var import_utils = require("../../utils/index.js");
+var import_constants2 = require("./constants.js");
 var import_helpers = require("./helpers.js");
 class LiquidationsService extends import_base.SDKConstruct {
   /**
    * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
    **/
   async getLiquidatableAccounts(props) {
-    if (props?.networks && !props.networks.includes(this.sdk.networkType)) {
-      return [];
-    }
     await this.sdk.withdrawalCompressor?.loadWithdrawableAssets();
     const accounts = await this.sdk.accounts.getCreditAccounts({
       maxHealthFactor: import_constants.WAD - 1n,
@@ -67,67 +66,58 @@ class LiquidationsService extends import_base.SDKConstruct {
    * {@inheritDoc ILiquidationsService.getLiquidationDetails}
    **/
   async getLiquidationDetails(props) {
-    const { network, creditAccount } = props;
-    if (network !== this.sdk.networkType) {
-      throw new Error(
-        `network mismatch: this SDK is attached to ${this.sdk.networkType}, requested ${network}`
-      );
-    }
-    const ca = await this.sdk.accounts.getCreditAccountData(creditAccount);
-    if (!ca) {
-      throw new Error(`credit account ${creditAccount} not found`);
-    }
-    if (!ca.success) {
-      throw new Error(
-        `cannot compute liquidation details for ${creditAccount}: collateral computation failed`
-      );
-    }
-    const compressor = this.sdk.withdrawalCompressor;
-    await compressor?.loadWithdrawableAssets();
+    const { creditAccount, liquidator, ignoreReservePrices } = props;
+    const ca = await this.#getCreditAccountData(creditAccount);
+    await this.sdk.withdrawalCompressor?.loadWithdrawableAssets();
     const account = this.#buildAccount(ca);
-    const receivedAssets = [];
-    for (const t of ca.tokens) {
-      if (t.balance > import_helpers.DUST_THRESHOLD && !compressor?.getWithdrawalSourceToken(t.token)) {
-        receivedAssets.push({
-          isDelayed: false,
-          token: t.token,
-          amount: t.balance
-        });
-      }
-    }
-    if (account.isDelayed && compressor) {
-      const { claimable, pending } = await compressor.getCurrentWithdrawals(creditAccount);
-      for (const w of claimable) {
-        for (const o of w.outputs) {
-          receivedAssets.push({
-            isDelayed: true,
-            token: o.token,
-            amount: o.amount,
-            sourceToken: w.token
-          });
-        }
-      }
-      for (const w of pending) {
-        for (const o of w.expectedOutputs) {
-          receivedAssets.push({
-            isDelayed: true,
-            token: o.token,
-            amount: o.amount,
-            sourceToken: w.token,
-            claimableAt: w.claimableAt
-          });
-        }
-      }
-    }
-    return { ...account, receivedAssets };
+    const data = await this.#getLiquidationData(
+      ca,
+      liquidator,
+      ignoreReservePrices
+    );
+    const suite = this.sdk.marketRegister.findCreditManager(ca.creditManager);
+    return {
+      ...account,
+      // the compressor reports the exact amounts of the liquidation path it
+      // selected, which supersede the estimates of the list row
+      repaymentAmount: {
+        token: account.totalValue.token,
+        balance: data.requiredUnderlyingAmount
+      },
+      isDelayed: data.expectedOutputs.some((o) => o.delayed),
+      receivedAssets: (0, import_helpers.toReceivedAssets)(data.expectedOutputs),
+      isLiquidatorEligible: data.isLiquidatorEligible,
+      kycProtocol: data.kycProtocol || void 0,
+      kycToken: (0, import_utils.hexEq)(data.kycToken, import_constants.ADDRESS_0X0) ? void 0 : data.kycToken,
+      approve: (0, import_helpers.toLiquidationApproval)({
+        target: data.liquidationCall.target,
+        creditFacade: suite.creditFacade.address,
+        creditManager: ca.creditManager,
+        token: suite.underlying,
+        amount: data.requiredUnderlyingAmount
+      })
+    };
+  }
+  /**
+   * {@inheritDoc ILiquidationsService.buildLiquidationTx}
+   **/
+  async buildLiquidationTx(props) {
+    const { creditAccount, liquidator, ignoreReservePrices } = props;
+    const ca = await this.#getCreditAccountData(creditAccount);
+    const data = await this.#getLiquidationData(
+      ca,
+      liquidator,
+      ignoreReservePrices
+    );
+    return (0, import_helpers.liquidationCallToRawTx)(
+      data.liquidationCall,
+      `liquidate credit account ${this.labelAddress(creditAccount)} to ${this.labelAddress(liquidator)}`
+    );
   }
   /**
    * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
    **/
   async getLiquidatorWithdrawals(props) {
-    if (props.networks && !props.networks.includes(this.sdk.networkType)) {
-      return [];
-    }
     const compressor = this.sdk.withdrawalCompressor;
     if (!compressor) {
       return [];
@@ -142,6 +132,39 @@ class LiquidationsService extends import_base.SDKConstruct {
     );
     return (0, import_helpers.toLiquidatorWithdrawals)(current, this.sdk.networkType);
   }
+  async #getCreditAccountData(creditAccount) {
+    const ca = await this.sdk.accounts.getCreditAccountData(creditAccount);
+    if (!ca) {
+      throw new Error(`credit account ${creditAccount} not found`);
+    }
+    if (!ca.success) {
+      throw new Error(
+        `cannot compute liquidation details for ${creditAccount}: collateral computation failed`
+      );
+    }
+    return ca;
+  }
+  /**
+   * Previews the liquidation via the liquidation compressor.
+   *
+   * @param ca - Credit account to liquidate
+   * @param liquidator - Liquidator wallet, zero address when not known: it only
+   * affects the KYC eligibility fields and the receiver encoded into the calls
+   * @param ignoreReservePrices - Exclude reserve price feeds from the updates
+   **/
+  async #getLiquidationData(ca, liquidator = import_constants.ADDRESS_0X0, ignoreReservePrices) {
+    const priceUpdates = await this.sdk.accounts.getOnDemandPriceUpdates(
+      ca,
+      ignoreReservePrices
+    );
+    const { result } = await this.client.simulateContract({
+      address: import_constants2.LIQUIDATION_COMPRESSOR_V313_ADDRESS,
+      abi: import_ILiquidationCompressorV313.iLiquidationCompressorV313Abi,
+      functionName: "getLiquidationData",
+      args: [liquidator, ca.creditAccount, priceUpdates]
+    });
+    return result;
+  }
   /**
    * Accounts of expired credit managers with outstanding debt are liquidatable
    * regardless of their health factor.

package/dist/cjs/sdk/accounts/liquidations/MultichainLiquidationsService.js

@@ -58,6 +58,12 @@ class MultichainLiquidationsService {
   async getLiquidationDetails(props) {
     return this.#sdk.chain(props.network).liquidations.getLiquidationDetails(props);
   }
+  /**
+   * {@inheritDoc ILiquidationsService.buildLiquidationTx}
+   **/
+  async buildLiquidationTx(props) {
+    return this.#sdk.chain(props.network).liquidations.buildLiquidationTx(props);
+  }
   /**
    * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
    **/

package/dist/cjs/sdk/accounts/liquidations/constants.js

@@ -0,0 +1,29 @@
+"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 constants_exports = {};
+__export(constants_exports, {
+  LIQUIDATION_COMPRESSOR_V313_ADDRESS: () => LIQUIDATION_COMPRESSOR_V313_ADDRESS
+});
+module.exports = __toCommonJS(constants_exports);
+var import_constants = require("../../constants/index.js");
+const LIQUIDATION_COMPRESSOR_V313_ADDRESS = import_constants.ADDRESS_0X0;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LIQUIDATION_COMPRESSOR_V313_ADDRESS
+});

package/dist/cjs/sdk/accounts/liquidations/helpers.js

@@ -21,10 +21,14 @@ __export(helpers_exports, {
   DUST_THRESHOLD: () => DUST_THRESHOLD,
   calcEstimatedProfit: () => calcEstimatedProfit,
   calcRepaymentAmount: () => calcRepaymentAmount,
+  liquidationCallToRawTx: () => liquidationCallToRawTx,
   pickMainAsset: () => pickMainAsset,
-  toLiquidatorWithdrawals: () => toLiquidatorWithdrawals
+  toLiquidationApproval: () => toLiquidationApproval,
+  toLiquidatorWithdrawals: () => toLiquidatorWithdrawals,
+  toReceivedAssets: () => toReceivedAssets
 });
 module.exports = __toCommonJS(helpers_exports);
+var import_viem = require("viem");
 var import_constants = require("../../constants/index.js");
 var import_utils = require("../../utils/index.js");
 const DUST_THRESHOLD = 10n;
@@ -80,11 +84,54 @@ function toLiquidatorWithdrawals(current, network) {
   }
   return rows;
 }
+function toReceivedAssets(outputs) {
+  return outputs.map((o) => {
+    if (!o.delayed) {
+      return { isDelayed: false, token: o.token, amount: o.amount };
+    }
+    return {
+      isDelayed: true,
+      token: o.token,
+      amount: o.amount,
+      redeemerAddress: (0, import_utils.hexEq)(o.redeemerAddress, import_constants.ADDRESS_0X0) ? void 0 : o.redeemerAddress,
+      claimableAt: o.claimableAt === 0n ? void 0 : o.claimableAt
+    };
+  });
+}
+function toLiquidationApproval(props) {
+  const { target, creditFacade, creditManager, token, amount } = props;
+  if (amount === 0n) {
+    return void 0;
+  }
+  return {
+    spender: (0, import_utils.hexEq)(target, creditFacade) ? creditManager : target,
+    token,
+    amount
+  };
+}
+function liquidationCallToRawTx(call, description) {
+  return {
+    to: call.target,
+    value: "0",
+    signature: "",
+    callData: call.callData,
+    contractMethod: {
+      name: (0, import_viem.slice)(call.callData, 0, 4),
+      inputs: [],
+      payable: false
+    },
+    contractInputsValues: {},
+    description
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DUST_THRESHOLD,
   calcEstimatedProfit,
   calcRepaymentAmount,
+  liquidationCallToRawTx,
   pickMainAsset,
-  toLiquidatorWithdrawals
+  toLiquidationApproval,
+  toLiquidatorWithdrawals,
+  toReceivedAssets
 });

package/dist/cjs/sdk/accounts/liquidations/index.js

@@ -15,13 +15,13 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var liquidations_exports = {};
 module.exports = __toCommonJS(liquidations_exports);
-__reExport(liquidations_exports, require("./helpers.js"), module.exports);
+__reExport(liquidations_exports, require("./constants.js"), module.exports);
 __reExport(liquidations_exports, require("./LiquidationsService.js"), module.exports);
 __reExport(liquidations_exports, require("./MultichainLiquidationsService.js"), module.exports);
 __reExport(liquidations_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./helpers.js"),
+  ...require("./constants.js"),
   ...require("./LiquidationsService.js"),
   ...require("./MultichainLiquidationsService.js"),
   ...require("./types.js")

package/dist/esm/abi/ILiquidationCompressorV313.js

@@ -0,0 +1,79 @@
+const iLiquidationCompressorV313Abi = [
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getLiquidationData",
+    inputs: [
+      { name: "liquidator", type: "address", internalType: "address" },
+      { name: "creditAccount", type: "address", internalType: "address" },
+      {
+        name: "priceUpdates",
+        type: "tuple[]",
+        internalType: "struct PriceUpdate[]",
+        components: [
+          { name: "priceFeed", type: "address", internalType: "address" },
+          { name: "data", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct LiquidationData",
+        components: [
+          {
+            name: "requiredUnderlyingAmount",
+            type: "uint256",
+            internalType: "uint256"
+          },
+          {
+            name: "expectedOutputs",
+            type: "tuple[]",
+            internalType: "struct LiquidationOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "amount", type: "uint256", internalType: "uint256" },
+              { name: "delayed", type: "bool", internalType: "bool" },
+              {
+                name: "redeemerAddress",
+                type: "address",
+                internalType: "address"
+              },
+              { name: "claimableAt", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          {
+            name: "liquidationCall",
+            type: "tuple",
+            internalType: "struct MultiCall",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "isLiquidatorEligible", type: "bool", internalType: "bool" },
+          { name: "kycProtocol", type: "string", internalType: "string" },
+          { name: "kycToken", type: "address", internalType: "address" }
+        ]
+      }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  }
+];
+export {
+  iLiquidationCompressorV313Abi
+};

package/dist/esm/abi/compressors/liquidationCompressor.js

@@ -0,0 +1,191 @@
+const liquidationCompressorAbi = [
+  {
+    type: "constructor",
+    inputs: [
+      { name: "_owner", type: "address", internalType: "address" },
+      { name: "addressProvider_", type: "address", internalType: "address" }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "addressProvider",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "compressorTypeToCompressor",
+    inputs: [
+      { name: "", type: "bytes32", internalType: "bytes32" },
+      { name: "", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getLiquidationData",
+    inputs: [
+      { name: "liquidator", type: "address", internalType: "address" },
+      { name: "creditAccount", type: "address", internalType: "address" },
+      {
+        name: "priceUpdates",
+        type: "tuple[]",
+        internalType: "struct PriceUpdate[]",
+        components: [
+          { name: "priceFeed", type: "address", internalType: "address" },
+          { name: "data", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct LiquidationData",
+        components: [
+          {
+            name: "requiredUnderlyingAmount",
+            type: "uint256",
+            internalType: "uint256"
+          },
+          {
+            name: "expectedOutputs",
+            type: "tuple[]",
+            internalType: "struct LiquidationOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "amount", type: "uint256", internalType: "uint256" },
+              { name: "delayed", type: "bool", internalType: "bool" },
+              {
+                name: "redeemerAddress",
+                type: "address",
+                internalType: "address"
+              },
+              { name: "claimableAt", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          {
+            name: "liquidationCall",
+            type: "tuple",
+            internalType: "struct MultiCall",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "isLiquidatorEligible", type: "bool", internalType: "bool" },
+          { name: "kycProtocol", type: "string", internalType: "string" },
+          { name: "kycToken", type: "address", internalType: "address" }
+        ]
+      }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "liquidatableTypeToCompressorType",
+    inputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "liquidatableTypeToSpecificCompressorVersion",
+    inputs: [
+      { name: "", type: "bytes32", internalType: "bytes32" },
+      { name: "", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "owner",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "renounceOwnership",
+    inputs: [],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "setLiquidatableTypeToCompressorType",
+    inputs: [
+      { name: "liquidatableType", type: "bytes32", internalType: "bytes32" },
+      { name: "compressorType", type: "bytes32", internalType: "bytes32" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "setLiquidatableVersionToSpecificCompressorVersion",
+    inputs: [
+      { name: "liquidatableType", type: "bytes32", internalType: "bytes32" },
+      { name: "liquidatableVersion", type: "uint256", internalType: "uint256" },
+      { name: "compressorVersion", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "setSubcompressor",
+    inputs: [
+      { name: "subcompressor", type: "address", internalType: "address" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "transferOwnership",
+    inputs: [{ name: "newOwner", type: "address", internalType: "address" }],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "event",
+    name: "OwnershipTransferred",
+    inputs: [
+      {
+        name: "previousOwner",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "newOwner",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      }
+    ],
+    anonymous: false
+  }
+];
+export {
+  liquidationCompressorAbi
+};

package/dist/esm/abi/compressors/subcompressors/liquidation/midasLiquidationSubcompressor.js

@@ -0,0 +1,80 @@
+const midasLiquidationSubcompressorAbi = [
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getLiquidationData",
+    inputs: [
+      { name: "liquidator", type: "address", internalType: "address" },
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "phantomToken", type: "address", internalType: "address" },
+      {
+        name: "priceUpdates",
+        type: "tuple[]",
+        internalType: "struct PriceUpdate[]",
+        components: [
+          { name: "priceFeed", type: "address", internalType: "address" },
+          { name: "data", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    outputs: [
+      {
+        name: "data",
+        type: "tuple",
+        internalType: "struct LiquidationData",
+        components: [
+          {
+            name: "requiredUnderlyingAmount",
+            type: "uint256",
+            internalType: "uint256"
+          },
+          {
+            name: "expectedOutputs",
+            type: "tuple[]",
+            internalType: "struct LiquidationOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "amount", type: "uint256", internalType: "uint256" },
+              { name: "delayed", type: "bool", internalType: "bool" },
+              {
+                name: "redeemerAddress",
+                type: "address",
+                internalType: "address"
+              },
+              { name: "claimableAt", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          {
+            name: "liquidationCall",
+            type: "tuple",
+            internalType: "struct MultiCall",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "isLiquidatorEligible", type: "bool", internalType: "bool" },
+          { name: "kycProtocol", type: "string", internalType: "string" },
+          { name: "kycToken", type: "address", internalType: "address" }
+        ]
+      }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  }
+];
+export {
+  midasLiquidationSubcompressorAbi
+};