feat: add get zappers

Author: doomsower

scripts/example.ts

@@ -13,7 +13,7 @@ async function example(): Promise<void> {
 
   await example.run({
     addressProvider: ADDRESS_PROVIDER,
-    marketConfigurator: MARKET_CONFIGURATOR,
+    marketConfigurators: [MARKET_CONFIGURATOR],
     outFile: "example-state.json",
   });
   logger.info("done");

src/dev/SDKExample.ts

@@ -77,6 +77,11 @@ export class SDKExample {
     await publicClient.waitForTransactionReceipt({ hash });
 
     await this.#sdk.marketRegister.loadMarkets(marketConfigurators, true);
+    try {
+      await this.#sdk.marketRegister.loadZappers();
+    } catch (e) {
+      this.#logger?.error(`failed to load zappers: ${e}`);
+    }
 
     this.#logger?.info("attached sdk");
     if (outFile) {

src/sdk/GearboxSDK.ts

@@ -339,7 +339,7 @@ export class GearboxSDK {
         botList: this.botListContract.stateHuman(raw),
         gearStakingV3: this.gearStakingContract.stateHuman(raw),
       },
-      markets: this.marketRegister.stateHuman(raw),
+      ...this.marketRegister.stateHuman(raw),
     };
   }
 

src/sdk/market/MarketRegister.ts

@@ -1,11 +1,21 @@
 import type { Address } from "viem";
 
-import { iMarketCompressorAbi } from "../abi";
-import type { MarketData } from "../base";
+import { iMarketCompressorAbi, iPeripheryCompressorAbi } from "../abi";
+import type { MarketData, ZapperData } from "../base";
 import { SDKConstruct } from "../base";
-import { ADDRESS_0X0, AP_MARKET_COMPRESSOR } from "../constants";
+import {
+  ADDRESS_0X0,
+  AP_MARKET_COMPRESSOR,
+  AP_PERIPHERY_COMPRESSOR,
+} from "../constants";
 import type { GearboxSDK } from "../GearboxSDK";
-import type { ILogger, MarketStateHuman, RawTx, TVL } from "../types";
+import type {
+  ILogger,
+  MarketStateHuman,
+  RawTx,
+  TVL,
+  ZapperStateHuman,
+} from "../types";
 import { AddressMap, childLogger } from "../utils";
 import { simulateMulticall } from "../utils/viem";
 import type { CreditSuite } from "./CreditSuite";
@@ -20,6 +30,7 @@ export class MarketRegister extends SDKConstruct {
    * Mapping pool.address -> MarketSuite
    */
   #markets = new AddressMap<MarketSuite>();
+  #zappers: ZapperData[] = [];
 
   constructor(sdk: GearboxSDK, markets?: MarketData[]) {
     super(sdk);
@@ -45,6 +56,29 @@ export class MarketRegister extends SDKConstruct {
     await this.#loadMarkets(marketConfigurators, [], ignoreUpdateablePrices);
   }
 
+  public async loadZappers(): Promise<void> {
+    const pcAddr = this.sdk.addressProvider.getAddress(
+      AP_PERIPHERY_COMPRESSOR,
+      3_10,
+    );
+    this.#logger?.debug(`loading zappers with periphery compressor ${pcAddr}`);
+    const resp = await this.provider.publicClient.multicall({
+      contracts: this.markets.map(m => ({
+        abi: iPeripheryCompressorAbi,
+        address: pcAddr,
+        functionName: "getZappers",
+        args: [m.configurator, m.pool.pool.address],
+      })),
+      allowFailure: false,
+    });
+    this.#zappers = resp.flat() as any as ZapperData[];
+    const zappersTokens = this.#zappers.flatMap(z => [z.tokenIn, z.tokenOut]);
+    for (const t of zappersTokens) {
+      this.sdk.tokensMeta.upsert(t.addr, t);
+      this.sdk.provider.addressLabels.set(t.addr as Address, t.symbol);
+    }
+  }
+
   public async syncState(): Promise<void> {
     const pools = this.markets
       .filter(m => m.dirty)
@@ -144,8 +178,20 @@ export class MarketRegister extends SDKConstruct {
     return this.markets.map(market => market.state);
   }
 
-  public stateHuman(raw = true): MarketStateHuman[] {
-    return this.markets.map(market => market.stateHuman(raw));
+  public stateHuman(raw = true): {
+    markets: MarketStateHuman[];
+    zappers: ZapperStateHuman[];
+  } {
+    return {
+      markets: this.markets.map(market => market.stateHuman(raw)),
+      zappers: this.zappers.map(z => ({
+        address: z.baseParams.addr,
+        contractType: z.baseParams.contractType,
+        version: Number(z.baseParams.version),
+        tokenIn: this.labelAddress(z.tokenIn.addr),
+        tokenOut: this.labelAddress(z.tokenOut.addr),
+      })),
+    };
   }
 
   public get pools(): PoolSuite[] {
@@ -213,6 +259,10 @@ export class MarketRegister extends SDKConstruct {
     return this.#markets;
   }
 
+  public get zappers(): ZapperData[] {
+    return this.#zappers;
+  }
+
   public get markets(): MarketSuite[] {
     return this.#markets.values();
   }

src/sdk/market/MarketSuite.ts

@@ -1,6 +1,6 @@
 import type { Address } from "viem";
 
-import type { MarketData, ZapperData } from "../base";
+import type { MarketData } from "../base";
 import { SDKConstruct } from "../base";
 import type { GearboxSDK } from "../GearboxSDK";
 import type { MarketStateHuman } from "../types";
@@ -22,7 +22,6 @@ export class MarketSuite extends SDKConstruct {
    * Original data received from compressor
    */
   public readonly state: MarketData;
-  public readonly zappers: readonly ZapperData[] = [];
 
   constructor(sdk: GearboxSDK, marketData: MarketData) {
     super(sdk);
@@ -41,17 +40,12 @@ export class MarketSuite extends SDKConstruct {
 
     this.acl = marketData.acl;
 
-    const allTokens = [
-      ...marketData.tokens,
-      // ...marketData.zappers.flatMap(z => [z.tokenIn, z.tokenOut]),
-    ];
-    for (const t of allTokens) {
+    for (const t of marketData.tokens) {
       sdk.tokensMeta.upsert(t.addr, t);
       sdk.provider.addressLabels.set(t.addr as Address, t.symbol);
     }
 
     this.pool = new PoolSuite(sdk, marketData);
-    // this.zappers = marketData.zappers;
 
     for (let i = 0; i < marketData.creditManagers.length; i++) {
       this.creditManagers.push(new CreditSuite(sdk, marketData, i));
@@ -93,13 +87,6 @@ export class MarketSuite extends SDKConstruct {
       emergencyLiquidators: this.state.emergencyLiquidators.map(a =>
         this.labelAddress(a),
       ),
-      zappers: this.zappers.map(z => ({
-        address: z.baseParams.addr,
-        contractType: z.baseParams.contractType,
-        version: Number(z.baseParams.version),
-        tokenIn: this.labelAddress(z.tokenIn.addr),
-        tokenOut: this.labelAddress(z.tokenOut.addr),
-      })),
     };
   }
 }

src/sdk/types/state-human.ts

@@ -199,12 +199,12 @@ export interface MarketStateHuman {
   pausableAdmins: string[];
   unpausableAdmins: string[];
   emergencyLiquidators: string[];
-  zappers: ZapperStateHuman[];
 }
 
 export interface GearboxStateHuman {
   block: number;
   timestamp: number;
   core: CoreStateHuman;
   markets: MarketStateHuman[];
+  zappers: ZapperStateHuman[];
 }