@gearbox-protocol/sdk 13.7.0-kyc.3 → 14.0.0-next.10

package/dist/esm/sdk/market/MarketRegister.js

@@ -4,17 +4,12 @@ import {
   AP_MARKET_COMPRESSOR,
   VERSION_RANGE_310
 } from "../constants/index.js";
-import { AddressMap, AddressSet } from "../utils/index.js";
-import {
-  executeDelegatedMulticalls
-} from "../utils/viem/index.js";
+import { AddressMap } from "../utils/index.js";
+import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 import { ZapperRegister } from "./ZapperRegister.js";
 class MarketRegister extends ZapperRegister {
-  /**
-   * Mapping pool.address -> MarketSuite
-   */
   #markets = new AddressMap(void 0, "markets");
   #marketFilter;
   #marketConfigurators = new AddressMap(
@@ -28,7 +23,9 @@ class MarketRegister extends ZapperRegister {
    **/
   constructor(sdk, ignoreMarkets = []) {
     super(sdk);
-    this.#ignoreMarkets = new AddressSet(ignoreMarkets);
+    this.#ignoreMarkets = new Set(
+      ignoreMarkets.map((m) => m.toLowerCase())
+    );
   }
   /**
    * Restores market state from a previously serialized snapshot,
@@ -36,41 +33,40 @@ class MarketRegister extends ZapperRegister {
    * @param state - Array of market data snapshots.
    **/
   hydrate(state) {
+    this.#markets.clear();
     const configurators = new Set(state.map((m) => m.configurator));
     this.#setMarketFilter([...configurators]);
-    this.#setMarkets(state);
+    for (const data of state) {
+      const pool = data.pool.baseParams.addr;
+      if (this.#ignoreMarkets.has(pool.toLowerCase())) {
+        this.logger?.debug(
+          `ignoring market of pool ${pool} (${data.pool.name})`
+        );
+        continue;
+      }
+      this.#markets.upsert(
+        data.pool.baseParams.addr,
+        new MarketSuite(this.sdk, data)
+      );
+    }
   }
   /**
-   * @internal
-   * Returns delegated multicalls for loading all markets from the on-chain
-   * market compressor. Used by the SDK to compose batched RPC calls.
+   * Fetches all markets from the on-chain for the given market configurators.
    *
-   * @param configurators - Addresses of market configurator contracts to query.
+   * @param marketConfigurators - Addresses of market configurator contracts to query.
+   * @param ignoreUpdateablePrices - When `true`, skips generating off-chain
+   *   price updates before loading
    **/
-  getLoadMulticalls(configurators) {
-    this.#setMarketFilter(configurators);
-    const [marketCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
-      AP_MARKET_COMPRESSOR,
-      VERSION_RANGE_310
-    );
-    return [
-      {
-        call: {
-          abi: marketCompressorAbi,
-          address: marketCompressorAddress,
-          functionName: "getMarkets",
-          args: [this.marketFilter]
-        },
-        onResult: (resp) => {
-          this.#setMarkets(resp);
-          this.logger?.info(
-            `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
-          );
-        }
-      }
-    ];
+  async loadMarkets(marketConfigurators, ignoreUpdateablePrices) {
+    if (!marketConfigurators.length) {
+      this.logger?.warn(
+        "no market configurators provided, skipping loadMarkets"
+      );
+      return;
+    }
+    await this.#loadMarkets(marketConfigurators, [], ignoreUpdateablePrices);
   }
-  #setMarketFilter(configurators) {
+  #setMarketFilter(configurators, pools = []) {
     for (const c of configurators) {
       this.#marketConfigurators.upsert(
         c,
@@ -79,7 +75,7 @@ class MarketRegister extends ZapperRegister {
     }
     this.#marketFilter = {
       configurators,
-      pools: [],
+      pools,
       underlying: ADDRESS_0X0
     };
   }
@@ -106,45 +102,106 @@ class MarketRegister extends ZapperRegister {
    **/
   async syncState(ignoreUpdateablePrices) {
     const dirty = this.markets.some((m) => m.dirty) || this.marketConfigurators.some((c) => c.dirty);
-    let multicalls;
-    let txs = [];
     if (dirty) {
       this.logger?.debug(
         "some markets or market configurators are dirty, reloading everything"
       );
-      multicalls = this.getLoadMulticalls([...this.marketFilter.configurators]);
-      if (!ignoreUpdateablePrices) {
-        const updatables = await this.sdk.priceFeeds.getPartialUpdatablePriceFeeds([
-          ...this.marketFilter.configurators
-        ]);
-        const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
-        txs = updates.txs;
-      }
+      await this.#loadMarkets(
+        [...this.marketFilter.configurators],
+        [...this.marketFilter.pools],
+        ignoreUpdateablePrices
+      );
     } else if (!ignoreUpdateablePrices) {
-      multicalls = this.#getOracleSyncMulticalls();
-      if (!multicalls.length) {
-        return;
-      }
-      this.logger?.debug(`syncing prices on ${multicalls.length} oracles`);
-      const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs();
+      await this.updatePrices();
+    }
+  }
+  async #loadMarkets(configurators, pools, ignoreUpdateablePrices) {
+    this.#setMarketFilter(configurators, pools);
+    const [marketCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
+      AP_MARKET_COMPRESSOR,
+      VERSION_RANGE_310
+    );
+    let txs = [];
+    if (!ignoreUpdateablePrices) {
+      const updatables = await this.sdk.priceFeeds.getPartialUpdatablePriceFeeds(
+        configurators,
+        pools
+      );
+      const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
       txs = updates.txs;
+    }
+    this.logger?.debug(
+      { configurators, pools },
+      `calling getMarkets with ${txs.length} price updates in block ${this.sdk.currentBlock}`
+    );
+    let markets = [];
+    if (txs.length) {
+      const [resp] = await simulateWithPriceUpdates(this.client, {
+        priceUpdates: txs,
+        contracts: [
+          {
+            abi: marketCompressorAbi,
+            address: marketCompressorAddress,
+            functionName: "getMarkets",
+            args: [this.marketFilter]
+          }
+        ],
+        blockNumber: this.sdk.currentBlock,
+        gas: this.sdk.gasLimit
+      });
+      markets = resp;
     } else {
-      return;
+      markets = await this.client.readContract({
+        abi: marketCompressorAbi,
+        address: marketCompressorAddress,
+        functionName: "getMarkets",
+        args: [this.marketFilter],
+        blockNumber: this.sdk.currentBlock,
+        // @ts-expect-error
+        gas: this.sdk.gasLimit
+      });
     }
-    await executeDelegatedMulticalls(this.client, multicalls, {
-      priceUpdates: txs,
-      blockNumber: this.sdk.currentBlock,
-      gas: this.sdk.gasLimit
-    });
+    for (const data of markets) {
+      const pool = data.pool.baseParams.addr;
+      if (this.#ignoreMarkets.has(pool.toLowerCase())) {
+        this.logger?.debug(
+          `ignoring market of pool ${pool} (${data.pool.name})`
+        );
+        continue;
+      }
+      this.#markets.upsert(pool, new MarketSuite(this.sdk, data));
+    }
+    this.logger?.info(
+      `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
+    );
   }
-  #getOracleSyncMulticalls(oracles) {
+  /**
+   * Loads new prices and price feeds for given oracles from PriceFeedCompressor, defaults to all oracles
+   */
+  async updatePrices(oracles) {
     const uniqOracles = new AddressMap();
     for (const m of this.markets) {
       if (!oracles || oracles.includes(m.priceOracle.address)) {
         uniqOracles.upsert(m.priceOracle.address, m.priceOracle);
       }
     }
-    return uniqOracles.values().map((o) => o.syncStateMulticall());
+    const multicalls = uniqOracles.values().map((o) => o.syncStateMulticall());
+    if (!multicalls.length) {
+      return;
+    }
+    this.logger?.debug(`syncing prices on ${multicalls.length} oracles`);
+    const { txs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs();
+    const oraclesStates = await simulateWithPriceUpdates(this.client, {
+      priceUpdates: txs,
+      contracts: multicalls.map((mc) => mc.call),
+      gas: this.sdk.gasLimit,
+      blockNumber: this.sdk.currentBlock
+    });
+    for (let i = 0; i < multicalls.length; i++) {
+      const handler = multicalls[i].onResult;
+      const result = oraclesStates[i];
+      handler(result);
+    }
   }
   get watchAddresses() {
     return /* @__PURE__ */ new Set([
@@ -265,19 +322,6 @@ class MarketRegister extends ZapperRegister {
   get markets() {
     return this.#markets.values();
   }
-  #setMarkets(markets) {
-    this.#markets.clear();
-    for (const data of markets) {
-      const pool = data.pool.baseParams.addr;
-      if (this.#ignoreMarkets.has(pool)) {
-        this.logger?.debug(
-          `ignoring market of pool ${pool} (${data.pool.name})`
-        );
-        continue;
-      }
-      this.#markets.upsert(pool, new MarketSuite(this.sdk, data));
-    }
-  }
 }
 export {
   MarketRegister

package/dist/esm/sdk/market/MarketSuite.js

@@ -44,9 +44,6 @@ class MarketSuite extends SDKConstruct {
   get underlying() {
     return this.pool.underlying;
   }
-  get kycFactory() {
-    return this.pool.kycFactory;
-  }
   get dirty() {
     return this.configurator.dirty || this.pool.dirty || this.priceOracle.dirty || this.creditManagers.some((cm) => cm.dirty);
   }

package/dist/esm/sdk/market/index.js

@@ -1,6 +1,5 @@
 export * from "./adapters/index.js";
 export * from "./credit/index.js";
-export * from "./kyc/index.js";
 export * from "./MarketRegister.js";
 export * from "./MarketSuite.js";
 export * from "./oracle/index.js";

package/dist/esm/sdk/market/pool/PoolSuite.js

@@ -55,9 +55,6 @@ class PoolSuite extends SDKConstruct {
   get underlying() {
     return this.pool.underlying;
   }
-  get kycFactory() {
-    return this.pool.kycFactory;
-  }
   get dirty() {
     return this.pool.dirty || this.rateKeeper.dirty || this.pqk.dirty || this.interestRateModel.dirty;
   }

package/dist/esm/sdk/market/pool/PoolV310Contract.js

@@ -10,15 +10,13 @@ import {
 const abi = [...iPoolV310Abi, ...iPausableAbi];
 class PoolV310Contract extends BaseContract {
   creditManagerDebtParams;
-  #sdk;
-  constructor(sdk, data) {
+  constructor(options, data) {
     const { baseParams, creditManagerDebtParams, ...rest } = data;
-    super(sdk, {
+    super(options, {
       ...data.baseParams,
       name: `PoolV3(${data.name})`,
       abi
     });
-    this.#sdk = sdk;
     Object.assign(this, rest);
     this.creditManagerDebtParams = new AddressMap(
       creditManagerDebtParams.map((p) => [p.creditManager, p])
@@ -30,13 +28,6 @@ class PoolV310Contract extends BaseContract {
       symbol: data.symbol
     });
   }
-  get kycFactory() {
-    const meta = this.#sdk.tokensMeta.mustGet(this.underlying);
-    if (this.#sdk.tokensMeta.isKYCUnderlying(meta)) {
-      return this.#sdk.mustGetContract(meta.kycFactory);
-    }
-    return void 0;
-  }
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

package/dist/esm/sdk/market/pool/index.js

@@ -1,5 +1,4 @@
 export * from "./GaugeContract.js";
 export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolSuite.js";
-export * from "./PoolV310Contract.js";
 export * from "./types.js";

package/dist/esm/sdk/market/pricefeeds/PriceFeedsRegister.js

@@ -221,13 +221,13 @@ class PriceFeedRegister extends SDKConstruct {
    * Loads PARTIAL information about all updatable price feeds from MarketCompressor
    * Discovered price feeds are not saved anywhere in PriceFeedRegister, and can later be used to load price feed updates
    */
-  async getPartialUpdatablePriceFeeds(configurators) {
+  async getPartialUpdatablePriceFeeds(configurators, pools) {
     const [priceFeedCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
       AP_PRICE_FEED_COMPRESSOR,
       VERSION_RANGE_310
     );
     this.logger?.debug(
-      { configurators },
+      { configurators, pools },
       `calling getUpdatablePriceFeeds in block ${this.sdk.currentBlock}`
     );
     const result = await this.client.readContract({
@@ -237,7 +237,7 @@ class PriceFeedRegister extends SDKConstruct {
       args: [
         {
           configurators,
-          pools: [],
+          pools: pools ?? [],
           underlying: ADDRESS_0X0
         }
       ],
@@ -328,6 +328,13 @@ class PriceFeedRegister extends SDKConstruct {
   get latestUpdate() {
     return this.#latestUpdate;
   }
+  /**
+   * @internal
+   * Returns true if any of the updaters are in historical mode
+   */
+  get historical() {
+    return this.#updaters.some((u) => u.historical);
+  }
 }
 export {
   PriceFeedRegister

package/dist/esm/sdk/market/pricefeeds/updates/PythAccumulatorUpdateData.js

@@ -1,4 +1,3 @@
-import BN from "bn.js";
 import { Buffer } from "buffer";
 const ACCUMULATOR_MAGIC = "504e4155";
 const MAJOR_VERSION = 1;
@@ -6,6 +5,14 @@ const MINOR_VERSION = 0;
 const KECCAK160_HASH_SIZE = 20;
 const PRICE_FEED_MESSAGE_VARIANT = 0;
 const TWAP_MESSAGE_VARIANT = 1;
+function bufToBigInt(buf) {
+  if (buf.length === 0) return 0n;
+  let result = 0n;
+  for (let i = 0; i < buf.length; i++) {
+    result = result << 8n | BigInt(buf[i]);
+  }
+  return result;
+}
 function isAccumulatorUpdateData(updateBytes) {
   return updateBytes.toString("hex").slice(0, 8) === ACCUMULATOR_MAGIC && updateBytes[4] === MAJOR_VERSION && updateBytes[5] === MINOR_VERSION;
 }
@@ -18,19 +25,19 @@ function parsePriceFeedMessage(message) {
   cursor += 1;
   const feedId = message.subarray(cursor, cursor + 32);
   cursor += 32;
-  const price = new BN(message.subarray(cursor, cursor + 8), "be");
+  const price = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
-  const confidence = new BN(message.subarray(cursor, cursor + 8), "be");
+  const confidence = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
   const exponent = message.readInt32BE(cursor);
   cursor += 4;
-  const publishTime = new BN(message.subarray(cursor, cursor + 8), "be");
+  const publishTime = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
-  const prevPublishTime = new BN(message.subarray(cursor, cursor + 8), "be");
+  const prevPublishTime = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
-  const emaPrice = new BN(message.subarray(cursor, cursor + 8), "be");
+  const emaPrice = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
-  const emaConf = new BN(message.subarray(cursor, cursor + 8), "be");
+  const emaConf = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
   return {
     feedId,
@@ -52,19 +59,19 @@ function parseTwapMessage(message) {
   cursor += 1;
   const feedId = message.subarray(cursor, cursor + 32);
   cursor += 32;
-  const cumulativePrice = new BN(message.subarray(cursor, cursor + 16), "be");
+  const cumulativePrice = bufToBigInt(message.subarray(cursor, cursor + 16));
   cursor += 16;
-  const cumulativeConf = new BN(message.subarray(cursor, cursor + 16), "be");
+  const cumulativeConf = bufToBigInt(message.subarray(cursor, cursor + 16));
   cursor += 16;
-  const numDownSlots = new BN(message.subarray(cursor, cursor + 8), "be");
+  const numDownSlots = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
   const exponent = message.readInt32BE(cursor);
   cursor += 4;
-  const publishTime = new BN(message.subarray(cursor, cursor + 8), "be");
+  const publishTime = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
-  const prevPublishTime = new BN(message.subarray(cursor, cursor + 8), "be");
+  const prevPublishTime = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
-  const publishSlot = new BN(message.subarray(cursor, cursor + 8), "be");
+  const publishSlot = bufToBigInt(message.subarray(cursor, cursor + 8));
   cursor += 8;
   return {
     feedId,

package/dist/esm/sdk/market/pricefeeds/updates/PythUpdater.js

@@ -30,6 +30,9 @@ const PythOptions = z.object({
 });
 class PythUpdater extends SDKConstruct {
   #cache;
+  /**
+   * Fixed pyth historic timestamp in seconds
+   */
   #historicalTimestamp;
   #apiProxy;
   #failOnMissingFeeds;
@@ -44,10 +47,7 @@ class PythUpdater extends SDKConstruct {
         `using historical timestamp ${this.#historicalTimestamp}`
       );
     }
-    this.#cache = new PriceUpdatesCache({
-      // currently staleness period is 240 seconds on all networks, add some buffer
-      // this period of 4 minutes is selected based on time that is required for user to sign transaction with wallet
-      // so it's unlikely to decrease
+    this.#cache = opts.cache ?? new PriceUpdatesCache({
       ttl: cacheTTL ?? 225 * 1e3,
       historical: !!historicTimestamp
     });
@@ -96,6 +96,9 @@ class PythUpdater extends SDKConstruct {
     );
     return results;
   }
+  get historical() {
+    return !!this.#historicalTimestamp;
+  }
   /**
    * Gets pyth payloads
    * @param dataFeedsIds

package/dist/esm/sdk/market/pricefeeds/updates/RedstoneUpdater.js

@@ -52,10 +52,7 @@ class RedstoneUpdater extends SDKConstruct {
         `using historical timestamp ${this.#historicalTimestampMs}`
       );
     }
-    this.#cache = new PriceUpdatesCache({
-      // currently staleness period is 240 seconds on all networks, add some buffer
-      // this period of 4 minutes is selected based on time that is required for user to sign transaction with wallet
-      // so it's unlikely to decrease
+    this.#cache = opts.cache ?? new PriceUpdatesCache({
       ttl: opts.cacheTTL ?? 225 * 1e3,
       historical: !!ts
     });
@@ -126,6 +123,9 @@ class RedstoneUpdater extends SDKConstruct {
     );
     return results;
   }
+  get historical() {
+    return !!this.#historicalTimestampMs;
+  }
   /**
    * Gets payloads, retries once if it has expired while inflight
    * @param dataServiceId

package/dist/esm/sdk/market/pricefeeds/updates/fetchPythPayloads.js

@@ -104,7 +104,7 @@ function splitAccumulatorUpdates(binary) {
     const msg = parsePriceFeedMessage(upd);
     results.push({
       dataFeedId: toHex(msg.feedId),
-      timestamp: msg.publishTime.toNumber(),
+      timestamp: Number(msg.publishTime),
       data: toHex(sliceAccumulatorUpdateData(data, i, i + 1))
     });
   }

package/dist/esm/sdk/market/pricefeeds/updates/index.js

@@ -1,8 +1,10 @@
 export * from "./fetchPythPayloads.js";
 export * from "./fetchRedstonePayloads.js";
+import { PriceUpdatesCache } from "./PriceUpdatesCache.js";
 import { PythOptions, PythUpdater } from "./PythUpdater.js";
 import { RedstoneOptions, RedstoneUpdater } from "./RedstoneUpdater.js";
 export {
+  PriceUpdatesCache,
   PythOptions,
   PythUpdater,
   RedstoneOptions,

package/dist/esm/sdk/options.js

@@ -4,59 +4,13 @@ import {
   RedstoneOptions
 } from "./market/pricefeeds/updates/index.js";
 import { ZodAddress } from "./utils/index.js";
-const SDKOptions = z.object({
-  /**
-   * Override address of the Gearbox AddressProvider contract.
-   * If not set, uses default universal address provider address {@link ADDRESS_PROVIDER_V310}
-   **/
-  addressProvider: ZodAddress().optional(),
-  /**
-   * Addresses of market configurator contracts to load.
-   * If not set, all default market configurators for the chain are loaded
-   * (from {@link GearboxChain.defaultMarketConfigurators})
-   **/
-  marketConfigurators: z.array(ZodAddress()).optional(),
-  /**
-   * Addresses of KYC factory contracts to load.
-   * If not set, all default KYC factories for the chain are loaded
-   * (from {@link GearboxChain.kycFactories})
-   **/
-  kycFactories: z.array(ZodAddress()).optional(),
-  /**
-   * Pin SDK to a specific block number during attach.
-   * When set, all on-chain reads use this block instead of `latest`.
-   **/
-  blockNumber: z.union([z.bigint().nonnegative(), z.number().int().nonnegative()]).optional(),
-  /**
-   * Skip fetching updatable price feeds on attach and sync.
-   * Speeds up initialisation when prices are not needed.
-   **/
-  ignoreUpdateablePrices: z.boolean().optional(),
-  /**
-   * Pool addresses whose markets should be skipped during attach/hydrate/sync.
-   **/
-  ignoreMarkets: z.array(ZodAddress()).optional(),
-  /**
-   * When `true`, throw on unrecognised contract types instead of falling
-   * back to a generic contract wrapper.
-   **/
+const OnchainSDKOptionsSchema = z.object({
+  /** When `true`, throw on unrecognised contract types. */
   strictContractTypes: z.boolean().optional(),
-  /**
-   * Plugins that extend SDK functionality.
-   **/
+  /** Plugins that extend SDK functionality. */
   plugins: z.record(z.string(), z.any()).optional(),
-  /**
-   * Custom logger implementation.
-   **/
+  /** Custom logger implementation. */
   logger: z.any(),
-  /**
-   * Options for Redstone price-feed updates.
-   **/
-  redstone: RedstoneOptions.optional(),
-  /**
-   * Options for Pyth price-feed updates.
-   **/
-  pyth: PythOptions.optional(),
   /**
    * Explicit gas limit for read-only `eth_call` requests.
    * `null` disables the gas limit entirely; `undefined` uses the SDK default.
@@ -64,6 +18,23 @@ const SDKOptions = z.object({
    **/
   gasLimit: z.bigint().nonnegative().nullable().optional()
 });
+const AttachOptionsSchema = z.object({
+  /** Override address of the Gearbox AddressProvider contract. */
+  addressProvider: ZodAddress().optional(),
+  /** Addresses of market configurator contracts to load. */
+  marketConfigurators: z.array(ZodAddress()).optional(),
+  /** Pin SDK to a specific block number during attach. */
+  blockNumber: z.union([z.bigint().nonnegative(), z.number().int().nonnegative()]).optional(),
+  /** Skip fetching updatable price feeds on attach and sync. */
+  ignoreUpdateablePrices: z.boolean().optional(),
+  /** Pool addresses whose markets should be skipped. */
+  ignoreMarkets: z.array(ZodAddress()).optional(),
+  /** Options for Redstone price-feed updates. */
+  redstone: RedstoneOptions.optional(),
+  /** Options for Pyth price-feed updates. */
+  pyth: PythOptions.optional()
+});
 export {
-  SDKOptions
+  AttachOptionsSchema,
+  OnchainSDKOptionsSchema
 };

package/dist/esm/sdk/plugins/BasePlugin.js

@@ -1,3 +1,4 @@
+import { SdkAlreadyAttachedError, SdkNotAttachedError } from "../core/index.js";
 class BasePlugin {
   #sdk;
   logger;
@@ -20,19 +21,25 @@ class BasePlugin {
    **/
   get sdk() {
     if (!this.#sdk) {
-      throw new Error("SDK is not attached");
+      throw new SdkNotAttachedError();
     }
     return this.#sdk;
   }
+  /**
+   * @internal
+   * Set the SDK instance. Called by the SDK constructor.
+   * @param sdk - The SDK instance.
+   * @throws Error if the SDK is already attached.
+   */
   set sdk(sdk) {
     if (this.#sdk) {
-      throw new Error("SDK is already attached");
+      throw new SdkAlreadyAttachedError();
     }
     this.#sdk = sdk;
     this.logger = sdk.logger?.child?.({ name: this.constructor.name }) ?? sdk.logger;
   }
   /**
-   * {@inheritDoc IGearboxSDKPlugin.attach}
+   * {@inheritDoc IOnchainSDKPlugin.attach}
    **/
   async attach() {
     if (this.loadOnAttach) {
@@ -40,7 +47,7 @@ class BasePlugin {
     }
   }
   /**
-   * {@inheritDoc IGearboxSDKPlugin.syncState}
+   * {@inheritDoc IOnchainSDKPlugin.syncState}
    **/
   async syncState() {
     await this.load(false);