Merge pull request #412 from Gearbox-protocol/bot

fix: concentrate bots related data inside bots plugin

Author: essserrr

src/plugins/bots/BotsPlugin.ts

@@ -14,6 +14,7 @@ import {
   AP_PERIPHERY_COMPRESSOR,
   AP_TREASURY,
   BasePlugin,
+  chains as CHAINS,
   hexEq,
   isV300,
   isV310,
@@ -22,6 +23,7 @@ import {
 } from "../../sdk/index.js";
 import { iPartialLiquidationBotV310Abi } from "./abi/iPartialLiquidationBotV310.js";
 import {
+  LEGACY_MIGRATION_BOT,
   PARTIAL_LIQUIDATION_BOT_CONFIGS,
   PARTIAL_LIQUIDATION_BOT_DEPLOYER,
   PARTIAL_LIQUIDATION_BOT_SALT,
@@ -35,6 +37,7 @@ import {
   type BotsPluginState,
   type BotsPluginStateHuman,
   LIQUIDATION_BOT_TYPES,
+  type MigrationBotState,
 } from "./types.js";
 
 export class UnsupportedBotVersionError extends Error {
@@ -280,4 +283,10 @@ export class BotsPlugin
       throw new Error(`unsupported bot version: ${v}`);
     }
   }
+
+  public static getMigrationBotData(
+    chainId: number,
+  ): MigrationBotState | undefined {
+    return chainId === CHAINS.Mainnet.id ? LEGACY_MIGRATION_BOT : undefined;
+  }
 }

src/plugins/bots/config.ts

@@ -1,6 +1,6 @@
 import type { Address } from "viem";
-import type { NetworkType } from "../../sdk/index.js";
-import type { BotParameters } from "./types.js";
+import { BotPermissions, type NetworkType } from "../../sdk/index.js";
+import type { BotBaseType, BotParameters, MigrationBotState } from "./types.js";
 
 export const PARTIAL_LIQUIDATION_BOT_CONFIGS: Partial<
   Record<NetworkType, Omit<BotParameters, "treasury">[]>
@@ -34,3 +34,29 @@ export const PARTIAL_LIQUIDATION_BOT_CONFIGS: Partial<
 export const PARTIAL_LIQUIDATION_BOT_SALT = "GEARBOX";
 export const PARTIAL_LIQUIDATION_BOT_DEPLOYER: Address =
   "0xc93155E0a835Cf4E17a19463Fa67ed43c164d06a";
+
+// TODO: HARDCODED
+const ACCOUNT_MIGRATOR_BOT =
+  "0x286Fe53994f5668D56538Aa10eaa3Ac36f878e9C".toLowerCase() as Address;
+const ACCOUNT_MIGRATOR_PREVIEWER =
+  "0x6523B8c9daB92eea7944a79b4Dbb598c7934DCca".toLowerCase() as Address;
+export const LEGACY_MIGRATION_BOT: MigrationBotState = {
+  address: ACCOUNT_MIGRATOR_BOT,
+  previewer: ACCOUNT_MIGRATOR_PREVIEWER,
+  version: 310,
+  botType: "MIGRATION_BOT",
+};
+
+export const PERMISSION_BY_TYPE: Record<BotBaseType, bigint> = {
+  LIQUIDATION_PROTECTION: BigInt(
+    BotPermissions.ADD_COLLATERAL |
+      BotPermissions.WITHDRAW_COLLATERAL |
+      BotPermissions.DECREASE_DEBT,
+  ),
+
+  MIGRATION: BigInt(
+    BotPermissions.EXTERNAL_CALLS |
+      BotPermissions.UPDATE_QUOTA |
+      BotPermissions.DECREASE_DEBT,
+  ),
+};

src/plugins/bots/types.ts

@@ -67,3 +67,16 @@ export interface BotsPluginState {
    */
   bots: Record<Address, BotState[]>;
 }
+
+export type BotBaseType = "LIQUIDATION_PROTECTION" | "MIGRATION";
+
+export const MIGRATION_BOT_TYPES = ["MIGRATION_BOT"] as const;
+export type MigrationBotType = (typeof MIGRATION_BOT_TYPES)[number];
+
+export type MigrationBotState = {
+  address: Address;
+  version: 310;
+
+  previewer: Address;
+  botType: MigrationBotType;
+};

src/sdk/accountMigration/AbstractMigrateCreditAccountsService.ts

@@ -21,7 +21,6 @@ import type { ILogger } from "../types/index.js";
 import { childLogger } from "../utils/index.js";
 import type {
   MigrateCreditAccountProps,
-  MigrationBotState,
   PreviewCreditAccountMigrationProps,
   PreviewMigrationResult,
 } from "./types.js";
@@ -49,14 +48,6 @@ export abstract class AbstractMigrateCreditAccountsService extends SDKConstruct
     },
   };
 
-  // TODO: HARDCODED
-  private static readonly accountMigratorBot =
-    "0x286Fe53994f5668D56538Aa10eaa3Ac36f878e9C".toLowerCase() as Address;
-
-  // TODO: HARDCODED
-  private static readonly accountMigratorPreviewer =
-    "0x6523B8c9daB92eea7944a79b4Dbb598c7934DCca".toLowerCase() as Address;
-
   constructor(sdk: GearboxSDK, version: number) {
     super(sdk);
 
@@ -167,41 +158,6 @@ export abstract class AbstractMigrateCreditAccountsService extends SDKConstruct
       ]?.[source] ?? source
     );
   }
-  public static getMigrationBotAddress(chainId: number) {
-    const botAddress =
-      chainId === CHAINS.Mainnet.id
-        ? AbstractMigrateCreditAccountsService.accountMigratorBot
-        : undefined;
-    const previewerAddress =
-      chainId === CHAINS.Mainnet.id
-        ? AbstractMigrateCreditAccountsService.accountMigratorPreviewer
-        : undefined;
-
-    return previewerAddress && botAddress
-      ? { botAddress, previewerAddress }
-      : undefined;
-  }
-
-  public static getMigrationBotData(
-    chainId: number,
-  ): MigrationBotState | undefined {
-    const { botAddress } =
-      AbstractMigrateCreditAccountsService.getMigrationBotAddress(chainId) ||
-      {};
-
-    // TODO: HARDCODED
-    return botAddress
-      ? {
-          baseParams: {
-            addr: botAddress,
-            version: 310,
-          },
-          address: botAddress,
-          version: 310,
-          botType: "MIGRATION_BOT",
-        }
-      : undefined;
-  }
 
   public static getTokensToMigrate(creditAccount: CreditAccountData_Legacy) {
     const sourceTokensToMigrate = Object.values(creditAccount.tokens).filter(

src/sdk/accountMigration/types.ts

@@ -9,20 +9,6 @@ import type { accountMigratorPreviewerV310Abi } from "../../abi/migration.js";
 import type { SDKConstruct } from "../base/SDKConstruct.js";
 import type { Asset, RouterCASlice } from "../router/index.js";
 
-export type MigrationBotState = {
-  baseParams: {
-    addr: Address;
-    version: number;
-  };
-  address: Address;
-  version: number;
-  botType: MigrationBotType;
-};
-
-export const MIGRATION_BOT_TYPES = ["MIGRATION_BOT"] as const;
-
-export type MigrationBotType = (typeof MIGRATION_BOT_TYPES)[number];
-
 export interface MigrateCreditAccountProps {
   /**
    * accountMigratorBot Address

src/sdk/accounts/AbstractCreditAccountsService.ts

@@ -10,7 +10,6 @@ import {
   iBotListV300Abi,
   iCreditFacadeV300MulticallAbi,
 } from "../../abi/v300.js";
-import { AbstractMigrateCreditAccountsService } from "../accountMigration/AbstractMigrateCreditAccountsService.js";
 import type { CreditAccountData } from "../base/index.js";
 import { SDKConstruct } from "../base/index.js";
 import {
@@ -287,6 +286,7 @@ export abstract class AbstractCreditAccountService extends SDKConstruct {
    */
   public async getConnectedBots(
     accountsToCheck: Array<{ creditAccount: Address; creditManager: Address }>,
+    legacyMigrationBot: Address | undefined,
   ): Promise<{
     legacy: GetConnectedBotsResult;
     legacyMigration: GetConnectedMigrationBotsResult;
@@ -307,19 +307,16 @@ export abstract class AbstractCreditAccountService extends SDKConstruct {
         }),
         allowFailure: true,
       }),
-      this.getActiveMigrationBots(accountsToCheck),
+      this.getActiveMigrationBots(accountsToCheck, legacyMigrationBot),
     ]);
 
     return { legacy: resp, legacyMigration: migration };
   }
   private async getActiveMigrationBots(
     accountsToCheck: Array<{ creditAccount: Address; creditManager: Address }>,
+    legacyMigrationBot: Address | undefined,
   ) {
-    const migrationBot =
-      AbstractMigrateCreditAccountsService.getMigrationBotAddress(
-        this.sdk.chainId,
-      );
-    if (migrationBot) {
+    if (legacyMigrationBot) {
       const result = await this.client.multicall({
         contracts: accountsToCheck.map(ca => {
           const cm = this.sdk.marketRegister.findCreditManager(
@@ -333,14 +330,14 @@ export abstract class AbstractCreditAccountService extends SDKConstruct {
             address: cm.creditFacade.botList,
             functionName: "getBotStatus",
             args: isV300(cm.creditFacade.version)
-              ? [migrationBot.botAddress, ca.creditManager, ca.creditAccount]
-              : [migrationBot.botAddress, ca.creditAccount],
+              ? [legacyMigrationBot, ca.creditManager, ca.creditAccount]
+              : [legacyMigrationBot, ca.creditAccount],
           } as const;
         }),
         allowFailure: true,
       });
 
-      return { result, migrationBot };
+      return { result, botAddress: legacyMigrationBot };
     }
 
     return undefined;

src/sdk/accounts/CreditAccountsServiceV310.ts

@@ -3,7 +3,6 @@ import { iCreditFacadeMulticallV310Abi } from "../../abi/310/generated.js";
 import { MAX_UINT256 } from "../constants/math.js";
 import type { MultiCall } from "../types/index.js";
 import { AbstractCreditAccountService } from "./AbstractCreditAccountsService.js";
-import { PERMISSION_BY_TYPE } from "./constants.js";
 import type {
   ClaimFarmRewardsProps,
   CreditAccountOperationResult,
@@ -24,8 +23,7 @@ export class CreditAccountServiceV310
    */
   public async setBot({
     botAddress,
-    botBaseType,
-    stopBot,
+    permissions,
 
     targetContract,
   }: SetBotProps): Promise<
@@ -48,7 +46,7 @@ export class CreditAccountServiceV310
       callData: encodeFunctionData({
         abi: iCreditFacadeMulticallV310Abi,
         functionName: "setBotPermissions",
-        args: [botAddress, stopBot ? 0n : PERMISSION_BY_TYPE[botBaseType]],
+        args: [botAddress, permissions],
       }),
     };
 

src/sdk/accounts/constants.ts

@@ -1,6 +1,5 @@
 export * from "./AbstractCreditAccountsService.js";
 export * from "./CreditAccountsServiceV300.js";
 export * from "./CreditAccountsServiceV310.js";
-export * from "./constants.js";
 export * from "./createCreditAccountService.js";
 export * from "./types.js";

src/sdk/accounts/index.ts

@@ -7,8 +7,6 @@ import type {
 } from "viem";
 import type { creditAccountCompressorAbi } from "../../abi/compressors/creditAccountCompressor.js";
 import type { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
-import type { LiquidationBotType as LiquidationBotTypeSDK } from "../../plugins/bots/types.js";
-import type { MigrationBotType } from "../accountMigration/types.js";
 import type { ConnectedBotData, CreditAccountData } from "../base/index.js";
 import type { SDKConstruct } from "../base/SDKConstruct.js";
 import type {
@@ -435,23 +433,6 @@ export interface Rewards {
   rewards: Array<Asset>;
 }
 
-/**
-  It was planned that bots related to each other like
-  {
-    liquidationProtection: LiquidationBotType[]
-    someOtherBaseType: someOtherDetailedType[ ... ]
-  }
-
-  BotBaseType = "liquidationProtection" | someOtherBaseType
-  BotDetailedType = LiquidationBotType | someOtherDetailedType
- * */
-export type BotBaseType = "LIQUIDATION_PROTECTION" | "MIGRATION";
-export type LiquidationBotType = Exclude<
-  LiquidationBotTypeSDK,
-  "PARTIAL_LIQUIDATION_BOT"
->;
-export type { MigrationBotType };
-
 interface CMSlice {
   creditManager: Address;
   creditFacade: Address;
@@ -464,13 +445,9 @@ export interface SetBotProps {
    */
   botAddress: Address;
   /**
-   * Bot base type (see comments above)
-   */
-  botBaseType: BotBaseType;
-  /**
-   * Either stop or enable bot
+   * Permissions to set for the bot
    */
-  stopBot: boolean;
+  permissions: bigint;
   /**
    * Minimal credit account data {@link RouterCASlice} on which operation is performed; if omitted, credit manager data is used
    * Minimal credit manager data {@link CMSlice} on which operation is performed; used only if credit account is omitted
@@ -508,10 +485,7 @@ export type GetConnectedMigrationBotsResult =
             status: "success";
           }
       )[];
-      migrationBot: {
-        botAddress: Address;
-        previewerAddress: Address;
-      };
+      botAddress: Address;
     }
   | undefined;
 
@@ -549,11 +523,13 @@ export interface ICreditAccountsService extends SDKConstruct {
   /**
    * Method to get all connected bots for credit account
    * @param {Array<{ creditAccount: Address; creditManager: Address }>} accountsToCheck - list of credit accounts
+   * @param {Address | undefined} legacyMigrationBot - address of the bot to check connected bots on
    * and their credit managers to check connected bots on
    * @returns call result of getConnectedBots for each credit account
    */
   getConnectedBots(
     accountsToCheck: Array<{ creditAccount: Address; creditManager: Address }>,
+    legacyMigrationBot: Address | undefined,
   ): Promise<{
     legacy: GetConnectedBotsResult;
     legacyMigration: GetConnectedMigrationBotsResult;