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

package/dist/types/sdk/market/credit/CreditSuite.d.ts

@@ -1,23 +1,103 @@
 import type { Address } from "viem";
-import type { CreditSuiteState, MarketData } from "../../base/index.js";
+import type { CreditSuiteState } from "../../base/index.js";
 import { SDKConstruct } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { IRouterContract } from "../../router/index.js";
 import type { CreditSuiteStateHuman } from "../../types/index.js";
+import type { MarketConfiguratorContract } from "../MarketConfiguratorContract.js";
+import type { MarketSuite } from "../MarketSuite.js";
 import type { CreditFacadeContract, ICreditConfiguratorContract, ICreditManagerContract } from "./types.js";
+/**
+ * SDK aggregate for one credit-manager branch inside a market.
+ *
+ * @remarks
+ * This is the market's "retail branch": it borrows
+ * liquidity from the pool to open credit accounts under an isolated mandate.
+ * The suite groups the three contracts that define that branch:
+ * `creditManager` for debt, collateral, adapters, and account accounting;
+ * `creditFacade` for user-facing account operations and multicalls; and
+ * `creditConfigurator` for risk-parameter and adapter configuration.
+ */
 export declare class CreditSuite extends SDKConstruct {
+    /**
+     * Pool that supplies underlying liquidity to this credit manager.
+     */
     readonly pool: Address;
-    readonly underlying: Address;
+    /**
+     * 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.
+     */
     readonly creditManager: ICreditManagerContract;
+    /**
+     * Wrapper around the credit facade contract used to build account
+     * transactions such as open, close, liquidate, and multicall.
+     */
     readonly creditFacade: CreditFacadeContract;
+    /**
+     * Wrapper around the credit configurator that mutates risk
+     * parameters, collateral tokens, adapter permissions, and facade settings.
+     */
     readonly creditConfigurator: ICreditConfiguratorContract;
-    readonly marketConfigurator: Address;
+    /**
+     * Original compressor contract snapshot for this credit suite.
+     */
     readonly state: CreditSuiteState;
+    /**
+     * Human-readable credit manager name from the core contract state.
+     */
     readonly name: string;
-    constructor(sdk: OnchainSDK, marketData: MarketData, index: number);
+    /**
+     * 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: OnchainSDK, data: CreditSuiteState);
+    /**
+     * Token borrowed from the pool and used as the account debt asset.
+     */
+    get underlying(): Address;
+    /**
+     * Parent market that contains this credit manager
+     */
+    get market(): MarketSuite;
+    /**
+     * Market configurator that governs this credit suite and its parent pool.
+     */
+    get marketConfigurator(): MarketConfiguratorContract;
+    /**
+     * Router configured for this credit suite.
+     */
     get router(): IRouterContract;
+    /**
+     * 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(): boolean;
+    /**
+     * Whether the facade, manager, or configurator has observed logs that require
+     * a credit-suite resync.
+     */
     get dirty(): boolean;
+    /**
+     * Credit contracts whose events are enough to detect stale suite state.
+     *
+     * @internal
+     */
     get watchAddresses(): Set<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?: boolean): CreditSuiteStateHuman;
 }

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

@@ -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/types/sdk/market/pool/PoolSuite.d.ts

@@ -9,20 +9,95 @@ import { GaugeContract } from "./GaugeContract.js";
 import { LinearInterestRateModelContract } from "./LinearInterestRateModelContract.js";
 import { TumblerContract } from "./TumblerContract.js";
 import type { IInterestRateModelContract, IRateKeeperContract, PoolContract, PoolQuotaKeeperContract } from "./types.js";
+/**
+ * SDK aggregate for the pool-side contracts of a Gearbox market.
+ *
+ * @remarks
+ * The pool is the market's passive liquidity source. This suite groups the
+ * ERC-4626 pool wrapper with the quota keeper that caps collateral-side
+ * exposure, the rate keeper that supplies quota rates, and the interest-rate
+ * model that prices pool utilization. Higher-level market and pool services use
+ * this class when they need the complete pool control plane instead of a single
+ * contract wrapper.
+ */
 export declare class PoolSuite extends SDKConstruct {
     #private;
+    /**
+     * ERC-4626 liquidity pool wrapper for deposits, withdrawals, borrowing
+     * limits, and base interest accounting.
+     */
     readonly pool: PoolContract;
+    /**
+     * Quota keeper wrapper that tracks per-token quota limits, quoted exposure,
+     * quota rates, and credit-manager access.
+     */
     readonly pqk: PoolQuotaKeeperContract;
+    /**
+     * Rate keeper used by the quota keeper to obtain collateral-specific quota
+     * rates. Can be a {@link GaugeContract} or a {@link TumblerContract}.
+     */
     readonly rateKeeper: IRateKeeperContract;
+    /**
+     * Interest-rate model used by the pool to calculate the base borrow rate from
+     * expected and available liquidity.
+     */
     readonly interestRateModel: IInterestRateModelContract;
+    /**
+     * 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: OnchainSDK, data: MarketData);
+    /**
+     * Narrows `rateKeeper` to a gauge rate keeper.
+     *
+     * @throws If the market uses a different rate keeper type.
+     */
     get gauge(): GaugeContract;
+    /**
+     * Narrows `rateKeeper` to a tumbler rate keeper.
+     *
+     * @throws If the market uses a different rate keeper type.
+     */
     get tumbler(): TumblerContract;
+    /**
+     * Narrows `interestRateModel` to the linear interest-rate model.
+     *
+     * @throws If the market uses a different interest-rate model type.
+     */
     get linearModel(): LinearInterestRateModelContract;
+    /**
+     * Market configurator that governs the pool and its connected credit suites.
+     *
+     * @throws If the configurator is missing from the SDK contract register.
+     */
     get marketConfigurator(): MarketConfiguratorContract;
+    /**
+     * Underlying asset deposited into the pool and borrowed by connected credit
+     * suites.
+     */
     get underlying(): Address;
+    /**
+     * RWA factory associated with the pool's underlying, undefined for non-RWA markets.
+     */
     get rwaFactory(): IRWAFactory | undefined;
+    /**
+     * Whether any pool-side wrapper has observed logs that require a resync.
+     */
     get dirty(): boolean;
+    /**
+     * Pool-side contract addresses whose logs are enough to detect stale state.
+     *
+     * @internal
+     */
     get watchAddresses(): Set<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?: boolean): PoolSuiteStateHuman;
 }

package/dist/types/sdk/market/pool/PoolV310Contract.d.ts

@@ -1,8 +1,8 @@
-import type { Address, ContractEventName, DecodeFunctionDataReturnType, Log } from "viem";
+import type { ContractEventName, DecodeFunctionDataReturnType, Log } from "viem";
 import type { CreditManagerDebtParams, PoolState } from "../../base/index.js";
 import { BaseContract } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
-import type { PoolStateHuman, RawTx } from "../../types/index.js";
+import type { PoolStateHuman } from "../../types/index.js";
 import { AddressMap } from "../../utils/index.js";
 import type { IRWAFactory } from "../rwa/types.js";
 declare const abi: readonly [{
@@ -1138,16 +1138,6 @@ export declare class PoolV310Contract extends BaseContract<abi> {
     get rwaFactory(): IRWAFactory | undefined;
     stateHuman(raw?: boolean): PoolStateHuman;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
-    /**
-     * Deposits underlying assets into the pool on behalf of a user with a
-     * referral code.
-     */
-    depositWithReferral(amount: bigint, onBehalfOf: Address, referralCode: bigint): RawTx;
-    /**
-     * Redeems pool shares from the owner and sends the underlying assets to
-     * the receiver.
-     */
-    redeem(amount: bigint, owner: Address, receiver: Address): RawTx;
     protected stringifyFunctionParams(params: DecodeFunctionDataReturnType<abi>): string[];
 }
 export {};

package/dist/types/sdk/pools/PoolService.d.ts

@@ -1,6 +1,6 @@
 import type { Address } from "viem";
 import { SDKConstruct } from "../base/index.js";
-import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCallResult, RemoveLiquidityProps, WithdrawalMetadata } from "./types.js";
+import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCall, RemoveLiquidityProps, WithdrawalMetadata } from "./types.js";
 export declare class PoolService extends SDKConstruct implements IPoolsService {
     #private;
     /**
@@ -18,7 +18,7 @@ export declare class PoolService extends SDKConstruct implements IPoolsService {
     /**
      * {@inheritDoc IPoolsService.addLiquidity}
      */
-    addLiquidity(props: AddLiquidityProps): PoolServiceCallResult | undefined;
+    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
     /**
      * {@inheritDoc IPoolsService.getWithdrawalTokensIn}
      */
@@ -30,7 +30,7 @@ export declare class PoolService extends SDKConstruct implements IPoolsService {
     /**
      * {@inheritDoc IPoolsService.removeLiquidity}
      */
-    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCallResult;
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
     /**
      * {@inheritDoc IPoolsService.getWithdrawalMetadata}
      */

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

@@ -1,7 +1,6 @@
 import type { Abi, Address, ContractFunctionArgs, ContractFunctionName } from "viem";
 import type { ZapperData } from "../market/index.js";
 import type { Asset } from "../router/index.js";
-import type { MultiCall, RawTx } from "../types/transactions.js";
 interface PermitResult {
     r: Address;
     s: Address;
@@ -20,10 +19,6 @@ export type PoolServiceCall<abi extends Abi | readonly unknown[] = Abi, function
     target: Address;
     value?: bigint;
 };
-export interface PoolServiceCallResult {
-    tx: RawTx;
-    calls: Array<MultiCall>;
-}
 export interface AddLiquidityProps {
     /**
      * Token and amount to deposit.
@@ -151,13 +146,13 @@ export interface IPoolsService {
      * @param props - {@link AddLiquidityProps}
      * @returns - {@link AddLiquidityCall}
      */
-    addLiquidity(props: AddLiquidityProps): PoolServiceCallResult | undefined;
+    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
     /**
      * Construct a call to remove liquidity from a Gearbox lending pool.
      *
      * @param props - {@link RemoveLiquidityProps}
      * @returns - {@link RemoveLiquidityCall}
      */
-    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCallResult;
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.10.3-next.1",
+  "version": "14.10.3",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {

package/dist/cjs/sdk/market/zapper/IERC20ZapperDepositsContract.js

@@ -1,54 +0,0 @@
-"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 IERC20ZapperDepositsContract_exports = {};
-__export(IERC20ZapperDepositsContract_exports, {
-  IERC20ZapperDepositsContract: () => IERC20ZapperDepositsContract
-});
-module.exports = __toCommonJS(IERC20ZapperDepositsContract_exports);
-var import_iERC20ZapperDeposits = require("../../../abi/iERC20ZapperDeposits.js");
-var import_base = require("../../base/index.js");
-const abi = import_iERC20ZapperDeposits.ierc20ZapperDepositsAbi;
-class IERC20ZapperDepositsContract extends import_base.BaseContract {
-  constructor(options, args) {
-    super(options, { ...args, abi });
-  }
-  /**
-   * Deposits ERC20 tokens into the pool via this zapper using a referral code.
-   */
-  depositWithReferral(tokenInAmount, receiver, referralCode) {
-    return this.createRawTx({
-      functionName: "depositWithReferral",
-      args: [tokenInAmount, receiver, referralCode]
-    });
-  }
-  /**
-   * Deposits ERC20 tokens via this zapper with a referral code and an
-   * EIP-2612 permit signature, skipping a separate approve transaction.
-   */
-  depositWithReferralAndPermit(tokenInAmount, receiver, referralCode, deadline, v, r, s) {
-    return this.createRawTx({
-      functionName: "depositWithReferralAndPermit",
-      args: [tokenInAmount, receiver, referralCode, deadline, v, r, s]
-    });
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  IERC20ZapperDepositsContract
-});

package/dist/cjs/sdk/market/zapper/IETHZapperDepositsContract.js

@@ -1,45 +0,0 @@
-"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 IETHZapperDepositsContract_exports = {};
-__export(IETHZapperDepositsContract_exports, {
-  IETHZapperDepositsContract: () => IETHZapperDepositsContract
-});
-module.exports = __toCommonJS(IETHZapperDepositsContract_exports);
-var import_iETHZapperDeposits = require("../../../abi/iETHZapperDeposits.js");
-var import_base = require("../../base/index.js");
-const abi = import_iETHZapperDeposits.iethZapperDepositsAbi;
-class IETHZapperDepositsContract extends import_base.BaseContract {
-  constructor(options, args) {
-    super(options, { ...args, abi });
-  }
-  /**
-   * Deposits native ETH into the pool via this zapper using a referral code.
-   * The caller must attach the deposit amount as msg.value.
-   */
-  depositWithReferral(receiver, referralCode) {
-    return this.createRawTx({
-      functionName: "depositWithReferral",
-      args: [receiver, referralCode]
-    });
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  IETHZapperDepositsContract
-});

package/dist/cjs/sdk/market/zapper/IZapperContract.js

@@ -1,54 +0,0 @@
-"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 IZapperContract_exports = {};
-__export(IZapperContract_exports, {
-  IZapperContract: () => IZapperContract
-});
-module.exports = __toCommonJS(IZapperContract_exports);
-var import_iZapper = require("../../../abi/iZapper.js");
-var import_base = require("../../base/index.js");
-const abi = import_iZapper.iZapperAbi;
-class IZapperContract extends import_base.BaseContract {
-  constructor(options, args) {
-    super(options, { ...args, abi });
-  }
-  /**
-   * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-   */
-  redeem(tokenInAmount, receiver) {
-    return this.createRawTx({
-      functionName: "redeem",
-      args: [tokenInAmount, receiver]
-    });
-  }
-  /**
-   * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-   * skipping a separate approve transaction.
-   */
-  redeemWithPermit(tokenInAmount, receiver, deadline, v, r, s) {
-    return this.createRawTx({
-      functionName: "redeemWithPermit",
-      args: [tokenInAmount, receiver, deadline, v, r, s]
-    });
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  IZapperContract
-});

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

@@ -1,26 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var zapper_exports = {};
-module.exports = __toCommonJS(zapper_exports);
-__reExport(zapper_exports, require("./IERC20ZapperDepositsContract.js"), module.exports);
-__reExport(zapper_exports, require("./IETHZapperDepositsContract.js"), module.exports);
-__reExport(zapper_exports, require("./IZapperContract.js"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("./IERC20ZapperDepositsContract.js"),
-  ...require("./IETHZapperDepositsContract.js"),
-  ...require("./IZapperContract.js")
-});

package/dist/esm/sdk/market/zapper/IERC20ZapperDepositsContract.js

@@ -1,30 +0,0 @@
-import { ierc20ZapperDepositsAbi } from "../../../abi/iERC20ZapperDeposits.js";
-import { BaseContract } from "../../base/index.js";
-const abi = ierc20ZapperDepositsAbi;
-class IERC20ZapperDepositsContract extends BaseContract {
-  constructor(options, args) {
-    super(options, { ...args, abi });
-  }
-  /**
-   * Deposits ERC20 tokens into the pool via this zapper using a referral code.
-   */
-  depositWithReferral(tokenInAmount, receiver, referralCode) {
-    return this.createRawTx({
-      functionName: "depositWithReferral",
-      args: [tokenInAmount, receiver, referralCode]
-    });
-  }
-  /**
-   * Deposits ERC20 tokens via this zapper with a referral code and an
-   * EIP-2612 permit signature, skipping a separate approve transaction.
-   */
-  depositWithReferralAndPermit(tokenInAmount, receiver, referralCode, deadline, v, r, s) {
-    return this.createRawTx({
-      functionName: "depositWithReferralAndPermit",
-      args: [tokenInAmount, receiver, referralCode, deadline, v, r, s]
-    });
-  }
-}
-export {
-  IERC20ZapperDepositsContract
-};

package/dist/esm/sdk/market/zapper/IETHZapperDepositsContract.js

@@ -1,21 +0,0 @@
-import { iethZapperDepositsAbi } from "../../../abi/iETHZapperDeposits.js";
-import { BaseContract } from "../../base/index.js";
-const abi = iethZapperDepositsAbi;
-class IETHZapperDepositsContract extends BaseContract {
-  constructor(options, args) {
-    super(options, { ...args, abi });
-  }
-  /**
-   * Deposits native ETH into the pool via this zapper using a referral code.
-   * The caller must attach the deposit amount as msg.value.
-   */
-  depositWithReferral(receiver, referralCode) {
-    return this.createRawTx({
-      functionName: "depositWithReferral",
-      args: [receiver, referralCode]
-    });
-  }
-}
-export {
-  IETHZapperDepositsContract
-};

package/dist/esm/sdk/market/zapper/IZapperContract.js

@@ -1,30 +0,0 @@
-import { iZapperAbi } from "../../../abi/iZapper.js";
-import { BaseContract } from "../../base/index.js";
-const abi = iZapperAbi;
-class IZapperContract extends BaseContract {
-  constructor(options, args) {
-    super(options, { ...args, abi });
-  }
-  /**
-   * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-   */
-  redeem(tokenInAmount, receiver) {
-    return this.createRawTx({
-      functionName: "redeem",
-      args: [tokenInAmount, receiver]
-    });
-  }
-  /**
-   * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-   * skipping a separate approve transaction.
-   */
-  redeemWithPermit(tokenInAmount, receiver, deadline, v, r, s) {
-    return this.createRawTx({
-      functionName: "redeemWithPermit",
-      args: [tokenInAmount, receiver, deadline, v, r, s]
-    });
-  }
-}
-export {
-  IZapperContract
-};

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

@@ -1,3 +0,0 @@
-export * from "./IERC20ZapperDepositsContract.js";
-export * from "./IETHZapperDepositsContract.js";
-export * from "./IZapperContract.js";