@gearbox-protocol/sdk 13.0.0-next.9 → 13.0.1

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

@@ -11,6 +11,8 @@ import {
   bytes32ToString,
   createRawTx,
   functionArgsToMap,
+  functionArgsToRecord,
+  getFunctionSignature,
   json_stringify
 } from "../utils/index.js";
 import { Construct } from "./Construct.js";
@@ -39,15 +41,15 @@ class BaseContract extends Construct {
   version;
   address;
   name;
-  constructor({ client, logger }, args) {
-    super({ client, logger });
+  constructor(options, args) {
+    super(options);
     this.abi = args.abi;
     this.address = getAddress(args.addr);
     this.contract = getContract({
       address: this.address,
       // add exceptions for better error decoding
       abi: [...this.abi, ...errorAbis],
-      client
+      client: this.client
     });
     this.version = Number(args.version || 0);
     this.contractType = args.contractType ?? "";
@@ -55,8 +57,11 @@ class BaseContract extends Construct {
       this.contractType = bytes32ToString(this.contractType);
     }
     this.name = args.name || this.contractType || this.address || this.constructor.name;
-    this.register.setContract(this.address, this);
-    this.register.setAddressLabel(this.address, this.name);
+    const register = this.safeGetRegister();
+    if (register) {
+      register.setContract(this.address, this);
+      register.setAddressLabel(this.address, this.name);
+    }
   }
   stateHuman(_ = true) {
     return {
@@ -190,11 +195,62 @@ class BaseContract extends Construct {
       chainId: this.chainId,
       target: this.address,
       contractType: this.contractType,
-      label: this.register.labelAddress(this.address, true),
+      label: this.labelAddress(this.address, true),
       functionName,
       args
     };
   }
+  /**
+   * Parses calldata into structured result with preserved original types.
+   * When strict is true, throws {@link ContractParseError} on unknown selectors;
+   * otherwise returns a fallback with the raw calldata.
+   */
+  parseFunctionDataV2(calldata, strict) {
+    try {
+      const decoded = decodeFunctionData({
+        abi: this.abi,
+        data: calldata
+      });
+      const functionName = getFunctionSignature(this.abi, calldata);
+      return this.wrapParseCallV2(
+        functionName,
+        this.parseFunctionParamsV2(decoded, strict)
+      );
+    } catch (e) {
+      if (strict) {
+        throw new ContractParseError(e, {
+          address: this.address,
+          callData: calldata,
+          contractName: this.name
+        });
+      }
+      this.logger?.warn(e);
+      const selector = calldata.slice(0, 10);
+      const data = `0x${calldata.slice(10)}`;
+      return this.wrapParseCallV2(`unknown function ${selector}`, {
+        _data: data
+      });
+    }
+  }
+  /**
+   * Converts viem-decoded function arguments to a record preserving original types.
+   * Override in subclasses to handle nesting (e.g., multicall inner calls).
+   * @param strict - propagated from parseFunctionDataV2 for recursive parsing
+   */
+  parseFunctionParamsV2(params, _strict) {
+    return functionArgsToRecord(this.abi, params.functionName, params.args);
+  }
+  wrapParseCallV2(functionName, rawArgs) {
+    return {
+      chainId: this.chainId,
+      target: this.address,
+      contractType: this.contractType,
+      label: this.labelAddress(this.address, true),
+      version: this.version,
+      functionName,
+      rawArgs
+    };
+  }
   /**
    * Creates a raw transaction for a function in this contract
    * @param parameters

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

@@ -2,16 +2,6 @@ import { NOT_DEPLOYED } from "../constants/addresses.js";
 import { AddressMap } from "../utils/AddressMap.js";
 import { TokensMeta } from "./TokensMeta.js";
 class ChainContractsRegister {
-  static #chains = /* @__PURE__ */ new Map();
-  static for(client, logger) {
-    const chainId = client.chain.id;
-    let result = ChainContractsRegister.#chains.get(chainId);
-    if (!result) {
-      result = new ChainContractsRegister(client, logger);
-      ChainContractsRegister.#chains.set(chainId, result);
-    }
-    return result;
-  }
   contracts = new AddressMap(
     [],
     "contracts"
@@ -113,6 +103,39 @@ class ChainContractsRegister {
       (call) => this.parseFunctionData(call.target, call.callData)
     );
   }
+  /**
+   * Parses calldata for a contract at the given address, preserving original types.
+   * When strict is true, throws on unknown address or selector; otherwise returns a fallback.
+   */
+  parseFunctionDataV2(address, calldata, strict) {
+    const contract = this.contracts.get(address);
+    if (contract) {
+      return contract.parseFunctionDataV2(calldata, strict);
+    }
+    if (strict) {
+      throw new Error(`contract ${address} not found on chain ${this.chainId}`);
+    }
+    const selector = calldata.slice(0, 10);
+    const data = `0x${calldata.slice(10)}`;
+    return {
+      chainId: this.chainId,
+      target: address,
+      contractType: "",
+      label: this.labelAddress(address, true),
+      version: 0,
+      functionName: `unknown function ${selector}`,
+      rawArgs: { _data: data }
+    };
+  }
+  /**
+   * Parses multicalls preserving original types.
+   * When strict is true, throws on unknown targets or selectors.
+   */
+  parseMultiCallV2(calls, strict) {
+    return calls.map(
+      (call) => this.parseFunctionDataV2(call.target, call.callData, strict)
+    );
+  }
 }
 export {
   ChainContractsRegister

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

@@ -3,19 +3,41 @@ import { ChainContractsRegister } from "./ChainContractsRegister.js";
 class Construct {
   logger;
   client;
-  register;
+  #register;
   /**
    * Indicates that contract state needs to be updated
    */
   #dirty = false;
-  constructor({ client, logger }) {
-    this.client = client;
-    this.register = ChainContractsRegister.for(client, logger);
+  constructor(options) {
+    if (options instanceof ChainContractsRegister) {
+      this.#register = options;
+      this.client = options.client;
+    } else if ("register" in options) {
+      this.#register = options.register;
+      this.client = options.register.client;
+    } else {
+      this.client = options.client;
+    }
     this.logger = childLogger(
       this.constructor.name,
-      this.register.logger ?? logger
+      this.#register?.logger ?? options.logger
     );
   }
+  /**
+   * Throws if register was not provided in constructor options
+   * Ephemeral contracts that do not need to access other contracts may not need it
+   */
+  get register() {
+    if (!this.#register) {
+      throw new Error(
+        "contracts register not available, it must be provided if contract needs to access other contracts"
+      );
+    }
+    return this.#register;
+  }
+  safeGetRegister() {
+    return this.#register;
+  }
   get chain() {
     return this.client.chain;
   }
@@ -37,19 +59,11 @@ class Construct {
   set dirty(value) {
     this.#dirty = value;
   }
-  /**
-   * Syntax sugar for rgister.tokensMeta
-   */
   get tokensMeta() {
     return this.register.tokensMeta;
   }
-  /**
-   * Syntax suggar for getting contract labels
-   * @param address
-   * @returns
-   */
-  labelAddress(address) {
-    return this.register.labelAddress(address);
+  labelAddress(address, omitAddress) {
+    return this.#register?.labelAddress(address, omitAddress) ?? address;
   }
   /**
    * Returns list of addresses that should be watched for events to sync state

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

@@ -1,8 +1,8 @@
 import { BaseContract } from "./BaseContract.js";
 const abi = [];
 class PlaceholderContract extends BaseContract {
-  constructor(sdk, args) {
-    super(sdk, { ...args, abi });
+  constructor(options, args) {
+    super(options, { ...args, abi });
   }
 }
 export {

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

@@ -2,7 +2,7 @@ import { Construct } from "./Construct.js";
 class SDKConstruct extends Construct {
   sdk;
   constructor(sdk) {
-    super(sdk);
+    super({ register: sdk });
     this.sdk = sdk;
   }
 }

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

@@ -1,24 +1,20 @@
-import {
-  decodeAbiParameters
-} from "viem";
-import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
 import { iVersionAbi } from "../../abi/iVersion.js";
 import {
+  AddressMap,
+  AddressSet,
   bytes32ToString,
-  KYC_UNDERLYING_DEFAULT,
-  KYC_UNDERLYING_ON_DEMAND
-} from "../index.js";
-import { AddressMap, AddressSet, formatBN } from "../utils/index.js";
+  formatBN
+} from "../utils/index.js";
 class TokensMeta extends AddressMap {
   #client;
-  #tokenDataLoaded = new AddressSet();
+  #phantomTokensLoaded;
   constructor(client) {
     super(void 0, "tokensMeta");
     this.#client = client;
   }
   reset() {
     this.clear();
-    this.#tokenDataLoaded.clear();
+    this.#phantomTokensLoaded = void 0;
   }
   symbol(token) {
     return this.mustGet(token).symbol;
@@ -26,43 +22,28 @@ class TokensMeta extends AddressMap {
   decimals(token) {
     return this.mustGet(token).decimals;
   }
-  isPhantomToken(t) {
-    if (!this.#tokenDataLoaded.has(t.addr)) {
-      throw new Error(
-        `extended token data not loaded for ${t.symbol} (${t.addr})`
-      );
-    }
-    return "contractType" in t && t.contractType.startsWith("PHANTOM_TOKEN::");
-  }
-  isKYCUnderlying(t) {
-    if (!this.#tokenDataLoaded.has(t.addr)) {
-      throw new Error(
-        `extended token data not loaded for ${t.symbol} (${t.addr})`
-      );
+  /**
+   * 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 "contractType" in t && t.contractType.startsWith("KYC_UNDERLYING::");
+    return this.mustGet(token).phantomTokenType;
   }
   /**
    * Returns a map of all phantom tokens
    * Throws if the phantom token data is not loaded
    */
   get phantomTokens() {
-    const result = new AddressMap();
-    for (const [token, meta] of this.entries()) {
-      if (this.isPhantomToken(meta)) {
-        result.upsert(token, meta);
-      }
+    if (!this.#phantomTokensLoaded) {
+      throw new Error("phantom tokens not loaded");
     }
-    return result;
-  }
-  get kycUnderlyings() {
-    const result = new AddressMap();
-    for (const [token, meta] of this.entries()) {
-      if (this.isKYCUnderlying(meta)) {
-        result.upsert(token, meta);
-      }
-    }
-    return result;
+    return new AddressMap(
+      this.entries().filter(([_, v]) => !!v.phantomTokenType),
+      "phantomTokens"
+    );
   }
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
@@ -83,92 +64,30 @@ class TokensMeta extends AddressMap {
     return meta;
   }
   /**
-   * Loads token information about phantom token and KYC underlying tokens
-   *
-   * @param tokens - tokens to load data for, defaults to all tokens
+   * Loads phantom token data for all known tokens from chain
    */
-  async loadTokenData(...tokens) {
-    const tokenz = new AddressSet(tokens.length > 0 ? tokens : this.keys());
-    const tokensToLoad = Array.from(tokenz.difference(this.#tokenDataLoaded));
-    if (tokensToLoad.length === 0) {
-      return;
-    }
+  async loadPhantomTokens() {
+    this.#phantomTokensLoaded = new AddressSet();
+    const tokens = this.keys();
     const resp = await this.#client.multicall({
-      contracts: tokensToLoad.flatMap(
-        (t) => [
-          {
-            address: t,
-            abi: iVersionAbi,
-            functionName: "contractType"
-          },
-          {
-            address: t,
-            abi: iStateSerializerAbi,
-            functionName: "serialize"
-          }
-        ]
+      contracts: tokens.map(
+        (t) => ({
+          address: t,
+          abi: iVersionAbi,
+          functionName: "contractType"
+        })
       ),
       allowFailure: true,
       batchSize: 0
     });
-    for (let i = 0; i < tokensToLoad.length; i++) {
-      this.#overrideTokenMeta(tokensToLoad[i], resp[i], resp[i + 1]);
-      this.#tokenDataLoaded.add(tokensToLoad[i]);
-    }
-  }
-  #overrideTokenMeta(token, contractTypeResp, serializeResp) {
-    const meta = this.mustGet(token);
-    if (contractTypeResp.status === "success") {
-      const contractType = bytes32ToString(contractTypeResp.result);
-      if (contractType.startsWith("KYC_UNDERLYING::")) {
-        if (serializeResp.status === "success") {
-          this.#overrideKYCUnderlying(meta, contractType, serializeResp.result);
-        } else {
-          throw new Error(
-            `token ${meta.symbol} (${token}) is ${contractType} but serialize failed: ${serializeResp.error}`
-          );
+    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;
         }
-      } else if (contractType.startsWith("PHANTOM_TOKEN::")) {
-        this.upsert(token, {
-          ...meta,
-          contractType
-        });
       }
-    }
-  }
-  #overrideKYCUnderlying(meta, contractType, serialized) {
-    if (contractType === KYC_UNDERLYING_DEFAULT) {
-      const decoded = decodeAbiParameters(
-        [
-          { type: "address", name: "kycFactory" },
-          { type: "address", name: "asset" }
-        ],
-        serialized
-      );
-      this.upsert(meta.addr, {
-        ...meta,
-        contractType,
-        kycFactory: decoded[0],
-        asset: decoded[1]
-      });
-    } else if (contractType === KYC_UNDERLYING_ON_DEMAND) {
-      const decoded = decodeAbiParameters(
-        [
-          { type: "address", name: "kycFactory" },
-          { type: "address", name: "asset" },
-          { type: "address", name: "pool" },
-          { type: "address", name: "liquidityProvider" }
-        ],
-        serialized
-      );
-      this.upsert(meta.addr, {
-        ...meta,
-        contractType,
-        kycFactory: decoded[0],
-        asset: decoded[1],
-        pool: decoded[2],
-        liquidityProvider: decoded[3]
-      });
+      this.#phantomTokensLoaded.add(tokens[i]);
     }
   }
 }

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

@@ -0,0 +1,11 @@
+class MissingSerializedParamsError extends Error {
+  constructor(propertyName) {
+    super(
+      `Cannot access '${propertyName}': serializedParams were not provided`
+    );
+    this.name = "MissingSerializedParamsError";
+  }
+}
+export {
+  MissingSerializedParamsError
+};

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

@@ -1,8 +1,8 @@
 export * from "./BaseContract.js";
 export * from "./ChainContractsRegister.js";
 export * from "./Construct.js";
+export * from "./errors.js";
 export * from "./PlaceholderContract.js";
 export * from "./SDKConstruct.js";
 export * from "./TokensMeta.js";
-export * from "./token-types.js";
 export * from "./types.js";

package/dist/esm/sdk/chain/chains.js

@@ -13,6 +13,7 @@ import {
   monad,
   optimism,
   plasma,
+  somnia,
   sonic,
   worldchain
 } from "viem/chains";
@@ -55,14 +56,12 @@ const chains = {
       ...mainnet,
       network: "Mainnet",
       defaultMarketConfigurators: {
-        "0x354fe9f450F60b8547f88BE042E4A45b46128a06": "Chaos Labs",
-        "0x4d427D418342d8CE89a7634c3a402851978B680A": "K3",
         "0xc168343c791d56dd1da4b4b8b0cc1c1ec1a16e6b": "cp0x",
         "0x3b56538833fc02f4f0e75609390f26ded0c32e42": "Re7",
         "0x7a133fbd01736fd076158307c9476cc3877f1af5": "Invariant Group",
         "0x09d8305F49374AEA6A78aF6C996df2913e8f3b19": "Tulipa",
         "0x1b265b97eb169fb6668e3258007c3b0242c7bdbe": "kpk",
-        "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "Edge UltraYield",
+        "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "UltraYield",
         "0x601067eba24bb5b558a184fc082525637e96a42d": "Gami Labs"
       },
       testMarketConfigurators: {
@@ -73,8 +72,7 @@ const chains = {
         address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
         symbol: "USDC"
       },
-      firstBlock: 18433056n
-      // AddressProvderV3 0x9ea7b04Da02a5373317D745c1571c84aaD03321D
+      firstBlock: 22358644n
     },
     "ethereum-rpc"
   ),
@@ -100,7 +98,7 @@ const chains = {
       network: "Optimism",
       defaultMarketConfigurators: {
         "0x2a15969CE5320868eb609680751cF8896DD92De5": "Chaos Labs",
-        "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "Edge UltraYield"
+        "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "UltraYield"
       },
       isPublic: true,
       wellKnownToken: {
@@ -169,13 +167,14 @@ const chains = {
     network: "Monad",
     defaultMarketConfigurators: {
       "0x16956912813ab9a38d95730b52a8cf53e860a7c5": "Tulipa",
-      "0x7c6ee1bf9c1eb3ee55bdbdc1e8d0317aab718e0a": "Edge UltraYield"
+      "0x7c6ee1bf9c1eb3ee55bdbdc1e8d0317aab718e0a": "UltraYield"
     },
     isPublic: true,
     wellKnownToken: {
       address: "0xe7cd86e13AC4309349F30B3435a9d337750fC82D",
       symbol: "USDT0"
-    }
+    },
+    firstBlock: 34650262n
   }),
   Berachain: withPublicNode(
     {
@@ -250,8 +249,7 @@ const chains = {
       address: "0x796Ea11Fa2dD751eD01b53C372fFDB4AAa8f00F9",
       symbol: "USDC"
     },
-    firstBlock: 16672969n
-    // TODO: has no block explorer API
+    firstBlock: 16672963n
   }),
   Hemi: defineChain({
     ...hemi,
@@ -288,7 +286,7 @@ const chains = {
     network: "Plasma",
     defaultMarketConfigurators: {
       "0x7a133fbd01736fd076158307c9476cc3877f1af5": "Invariant Group",
-      "0x4bce62622be621ce036691de98afcab0e41a77a3": "Edge UltraYield",
+      "0x4bce62622be621ce036691de98afcab0e41a77a3": "UltraYield",
       "0xce1cf71a28837daaa7b92d00ca4ef2fd649c2a67": "Hyperithm",
       "0x9655f82b585b11cee8a05576ed8efcf755cec04b": "TelosC"
     },
@@ -301,27 +299,11 @@ const chains = {
       multicall3: {
         address: "0xcA11bde05977b3631167028862bE2a173976CA11"
       }
-    }
+    },
+    firstBlock: 670913n
   }),
   Somnia: defineChain({
-    id: 5031,
-    name: "Somnia",
-    nativeCurrency: {
-      name: "Somnia",
-      symbol: "SOMI",
-      decimals: 18
-    },
-    rpcUrls: {
-      default: {
-        http: ["https://api.infra.mainnet.somnia.network"]
-      }
-    },
-    blockExplorers: {
-      default: {
-        name: "Somnia Explorer",
-        url: "https://explorer.somnia.network"
-      }
-    },
+    ...somnia,
     contracts: {
       multicall3: {
         address: "0x5e44F178E8cF9B2F5409B6f18ce936aB817C5a11",
@@ -337,7 +319,8 @@ const chains = {
     wellKnownToken: {
       address: "0x67B302E35Aef5EEE8c32D934F5856869EF428330",
       symbol: "USDT"
-    }
+    },
+    firstBlock: 147687380n
   })
 };
 const networkByChainId = Object.values(chains).reduce((acc, chain) => {

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

@@ -1,90 +1,8 @@
 const MULTICALL_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
 const ADDRESS_0X0 = "0x0000000000000000000000000000000000000000";
 const NOT_DEPLOYED = "0xNOT DEPLOYED";
-const TIMELOCK = {
-  Mainnet: "0xa133C9A92Fb8dDB962Af1cbae58b2723A0bdf23b",
-  Arbitrum: "0x148DD932eCe1155c11006F5650c6Ff428f8D374A",
-  Optimism: "0x148DD932eCe1155c11006F5650c6Ff428f8D374A",
-  Base: NOT_DEPLOYED,
-  Sonic: "0xAdbF876ce58CB65c99b18078353e1DCB16E69e84",
-  // New networks
-  MegaETH: NOT_DEPLOYED,
-  Monad: NOT_DEPLOYED,
-  Berachain: NOT_DEPLOYED,
-  Avalanche: NOT_DEPLOYED,
-  BNB: NOT_DEPLOYED,
-  WorldChain: NOT_DEPLOYED,
-  Etherlink: NOT_DEPLOYED,
-  Hemi: NOT_DEPLOYED,
-  Lisk: NOT_DEPLOYED,
-  Plasma: NOT_DEPLOYED,
-  Somnia: NOT_DEPLOYED
-};
-const GEARBOX_MULTISIG = {
-  Mainnet: "0xA7D5DDc1b8557914F158076b228AA91eF613f1D5",
-  Arbitrum: "0x57Fd8B1a9213624157786Fff4a7bc532Ce717773",
-  Optimism: "0x8bA8cd6D00919ceCc19D9B4A2c8669a524883C4c",
-  Base: NOT_DEPLOYED,
-  Sonic: "0xacEB9dc6a81f1C9E2d8a86c3bFec3f6EF584139D",
-  // New networks
-  MegaETH: NOT_DEPLOYED,
-  Monad: NOT_DEPLOYED,
-  Berachain: NOT_DEPLOYED,
-  Avalanche: NOT_DEPLOYED,
-  BNB: NOT_DEPLOYED,
-  WorldChain: NOT_DEPLOYED,
-  Etherlink: NOT_DEPLOYED,
-  Hemi: NOT_DEPLOYED,
-  Lisk: NOT_DEPLOYED,
-  Plasma: NOT_DEPLOYED,
-  Somnia: NOT_DEPLOYED
-};
-const GEARBOX_RISK_CURATORS = {
-  Mainnet: [TIMELOCK.Mainnet],
-  Arbitrum: [TIMELOCK.Arbitrum],
-  Optimism: [TIMELOCK.Optimism],
-  Base: [TIMELOCK.Base],
-  Sonic: [TIMELOCK.Sonic],
-  // New networks
-  MegaETH: [],
-  Monad: [],
-  Berachain: [],
-  Avalanche: [],
-  BNB: [],
-  WorldChain: [],
-  Etherlink: [],
-  Hemi: [],
-  Lisk: [],
-  Plasma: [],
-  Somnia: []
-};
-const DEPRECIATED_POOLS = {
-  Mainnet: {
-    ["0x1dc0f3359a254f876b37906cfc1000a35ce2d717".toLowerCase()]: "USDT_V3_BROKEN"
-  },
-  Arbitrum: {},
-  Optimism: {},
-  Base: {},
-  Sonic: {},
-  // New networks
-  MegaETH: {},
-  Monad: {},
-  Berachain: {},
-  Avalanche: {},
-  BNB: {},
-  WorldChain: {},
-  Etherlink: {},
-  Hemi: {},
-  Lisk: {},
-  Plasma: {},
-  Somnia: {}
-};
 export {
   ADDRESS_0X0,
-  DEPRECIATED_POOLS,
-  GEARBOX_MULTISIG,
-  GEARBOX_RISK_CURATORS,
   MULTICALL_ADDRESS,
-  NOT_DEPLOYED,
-  TIMELOCK
+  NOT_DEPLOYED
 };

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";