@gearbox-protocol/sdk 11.6.8 → 11.7.0

package/dist/cjs/sdk/GearboxSDK.js

@@ -102,7 +102,7 @@ class GearboxSDK {
   /**
    * Token metadata such as symbol and decimals
    */
-  tokensMeta = new import_base.TokensMeta(void 0, "tokensMeta");
+  tokensMeta;
   addHook = this.#hooks.addHook.bind(this.#hooks);
   removeHook = this.#hooks.removeHook.bind(this.#hooks);
   static async attach(options) {
@@ -165,6 +165,7 @@ class GearboxSDK {
     if (options.gasLimit !== null) {
       this.gasLimit = options.gasLimit || 550000000n;
     }
+    this.tokensMeta = new import_base.TokensMeta(this);
   }
   async #attach(opts) {
     const {

package/dist/cjs/sdk/base/TokensMeta.js

@@ -21,14 +21,45 @@ __export(TokensMeta_exports, {
   TokensMeta: () => TokensMeta
 });
 module.exports = __toCommonJS(TokensMeta_exports);
+var import_iVersion = require("../../abi/iVersion.js");
+var import__ = require("../index.js");
 var import_utils = require("../utils/index.js");
 class TokensMeta extends import_utils.AddressMap {
+  #sdk;
+  #phantomTokensLoaded;
+  constructor(sdk) {
+    super(void 0, "tokensMeta");
+    this.#sdk = sdk;
+  }
   symbol(token) {
     return this.mustGet(token).symbol;
   }
   decimals(token) {
     return this.mustGet(token).decimals;
   }
+  /**
+   * Returns the phantom token type for a given token, or undefined for normal tokens
+   * Throws if the phantom token data is not loaded
+   */
+  phantomTokenType(token) {
+    if (!this.#phantomTokensLoaded?.has(token)) {
+      throw new Error("phantom token data not loaded");
+    }
+    return this.mustGet(token).phantomTokenType;
+  }
+  /**
+   * Returns a map of all phantom tokens
+   * Throws if the phantom token data is not loaded
+   */
+  get phantomTokens() {
+    if (!this.#phantomTokensLoaded) {
+      throw new Error("phantom tokens not loaded");
+    }
+    return new import_utils.AddressMap(
+      this.entries().filter(([_, v]) => !!v.phantomTokenType),
+      "phantomTokens"
+    );
+  }
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
     const amount = typeof arg0 === "object" ? arg0.balance : arg1;
@@ -47,6 +78,32 @@ class TokensMeta extends import_utils.AddressMap {
     }
     return meta;
   }
+  /**
+   * Loads phantom token data for all known tokens from chain
+   */
+  async loadPhantomTokens() {
+    this.#phantomTokensLoaded = new import_utils.AddressSet();
+    const tokens = this.keys();
+    const resp = await this.#sdk.client.multicall({
+      contracts: tokens.map(
+        (t) => ({
+          address: t,
+          abi: import_iVersion.iVersionAbi,
+          functionName: "contractType"
+        })
+      ),
+      allowFailure: true
+    });
+    for (let i = 0; i < resp.length; i++) {
+      if (resp[i].status === "success") {
+        const contractType = (0, import__.bytes32ToString)(resp[i].result);
+        if (contractType.startsWith("PHANTOM_TOKEN::")) {
+          this.mustGet(tokens[i]).phantomTokenType = contractType;
+        }
+      }
+      this.#phantomTokensLoaded.add(tokens[i]);
+    }
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/sdk/constants/index.js

@@ -21,6 +21,7 @@ __reExport(constants_exports, require("./bot-permissions.js"), module.exports);
 __reExport(constants_exports, require("./math.js"), module.exports);
 __reExport(constants_exports, require("./networks.js"), module.exports);
 __reExport(constants_exports, require("./periphery.js"), module.exports);
+__reExport(constants_exports, require("./phantom-tokens.js"), module.exports);
 __reExport(constants_exports, require("./versions.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -30,5 +31,6 @@ __reExport(constants_exports, require("./versions.js"), module.exports);
   ...require("./math.js"),
   ...require("./networks.js"),
   ...require("./periphery.js"),
+  ...require("./phantom-tokens.js"),
   ...require("./versions.js")
 });

package/dist/cjs/sdk/constants/phantom-tokens.js

@@ -0,0 +1,36 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var phantom_tokens_exports = {};
+__export(phantom_tokens_exports, {
+  PHANTOM_TOKEN_CONTRACT_TYPES: () => PHANTOM_TOKEN_CONTRACT_TYPES
+});
+module.exports = __toCommonJS(phantom_tokens_exports);
+const PHANTOM_TOKEN_CONTRACT_TYPES = [
+  "PHANTOM_TOKEN::CONVEX",
+  "PHANTOM_TOKEN::INFINIFI_UNWIND",
+  "PHANTOM_TOKEN::INFRARED",
+  "PHANTOM_TOKEN::MELLOW_WITHDRAWAL",
+  "PHANTOM_TOKEN::MIDAS_REDEMPTION",
+  "PHANTOM_TOKEN::STAKING_REWARDS",
+  "PHANTOM_TOKEN::UPSHIFT_WITHDRAW"
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PHANTOM_TOKEN_CONTRACT_TYPES
+});

package/dist/esm/sdk/GearboxSDK.js

@@ -101,7 +101,7 @@ class GearboxSDK {
   /**
    * Token metadata such as symbol and decimals
    */
-  tokensMeta = new TokensMeta(void 0, "tokensMeta");
+  tokensMeta;
   addHook = this.#hooks.addHook.bind(this.#hooks);
   removeHook = this.#hooks.removeHook.bind(this.#hooks);
   static async attach(options) {
@@ -164,6 +164,7 @@ class GearboxSDK {
     if (options.gasLimit !== null) {
       this.gasLimit = options.gasLimit || 550000000n;
     }
+    this.tokensMeta = new TokensMeta(this);
   }
   async #attach(opts) {
     const {

package/dist/esm/sdk/base/TokensMeta.js

@@ -1,11 +1,42 @@
-import { AddressMap, formatBN } from "../utils/index.js";
+import { iVersionAbi } from "../../abi/iVersion.js";
+import { bytes32ToString } from "../index.js";
+import { AddressMap, AddressSet, formatBN } from "../utils/index.js";
 class TokensMeta extends AddressMap {
+  #sdk;
+  #phantomTokensLoaded;
+  constructor(sdk) {
+    super(void 0, "tokensMeta");
+    this.#sdk = sdk;
+  }
   symbol(token) {
     return this.mustGet(token).symbol;
   }
   decimals(token) {
     return this.mustGet(token).decimals;
   }
+  /**
+   * Returns the phantom token type for a given token, or undefined for normal tokens
+   * Throws if the phantom token data is not loaded
+   */
+  phantomTokenType(token) {
+    if (!this.#phantomTokensLoaded?.has(token)) {
+      throw new Error("phantom token data not loaded");
+    }
+    return this.mustGet(token).phantomTokenType;
+  }
+  /**
+   * Returns a map of all phantom tokens
+   * Throws if the phantom token data is not loaded
+   */
+  get phantomTokens() {
+    if (!this.#phantomTokensLoaded) {
+      throw new Error("phantom tokens not loaded");
+    }
+    return new AddressMap(
+      this.entries().filter(([_, v]) => !!v.phantomTokenType),
+      "phantomTokens"
+    );
+  }
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
     const amount = typeof arg0 === "object" ? arg0.balance : arg1;
@@ -24,6 +55,32 @@ class TokensMeta extends AddressMap {
     }
     return meta;
   }
+  /**
+   * Loads phantom token data for all known tokens from chain
+   */
+  async loadPhantomTokens() {
+    this.#phantomTokensLoaded = new AddressSet();
+    const tokens = this.keys();
+    const resp = await this.#sdk.client.multicall({
+      contracts: tokens.map(
+        (t) => ({
+          address: t,
+          abi: iVersionAbi,
+          functionName: "contractType"
+        })
+      ),
+      allowFailure: true
+    });
+    for (let i = 0; i < resp.length; i++) {
+      if (resp[i].status === "success") {
+        const contractType = bytes32ToString(resp[i].result);
+        if (contractType.startsWith("PHANTOM_TOKEN::")) {
+          this.mustGet(tokens[i]).phantomTokenType = contractType;
+        }
+      }
+      this.#phantomTokensLoaded.add(tokens[i]);
+    }
+  }
 }
 export {
   TokensMeta

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

@@ -4,4 +4,5 @@ export * from "./bot-permissions.js";
 export * from "./math.js";
 export * from "./networks.js";
 export * from "./periphery.js";
+export * from "./phantom-tokens.js";
 export * from "./versions.js";

package/dist/esm/sdk/constants/phantom-tokens.js

@@ -0,0 +1,12 @@
+const PHANTOM_TOKEN_CONTRACT_TYPES = [
+  "PHANTOM_TOKEN::CONVEX",
+  "PHANTOM_TOKEN::INFINIFI_UNWIND",
+  "PHANTOM_TOKEN::INFRARED",
+  "PHANTOM_TOKEN::MELLOW_WITHDRAWAL",
+  "PHANTOM_TOKEN::MIDAS_REDEMPTION",
+  "PHANTOM_TOKEN::STAKING_REWARDS",
+  "PHANTOM_TOKEN::UPSHIFT_WITHDRAW"
+];
+export {
+  PHANTOM_TOKEN_CONTRACT_TYPES
+};

package/dist/types/sdk/base/TokensMeta.d.ts

@@ -1,4 +1,6 @@
 import type { Address } from "viem";
+import type { GearboxSDK } from "../GearboxSDK.js";
+import { type PhantomTokenContractType } from "../index.js";
 import type { Asset } from "../router/index.js";
 import { AddressMap } from "../utils/index.js";
 import type { TokenMetaData } from "./types.js";
@@ -6,11 +8,33 @@ export interface FormatBNOptions {
     precision?: number;
     symbol?: boolean;
 }
-export declare class TokensMeta extends AddressMap<TokenMetaData> {
+export interface TokenMetaDataExtended extends TokenMetaData {
+    /**
+     * Undefined if token is not a phantom token
+     */
+    phantomTokenType?: PhantomTokenContractType;
+}
+export declare class TokensMeta extends AddressMap<TokenMetaDataExtended> {
+    #private;
+    constructor(sdk: GearboxSDK);
     symbol(token: Address): string;
     decimals(token: Address): number;
+    /**
+     * Returns the phantom token type for a given token, or undefined for normal tokens
+     * Throws if the phantom token data is not loaded
+     */
+    phantomTokenType(token: Address): PhantomTokenContractType | undefined;
+    /**
+     * Returns a map of all phantom tokens
+     * Throws if the phantom token data is not loaded
+     */
+    get phantomTokens(): AddressMap<TokenMetaDataExtended>;
     formatBN(asset: Asset, options?: FormatBNOptions): string;
     formatBN(token: Address, amount: number | bigint | string | undefined, options?: FormatBNOptions): string;
     findBySymbol(symbol: string): TokenMetaData | undefined;
     mustFindBySymbol(symbol: string): TokenMetaData;
+    /**
+     * Loads phantom token data for all known tokens from chain
+     */
+    loadPhantomTokens(): Promise<void>;
 }

package/dist/types/sdk/constants/index.d.ts

@@ -4,4 +4,5 @@ export * from "./bot-permissions.js";
 export * from "./math.js";
 export * from "./networks.js";
 export * from "./periphery.js";
+export * from "./phantom-tokens.js";
 export * from "./versions.js";

package/dist/types/sdk/constants/phantom-tokens.d.ts

@@ -0,0 +1,2 @@
+export declare const PHANTOM_TOKEN_CONTRACT_TYPES: readonly ["PHANTOM_TOKEN::CONVEX", "PHANTOM_TOKEN::INFINIFI_UNWIND", "PHANTOM_TOKEN::INFRARED", "PHANTOM_TOKEN::MELLOW_WITHDRAWAL", "PHANTOM_TOKEN::MIDAS_REDEMPTION", "PHANTOM_TOKEN::STAKING_REWARDS", "PHANTOM_TOKEN::UPSHIFT_WITHDRAW"];
+export type PhantomTokenContractType = (typeof PHANTOM_TOKEN_CONTRACT_TYPES)[number];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "11.6.8",
+  "version": "11.7.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",