@gearbox-protocol/sdk 13.1.0-next.2 → 13.1.0

package/dist/esm/plugins/zappers/ZappersPlugin.js

@@ -0,0 +1,126 @@
+import { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
+import {
+  AddressMap,
+  AP_PERIPHERY_COMPRESSOR,
+  BasePlugin,
+  hexEq,
+  VERSION_RANGE_310
+} from "../../sdk/index.js";
+class ZappersPlugin extends BasePlugin {
+  #zappers;
+  #extraZappers;
+  constructor(extraZappers = [], loadOnAttach = false) {
+    super(loadOnAttach);
+    this.#extraZappers = this.#addExtraZappers(extraZappers);
+  }
+  async load(force) {
+    if (!force && this.loaded) {
+      return this.state;
+    }
+    const [pcAddr] = this.sdk.addressProvider.mustGetLatest(
+      AP_PERIPHERY_COMPRESSOR,
+      VERSION_RANGE_310
+    );
+    this.sdk.logger?.debug(
+      `loading zappers with periphery compressor ${pcAddr}`
+    );
+    const markets = this.sdk.marketRegister.markets;
+    const resp = await this.client.multicall({
+      contracts: markets.map(
+        (m) => ({
+          abi: peripheryCompressorAbi,
+          address: pcAddr,
+          functionName: "getZappers",
+          args: [m.configurator.address, m.pool.pool.address]
+        })
+      ),
+      allowFailure: true,
+      batchSize: 0,
+      blockNumber: this.sdk.currentBlock
+    });
+    this.#zappers = new AddressMap(void 0, "zappers");
+    for (let i = 0; i < resp.length; i++) {
+      const { status, result, error } = resp[i];
+      const marketConfigurator = markets[i].configurator.address;
+      const pool = markets[i].pool.pool.address;
+      if (status === "success") {
+        this.#zappers.upsert(
+          pool,
+          result.map((z) => ({ ...z, pool }))
+        );
+      } else {
+        this.sdk.logger?.error(
+          `failed to load zapper for market configurator ${this.labelAddress(
+            marketConfigurator
+          )} and pool ${this.labelAddress(pool)}: ${error}`
+        );
+      }
+    }
+    this.#loadZapperTokens();
+    return this.state;
+  }
+  #addExtraZappers(extraZappers) {
+    const zappers = new AddressMap();
+    for (const z of extraZappers) {
+      const existing = zappers?.get(z.pool);
+      if (existing) {
+        const hasZapper = existing.some(
+          (zz) => hexEq(zz.baseParams.addr, z.baseParams.addr)
+        );
+        if (!hasZapper) {
+          existing.push(z);
+        }
+      } else {
+        zappers?.upsert(z.pool, [z]);
+      }
+    }
+    return zappers;
+  }
+  get extraZappers() {
+    if (!this.#extraZappers) {
+      console.error("extra zappers not attached");
+      return new AddressMap();
+    }
+    return this.#extraZappers;
+  }
+  get zappers() {
+    if (!this.#zappers) {
+      throw new Error("zappers plugin not attached");
+    }
+    return this.#zappers;
+  }
+  get loaded() {
+    return !!this.#zappers;
+  }
+  stateHuman(_) {
+    return this.zappers.values().flatMap(
+      (l) => l.flatMap((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)
+      }))
+    );
+  }
+  get state() {
+    return {
+      zappers: this.zappers.asRecord()
+    };
+  }
+  hydrate(state) {
+    this.#zappers = new AddressMap(Object.entries(state.zappers), "zappers");
+    this.#loadZapperTokens();
+  }
+  #loadZapperTokens() {
+    const zappersTokens = this.zappers.values().flatMap((l) => l.flatMap((z) => [z.tokenIn, z.tokenOut]));
+    const extraZappersTokens = this.extraZappers.values().flatMap((l) => l.flatMap((z) => [z.tokenIn, z.tokenOut]));
+    for (const t of [...zappersTokens, ...extraZappersTokens]) {
+      this.sdk.tokensMeta.upsert(t.addr, t);
+      this.sdk.setAddressLabel(t.addr, t.symbol);
+    }
+  }
+}
+export {
+  ZappersPlugin
+};

package/dist/esm/{sdk/market/ZapperRegister.js → plugins/zappers/extraZappers.js}

@@ -1,110 +1,4 @@
-import { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
-import { SDKConstruct } from "../base/index.js";
-import {
-  AP_PERIPHERY_COMPRESSOR,
-  VERSION_RANGE_310
-} from "../constants/index.js";
-import { AddressMap, hexEq } from "../utils/index.js";
-class ZapperRegister extends SDKConstruct {
-  /**
-   * Mapping pool.address -> ZapperData[]
-   * Needs to be loaded explicitly using loadZappers method
-   */
-  #zappers;
-  /**
-   * Load zappers for all pools using periphery compressor, adds hardcoded zappers
-   */
-  async loadZappers(force) {
-    if (!force && this.#zappers) {
-      return;
-    }
-    const [pcAddr] = this.sdk.addressProvider.mustGetLatest(
-      AP_PERIPHERY_COMPRESSOR,
-      VERSION_RANGE_310
-    );
-    this.logger?.debug(`loading zappers with periphery compressor ${pcAddr}`);
-    const markets = this.sdk.marketRegister.markets;
-    const resp = await this.client.multicall({
-      contracts: markets.map(
-        (m) => ({
-          abi: peripheryCompressorAbi,
-          address: pcAddr,
-          functionName: "getZappers",
-          args: [m.configurator.address, m.pool.pool.address]
-        })
-      ),
-      allowFailure: true,
-      batchSize: 0
-    });
-    this.#zappers = new AddressMap(void 0, "zappers");
-    for (let i = 0; i < resp.length; i++) {
-      const { status, result, error } = resp[i];
-      const marketConfigurator = markets[i].configurator.address;
-      const pool = markets[i].pool.pool.address;
-      if (status === "success") {
-        for (const z of result) {
-          this.#addZapper({ ...z, pool, type: "base" });
-        }
-      } else {
-        this.logger?.error(
-          `failed to load zapper for market configurator ${this.labelAddress(
-            marketConfigurator
-          )} and pool ${this.labelAddress(pool)}: ${error}`
-        );
-      }
-    }
-    for (const z of KYC_ZAPPERS[this.networkType] ?? []) {
-      this.#addZapper({ ...z, type: "kyc" });
-    }
-    for (const z of MIGRATION_ZAPPERS[this.networkType] ?? []) {
-      this.#addZapper({ ...z, type: "migration" });
-    }
-  }
-  #addZapper(z) {
-    if (BROKEN_ZAPPERS.has(z.baseParams.addr)) {
-      return;
-    }
-    const existing = this.zappers.get(z.pool);
-    if (existing) {
-      const hasZapper = existing.some(
-        (zz) => hexEq(zz.baseParams.addr, z.baseParams.addr)
-      );
-      if (!hasZapper) {
-        existing.push(z);
-      }
-    } else {
-      this.zappers.upsert(z.pool, [z]);
-    }
-    const zappersTokens = [z.tokenIn, z.tokenOut];
-    for (const t of zappersTokens) {
-      this.sdk.tokensMeta.upsert(t.addr, t);
-      this.sdk.setAddressLabel(t.addr, t.symbol);
-    }
-  }
-  get zappers() {
-    if (!this.#zappers) {
-      throw new Error("zappers not loaded, call loadZappers first");
-    }
-    return this.#zappers;
-  }
-  poolZappers(pool) {
-    return this.zappers.get(pool) ?? [];
-  }
-  /**
-   * Can return multiple zappers if there are multiple zappers for the same tokenIn and tokenOut
-   */
-  getZapper(pool, tokenIn, tokenOut) {
-    const zappers = this.zappers.get(pool)?.filter(
-      (z) => hexEq(z.tokenIn.addr, tokenIn) && hexEq(z.tokenOut.addr, tokenOut)
-    );
-    return zappers;
-  }
-}
-const BROKEN_ZAPPERS = new AddressMap(
-  [["0x90D66b03EC4D462e42e3c7741049FB46a4a03B69", true]],
-  "brokenZappers"
-);
-const MIGRATION_ZAPPERS = {
+const extraZappers = {
   Mainnet: [
     {
       baseParams: {
@@ -213,7 +107,6 @@ const MIGRATION_ZAPPERS = {
     }
   ]
 };
-const KYC_ZAPPERS = {};
 export {
-  ZapperRegister
+  extraZappers
 };

package/dist/esm/plugins/zappers/index.js

@@ -0,0 +1,3 @@
+export * from "./extraZappers.js";
+export * from "./types.js";
+export * from "./ZappersPlugin.js";

package/dist/esm/plugins/zappers/package.json

@@ -0,0 +1 @@
+{"type": "module","sideEffects":false}