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

package/dist/esm/plugins/adapters/abi/midas/iMidasGatewayV311.js

@@ -0,0 +1,170 @@
+const iMidasGatewayV311Abi = [
+  {
+    type: "function",
+    name: "accessControl",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "contractType",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "depositInstant",
+    inputs: [
+      { name: "amountToken", type: "uint256", internalType: "uint256" },
+      { name: "minReceiveAmount", type: "uint256", internalType: "uint256" },
+      { name: "referrerId", type: "bytes32", internalType: "bytes32" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "isEligibleAccountOwner",
+    inputs: [{ name: "account", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "mToken",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "mode",
+    inputs: [],
+    outputs: [{ name: "", type: "uint8", internalType: "enum MidasMode" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "pendingAndClaimableTokenOutAmounts",
+    inputs: [{ name: "account", type: "address", internalType: "address" }],
+    outputs: [
+      { name: "pendingAmount", type: "uint256", internalType: "uint256" },
+      { name: "claimableAmount", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "pendingRedeemers",
+    inputs: [{ name: "account", type: "address", internalType: "address" }],
+    outputs: [
+      { name: "redeemers", type: "address[]", internalType: "address[]" }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "phantomToken",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "quoteToken",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "redeemInstant",
+    inputs: [
+      { name: "amountMTokenIn", type: "uint256", internalType: "uint256" },
+      { name: "minReceiveAmount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "redemptionLogger",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "requestRedeem",
+    inputs: [
+      { name: "amountMTokenIn", type: "uint256", internalType: "uint256" },
+      { name: "extraData", type: "bytes", internalType: "bytes" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "transferMaster",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "transferRedeemer",
+    inputs: [
+      { name: "redeemer", type: "address", internalType: "address" },
+      { name: "newAccount", type: "address", internalType: "address" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "withdraw",
+    inputs: [{ name: "amount", type: "uint256", internalType: "uint256" }],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "withdrawFromRedeemer",
+    inputs: [
+      { name: "redeemer", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  { type: "error", name: "AccessControlNotSetException", inputs: [] },
+  {
+    type: "error",
+    name: "ArbitraryCAAllowedInPermissionedModeException",
+    inputs: []
+  },
+  { type: "error", name: "CreditAccountNotEligibleException", inputs: [] },
+  { type: "error", name: "IncompatibleAccessControlsException", inputs: [] },
+  {
+    type: "error",
+    name: "IncompatibleIssuanceAndRedemptionVaultsException",
+    inputs: []
+  },
+  { type: "error", name: "InsufficientBalanceException", inputs: [] },
+  { type: "error", name: "MaxPendingRedeemersPerAccountException", inputs: [] },
+  { type: "error", name: "NewAccountNotGreenlistedException", inputs: [] },
+  { type: "error", name: "RedeemerNotOwnedByAccountException", inputs: [] },
+  { type: "error", name: "RedeemerTransferNotAllowedException", inputs: [] }
+];
+export {
+  iMidasGatewayV311Abi
+};

package/dist/esm/plugins/adapters/abi/midas/index.js

@@ -0,0 +1 @@
+export * from "./iMidasGatewayV311.js";

package/dist/esm/plugins/adapters/abi/securitize/iSecuritizeRedemptionGatewayV311.js

@@ -3,7 +3,11 @@ const iSecuritizeRedemptionGatewayV311Abi = [
     type: "function",
     name: "claim",
     inputs: [
-      { name: "redeemers", type: "address[]", internalType: "address[]" }
+      {
+        name: "redeemers",
+        type: "address[]",
+        internalType: "address[]"
+      }
     ],
     outputs: [],
     stateMutability: "nonpayable"
@@ -12,57 +16,157 @@ const iSecuritizeRedemptionGatewayV311Abi = [
     type: "function",
     name: "contractType",
     inputs: [],
-    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    outputs: [
+      {
+        name: "",
+        type: "bytes32",
+        internalType: "bytes32"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "dsToken",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "getRedeemers",
-    inputs: [{ name: "account", type: "address", internalType: "address" }],
-    outputs: [{ name: "", type: "address[]", internalType: "address[]" }],
+    inputs: [
+      {
+        name: "account",
+        type: "address",
+        internalType: "address"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "address[]",
+        internalType: "address[]"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "getRedemptionAmount",
-    inputs: [{ name: "account", type: "address", internalType: "address" }],
-    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    inputs: [
+      {
+        name: "account",
+        type: "address",
+        internalType: "address"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "uint256",
+        internalType: "uint256"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "getUnclaimedRedeemers",
-    inputs: [{ name: "account", type: "address", internalType: "address" }],
-    outputs: [{ name: "", type: "address[]", internalType: "address[]" }],
+    inputs: [
+      {
+        name: "account",
+        type: "address",
+        internalType: "address"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "address[]",
+        internalType: "address[]"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isEligibleAccountOwner",
+    inputs: [
+      {
+        name: "account",
+        type: "address",
+        internalType: "address"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "bool",
+        internalType: "bool"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "masterRedeemer",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "navProvider",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "phantomToken",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "redeem",
     inputs: [
-      { name: "dsTokenAmount", type: "uint256", internalType: "uint256" },
-      { name: "extraData", type: "bytes", internalType: "bytes" }
+      {
+        name: "dsTokenAmount",
+        type: "uint256",
+        internalType: "uint256"
+      },
+      {
+        name: "extraData",
+        type: "bytes",
+        internalType: "bytes"
+      }
     ],
     outputs: [],
     stateMutability: "nonpayable"
@@ -71,43 +175,81 @@ const iSecuritizeRedemptionGatewayV311Abi = [
     type: "function",
     name: "redemptionAccount",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "redemptionLogger",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "securitizeWhitelister",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "stableCoinToken",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "transferMaster",
     inputs: [],
-    outputs: [{ name: "", type: "address", internalType: "address" }],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "address"
+      }
+    ],
     stateMutability: "view"
   },
   {
     type: "function",
     name: "transferRedeemer",
     inputs: [
-      { name: "redeemer", type: "address", internalType: "address" },
-      { name: "newAccount", type: "address", internalType: "address" }
+      {
+        name: "redeemer",
+        type: "address",
+        internalType: "address"
+      },
+      {
+        name: "newAccount",
+        type: "address",
+        internalType: "address"
+      }
     ],
     outputs: [],
     stateMutability: "nonpayable"
@@ -116,7 +258,13 @@ const iSecuritizeRedemptionGatewayV311Abi = [
     type: "function",
     name: "version",
     inputs: [],
-    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    outputs: [
+      {
+        name: "",
+        type: "uint256",
+        internalType: "uint256"
+      }
+    ],
     stateMutability: "view"
   },
   {
@@ -124,9 +272,21 @@ const iSecuritizeRedemptionGatewayV311Abi = [
     name: "MaxUnclaimedRedeemersPerAccountException",
     inputs: []
   },
-  { type: "error", name: "NewAccountNotRegisteredException", inputs: [] },
-  { type: "error", name: "RedeemerNotOwnedByAccountException", inputs: [] },
-  { type: "error", name: "RedeemerTransferNotAllowedException", inputs: [] }
+  {
+    type: "error",
+    name: "NewAccountNotRegisteredException",
+    inputs: []
+  },
+  {
+    type: "error",
+    name: "RedeemerNotOwnedByAccountException",
+    inputs: []
+  },
+  {
+    type: "error",
+    name: "RedeemerTransferNotAllowedException",
+    inputs: []
+  }
 ];
 export {
   iSecuritizeRedemptionGatewayV311Abi

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

@@ -7,10 +7,8 @@ import {
 import {
   MissingSerializedParamsError
 } from "../../../sdk/index.js";
-import {
-  iMidasGatewayAdapterV311Abi,
-  iMidasGatewayV311Abi
-} from "../abi/adapters/index.js";
+import { iMidasGatewayAdapterV311Abi } from "../abi/adapters/index.js";
+import { iMidasGatewayV311Abi } from "../abi/index.js";
 import { AbstractAdapterContract } from "./AbstractAdapter.js";
 const abi = iMidasGatewayAdapterV311Abi;
 const protocolAbi = iMidasGatewayV311Abi;

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

@@ -1,21 +1,23 @@
+import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
 import { SDKConstruct } from "../../base/index.js";
-import { WAD } from "../../constants/index.js";
-import { AddressSet } from "../../utils/index.js";
+import { ADDRESS_0X0, WAD } from "../../constants/index.js";
+import { AddressSet, hexEq } from "../../utils/index.js";
+import { LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./constants.js";
 import {
   calcEstimatedProfit,
   calcRepaymentAmount,
   DUST_THRESHOLD,
+  liquidationCallToRawTx,
   pickMainAsset,
-  toLiquidatorWithdrawals
+  toLiquidationApproval,
+  toLiquidatorWithdrawals,
+  toReceivedAssets
 } from "./helpers.js";
 class LiquidationsService extends 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: WAD - 1n,
@@ -50,67 +52,58 @@ class LiquidationsService extends 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 > 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: toReceivedAssets(data.expectedOutputs),
+      isLiquidatorEligible: data.isLiquidatorEligible,
+      kycProtocol: data.kycProtocol || void 0,
+      kycToken: hexEq(data.kycToken, ADDRESS_0X0) ? void 0 : data.kycToken,
+      approve: 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 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 [];
@@ -125,6 +118,39 @@ class LiquidationsService extends SDKConstruct {
     );
     return 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 = ADDRESS_0X0, ignoreReservePrices) {
+    const priceUpdates = await this.sdk.accounts.getOnDemandPriceUpdates(
+      ca,
+      ignoreReservePrices
+    );
+    const { result } = await this.client.simulateContract({
+      address: LIQUIDATION_COMPRESSOR_V313_ADDRESS,
+      abi: 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/esm/sdk/accounts/liquidations/MultichainLiquidationsService.js

@@ -35,6 +35,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}
    **/