Merge pull request #413 from Gearbox-protocol/bot-fixes

fix: better support for v310 bots

Author: essserrr

src/plugins/bots/config.ts

@@ -44,17 +44,14 @@ export const LEGACY_MIGRATION_BOT: MigrationBotState = {
   address: ACCOUNT_MIGRATOR_BOT,
   previewer: ACCOUNT_MIGRATOR_PREVIEWER,
   version: 310,
-  botType: "MIGRATION_BOT",
+  baseType: "LEGACY_MIGRATION",
 };
 
-export const PERMISSION_BY_TYPE: Record<BotBaseType, bigint> = {
-  LIQUIDATION_PROTECTION: BigInt(
-    BotPermissions.ADD_COLLATERAL |
-      BotPermissions.WITHDRAW_COLLATERAL |
-      BotPermissions.DECREASE_DEBT,
-  ),
-
-  MIGRATION: BigInt(
+export const PERMISSION_BY_TYPE: Record<
+  Extract<BotBaseType, "LEGACY_MIGRATION">,
+  bigint
+> = {
+  LEGACY_MIGRATION: BigInt(
     BotPermissions.EXTERNAL_CALLS |
       BotPermissions.UPDATE_QUOTA |
       BotPermissions.DECREASE_DEBT,

src/plugins/bots/types.ts

@@ -40,15 +40,11 @@ export interface BotsPluginState {
   bots: 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 BotBaseType = "LIQUIDATION_PROTECTION" | "LEGACY_MIGRATION";
 
 export type MigrationBotState = {
   address: Address;
   version: 310;
-
   previewer: Address;
-  botType: MigrationBotType;
+  baseType: Extract<BotBaseType, "LEGACY_MIGRATION">;
 };

src/sdk/accounts/AbstractCreditAccountsService.ts

@@ -39,6 +39,7 @@ import type { ILogger, IPriceUpdateTx, MultiCall } from "../types/index.js";
 import { AddressMap, childLogger } from "../utils/index.js";
 import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 import type {
+  AccountToCheck,
   AddCollateralProps,
   ChangeDeptProps,
   ClaimDelayedProps,
@@ -280,18 +281,22 @@ export abstract class AbstractCreditAccountService extends SDKConstruct {
 
   /**
    * Method to get all connected bots for credit account
-   * @param {Array<{ creditAccount: Address; creditManager: Address }>} accountsToCheck - list of credit accounts 
+   * @param {Array<AccountToCheck>} accountsToCheck - list of credit accounts 
       and their credit managers to check connected bots on
    * @returns call result of getConnectedBots for each credit account
    */
   public async getConnectedBots(
-    accountsToCheck: Array<{ creditAccount: Address; creditManager: Address }>,
+    accountsToCheck: Array<AccountToCheck>,
     legacyMigrationBot: Address | undefined,
+    additionalBots: Array<Address>,
   ): Promise<{
     legacy: GetConnectedBotsResult;
     legacyMigration: GetConnectedMigrationBotsResult;
+    additionalBots: Array<
+      Omit<NonNullable<GetConnectedMigrationBotsResult>, "botAddress">
+    >;
   }> {
-    const [resp, migration] = await Promise.all([
+    const [resp, migration, additional] = await Promise.all([
       this.client.multicall({
         contracts: accountsToCheck.map(o => {
           const pool = this.sdk.marketRegister.findByCreditManager(
@@ -308,15 +313,58 @@ export abstract class AbstractCreditAccountService extends SDKConstruct {
         allowFailure: true,
       }),
       this.getActiveMigrationBots(accountsToCheck, legacyMigrationBot),
+      this.getActiveBots(accountsToCheck, additionalBots),
     ]);
 
-    return { legacy: resp, legacyMigration: migration };
+    return {
+      legacy: resp,
+      additionalBots: additional,
+      legacyMigration: migration,
+    };
+  }
+  private async getActiveBots(
+    accountsToCheck: Array<AccountToCheck>,
+    bots: Array<Address>,
+  ) {
+    const result = await this.client.multicall({
+      contracts: accountsToCheck.flatMap(ca => {
+        const cm = this.sdk.marketRegister.findCreditManager(ca.creditManager);
+
+        return bots.map(bot => {
+          return {
+            abi: isV300(cm.creditFacade.version)
+              ? iBotListV300Abi
+              : iBotListV310Abi,
+            address: cm.creditFacade.botList,
+            functionName: "getBotStatus",
+            args: isV300(cm.creditFacade.version)
+              ? [bot, ca.creditManager, ca.creditAccount]
+              : [bot, ca.creditAccount],
+          } as const;
+        });
+      }),
+      allowFailure: true,
+    });
+
+    const botsByCAIndex = accountsToCheck.reduce<
+      Array<Omit<NonNullable<GetConnectedMigrationBotsResult>, "botAddress">>
+    >((acc, _, index) => {
+      const r = result.slice(index * bots.length, (index + 1) * bots.length);
+
+      acc.push({
+        result: r,
+      });
+
+      return acc;
+    }, []);
+
+    return botsByCAIndex;
   }
   private async getActiveMigrationBots(
     accountsToCheck: Array<{ creditAccount: Address; creditManager: Address }>,
-    legacyMigrationBot: Address | undefined,
+    bot: Address | undefined,
   ) {
-    if (legacyMigrationBot) {
+    if (bot) {
       const result = await this.client.multicall({
         contracts: accountsToCheck.map(ca => {
           const cm = this.sdk.marketRegister.findCreditManager(
@@ -330,14 +378,14 @@ export abstract class AbstractCreditAccountService extends SDKConstruct {
             address: cm.creditFacade.botList,
             functionName: "getBotStatus",
             args: isV300(cm.creditFacade.version)
-              ? [legacyMigrationBot, ca.creditManager, ca.creditAccount]
-              : [legacyMigrationBot, ca.creditAccount],
+              ? [bot, ca.creditManager, ca.creditAccount]
+              : [bot, ca.creditAccount],
           } as const;
         }),
         allowFailure: true,
       });
 
-      return { result, botAddress: legacyMigrationBot };
+      return { result, botAddress: bot };
     }
 
     return undefined;

src/sdk/accounts/CreditAccountsServiceV310.ts

@@ -1,4 +1,4 @@
-import { encodeFunctionData } from "viem";
+import { encodeFunctionData, getContract } from "viem";
 import { iCreditFacadeMulticallV310Abi } from "../../abi/310/generated.js";
 import { MAX_UINT256 } from "../constants/math.js";
 import type { MultiCall } from "../types/index.js";
@@ -23,7 +23,7 @@ export class CreditAccountServiceV310
    */
   public async setBot({
     botAddress,
-    permissions,
+    permissions: defaultPermissions,
 
     targetContract,
   }: SetBotProps): Promise<
@@ -41,6 +41,24 @@ export class CreditAccountServiceV310
           })
         : [];
 
+    const permissions =
+      defaultPermissions !== null
+        ? defaultPermissions
+        : await getContract({
+            address: botAddress,
+            client: this.sdk.client,
+            abi: [
+              {
+                type: "function",
+                name: "requiredPermissions",
+                inputs: [],
+                outputs: [
+                  { name: "", type: "uint192", internalType: "uint192" },
+                ],
+                stateMutability: "view",
+              },
+            ],
+          }).read.requiredPermissions();
     const addBotCall: MultiCall = {
       target: cm.creditFacade.address,
       callData: encodeFunctionData({

src/sdk/accounts/types.ts

@@ -204,6 +204,11 @@ export interface WithdrawCollateralProps extends PrepareUpdateQuotasProps {
   creditAccount: RouterCASlice;
 }
 
+export type AccountToCheck = {
+  creditAccount: Address;
+  creditManager: Address;
+};
+
 export interface ExecuteSwapProps extends PrepareUpdateQuotasProps {
   /**
    * Array of MultiCall from router methods getSingleSwap or getAllSwaps
@@ -447,7 +452,7 @@ export interface SetBotProps {
   /**
    * Permissions to set for the bot
    */
-  permissions: bigint;
+  permissions: bigint | null;
   /**
    * 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
@@ -522,17 +527,21 @@ export interface ICreditAccountsService extends SDKConstruct {
   getRewards(creditAccount: Address): Promise<Array<Rewards>>;
   /**
    * Method to get all connected bots for credit account
-   * @param {Array<{ creditAccount: Address; creditManager: Address }>} accountsToCheck - list of credit accounts
+   * @param {Array<AccountToCheck>} 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 }>,
+    accountsToCheck: Array<AccountToCheck>,
     legacyMigrationBot: Address | undefined,
+    additionalBots: Array<Address>,
   ): Promise<{
     legacy: GetConnectedBotsResult;
     legacyMigration: GetConnectedMigrationBotsResult;
+    additionalBots: Array<
+      Omit<NonNullable<GetConnectedMigrationBotsResult>, "botAddress">
+    >;
   }>;
   /**
    * V3.1 method, throws in V3. Connects/disables a bot and updates prices