@gearbox-protocol/sdk 13.6.0-kyc.2 → 13.6.0-kyc.3

package/dist/cjs/abi/kyc/iDSRegistryService.js

@@ -0,0 +1,70 @@
+"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 iDSRegistryService_exports = {};
+__export(iDSRegistryService_exports, {
+  iDSRegistryServiceAbi: () => iDSRegistryServiceAbi
+});
+module.exports = __toCommonJS(iDSRegistryService_exports);
+const iDSRegistryServiceAbi = [
+  {
+    type: "function",
+    name: "addWallet",
+    inputs: [
+      { name: "wallet", type: "address", internalType: "address" },
+      { name: "investorId", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getInvestor",
+    inputs: [{ name: "wallet", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "string", internalType: "string" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isInvestor",
+    inputs: [{ name: "investorId", type: "string", internalType: "string" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isWallet",
+    inputs: [{ name: "wallet", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "registerInvestor",
+    inputs: [
+      { name: "investorId", type: "string", internalType: "string" },
+      { name: "collisionHash", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  }
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  iDSRegistryServiceAbi
+});

package/dist/cjs/abi/kyc/iDSToken.js

@@ -0,0 +1,71 @@
+"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 iDSToken_exports = {};
+__export(iDSToken_exports, {
+  iDSTokenAbi: () => iDSTokenAbi
+});
+module.exports = __toCommonJS(iDSToken_exports);
+const iDSTokenAbi = [
+  {
+    type: "function",
+    name: "REGISTRY_SERVICE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "TRUST_SERVICE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "burn",
+    inputs: [
+      { name: "from", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" },
+      { name: "reason", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getDSService",
+    inputs: [{ name: "serviceId", type: "uint256", internalType: "uint256" }],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "issueTokens",
+    inputs: [
+      { name: "to", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  }
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  iDSTokenAbi
+});

package/dist/cjs/sdk/GearboxSDK.js

@@ -251,7 +251,7 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     );
     await this.#addressProvider.syncState(this.currentBlock);
     this.#marketRegister = new import_MarketRegister.MarketRegister(this, ignoreMarkets);
-    this.#kyc = new import_kyc.KYCRegister(this);
+    this.#kyc = new import_kyc.KYCRegistry(this);
     if (!marketConfigurators.length) {
       this.logger?.warn(
         "no market configurators provided, skipping market loading"
@@ -324,7 +324,7 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     );
     this.#marketRegister = new import_MarketRegister.MarketRegister(this, ignoreMarkets);
     this.#marketRegister.hydrate(state.markets);
-    this.#kyc = new import_kyc.KYCRegister(this);
+    this.#kyc = new import_kyc.KYCRegistry(this);
     this.#kyc.setState(state.kyc);
     this.#attachConfig = {
       ...opts,

package/dist/cjs/sdk/market/kyc/{KYCRegister.js → KYCRegistry.js}

@@ -16,18 +16,18 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var KYCRegister_exports = {};
-__export(KYCRegister_exports, {
-  KYCRegister: () => KYCRegister
+var KYCRegistry_exports = {};
+__export(KYCRegistry_exports, {
+  KYCRegistry: () => KYCRegistry
 });
-module.exports = __toCommonJS(KYCRegister_exports);
+module.exports = __toCommonJS(KYCRegistry_exports);
 var import_viem = require("viem");
 var import_iKYCCompressor = require("../../../abi/kyc/iKYCCompressor.js");
 var import_base = require("../../base/index.js");
 var import_constants = require("../../constants/index.js");
 var import_utils = require("../../utils/index.js");
 var import_securitize = require("./securitize/index.js");
-class KYCRegister extends import_base.SDKConstruct {
+class KYCRegistry extends import_base.SDKConstruct {
   #state;
   #factories = new import_utils.AddressMap();
   /**
@@ -38,7 +38,6 @@ class KYCRegister extends import_base.SDKConstruct {
    *
    * @param configurators - Market configurators to query.
    * @param kycFactories - KYC factory contracts to query.
-   * @returns
    */
   getLoadMulticalls(configurators, kycFactories = []) {
     if (!kycFactories.length) return [];
@@ -59,11 +58,14 @@ class KYCRegister extends import_base.SDKConstruct {
     ];
   }
   /**
-   * Returns the investor data for a given investor and optional list of factories.
-   * If no factories are provided, all factories will be used.
-   * @param investor
-   * @param factories_
-   * @returns
+   * Fetches decoded investor data from the on-chain KYC compressor.
+   *
+   * Each factory produces its own investor data (e.g. registered tokens,
+   * cached signatures, EIP-712 messages to sign).
+   *
+   * @param investor - Investor EOA address.
+   * @param factories_ - Optional subset of factory addresses to query.
+   *   When omitted, all loaded factories are used.
    */
   async getInvestorData(investor, factories_) {
     const [kycCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
@@ -89,17 +91,29 @@ class KYCRegister extends import_base.SDKConstruct {
     }
     return result;
   }
+  /** All loaded KYC factory instances. */
   get factories() {
     return this.#factories.values();
   }
+  /** Raw KYC compressor response, or `undefined` before attach/hydrate. */
   get state() {
     return this.#state;
   }
+  /**
+   * Returns a human-readable snapshot of the KYC state.
+   */
   stateHuman(raw) {
     return {
       factories: this.factories.map((f) => f.stateHuman(raw))
     };
   }
+  /**
+   * @internal
+   *
+   * Replaces the internal state with a new KYC compressor response.
+   * Rebuilds token metadata for KYC underlyings and re-instantiates factory
+   * wrappers.
+   */
   setState(resp) {
     this.#state = resp;
     for (const u of resp?.[0] ?? []) {
@@ -251,5 +265,5 @@ class KYCRegister extends import_base.SDKConstruct {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  KYCRegister
+  KYCRegistry
 });

package/dist/cjs/sdk/market/kyc/index.js

@@ -15,10 +15,10 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var kyc_exports = {};
 module.exports = __toCommonJS(kyc_exports);
-__reExport(kyc_exports, require("./KYCRegister.js"), module.exports);
+__reExport(kyc_exports, require("./KYCRegistry.js"), module.exports);
 __reExport(kyc_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./KYCRegister.js"),
+  ...require("./KYCRegistry.js"),
   ...require("./types.js")
 });

package/dist/esm/abi/kyc/iDSRegistryService.js

@@ -0,0 +1,46 @@
+const iDSRegistryServiceAbi = [
+  {
+    type: "function",
+    name: "addWallet",
+    inputs: [
+      { name: "wallet", type: "address", internalType: "address" },
+      { name: "investorId", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getInvestor",
+    inputs: [{ name: "wallet", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "string", internalType: "string" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isInvestor",
+    inputs: [{ name: "investorId", type: "string", internalType: "string" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "isWallet",
+    inputs: [{ name: "wallet", type: "address", internalType: "address" }],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "registerInvestor",
+    inputs: [
+      { name: "investorId", type: "string", internalType: "string" },
+      { name: "collisionHash", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  }
+];
+export {
+  iDSRegistryServiceAbi
+};

package/dist/esm/abi/kyc/iDSToken.js

@@ -0,0 +1,47 @@
+const iDSTokenAbi = [
+  {
+    type: "function",
+    name: "REGISTRY_SERVICE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "TRUST_SERVICE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "burn",
+    inputs: [
+      { name: "from", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" },
+      { name: "reason", type: "string", internalType: "string" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getDSService",
+    inputs: [{ name: "serviceId", type: "uint256", internalType: "uint256" }],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "issueTokens",
+    inputs: [
+      { name: "to", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  }
+];
+export {
+  iDSTokenAbi
+};

package/dist/esm/sdk/GearboxSDK.js

@@ -16,7 +16,7 @@ import {
   VERSION_RANGE_310
 } from "./constants/index.js";
 import { createAddressProvider, hydrateAddressProvider } from "./core/index.js";
-import { KYCRegister } from "./market/kyc/index.js";
+import { KYCRegistry } from "./market/kyc/index.js";
 import { MarketRegister } from "./market/MarketRegister.js";
 import { PriceFeedRegister } from "./market/pricefeeds/index.js";
 import {
@@ -245,7 +245,7 @@ class GearboxSDK extends ChainContractsRegister {
     );
     await this.#addressProvider.syncState(this.currentBlock);
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
-    this.#kyc = new KYCRegister(this);
+    this.#kyc = new KYCRegistry(this);
     if (!marketConfigurators.length) {
       this.logger?.warn(
         "no market configurators provided, skipping market loading"
@@ -318,7 +318,7 @@ class GearboxSDK extends ChainContractsRegister {
     );
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
     this.#marketRegister.hydrate(state.markets);
-    this.#kyc = new KYCRegister(this);
+    this.#kyc = new KYCRegistry(this);
     this.#kyc.setState(state.kyc);
     this.#attachConfig = {
       ...opts,

package/dist/esm/sdk/market/kyc/{KYCRegister.js → KYCRegistry.js}

@@ -12,7 +12,7 @@ import {
   KYC_FACTORY_SECURITIZE,
   SecuritizeKYCFactory
 } from "./securitize/index.js";
-class KYCRegister extends SDKConstruct {
+class KYCRegistry extends SDKConstruct {
   #state;
   #factories = new AddressMap();
   /**
@@ -23,7 +23,6 @@ class KYCRegister extends SDKConstruct {
    *
    * @param configurators - Market configurators to query.
    * @param kycFactories - KYC factory contracts to query.
-   * @returns
    */
   getLoadMulticalls(configurators, kycFactories = []) {
     if (!kycFactories.length) return [];
@@ -44,11 +43,14 @@ class KYCRegister extends SDKConstruct {
     ];
   }
   /**
-   * Returns the investor data for a given investor and optional list of factories.
-   * If no factories are provided, all factories will be used.
-   * @param investor
-   * @param factories_
-   * @returns
+   * Fetches decoded investor data from the on-chain KYC compressor.
+   *
+   * Each factory produces its own investor data (e.g. registered tokens,
+   * cached signatures, EIP-712 messages to sign).
+   *
+   * @param investor - Investor EOA address.
+   * @param factories_ - Optional subset of factory addresses to query.
+   *   When omitted, all loaded factories are used.
    */
   async getInvestorData(investor, factories_) {
     const [kycCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
@@ -74,17 +76,29 @@ class KYCRegister extends SDKConstruct {
     }
     return result;
   }
+  /** All loaded KYC factory instances. */
   get factories() {
     return this.#factories.values();
   }
+  /** Raw KYC compressor response, or `undefined` before attach/hydrate. */
   get state() {
     return this.#state;
   }
+  /**
+   * Returns a human-readable snapshot of the KYC state.
+   */
   stateHuman(raw) {
     return {
       factories: this.factories.map((f) => f.stateHuman(raw))
     };
   }
+  /**
+   * @internal
+   *
+   * Replaces the internal state with a new KYC compressor response.
+   * Rebuilds token metadata for KYC underlyings and re-instantiates factory
+   * wrappers.
+   */
   setState(resp) {
     this.#state = resp;
     for (const u of resp?.[0] ?? []) {
@@ -235,5 +249,5 @@ class KYCRegister extends SDKConstruct {
   }
 }
 export {
-  KYCRegister
+  KYCRegistry
 };

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

@@ -1,2 +1,2 @@
-export * from "./KYCRegister.js";
+export * from "./KYCRegistry.js";
 export * from "./types.js";

package/dist/types/abi/kyc/iDSRegistryService.d.ts

@@ -0,0 +1,71 @@
+export declare const iDSRegistryServiceAbi: readonly [{
+    readonly type: "function";
+    readonly name: "addWallet";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getInvestor";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isInvestor";
+    readonly inputs: readonly [{
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isWallet";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "registerInvestor";
+    readonly inputs: readonly [{
+        readonly name: "investorId";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "collisionHash";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}];

package/dist/types/abi/kyc/iDSToken.d.ts

@@ -0,0 +1,67 @@
+export declare const iDSTokenAbi: readonly [{
+    readonly type: "function";
+    readonly name: "REGISTRY_SERVICE";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "TRUST_SERVICE";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "burn";
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "reason";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getDSService";
+    readonly inputs: readonly [{
+        readonly name: "serviceId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "issueTokens";
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}];

package/dist/types/sdk/GearboxSDK.d.ts

@@ -6,7 +6,7 @@ import { ChainContractsRegister } from "./base/index.js";
 import type { GearboxChain, NetworkType } from "./chain/chains.js";
 import type { VersionRange } from "./constants/index.js";
 import type { IAddressProviderContract } from "./core/index.js";
-import { KYCRegister } from "./market/kyc/index.js";
+import { KYCRegistry } from "./market/kyc/index.js";
 import { MarketRegister } from "./market/MarketRegister.js";
 import { PriceFeedRegister } from "./market/pricefeeds/index.js";
 import type { SDKOptions } from "./options.js";
@@ -305,7 +305,7 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> extends C
      *
      * @throws If the SDK has not been attached or hydrated yet.
      **/
-    get kyc(): KYCRegister;
+    get kyc(): KYCRegistry;
     /**
      * Resolves the appropriate router contract for a given credit manager,
      * credit facade, or explicit version range.

package/dist/types/sdk/market/kyc/KYCRegistry.d.ts

@@ -0,0 +1,52 @@
+import type { Address } from "abitype";
+import { SDKConstruct } from "../../base/index.js";
+import type { DelegatedMulticall } from "../../utils/viem/index.js";
+import { SecuritizeKYCFactory } from "./securitize/index.js";
+import type { InvestorData, KYCCompressorResponse, KYCState, KYCStateHuman } from "./types.js";
+/**
+ * Registry of KYC underlying tokens and KYC factory contracts.
+ *
+ * Populated from the on-chain {@link https://github.com/Gearbox-protocol/periphery-v3 KYCCompressor}
+ * during SDK attach/hydrate. Provides methods to query investor-level data and
+ * to resolve KYC factory instances by address.
+ **/
+export declare class KYCRegistry extends SDKConstruct {
+    #private;
+    /**
+     * @internal
+     *
+     * Returns delegated multicalls for loading all KYC underlying tokens from the on-chain KYC compressor.
+     * Used by the SDK to compose batched RPC calls.
+     *
+     * @param configurators - Market configurators to query.
+     * @param kycFactories - KYC factory contracts to query.
+     */
+    getLoadMulticalls(configurators: Address[], kycFactories?: Address[]): DelegatedMulticall[];
+    /**
+     * Fetches decoded investor data from the on-chain KYC compressor.
+     *
+     * Each factory produces its own investor data (e.g. registered tokens,
+     * cached signatures, EIP-712 messages to sign).
+     *
+     * @param investor - Investor EOA address.
+     * @param factories_ - Optional subset of factory addresses to query.
+     *   When omitted, all loaded factories are used.
+     */
+    getInvestorData(investor: Address, factories_?: Address[]): Promise<InvestorData[]>;
+    /** All loaded KYC factory instances. */
+    get factories(): SecuritizeKYCFactory[];
+    /** Raw KYC compressor response, or `undefined` before attach/hydrate. */
+    get state(): KYCState | undefined;
+    /**
+     * Returns a human-readable snapshot of the KYC state.
+     */
+    stateHuman(raw?: boolean): KYCStateHuman;
+    /**
+     * @internal
+     *
+     * Replaces the internal state with a new KYC compressor response.
+     * Rebuilds token metadata for KYC underlyings and re-instantiates factory
+     * wrappers.
+     */
+    setState(resp?: KYCCompressorResponse): void;
+}

package/dist/types/sdk/market/kyc/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./KYCRegister.js";
+export * from "./KYCRegistry.js";
 export * from "./types.js";

package/dist/types/sdk/market/kyc/securitize/types.d.ts

@@ -2,40 +2,85 @@ import type { Address, Hex } from "viem";
 import type { BaseContractStateHuman } from "../../../types/index.js";
 import type { OpenAccountRequirements } from "../types.js";
 import type { KYC_FACTORY_SECURITIZE } from "./constants.js";
+/**
+ * Cached registration signature for a single DSToken, stored in the
+ * @see SecuritizeDegenNFT in https://github.com/Gearbox-protocol/periphery-v3
+ *
+ **/
 export interface SecuritizeRegisterMessage {
+    /** DSToken address the signature authorises. */
     token: Address;
+    /** EIP-712 deadline + raw signature bytes. */
     signature: SecuritizeSignature;
 }
+/**
+ * Deadline-bound EIP-712 signature produced by the investor.
+ *
+ **/
 export interface SecuritizeSignature {
+    /** Unix timestamp after which the signature is no longer valid. */
     deadline: bigint;
+    /** Raw EIP-712 signature bytes. */
     signature: Hex;
 }
+/**
+ * EIP-712 typed-data message that must be signed by the investor to allow the
+ * KYC factory to register a credit account as a vault in Securitize's VaultRegistrar
+ * @see VaultRegistrar in https://github.com/Gearbox-protocol/periphery-v3
+ *
+ **/
 export interface SecuritizeRegisterVaultMessage {
+    /** EIP-712 domain from the VaultRegistrar contract. */
     domain: {
         name: string;
         version: string;
         chainId: bigint;
         verifyingContract: Address;
     };
+    /** Investor EOA that will sign the message. */
     investor: Address;
+    /** Operator address (the DegenNFT contract). */
     operator: Address;
+    /** DSToken address to register for. */
     token: Address;
+    /** Monotonic nonce from VaultRegistrar (investor, operator). */
     nonce: bigint;
+    /** Unix timestamp after which the message is no longer valid. */
     deadline: bigint;
 }
+/**
+ * Per-credit-account data decoded from the KYC compressor's
+ * `getCreditAccountData` extra details for a Securitize factory.
+ **/
 export interface SecuritizeCreditAccountData {
+    /** Credit account address. */
     creditAccount: Address;
+    /** SecuritizeWallet proxy that owns the credit account. */
     wallet: Address;
+    /** Whether the Securitize admin has frozen this account. */
     frozen: boolean;
+    /** DSToken addresses where this credit account is registered as a vault. */
     registeredTokens: Address[];
 }
+/**
+ * Investor-level data decoded from the KYC compressor's `getKYCInvestorData`
+ * extra details for a Securitize factory.
+ **/
 export interface SecuritizeInvestorData {
+    /** Securitize KYC factory address that produced this data. */
     factory: Address;
+    /** Credit accounts owned by the investor through this factory. */
     creditAccounts: SecuritizeCreditAccountData[];
+    /** DSToken addresses where the investor is already registered. */
     registeredTokens: Address[];
+    /** Cached signatures still valid and reusable for registration. */
     cachedSignatures: SecuritizeRegisterMessage[];
+    /** EIP-712 messages the investor must sign to register new vaults. */
     registerVaultMessages: SecuritizeRegisterVaultMessage[];
 }
+/**
+ * Human-readable serialisation of {@link SecuritizeKYCFactory} state.
+ **/
 export interface SecuritizeKYCFactoryStateHuman extends BaseContractStateHuman {
     owner: string;
     degenNFT: string;

package/dist/types/sdk/market/kyc/types.d.ts

@@ -4,8 +4,17 @@ import type { iKYCCompressorAbi } from "../../../abi/kyc/iKYCCompressor.js";
 import type { IBaseContract, Unarray } from "../../base/index.js";
 import type { MultiCall, RawTx } from "../../types/index.js";
 import type { SecuritizeInvestorData, SecuritizeKYCFactoryStateHuman, SecuritizeRegisterMessage } from "./securitize/types.js";
+/**
+ * Discriminated union of all known KYC factory contract type strings.
+ **/
 export declare const KYC_FACTORY_TYPES: readonly ["KYC_FACTORY::SECURITIZE"];
+/**
+ * String literal union of known KYC factory types.
+ **/
 export type KYCFactoryType = (typeof KYC_FACTORY_TYPES)[number];
+/**
+ * Raw return type of `KYCCompressor.getKYCMarketsData`.
+ **/
 export type KYCCompressorResponse = AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iKYCCompressorAbi, "getKYCMarketsData">["outputs"]>;
 /**
  * On-chain state of a KYC underlying token.
@@ -13,24 +22,58 @@ export type KYCCompressorResponse = AbiParametersToPrimitiveTypes<ExtractAbiFunc
 export type KYCUnderlyingData = Unarray<KYCCompressorResponse[0]>;
 /**
  * On-chain state of a KYC factory.
- */
+ **/
 export type KYCFactoryData = Unarray<KYCCompressorResponse[1]>;
-export type KYCCOmpressorCall = ContractFunctionParameters<typeof iKYCCompressorAbi, "view", "getKYCMarketsData">;
+/**
+ * Typed contract call parameters for `KYCCompressor.getKYCMarketsData`.
+ **/
+export type KYCCompressorCall = ContractFunctionParameters<typeof iKYCCompressorAbi, "view", "getKYCMarketsData">;
+/**
+ * Single element of the `KYCCompressor.getKYCInvestorData` return array.
+ * Contains per-factory credit accounts and factory-specific extra details.
+ **/
 export type KYCCompressorInvestorData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iKYCCompressorAbi, "getKYCInvestorData">["outputs"]>[0]>;
+/**
+ * Full KYC compressor response, used as the persisted/hydrated state.
+ **/
 export type KYCState = KYCCompressorResponse;
+/**
+ * Decoded DSToken data from the SecuritizeDegenNFT contract.
+ * Mirrors `ISecuritizeDegenNFT.DSTokenData`.
+ **/
 export interface DStokenData {
+    /** DSToken address. */
     address: Address;
+    /** Securitize VaultRegistrar for this token. */
     registrar: Address;
+    /** Addresses authorised to register vaults for this token. */
     operators: Address[];
 }
+/**
+ * Investor data decoded from the KYC compressor.
+ **/
 export type InvestorData = SecuritizeInvestorData;
+/**
+ * Human-readable KYC factory state.
+ **/
 export type KYCFactoryStateHuman = SecuritizeKYCFactoryStateHuman;
+/**
+ * Human-readable snapshot of the full KYC registry state.
+ **/
 export interface KYCStateHuman {
+    /** State of each loaded KYC factory. */
     factories: KYCFactoryStateHuman[];
 }
+/**
+ * Base type returned by {@link IKYCFactory.getOpenAccountRequirements} when an
+ * investor needs to perform additional steps before opening a credit account.
+ * Each KYC factory implementation extends this with factory-specific fields
+ * (e.g. tokens to register, signatures to provide).
+ *
+ **/
 export interface OpenAccountRequirements {
     /**
-     * KYC factory type
+     * Discriminant identifying which KYC factory produced these requirements.
      */
     type: KYCFactoryType;
 }

package/dist/types/sdk/utils/viem/executeDelegatedMulticalls.d.ts

@@ -1,9 +1,26 @@
 import type { Chain, Client, ContractFunctionParameters, Transport } from "viem";
 import type { IPriceUpdateTx } from "../../types/index.js";
+/**
+ * A contract call paired with a callback that receives its decoded result.
+ * Used to compose batched on-chain reads that are executed together inside a
+ * single {@link simulateWithPriceUpdates} call.
+ **/
 export interface DelegatedMulticall {
+    /** Contract call parameters (ABI, address, function name, args). */
     call: ContractFunctionParameters;
+    /** Callback invoked with the decoded return value after simulation. */
     onResult: (resp: unknown) => void;
 }
+/**
+ * Executes multiple contract read calls in a single
+ * {@link simulateWithPriceUpdates} batch and dispatches each result to its
+ * corresponding {@link DelegatedMulticall.onResult} callback.
+ *
+ * @param client - Viem public client.
+ * @param multicalls - Calls to execute with their result handlers.
+ * @param opts - Price-update transactions, target block number, and optional
+ *   gas limit forwarded to the simulation.
+ **/
 export declare function executeDelegatedMulticalls(client: Client<Transport, Chain>, multicalls: DelegatedMulticall[], opts: {
     priceUpdates: IPriceUpdateTx[];
     blockNumber: bigint;

package/package.json

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

package/dist/types/sdk/market/kyc/KYCRegister.d.ts

@@ -1,31 +0,0 @@
-import type { Address } from "abitype";
-import { SDKConstruct } from "../../base/index.js";
-import type { DelegatedMulticall } from "../../utils/viem/index.js";
-import { SecuritizeKYCFactory } from "./securitize/index.js";
-import type { InvestorData, KYCCompressorResponse, KYCState, KYCStateHuman } from "./types.js";
-export declare class KYCRegister extends SDKConstruct {
-    #private;
-    /**
-     * @internal
-     *
-     * Returns delegated multicalls for loading all KYC underlying tokens from the on-chain KYC compressor.
-     * Used by the SDK to compose batched RPC calls.
-     *
-     * @param configurators - Market configurators to query.
-     * @param kycFactories - KYC factory contracts to query.
-     * @returns
-     */
-    getLoadMulticalls(configurators: Address[], kycFactories?: Address[]): DelegatedMulticall[];
-    /**
-     * Returns the investor data for a given investor and optional list of factories.
-     * If no factories are provided, all factories will be used.
-     * @param investor
-     * @param factories_
-     * @returns
-     */
-    getInvestorData(investor: Address, factories_?: Address[]): Promise<InvestorData[]>;
-    get factories(): SecuritizeKYCFactory[];
-    get state(): KYCState | undefined;
-    stateHuman(raw?: boolean): KYCStateHuman;
-    setState(resp?: KYCCompressorResponse): void;
-}