@gearbox-protocol/sdk 15.0.0-next.2 → 15.0.0-pyth.1

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

@@ -74,7 +74,7 @@ const chains = {
         "0x3b56538833fc02f4f0e75609390f26ded0c32e42": "Re7",
         "0x7a133fbd01736fd076158307c9476cc3877f1af5": "Invariant Group",
         "0x09d8305F49374AEA6A78aF6C996df2913e8f3b19": "Tulipa",
-        "0x1b265b97eb169fb6668e3258007c3b0242c7bdbe": "kpk",
+        "0x1b265b97eb169fb6668e3258007c3b0242c7bdbe": "KPK",
         "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "UltraYield",
         "0x601067eba24bb5b558a184fc082525637e96a42d": "Gami Labs"
       },
@@ -82,7 +82,7 @@ const chains = {
         "0x99df7330bf42d596af2e9d9836d4fc2077c574aa": "M11 Credit",
         "0x610627d8d01a413bdd9b0a0b60070da7dd1e54ad": "Securitize"
       },
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
@@ -100,7 +100,7 @@ const chains = {
       defaultMarketConfigurators: {
         "0x01023850b360b88de0d0f84015bbba1eba57fe7e": "Chaos Labs"
       },
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
@@ -119,7 +119,7 @@ const chains = {
         "0x2a15969CE5320868eb609680751cF8896DD92De5": "Chaos Labs",
         "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "UltraYield"
       },
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
@@ -135,7 +135,7 @@ const chains = {
       ...import_chains.base,
       network: "Base",
       defaultMarketConfigurators: {},
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: false,
       wellKnownToken: {
         address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
@@ -152,7 +152,7 @@ const chains = {
       defaultMarketConfigurators: {
         "0x8FFDd1F1433674516f83645a768E8900A2A5D076": "Chaos Labs"
       },
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: true,
       blockExplorers: {
         default: {
@@ -174,7 +174,7 @@ const chains = {
     ...import_chains.megaeth,
     network: "MegaETH",
     defaultMarketConfigurators: {},
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: false,
     wellKnownToken: {
       address: "0xFAfDdbb3FC7688494971a79cc65DCa3EF82079E7",
@@ -196,21 +196,21 @@ const chains = {
       "0x16956912813ab9a38d95730b52a8cf53e860a7c5": "Tulipa",
       "0x7c6ee1bf9c1eb3ee55bdbdc1e8d0317aab718e0a": "UltraYield"
     },
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0xe7cd86e13AC4309349F30B3435a9d337750fC82D",
       symbol: "USDT0"
     },
     firstBlock: 34650262n,
-    gasLimit: 200000000n
+    gasLimit: 150000000n
   }),
   Berachain: withPublicNode(
     {
       ...import_chains.berachain,
       network: "Berachain",
       defaultMarketConfigurators: {},
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: false,
       blockExplorers: {
         default: {
@@ -232,7 +232,7 @@ const chains = {
       ...import_chains.avalanche,
       network: "Avalanche",
       defaultMarketConfigurators: {},
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: false,
       wellKnownToken: {
         address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
@@ -251,7 +251,7 @@ const chains = {
         "0x92dc4ee43e9b207e16fbf3fd1a6933563c0a0d35": "Re7"
       },
       testMarketConfigurators: {},
-      kycFactories: [],
+      rwaFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d",
@@ -266,7 +266,7 @@ const chains = {
     ...import_chains.worldchain,
     network: "WorldChain",
     defaultMarketConfigurators: {},
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: false,
     wellKnownToken: {
       address: "0x79a02482a880bce3f13e09da970dc34db4cd24d1",
@@ -281,7 +281,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0x577424f0e6f50db668cc1bc76babb87e36732291": "Re7"
     },
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0x796Ea11Fa2dD751eD01b53C372fFDB4AAa8f00F9",
@@ -296,7 +296,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0xc9961b8a0c763779690577f2c76962c086af2fe3": "Invariant Group"
     },
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0xad11a8BEb98bbf61dbb1aa0F6d6F2ECD87b35afA",
@@ -316,7 +316,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0x25778dbf0e56b7feb8358c4aa2f6f9e19a1c145a": "Re7"
     },
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0xF242275d3a6527d877f2c927a82D9b057609cc71",
@@ -333,7 +333,7 @@ const chains = {
       "0xce1cf71a28837daaa7b92d00ca4ef2fd649c2a67": "Hyperithm",
       "0x9655f82b585b11cee8a05576ed8efcf755cec04b": "TelosC"
     },
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0x5d72a9d9a9510cd8cbdba12ac62593a58930a948",
@@ -360,7 +360,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0x1ca8b92aa7233a9f8f7ba031ac45c878141adff0": "Invariant Group"
     },
-    kycFactories: [],
+    rwaFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0x67B302E35Aef5EEE8c32D934F5856869EF428330",

package/dist/cjs/sdk/constants/address-provider.js

@@ -36,7 +36,6 @@ __export(address_provider_exports, {
   AP_GEAR_TOKEN: () => AP_GEAR_TOKEN,
   AP_INFLATION_ATTACK_BLOCKER: () => AP_INFLATION_ATTACK_BLOCKER,
   AP_INSOLVENCY_CHECKER: () => AP_INSOLVENCY_CHECKER,
-  AP_KYC_COMPRESSOR: () => AP_KYC_COMPRESSOR,
   AP_MARKET_COMPRESSOR: () => AP_MARKET_COMPRESSOR,
   AP_MARKET_CONFIGURATOR: () => AP_MARKET_CONFIGURATOR,
   AP_PARTIAL_LIQUIDATION_BOT: () => AP_PARTIAL_LIQUIDATION_BOT,
@@ -46,6 +45,7 @@ __export(address_provider_exports, {
   AP_PRICE_ORACLE: () => AP_PRICE_ORACLE,
   AP_REWARDS_COMPRESSOR: () => AP_REWARDS_COMPRESSOR,
   AP_ROUTER: () => AP_ROUTER,
+  AP_RWA_COMPRESSOR: () => AP_RWA_COMPRESSOR,
   AP_TOKEN_COMPRESSOR: () => AP_TOKEN_COMPRESSOR,
   AP_TREASURY: () => AP_TREASURY,
   AP_WETH_GATEWAY: () => AP_WETH_GATEWAY,
@@ -88,7 +88,7 @@ const AP_WETH_GATEWAY = "WETH_GATEWAY";
 const AP_WETH_TOKEN = "WETH_TOKEN";
 const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
-const AP_KYC_COMPRESSOR = "GLOBAL::KYC_COMPRESSOR";
+const AP_RWA_COMPRESSOR = "GLOBAL::RWA_COMPRESSOR";
 const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -110,7 +110,6 @@ const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
   AP_GEAR_TOKEN,
   AP_INFLATION_ATTACK_BLOCKER,
   AP_INSOLVENCY_CHECKER,
-  AP_KYC_COMPRESSOR,
   AP_MARKET_COMPRESSOR,
   AP_MARKET_CONFIGURATOR,
   AP_PARTIAL_LIQUIDATION_BOT,
@@ -120,6 +119,7 @@ const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
   AP_PRICE_ORACLE,
   AP_REWARDS_COMPRESSOR,
   AP_ROUTER,
+  AP_RWA_COMPRESSOR,
   AP_TOKEN_COMPRESSOR,
   AP_TREASURY,
   AP_WETH_GATEWAY,

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

@@ -25,6 +25,7 @@ __export(math_exports, {
   MIN_INT96: () => MIN_INT96,
   PERCENTAGE_DECIMALS: () => PERCENTAGE_DECIMALS,
   PERCENTAGE_FACTOR: () => PERCENTAGE_FACTOR,
+  PERCENTAGE_FACTOR_1KK: () => PERCENTAGE_FACTOR_1KK,
   PRICE_DECIMALS: () => PRICE_DECIMALS,
   PRICE_DECIMALS_POW: () => PRICE_DECIMALS_POW,
   RAY: () => RAY,
@@ -52,6 +53,7 @@ const PRICE_DECIMALS = 10n ** BigInt(PRICE_DECIMALS_POW);
 const SECONDS_PER_YEAR = 365 * 24 * 3600;
 const PERCENTAGE_DECIMALS = 100n;
 const PERCENTAGE_FACTOR = 10000n;
+const PERCENTAGE_FACTOR_1KK = PERCENTAGE_FACTOR * PERCENTAGE_DECIMALS;
 const LEVERAGE_DECIMALS = 100n;
 const SLIPPAGE_DECIMALS = 100n;
 // Annotate the CommonJS export names for ESM import in node:
@@ -63,6 +65,7 @@ const SLIPPAGE_DECIMALS = 100n;
   MIN_INT96,
   PERCENTAGE_DECIMALS,
   PERCENTAGE_FACTOR,
+  PERCENTAGE_FACTOR_1KK,
   PRICE_DECIMALS,
   PRICE_DECIMALS_POW,
   RAY,

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

@@ -28,17 +28,55 @@ var import_MarketConfiguratorContract = require("./MarketConfiguratorContract.js
 var import_oracle = require("./oracle/index.js");
 var import_pool = require("./pool/index.js");
 class MarketSuite extends import_base.SDKConstruct {
+  /**
+   * Access-control list contract that owns market roles such as pausable and
+   * unpausable admins.
+   */
   acl;
+  /**
+   * Treasury splitter or fee recipient associated with this market.
+   */
   treasury;
+  /**
+   * Market-level configurator that controls pool and credit-suite risk
+   * parameters.
+   */
   configurator;
+  /**
+   * Pool-side contract bundle: ERC-4626 pool, quota keeper, rate keeper, and
+   * interest-rate model.
+   */
   pool;
+  /**
+   * Market price oracle used by credit managers and pool for normalized
+   * price conversion and safe-price checks.
+   */
   priceOracle;
+  /**
+   * Bad-debt liquidation policy shared by the market's credit facades.
+   */
   lossPolicy;
+  /**
+   * Credit-suite wrappers connected to the pool.
+   *
+   * @remarks
+   * Each suite corresponds to one credit manager branch with its own facade,
+   * configurator, collateral set, adapters, debt limits, and expiration policy.
+   */
   creditManagers = [];
   /**
-   * Original data received from compressor
+   * Original market snapshot received from the market compressor contract.
    */
   state;
+  /**
+   * Creates a market aggregate from compressor state.
+   *
+   * @param sdk - Attached on-chain SDK instance used for contract lookup,
+   * labels, token metadata, and plugin access.
+   * @param marketData - Full market state returned by the market compressor.
+   * @throws If the configurator address from `marketData` is not already
+   * registered as a {@link MarketConfiguratorContract}.
+   */
   constructor(sdk, marketData) {
     super(sdk);
     this.state = marketData;
@@ -56,21 +94,37 @@ class MarketSuite extends import_base.SDKConstruct {
       sdk.setAddressLabel(t.addr, t.symbol);
     }
     this.pool = new import_pool.PoolSuite(sdk, marketData);
-    for (let i = 0; i < marketData.creditManagers.length; i++) {
-      this.creditManagers.push(new import_credit.CreditSuite(sdk, marketData, i));
+    for (const suiteData of marketData.creditManagers) {
+      this.creditManagers.push(new import_credit.CreditSuite(sdk, suiteData));
     }
     this.priceOracle = (0, import_oracle.createPriceOracle)(sdk, marketData.priceOracle);
     this.lossPolicy = (0, import_loss_policy.createLossPolicy)(sdk, marketData.lossPolicy);
   }
+  /**
+   * Underlying token of the market pool.
+   */
   get underlying() {
     return this.pool.underlying;
   }
-  get kycFactory() {
-    return this.pool.kycFactory;
+  /**
+   * Factory contract that opens and manages RWA-compliant credit accounts for
+   * this market. Defined only for RWA markets.
+   */
+  get rwaFactory() {
+    return this.pool.rwaFactory;
   }
+  /**
+   * Whether any child contract wrapper has observed events that require a
+   * market resync.
+   */
   get dirty() {
     return this.configurator.dirty || this.pool.dirty || this.priceOracle.dirty || this.creditManagers.some((cm) => cm.dirty);
   }
+  /**
+   * Contract addresses whose logs are enough to detect stale market state.
+   *
+   * @internal
+   */
   get watchAddresses() {
     return /* @__PURE__ */ new Set([
       this.configurator.address,
@@ -80,6 +134,12 @@ class MarketSuite extends import_base.SDKConstruct {
       ...Array.from(this.pool.watchAddresses)
     ]);
   }
+  /**
+   * Returns a label-enriched, JSON-friendly view of the market state.
+   *
+   * @param raw - Whether child wrappers should keep raw numeric values when
+   * applying human formatting.
+   */
   stateHuman(raw = true) {
     return {
       configurator: this.labelAddress(this.configurator.address),

package/dist/cjs/sdk/market/ZapperRegister.js

@@ -25,9 +25,10 @@ var import_peripheryCompressor = require("../../abi/compressors/peripheryCompres
 var import_base = require("../base/index.js");
 var import_constants = require("../constants/index.js");
 var import_utils = require("../utils/index.js");
+var import_zapper = require("./zapper/index.js");
 class ZapperRegister extends import_base.SDKConstruct {
   /**
-   * Mapping pool.address -> ZapperData[]
+   * Mapping pool.address -> Zapper[]
    * Needs to be loaded explicitly using loadZappers method
    */
   #zappers;
@@ -75,16 +76,17 @@ class ZapperRegister extends import_base.SDKConstruct {
     }
   }
   #addZapper(z) {
+    const zapper = (0, import_zapper.createZapper)(this.sdk, z);
     const existing = this.zappers.get(z.pool);
     if (existing) {
       const hasZapper = existing.some(
         (zz) => (0, import_utils.hexEq)(zz.baseParams.addr, z.baseParams.addr)
       );
       if (!hasZapper) {
-        existing.push(z);
+        existing.push(zapper);
       }
     } else {
-      this.zappers.upsert(z.pool, [z]);
+      this.zappers.upsert(z.pool, [zapper]);
     }
     const zappersTokens = [z.tokenIn, z.tokenOut];
     for (const t of zappersTokens) {

package/dist/cjs/sdk/market/credit/CreditSuite.js

@@ -36,35 +36,101 @@ var import_createCreditConfigurator = __toESM(require("./createCreditConfigurato
 var import_createCreditFacade = __toESM(require("./createCreditFacade.js"));
 var import_createCreditManager = __toESM(require("./createCreditManager.js"));
 class CreditSuite extends import_base.SDKConstruct {
+  /**
+   * Pool that supplies underlying liquidity to this credit manager.
+   */
   pool;
-  underlying;
+  /**
+   * Wrapper around the core credit manager contract.
+   *
+   * @remarks
+   * The credit manager owns account accounting, collateral checks, enabled
+   * collateral token masks, adapter mappings, debt updates, and liquidation
+   * calculations for this branch.
+   */
   creditManager;
+  /**
+   * Wrapper around the credit facade contract used to build account
+   * transactions such as open, close, liquidate, and multicall.
+   */
   creditFacade;
+  /**
+   * Wrapper around the credit configurator that mutates risk
+   * parameters, collateral tokens, adapter permissions, and facade settings.
+   */
   creditConfigurator;
-  marketConfigurator;
+  /**
+   * Original compressor contract snapshot for this credit suite.
+   */
   state;
+  /**
+   * Human-readable credit manager name from the core contract state.
+   */
   name;
-  constructor(sdk, marketData, index) {
+  /**
+   * Creates a credit suite from one entry in a market compressor snapshot.
+   *
+   * @param sdk - Attached SDK instance.
+   * @param data - Parent market snapshot part that contains the credit suite data.
+   */
+  constructor(sdk, data) {
     super(sdk);
-    const { creditManagers, pool } = marketData;
-    this.name = creditManagers[index].creditManager.name;
-    this.state = creditManagers[index];
-    this.pool = pool.baseParams.addr;
-    this.underlying = pool.underlying;
+    this.name = data.creditManager.name;
+    this.state = data;
+    this.pool = data.creditManager.pool;
     this.creditManager = (0, import_createCreditManager.default)(sdk, this.state);
     this.creditFacade = (0, import_createCreditFacade.default)(sdk, this.state);
     this.creditConfigurator = (0, import_createCreditConfigurator.default)(sdk, this.state);
-    this.marketConfigurator = marketData.configurator;
   }
+  /**
+   * Token borrowed from the pool and used as the account debt asset.
+   */
+  get underlying() {
+    return this.creditManager.underlying;
+  }
+  /**
+   * Parent market that contains this credit manager
+   */
+  get market() {
+    return this.sdk.marketRegister.findByCreditManager(
+      this.creditManager.address
+    );
+  }
+  /**
+   * Market configurator that governs this credit suite and its parent pool.
+   */
+  get marketConfigurator() {
+    return this.market.configurator;
+  }
+  /**
+   * Router configured for this credit suite.
+   */
   get router() {
     return this.sdk.routerFor(this);
   }
+  /**
+   * Whether this suite's facade is past its configured expiration timestamp.
+   *
+   * @remarks
+   * Expired credit suites can have different liquidation parameters on-chain.
+   * Non-expirable facades and facades with zero expiration are treated as not
+   * expired.
+   */
   get isExpired() {
     return this.creditFacade.expirable && this.creditFacade.expirationDate > 0 && this.creditFacade.expirationDate < this.sdk.timestamp;
   }
+  /**
+   * Whether the facade, manager, or configurator has observed logs that require
+   * a credit-suite resync.
+   */
   get dirty() {
     return this.creditFacade.dirty || this.creditManager.dirty || this.creditConfigurator.dirty;
   }
+  /**
+   * Credit contracts whose events are enough to detect stale suite state.
+   *
+   * @internal
+   */
   get watchAddresses() {
     return /* @__PURE__ */ new Set([
       this.creditConfigurator.address,
@@ -72,6 +138,12 @@ class CreditSuite extends import_base.SDKConstruct {
       this.creditFacade.address
     ]);
   }
+  /**
+   * Returns a label-enriched, JSON-friendly view of this credit suite.
+   *
+   * @param raw - Whether child wrappers should keep raw numeric values instead
+   * of applying human formatting where they support both modes.
+   */
   stateHuman(raw = true) {
     return {
       isExpired: this.isExpired,

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

@@ -17,22 +17,24 @@ var market_exports = {};
 module.exports = __toCommonJS(market_exports);
 __reExport(market_exports, require("./adapters/index.js"), module.exports);
 __reExport(market_exports, require("./credit/index.js"), module.exports);
-__reExport(market_exports, require("./kyc/index.js"), module.exports);
 __reExport(market_exports, require("./MarketRegister.js"), module.exports);
 __reExport(market_exports, require("./MarketSuite.js"), module.exports);
 __reExport(market_exports, require("./oracle/index.js"), module.exports);
 __reExport(market_exports, require("./pool/index.js"), module.exports);
 __reExport(market_exports, require("./pricefeeds/index.js"), module.exports);
+__reExport(market_exports, require("./rwa/index.js"), module.exports);
 __reExport(market_exports, require("./types.js"), module.exports);
+__reExport(market_exports, require("./zapper/index.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./adapters/index.js"),
   ...require("./credit/index.js"),
-  ...require("./kyc/index.js"),
   ...require("./MarketRegister.js"),
   ...require("./MarketSuite.js"),
   ...require("./oracle/index.js"),
   ...require("./pool/index.js"),
   ...require("./pricefeeds/index.js"),
-  ...require("./types.js")
+  ...require("./rwa/index.js"),
+  ...require("./types.js"),
+  ...require("./zapper/index.js")
 });

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

@@ -40,11 +40,34 @@ var import_GaugeContract = require("./GaugeContract.js");
 var import_LinearInterestRateModelContract = require("./LinearInterestRateModelContract.js");
 var import_TumblerContract = require("./TumblerContract.js");
 class PoolSuite extends import_base.SDKConstruct {
+  /**
+   * ERC-4626 liquidity pool wrapper for deposits, withdrawals, borrowing
+   * limits, and base interest accounting.
+   */
   pool;
+  /**
+   * Quota keeper wrapper that tracks per-token quota limits, quoted exposure,
+   * quota rates, and credit-manager access.
+   */
   pqk;
+  /**
+   * Rate keeper used by the quota keeper to obtain collateral-specific quota
+   * rates. Can be a {@link GaugeContract} or a {@link TumblerContract}.
+   */
   rateKeeper;
+  /**
+   * Interest-rate model used by the pool to calculate the base borrow rate from
+   * expected and available liquidity.
+   */
   interestRateModel;
   #marketConfigurator;
+  /**
+   * Creates the pool aggregate from a market compressor snapshot.
+   *
+   * @param sdk - Attached SDK instance
+   * @param data - Full market snapshot containing pool, quota, rate, and
+   * interest-rate model state.
+   */
   constructor(sdk, data) {
     super(sdk);
     this.pool = (0, import_createPool.default)(sdk, data.pool);
@@ -56,6 +79,11 @@ class PoolSuite extends import_base.SDKConstruct {
     );
     this.#marketConfigurator = data.configurator;
   }
+  /**
+   * Narrows `rateKeeper` to a gauge rate keeper.
+   *
+   * @throws If the market uses a different rate keeper type.
+   */
   get gauge() {
     if (this.rateKeeper instanceof import_GaugeContract.GaugeContract) {
       return this.rateKeeper;
@@ -64,6 +92,11 @@ class PoolSuite extends import_base.SDKConstruct {
       `Rate keeper is not a gauge, but a ${this.rateKeeper.contractType}`
     );
   }
+  /**
+   * Narrows `rateKeeper` to a tumbler rate keeper.
+   *
+   * @throws If the market uses a different rate keeper type.
+   */
   get tumbler() {
     if (this.rateKeeper instanceof import_TumblerContract.TumblerContract) {
       return this.rateKeeper;
@@ -72,6 +105,11 @@ class PoolSuite extends import_base.SDKConstruct {
       `Rate keeper is not a tumbler, but a ${this.rateKeeper.contractType}`
     );
   }
+  /**
+   * Narrows `interestRateModel` to the linear interest-rate model.
+   *
+   * @throws If the market uses a different interest-rate model type.
+   */
   get linearModel() {
     if (this.interestRateModel instanceof import_LinearInterestRateModelContract.LinearInterestRateModelContract) {
       return this.interestRateModel;
@@ -80,20 +118,40 @@ class PoolSuite extends import_base.SDKConstruct {
       `Interest rate model is not a linear model, but a ${this.interestRateModel.contractType}`
     );
   }
+  /**
+   * Market configurator that governs the pool and its connected credit suites.
+   *
+   * @throws If the configurator is missing from the SDK contract register.
+   */
   get marketConfigurator() {
     return this.register.mustGetContract(
       this.#marketConfigurator
     );
   }
+  /**
+   * Underlying asset deposited into the pool and borrowed by connected credit
+   * suites.
+   */
   get underlying() {
     return this.pool.underlying;
   }
-  get kycFactory() {
-    return this.pool.kycFactory;
+  /**
+   * RWA factory associated with the pool's underlying, undefined for non-RWA markets.
+   */
+  get rwaFactory() {
+    return this.pool.rwaFactory;
   }
+  /**
+   * Whether any pool-side wrapper has observed logs that require a resync.
+   */
   get dirty() {
     return this.pool.dirty || this.rateKeeper.dirty || this.pqk.dirty || this.interestRateModel.dirty;
   }
+  /**
+   * Pool-side contract addresses whose logs are enough to detect stale state.
+   *
+   * @internal
+   */
   get watchAddresses() {
     return /* @__PURE__ */ new Set([
       this.pool.address,
@@ -102,6 +160,12 @@ class PoolSuite extends import_base.SDKConstruct {
       this.interestRateModel.address
     ]);
   }
+  /**
+   * Returns a label-enriched, JSON-friendly view of the pool-side state.
+   *
+   * @param raw - Whether child wrappers should keep raw numeric values instead
+   * of applying human formatting where they support both modes.
+   */
   stateHuman(raw = true) {
     return {
       pool: this.pool.stateHuman(raw),

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

@@ -48,10 +48,10 @@ class PoolV310Contract extends import_base.BaseContract {
       symbol: data.symbol
     });
   }
-  get kycFactory() {
+  get rwaFactory() {
     const meta = this.#sdk.tokensMeta.mustGet(this.underlying);
-    if (this.#sdk.tokensMeta.isKYCUnderlying(meta)) {
-      return this.#sdk.mustGetContract(meta.kycFactory);
+    if (this.#sdk.tokensMeta.isRWAUnderlying(meta)) {
+      return this.#sdk.mustGetContract(meta.rwaFactory);
     }
     return void 0;
   }
@@ -127,6 +127,26 @@ class PoolV310Contract extends import_base.BaseContract {
         break;
     }
   }
+  /**
+   * Deposits underlying assets into the pool on behalf of a user with a
+   * referral code.
+   */
+  depositWithReferral(amount, onBehalfOf, referralCode) {
+    return this.createRawTx({
+      functionName: "depositWithReferral",
+      args: [amount, onBehalfOf, referralCode]
+    });
+  }
+  /**
+   * Redeems pool shares from the owner and sends the underlying assets to
+   * the receiver.
+   */
+  redeem(amount, owner, receiver) {
+    return this.createRawTx({
+      functionName: "redeem",
+      args: [amount, owner, receiver]
+    });
+  }
   stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "deposit": {