fix: account for differences in signatures of partial liquidation contracts v3 and v3.1

Author: doomsower

src/data/exceptions.ts

@@ -12,4 +12,4 @@ export const exceptionsAbis = [
   ...iRedstoneErrorsAbi,
   ...ilpPriceFeedExceptionsAbi,
   ...iRouterV3ErrorsAbi,
-];
+] as const;

src/services/liquidate/SingularPartialLiquidator.ts

@@ -1,16 +1,15 @@
-import { iPartialLiquidatorAbi } from "@gearbox-protocol/liquidator-v2-contracts/abi";
 import type { CreditAccountData } from "@gearbox-protocol/sdk";
-import { ADDRESS_0X0, formatBN, TypedObjectUtils } from "@gearbox-protocol/sdk";
+import { TypedObjectUtils } from "@gearbox-protocol/sdk";
 import {
   calcLiquidatableLTs,
   createAnvilClient,
   setLTs,
 } from "@gearbox-protocol/sdk/dev";
 import type { Address, SimulateContractReturnType } from "viem";
 
-import { exceptionsAbis } from "../../data/index.js";
 import {
   createPartialLiquidators,
+  humanizeOptimalLiquidation,
   type IPartialLiquidatorContract,
 } from "./partial/index.js";
 import SingularFullLiquidator from "./SingularFullLiquidator.js";
@@ -158,69 +157,30 @@ export default class SingularPartialLiquidator extends SingularLiquidator<Partia
         ca,
         undefined,
       );
-    const liquidatorAddr = this.liquidatorForCA(ca);
-    if (!liquidatorAddr) {
+    const liquidatorContract = this.liquidatorForCA(ca);
+    if (!liquidatorContract) {
       throw new Error(
         `no partial liquidator contract found for account ${ca.creditAccount} in ${cm.name}`,
       );
     }
-    const {
-      result: [
-        tokenOut,
-        optimalAmount,
-        repaidAmount,
-        flashLoanAmount,
-        isOptimalRepayable,
-      ],
-    } = await this.client.pub.simulateContract({
-      account: this.client.account,
-      abi: [...iPartialLiquidatorAbi, ...exceptionsAbis],
-      address: liquidatorAddr,
-      functionName: "getOptimalLiquidation",
-      args: [ca.creditAccount, 10100n, priceUpdates as any],
-    });
-    const [symb, decimals, uSymb, uDec] = [
-      this.sdk.tokensMeta.symbol(tokenOut),
-      this.sdk.tokensMeta.decimals(tokenOut),
-      this.sdk.tokensMeta.symbol(cm.underlying),
-      this.sdk.tokensMeta.decimals(cm.underlying),
-    ];
+    const optimalLiquidation = await liquidatorContract.getOptimalLiquidation(
+      ca.creditAccount,
+      priceUpdates,
+    );
     logger.debug(
-      {
-        tokenOut: `${symb} (${tokenOut})`,
-        optimalAmount:
-          formatBN(optimalAmount, decimals) + ` ${symb} (${optimalAmount})`,
-        flashLoanAmount:
-          formatBN(flashLoanAmount, uDec) + ` ${uSymb} (${flashLoanAmount})`,
-        repaidAmount:
-          formatBN(repaidAmount, uDec) + ` ${uSymb} (${repaidAmount})`,
-        isOptimalRepayable,
-      },
+      humanizeOptimalLiquidation(cm, optimalLiquidation),
       "found optimal liquidation",
     );
-    const connectors = this.sdk
-      .routerFor(cm)
-      .getAvailableConnectors(cm.creditManager.collateralTokens);
 
     try {
-      const { result: preview } = await this.client.pub.simulateContract({
-        account: ADDRESS_0X0,
-        address: liquidatorAddr,
-        abi: [...iPartialLiquidatorAbi, ...exceptionsAbis],
-        functionName: "previewPartialLiquidation",
-        args: [
-          ca.creditManager,
-          ca.creditAccount,
-          tokenOut,
-          optimalAmount,
-          flashLoanAmount,
-          priceUpdates,
-          connectors,
-          BigInt(this.config.slippage),
-        ],
-      });
+      const preview = await liquidatorContract.previewPartialLiquidation(
+        ca,
+        cm,
+        optimalLiquidation,
+        priceUpdates,
+      );
       if (preview.profit < 0n) {
-        if (isOptimalRepayable) {
+        if (optimalLiquidation.isOptimalRepayable) {
           throw new Error("optimal liquidation is not profitable or errored");
         } else {
           throw new Error(
@@ -229,19 +189,19 @@ export default class SingularPartialLiquidator extends SingularLiquidator<Partia
         }
       }
       return {
-        assetOut: tokenOut as Address,
-        amountOut: optimalAmount,
-        flashLoanAmount,
+        assetOut: optimalLiquidation.tokenOut,
+        amountOut: optimalLiquidation.optimalAmount,
+        flashLoanAmount: optimalLiquidation.flashLoanAmount,
         priceUpdates,
         calls: preview.calls.map(c => ({
           callData: c.callData,
           target: c.target,
         })),
         underlyingBalance: preview.profit,
-        skipOnFailure: !isOptimalRepayable,
+        skipOnFailure: !optimalLiquidation.isOptimalRepayable,
       };
     } catch (e) {
-      if (!isOptimalRepayable) {
+      if (!optimalLiquidation.isOptimalRepayable) {
         throw new Error(`warning: ${e}`);
       }
       throw e;
@@ -267,27 +227,13 @@ export default class SingularPartialLiquidator extends SingularLiquidator<Partia
     account: CreditAccountData,
     preview: PartialLiquidationPreview,
   ): Promise<SimulateContractReturnType> {
-    const liquidatorAddr = this.liquidatorForCA(account);
-    if (!liquidatorAddr) {
+    const liquidator = this.liquidatorForCA(account);
+    if (!liquidator) {
       throw new Error(
         `no partial liquidator contract found for account ${account.creditAccount} in ${account.creditManager}`,
       );
     }
-    return this.client.pub.simulateContract({
-      account: this.client.account,
-      address: liquidatorAddr,
-      abi: [...iPartialLiquidatorAbi, ...exceptionsAbis],
-      functionName: "partialLiquidateAndConvert",
-      args: [
-        account.creditManager,
-        account.creditAccount,
-        preview.assetOut,
-        preview.amountOut,
-        preview.flashLoanAmount,
-        preview.priceUpdates,
-        preview.calls,
-      ],
-    });
+    return liquidator.partialLiquidateAndConvert(account, preview);
   }
 
   /**
@@ -316,8 +262,9 @@ export default class SingularPartialLiquidator extends SingularLiquidator<Partia
    * @param ca
    * @returns
    */
-  private liquidatorForCA(ca: CreditAccountData): Address | undefined {
-    const contract = this.#liquidatorForCM[ca.creditManager];
-    return contract?.address;
+  private liquidatorForCA(
+    ca: CreditAccountData,
+  ): IPartialLiquidatorContract | undefined {
+    return this.#liquidatorForCM[ca.creditManager];
   }
 }

src/services/liquidate/partial/AbstractPartialLiquidatorContract.ts

@@ -1,21 +1,26 @@
-import { iPartialLiquidatorAbi } from "@gearbox-protocol/liquidator-v2-contracts/abi";
 import type {
+  CreditAccountData,
   CreditAccountsService,
   CreditSuite,
   Curator,
   GearboxSDK,
+  OnDemandPriceUpdate,
 } from "@gearbox-protocol/sdk";
 import { ADDRESS_0X0 } from "@gearbox-protocol/sdk";
 import { iDegenDistributorV3Abi } from "@gearbox-protocol/types/abi";
-import type { Address } from "viem";
+import type { Address, SimulateContractReturnType } from "viem";
+import { parseAbi } from "viem";
 
 import type { Config } from "../../../config/index.js";
 import { DI } from "../../../di.js";
 import type { ILogger } from "../../../log/index.js";
 import type Client from "../../Client.js";
+import type { PartialLiquidationPreview } from "../types.js";
 import type {
   IPartialLiquidatorContract,
   MerkleDistributorInfo,
+  OptimalPartialLiquidation,
+  RawPartialLiquidationPreview,
 } from "./types.js";
 
 export abstract class AbstractPartialLiquidatorContract
@@ -82,7 +87,7 @@ export abstract class AbstractPartialLiquidatorContract
 
   protected async updateRouterAddress(router: Address): Promise<void> {
     const receipt = await this.client.simulateAndWrite({
-      abi: iPartialLiquidatorAbi,
+      abi: parseAbi(["function setRouter(address newRouter)"]),
       address: this.address,
       functionName: "setRouter",
       args: [router],
@@ -114,7 +119,9 @@ export abstract class AbstractPartialLiquidatorContract
     const results = await this.client.pub.multicall({
       allowFailure: false,
       contracts: this.#creditManagers.map(cm => ({
-        abi: iPartialLiquidatorAbi,
+        abi: parseAbi([
+          "function cmToCA(address creditManager) view returns (address creditAccount)",
+        ]),
         address: this.address,
         functionName: "cmToCA",
         args: [cm.creditManager.address],
@@ -221,7 +228,7 @@ export abstract class AbstractPartialLiquidatorContract
     try {
       this.logger.debug(`need to register credit manager ${name} (${address})`);
       const receipt = await this.client.simulateAndWrite({
-        abi: iPartialLiquidatorAbi,
+        abi: parseAbi(["function registerCM(address creditManager)"]),
         address: this.address,
         functionName: "registerCM",
         args: [address],
@@ -243,6 +250,23 @@ export abstract class AbstractPartialLiquidatorContract
     }
   }
 
+  public abstract getOptimalLiquidation(
+    creditAccount: Address,
+    priceUpdates: OnDemandPriceUpdate[],
+  ): Promise<OptimalPartialLiquidation>;
+
+  public abstract previewPartialLiquidation(
+    ca: CreditAccountData,
+    cm: CreditSuite,
+    optimalLiquidation: OptimalPartialLiquidation,
+    priceUpdates: OnDemandPriceUpdate[],
+  ): Promise<RawPartialLiquidationPreview>;
+
+  public abstract partialLiquidateAndConvert(
+    account: CreditAccountData,
+    preview: PartialLiquidationPreview,
+  ): Promise<SimulateContractReturnType>;
+
   public get envVariables(): Record<string, string> {
     return {};
   }

src/services/liquidate/partial/index.ts

@@ -1,2 +1,3 @@
 export * from "./createPartialLiquidators.js";
 export type { IPartialLiquidatorContract } from "./types.js";
+export * from "./utils.js";

src/services/liquidate/partial/types.ts

@@ -1,5 +1,27 @@
-import type { CreditSuite } from "@gearbox-protocol/sdk";
-import type { Address, Hash } from "viem";
+import type {
+  CreditAccountData,
+  CreditSuite,
+  MultiCall,
+  OnDemandPriceUpdate,
+} from "@gearbox-protocol/sdk";
+import type { Address, Hash, SimulateContractReturnType } from "viem";
+
+import type { PartialLiquidationPreview } from "../types.js";
+
+export interface OptimalPartialLiquidation {
+  tokenOut: Address;
+  optimalAmount: bigint;
+  repaidAmount: bigint;
+  flashLoanAmount: bigint;
+  isOptimalRepayable: boolean;
+}
+
+export interface RawPartialLiquidationPreview {
+  profit: bigint;
+  calls: readonly MultiCall[];
+  amountIn: bigint;
+  amountOut: bigint;
+}
 
 export interface IPartialLiquidatorContract {
   address: Address;
@@ -15,6 +37,37 @@ export interface IPartialLiquidatorContract {
    * Deploys the liquidator contracts, if necessary
    */
   deploy: () => Promise<void>;
+  /**
+   * Cross-version call to getOptimalLiquidation on liquidator contracts for rouuters v300 and v310
+   * @param creditAccount
+   * @param priceUpdates
+   */
+  getOptimalLiquidation: (
+    creditAccount: Address,
+    priceUpdates: OnDemandPriceUpdate[],
+  ) => Promise<OptimalPartialLiquidation>;
+  /**
+   * Cross-version call to previewPartialLiquidation on liquidator contracts for rouuters v300 and v310
+   * @param ca
+   * @param cm
+   * @param optimalLiquidation
+   * @param priceUpdates
+   */
+  previewPartialLiquidation: (
+    ca: CreditAccountData,
+    cm: CreditSuite,
+    optimalLiquidation: OptimalPartialLiquidation,
+    priceUpdates: OnDemandPriceUpdate[],
+  ) => Promise<RawPartialLiquidationPreview>;
+  /**
+   * Cross-version call to partialLiquidateAndConvert on liquidator contracts for rouuters v300 and v310
+   * @param account
+   * @param preview
+   */
+  partialLiquidateAndConvert: (
+    account: CreditAccountData,
+    preview: PartialLiquidationPreview,
+  ) => Promise<SimulateContractReturnType>;
 }
 
 export interface IPartialLiqudatorContractFactory {

src/services/liquidate/partial/utils.ts

@@ -0,0 +1,28 @@
+import type { CreditSuite } from "@gearbox-protocol/sdk";
+import { formatBN } from "@gearbox-protocol/sdk";
+
+import type { OptimalPartialLiquidation } from "./types.js";
+
+export function humanizeOptimalLiquidation(
+  cm: CreditSuite,
+  data: OptimalPartialLiquidation,
+): Record<string, any> {
+  const [symb, decimals, uSymb, uDec] = [
+    cm.sdk.tokensMeta.symbol(data.tokenOut),
+    cm.sdk.tokensMeta.decimals(data.tokenOut),
+    cm.sdk.tokensMeta.symbol(cm.underlying),
+    cm.sdk.tokensMeta.decimals(cm.underlying),
+  ];
+  return {
+    tokenOut: `${symb} (${data.tokenOut})`,
+    optimalAmount:
+      formatBN(data.optimalAmount, decimals) +
+      ` ${symb} (${data.optimalAmount})`,
+    flashLoanAmount:
+      formatBN(data.flashLoanAmount, uDec) +
+      ` ${uSymb} (${data.flashLoanAmount})`,
+    repaidAmount:
+      formatBN(data.repaidAmount, uDec) + ` ${uSymb} (${data.repaidAmount})`,
+    isOptimalRepayable: data.isOptimalRepayable,
+  };
+}