@gearbox-protocol/sdk 14.10.3-next.1 → 14.10.3

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

@@ -7,17 +7,55 @@ import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { createPriceOracle } from "./oracle/index.js";
 import { PoolSuite } from "./pool/index.js";
 class MarketSuite extends 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;
@@ -35,21 +73,37 @@ class MarketSuite extends SDKConstruct {
       sdk.setAddressLabel(t.addr, t.symbol);
     }
     this.pool = new PoolSuite(sdk, marketData);
-    for (let i = 0; i < marketData.creditManagers.length; i++) {
-      this.creditManagers.push(new CreditSuite(sdk, marketData, i));
+    for (const suiteData of marketData.creditManagers) {
+      this.creditManagers.push(new CreditSuite(sdk, suiteData));
     }
     this.priceOracle = createPriceOracle(sdk, marketData.priceOracle);
     this.lossPolicy = createLossPolicy(sdk, marketData.lossPolicy);
   }
+  /**
+   * Underlying token of the market pool.
+   */
   get underlying() {
     return this.pool.underlying;
   }
+  /**
+   * 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,
@@ -59,6 +113,12 @@ class MarketSuite extends 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/esm/sdk/market/credit/CreditSuite.js

@@ -3,35 +3,101 @@ import createCreditConfigurator from "./createCreditConfigurator.js";
 import createCreditFacade from "./createCreditFacade.js";
 import createCreditManager from "./createCreditManager.js";
 class CreditSuite extends 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 = createCreditManager(sdk, this.state);
     this.creditFacade = createCreditFacade(sdk, this.state);
     this.creditConfigurator = createCreditConfigurator(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,
@@ -39,6 +105,12 @@ class CreditSuite extends 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/esm/sdk/market/index.js

@@ -7,4 +7,3 @@ export * from "./pool/index.js";
 export * from "./pricefeeds/index.js";
 export * from "./rwa/index.js";
 export * from "./types.js";
-export * from "./zapper/index.js";

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

@@ -7,11 +7,34 @@ import { GaugeContract } from "./GaugeContract.js";
 import { LinearInterestRateModelContract } from "./LinearInterestRateModelContract.js";
 import { TumblerContract } from "./TumblerContract.js";
 class PoolSuite extends 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 = createPool(sdk, data.pool);
@@ -23,6 +46,11 @@ class PoolSuite extends 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 GaugeContract) {
       return this.rateKeeper;
@@ -31,6 +59,11 @@ class PoolSuite extends 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 TumblerContract) {
       return this.rateKeeper;
@@ -39,6 +72,11 @@ class PoolSuite extends 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 LinearInterestRateModelContract) {
       return this.interestRateModel;
@@ -47,20 +85,40 @@ class PoolSuite extends 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;
   }
+  /**
+   * 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,
@@ -69,6 +127,12 @@ class PoolSuite extends 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/esm/sdk/market/pool/PoolV310Contract.js

@@ -109,26 +109,6 @@ class PoolV310Contract extends 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": {

package/dist/esm/sdk/pools/PoolService.js

@@ -1,16 +1,14 @@
+import { iPoolV310Abi } from "../../abi/310/generated.js";
 import { ierc20Abi } from "../../abi/iERC20.js";
+import { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
+import { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
+import { iZapperAbi } from "../../abi/iZapper.js";
 import {
-  BaseContract,
   RWA_UNDERLYING_DEFAULT,
   RWA_UNDERLYING_ON_DEMAND,
   SDKConstruct
 } from "../base/index.js";
 import { NATIVE_ADDRESS } from "../constants/index.js";
-import {
-  IERC20ZapperDepositsContract,
-  IETHZapperDepositsContract,
-  IZapperContract
-} from "../market/zapper/index.js";
 import { AddressSet, hexEq } from "../utils/index.js";
 class PoolService extends SDKConstruct {
   /**
@@ -83,49 +81,41 @@ class PoolService extends SDKConstruct {
     }
     const { zapper } = meta;
     if (zapper && hexEq(zapper.tokenIn.addr, NATIVE_ADDRESS)) {
-      const zapperContract = new IETHZapperDepositsContract(this.sdk, {
-        addr: zapper.baseParams.addr,
-        name: `ETHZapper(${this.labelAddress(zapper.baseParams.addr)})`
-      });
-      const tx2 = zapperContract.depositWithReferral(wallet, referralCode ?? 0n);
-      tx2.value = collateral.balance.toString();
       return {
-        tx: tx2,
-        calls: [{ target: zapper.baseParams.addr, callData: tx2.callData }]
+        target: zapper.baseParams.addr,
+        abi: iethZapperDepositsAbi,
+        functionName: "depositWithReferral",
+        args: [wallet, referralCode],
+        value: collateral.balance
       };
     } else if (zapper) {
-      const zapperContract = new IERC20ZapperDepositsContract(this.sdk, {
-        addr: zapper.baseParams.addr,
-        name: `ERC20Zapper(${this.labelAddress(zapper.baseParams.addr)})`
-      });
-      const tx2 = permit ? zapperContract.depositWithReferralAndPermit(
-        collateral.balance,
-        wallet,
-        referralCode ?? 0n,
-        permit.deadline,
-        permit.v,
-        permit.r,
-        permit.s
-      ) : zapperContract.depositWithReferral(
-        collateral.balance,
-        wallet,
-        referralCode ?? 0n
-      );
+      return permit ? {
+        target: zapper.baseParams.addr,
+        abi: ierc20ZapperDepositsAbi,
+        functionName: "depositWithReferralAndPermit",
+        args: [
+          collateral.balance,
+          wallet,
+          referralCode,
+          permit.deadline,
+          permit.v,
+          permit.r,
+          permit.s
+        ]
+      } : {
+        target: zapper.baseParams.addr,
+        abi: ierc20ZapperDepositsAbi,
+        functionName: "depositWithReferral",
+        args: [collateral.balance, wallet, referralCode]
+      };
+    } else {
       return {
-        tx: tx2,
-        calls: [{ target: zapper.baseParams.addr, callData: tx2.callData }]
+        target: pool,
+        abi: iPoolV310Abi,
+        functionName: "depositWithReferral",
+        args: [collateral.balance, wallet, referralCode]
       };
     }
-    const poolContract = this.sdk.marketRegister.findByPool(pool).pool.pool;
-    const tx = poolContract.depositWithReferral(
-      collateral.balance,
-      wallet,
-      referralCode ?? 0n
-    );
-    return {
-      tx,
-      calls: [{ target: pool, callData: tx.callData }]
-    };
   }
   /**
    * {@inheritDoc IPoolsService.getWithdrawalTokensIn}
@@ -165,44 +155,39 @@ class PoolService extends SDKConstruct {
     const underlying = this.#describeUnderlying(pool);
     if (this.sdk.tokensMeta.isRWAUnderlying(underlying)) {
       if (underlying.contractType === RWA_UNDERLYING_ON_DEMAND) {
-        const tokenContract = new BaseContract(this.sdk, {
-          addr: underlying.asset,
+        return {
           abi: ierc20Abi,
-          name: "ERC20"
-        });
-        const tx2 = tokenContract.createRawTx({
           functionName: "approve",
-          args: [underlying.liquidityProvider.addr, 0n]
-        });
-        return {
-          tx: tx2,
-          calls: [{ target: underlying.asset, callData: tx2.callData }]
+          args: [underlying.liquidityProvider, 0n],
+          target: underlying.asset
         };
       }
     }
     if (meta.zapper) {
-      const zapperContract = new IZapperContract(this.sdk, {
-        addr: meta.zapper.baseParams.addr,
-        name: `Zapper(${this.labelAddress(meta.zapper.baseParams.addr)})`
-      });
-      const tx2 = permit ? zapperContract.redeemWithPermit(
-        amount,
-        wallet,
-        permit.deadline,
-        permit.v,
-        permit.r,
-        permit.s
-      ) : zapperContract.redeem(amount, wallet);
-      return {
-        tx: tx2,
-        calls: [{ target: meta.zapper.baseParams.addr, callData: tx2.callData }]
+      return permit ? {
+        target: meta.zapper.baseParams.addr,
+        abi: iZapperAbi,
+        functionName: "redeemWithPermit",
+        args: [
+          amount,
+          wallet,
+          permit.deadline,
+          permit.v,
+          permit.r,
+          permit.s
+        ]
+      } : {
+        target: meta.zapper.baseParams.addr,
+        abi: iZapperAbi,
+        functionName: "redeem",
+        args: [amount, wallet]
       };
     }
-    const poolContract = this.sdk.marketRegister.findByPool(pool).pool.pool;
-    const tx = poolContract.redeem(amount, wallet, wallet);
     return {
-      tx,
-      calls: [{ target: pool, callData: tx.callData }]
+      target: pool,
+      abi: iPoolV310Abi,
+      functionName: "redeem",
+      args: [amount, wallet, wallet]
     };
   }
   /**

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

@@ -9,22 +9,91 @@ import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import type { IPriceOracleContract } from "./oracle/index.js";
 import { PoolSuite } from "./pool/index.js";
 import type { IRWAFactory } from "./rwa/types.js";
+/**
+ * Aggregates all SDK wrappers that make up one Gearbox market.
+ *
+ * @remarks
+ * A market is the SDK representation of the core "one pool, many markets"
+ * architecture: one liquidity pool can fund several isolated credit suites,
+ * while the market-level configurator, price oracle, and loss policy define
+ * the shared risk boundary.
+ */
 export declare class MarketSuite extends SDKConstruct {
+    /**
+     * Access-control list contract that owns market roles such as pausable and
+     * unpausable admins.
+     */
     readonly acl: Address;
+    /**
+     * Treasury splitter or fee recipient associated with this market.
+     */
     readonly treasury: Address;
+    /**
+     * Market-level configurator that controls pool and credit-suite risk
+     * parameters.
+     */
     readonly configurator: MarketConfiguratorContract;
+    /**
+     * Pool-side contract bundle: ERC-4626 pool, quota keeper, rate keeper, and
+     * interest-rate model.
+     */
     readonly pool: PoolSuite;
+    /**
+     * Market price oracle used by credit managers and pool for normalized
+     * price conversion and safe-price checks.
+     */
     readonly priceOracle: IPriceOracleContract;
+    /**
+     * Bad-debt liquidation policy shared by the market's credit facades.
+     */
     readonly lossPolicy: ILossPolicyContract;
+    /**
+     * 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.
+     */
     readonly creditManagers: CreditSuite[];
     /**
-     * Original data received from compressor
+     * Original market snapshot received from the market compressor contract.
      */
     readonly state: MarketData;
+    /**
+     * 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: OnchainSDK, marketData: MarketData);
+    /**
+     * Underlying token of the market pool.
+     */
     get underlying(): Address;
+    /**
+     * Factory contract that opens and manages RWA-compliant credit accounts for
+     * this market. Defined only for RWA markets.
+     */
     get rwaFactory(): IRWAFactory | undefined;
+    /**
+     * Whether any child contract wrapper has observed events that require a
+     * market resync.
+     */
     get dirty(): boolean;
+    /**
+     * Contract addresses whose logs are enough to detect stale market state.
+     *
+     * @internal
+     */
     get watchAddresses(): Set<Address>;
+    /**
+     * 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?: boolean): MarketStateHuman;
 }