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

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

@@ -1,15 +1,64 @@
-import type { Address } from "viem";
-import type { CreditManagerState, IBaseContract } from "../../base/index.js";
-import type { CreditConfiguratorStateHuman, CreditManagerStateHuman } from "../../types/index.js";
+import type { Address, Hex } from "viem";
+import type { IBaseContract } from "../../base/index.js";
+import type { CreditConfiguratorStateHuman, CreditFacadeStateHuman, CreditManagerStateHuman, MultiCall, RawTx } from "../../types/index.js";
 import type { AddressMap } from "../../utils/index.js";
 import type { IAdapterContract } from "../adapters/index.js";
-import type { CreditFacadeV310Contract, RampEvent } from "../index.js";
+import type { RampEvent } from "../index.js";
+import type { PriceUpdate } from "../pricefeeds/index.js";
 export interface ICreditConfiguratorContract extends IBaseContract {
     isPaused: boolean;
     checkRamps: () => Promise<RampEvent[]>;
     stateHuman: (raw?: boolean) => CreditConfiguratorStateHuman;
 }
-export interface ICreditManagerContract extends IBaseContract, Omit<CreditManagerState, "baseParams" | "collateralTokens" | "name"> {
+/**
+ * Wrapper around the core credit manager contract.
+ */
+export interface ICreditManagerContract extends IBaseContract {
+    /**
+     * Account factory contract address.
+     */
+    accountFactory: Address;
+    /**
+     * Underlying token address.
+     */
+    underlying: Address;
+    /**
+     * Address of the pool credit manager is connected to.
+     */
+    pool: Address;
+    /**
+     * Address of the connected credit facade.
+     */
+    creditFacade: Address;
+    /**
+     * Address of the connected credit configurator.
+     */
+    creditConfigurator: Address;
+    /**
+     * Maximum number of tokens that a credit account can have enabled as collateral.
+     */
+    maxEnabledTokens: number;
+    /**
+     * Percentage of accrued interest in bps taken by the protocol as profit.
+     */
+    feeInterest: number;
+    /**
+     * Percentage of liquidated account value in bps taken by the protocol as profit.
+     */
+    feeLiquidation: number;
+    /**
+     * Percentage of liquidated account value in bps that is used to repay debt
+     * (i.e. `100% - liquidation premium`).
+     */
+    liquidationDiscount: number;
+    /**
+     * Percentage of liquidated expired account value in bps taken by the protocol as profit.
+     */
+    feeLiquidationExpired: number;
+    /**
+     * Percentage of liquidated expired account value in bps that is used to repay debt.
+     */
+    liquidationDiscountExpired: number;
     /**
      * Mapping targetContract => adapter
      */
@@ -24,4 +73,83 @@ export interface ICreditManagerContract extends IBaseContract, Omit<CreditManage
     collateralTokens: Address[];
     stateHuman: (raw?: boolean) => CreditManagerStateHuman;
 }
-export type CreditFacadeContract = CreditFacadeV310Contract;
+/**
+ * Wrapper around the credit facade contract used to build account
+ * transactions such as open, close, liquidate, and multicall.
+ */
+export interface ICreditFacadeContract extends IBaseContract {
+    /**
+     * Degen NFT address (`address(0)` when Degen mode is disabled).
+     */
+    degenNFT: Address;
+    /**
+     * Bot list address.
+     */
+    botList: Address;
+    /**
+     * Whether the credit facade is expirable.
+     */
+    expirable: boolean;
+    /**
+     * Expiration timestamp (only meaningful when `expirable` is `true`).
+     */
+    expirationDate: number;
+    /**
+     * Maximum amount that can be borrowed by a credit manager in a single
+     * block, expressed as a multiple of `maxDebt`.
+     */
+    maxDebtPerBlockMultiplier: number;
+    /**
+     * Minimum credit account debt allowed by the facade, in underlying.
+     */
+    minDebt: bigint;
+    /**
+     * Maximum credit account debt allowed by the facade, in underlying.
+     */
+    maxDebt: bigint;
+    /**
+     * Bit mask encoding the set of forbidden tokens.
+     */
+    forbiddenTokensMask: bigint;
+    /**
+     * Whether the facade is currently paused.
+     */
+    isPaused: boolean;
+    /**
+     * Underlying token of the connected credit manager.
+     */
+    readonly underlying: Address;
+    stateHuman: (raw?: boolean) => CreditFacadeStateHuman;
+    /**
+     * Builds a raw transaction that liquidates a credit account.
+     *
+     * @param ca Credit account to liquidate.
+     * @param to Recipient of the liquidator's reward.
+     * @param calls Multicall body executed during liquidation.
+     * @param lossPolicyData Optional loss policy payload forwarded to the facade.
+     */
+    liquidateCreditAccount(ca: Address, to: Address, calls: MultiCall[], lossPolicyData?: Hex): RawTx;
+    /**
+     * Builds a raw transaction that partially liquidates a credit account's
+     * debt in exchange for discounted collateral.
+     */
+    partiallyLiquidateCreditAccount(ca: Address, token: Address, repaidAmount: bigint, minSeizedAmount: bigint, to: Address, updates: PriceUpdate[]): RawTx;
+    /**
+     * Builds a raw transaction that closes a credit account.
+     */
+    closeCreditAccount(ca: Address, calls: MultiCall[]): RawTx;
+    /**
+     * Builds a raw transaction that executes an owner-driven multicall on a
+     * credit account.
+     */
+    multicall(ca: Address, calls: MultiCall[]): RawTx;
+    /**
+     * Builds a raw transaction that executes a bot-driven multicall on a
+     * credit account.
+     */
+    botMulticall(ca: Address, calls: MultiCall[]): RawTx;
+    /**
+     * Builds a raw transaction that opens a new credit account.
+     */
+    openCreditAccount(to: Address, calls: MultiCall[], referralCode: bigint): RawTx;
+}

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

@@ -7,3 +7,4 @@ 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

@@ -8,7 +8,7 @@ import type { IRWAFactory } from "../rwa/types.js";
 import { GaugeContract } from "./GaugeContract.js";
 import { LinearInterestRateModelContract } from "./LinearInterestRateModelContract.js";
 import { TumblerContract } from "./TumblerContract.js";
-import type { IInterestRateModelContract, IRateKeeperContract, PoolContract, PoolQuotaKeeperContract } from "./types.js";
+import type { IInterestRateModelContract, IPoolContract, IRateKeeperContract, PoolQuotaKeeperContract } from "./types.js";
 /**
  * SDK aggregate for the pool-side contracts of a Gearbox market.
  *
@@ -26,7 +26,7 @@ export declare class PoolSuite extends SDKConstruct {
      * ERC-4626 liquidity pool wrapper for deposits, withdrawals, borrowing
      * limits, and base interest accounting.
      */
-    readonly pool: PoolContract;
+    readonly pool: IPoolContract;
     /**
      * Quota keeper wrapper that tracks per-token quota limits, quoted exposure,
      * quota rates, and credit-manager access.

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

@@ -1,10 +1,11 @@
-import type { ContractEventName, DecodeFunctionDataReturnType, Log } from "viem";
+import type { Address, 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 } from "../../types/index.js";
+import type { PoolStateHuman, RawTx } from "../../types/index.js";
 import { AddressMap } from "../../utils/index.js";
 import type { IRWAFactory } from "../rwa/types.js";
+import type { IPoolContract } from "./types.js";
 declare const abi: readonly [{
     readonly type: "function";
     readonly inputs: readonly [];
@@ -1131,13 +1132,23 @@ declare const abi: readonly [{
 type abi = typeof abi;
 export interface PoolV310Contract extends Omit<PoolState, "baseParams" | "creditManagerDebtParams" | "name">, BaseContract<abi> {
 }
-export declare class PoolV310Contract extends BaseContract<abi> {
+export declare class PoolV310Contract extends BaseContract<abi> implements IPoolContract {
     #private;
     readonly creditManagerDebtParams: AddressMap<CreditManagerDebtParams>;
     constructor(sdk: OnchainSDK, data: PoolState);
     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/market/pool/createPool.d.ts

@@ -1,4 +1,4 @@
 import type { PoolState } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
-import type { PoolContract } from "./types.js";
-export default function createPool(sdk: OnchainSDK, data: PoolState): PoolContract;
+import type { IPoolContract } from "./types.js";
+export default function createPool(sdk: OnchainSDK, data: PoolState): IPoolContract;

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

@@ -1,8 +1,9 @@
-import type { IBaseContract } from "../../base/index.js";
-import type { InterestRateModelStateHuman, RateKeeperStateHuman } from "../../types/index.js";
+import type { Address } from "viem";
+import type { CreditManagerDebtParams, IBaseContract } from "../../base/index.js";
+import type { InterestRateModelStateHuman, PoolStateHuman, RateKeeperStateHuman, RawTx } from "../../types/index.js";
 import type { AddressMap } from "../../utils/index.js";
+import type { IRWAFactory } from "../rwa/types.js";
 import type { PoolQuotaKeeperV310Contract } from "./PoolQuotaKeeperV310Contract.js";
-import type { PoolV310Contract } from "./PoolV310Contract.js";
 export type RateKeeperType = `RATE_KEEPER::${string}`;
 export type InterestRateModelType = `IRM::${string}`;
 export interface IRateKeeperContract extends IBaseContract {
@@ -12,5 +13,117 @@ export interface IRateKeeperContract extends IBaseContract {
 export interface IInterestRateModelContract extends IBaseContract {
     stateHuman: (raw?: boolean) => InterestRateModelStateHuman;
 }
-export type PoolContract = PoolV310Contract;
+/**
+ * Wrapper around the Gearbox lending pool contract.
+ * Pool implements ERC4626
+ */
+export interface IPoolContract extends IBaseContract {
+    /**
+     * Pool share token symbol (ERC20 metadata).
+     */
+    symbol: string;
+    /**
+     * Pool shares decimals, matches underlying token decimals.
+     */
+    decimals: number;
+    /**
+     * Total pool share token supply (ERC20).
+     */
+    totalSupply: bigint;
+    /**
+     * Pool quota keeper contract address.
+     */
+    quotaKeeper: Address;
+    /**
+     * Interest rate model contract address.
+     */
+    interestRateModel: Address;
+    /**
+     * Pool's underlying token, same as `asset()`.
+     */
+    underlying: Address;
+    /**
+     * Available liquidity in the pool.
+     */
+    availableLiquidity: bigint;
+    /**
+     * Amount of underlying that would be in the pool if debt principal, base
+     * interest and quota revenue were fully repaid.
+     */
+    expectedLiquidity: bigint;
+    /**
+     * Current cumulative base interest index in ray.
+     */
+    baseInterestIndex: bigint;
+    /**
+     * Annual interest rate in ray that credit account owners pay per unit of
+     * borrowed capital.
+     */
+    baseInterestRate: bigint;
+    /**
+     * Current pool share / underlying conversion rate, computed by the
+     * compressor
+     */
+    dieselRate: bigint;
+    /**
+     * Current annual supply rate for depositors, computed by the compressor
+     */
+    supplyRate: bigint;
+    /**
+     * Withdrawal fee in bps
+     */
+    withdrawFee: bigint;
+    /**
+     * Total borrowed amount across all credit managers (principal only).
+     */
+    totalBorrowed: bigint;
+    /**
+     * Total debt limit (`MAX_UINT256` means no limit).
+     */
+    totalDebtLimit: bigint;
+    /**
+     * Cumulative base interest index stored as of last update in ray.
+     */
+    baseInterestIndexLU: bigint;
+    /**
+     * Expected liquidity stored as of last update.
+     */
+    expectedLiquidityLU: bigint;
+    /**
+     * Current annual quota revenue in underlying tokens.
+     */
+    quotaRevenue: bigint;
+    /**
+     * Timestamp of the last base interest rate and index update.
+     */
+    lastBaseInterestUpdate: number;
+    /**
+     * Timestamp of the last quota revenue update.
+     */
+    lastQuotaRevenueUpdate: number;
+    /**
+     * Whether the pool is currently paused.
+     */
+    isPaused: boolean;
+    /**
+     * Per-credit-manager debt parameters indexed by credit manager address.
+     */
+    readonly creditManagerDebtParams: AddressMap<CreditManagerDebtParams>;
+    /**
+     * RWA factory associated with the pool's underlying, when the underlying
+     * is an RWA token. `undefined` for regular ERC-20 underlyings.
+     */
+    readonly rwaFactory: IRWAFactory | undefined;
+    stateHuman: (raw?: boolean) => PoolStateHuman;
+    /**
+     * 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;
+}
 export type PoolQuotaKeeperContract = PoolQuotaKeeperV310Contract;