@gearbox-protocol/sdk 14.1.1 → 15.0.0-next.1

package/dist/esm/sdk/accounts/index.js

@@ -1,4 +1,2 @@
-export * from "./AbstractCreditAccountsService.js";
 export * from "./CreditAccountsServiceV310.js";
-export * from "./createCreditAccountService.js";
 export * from "./types.js";

package/dist/esm/sdk/accounts/multicall-utils.js

@@ -1,8 +1,4 @@
-import {
-  decodeFunctionData,
-  getAbiItem,
-  toFunctionSelector
-} from "viem";
+import { decodeFunctionData, getAbiItem, toFunctionSelector } from "viem";
 import { iCreditFacadeMulticallV310Abi } from "../../abi/310/generated.js";
 import { AddressMap } from "../utils/AddressMap.js";
 import { AddressSet } from "../utils/AddressSet.js";

package/dist/esm/sdk/market/credit/CreditFacadeV310Contract.js

@@ -60,6 +60,12 @@ class CreditFacadeV310Contract extends CreditFacadeV310BaseContract {
       args: lossPolicyData ? [ca, to, calls, lossPolicyData] : [ca, to, calls]
     });
   }
+  partiallyLiquidateCreditAccount(ca, token, repaidAmount, minSeizedAmount, to, updates) {
+    return this.createRawTx({
+      functionName: "partiallyLiquidateCreditAccount",
+      args: [ca, token, repaidAmount, minSeizedAmount, to, updates]
+    });
+  }
   closeCreditAccount(ca, calls) {
     return this.createRawTx({
       functionName: "closeCreditAccount",

package/dist/esm/sdk/market/oracle/PriceOracleV310Contract.js

@@ -5,6 +5,7 @@ import {
   iCreditFacadeMulticallV310Abi,
   iPriceOracleV310Abi
 } from "../../../abi/310/generated.js";
+import { simulateWithPriceUpdates } from "../../utils/viem/simulateWithPriceUpdates.js";
 import {
   getRawPriceUpdates
 } from "../pricefeeds/index.js";
@@ -48,6 +49,31 @@ class PriceOracleV310Contract extends PriceOracleBaseContract {
       ]
     };
   }
+  /**
+   * {@inheritDoc IPriceOracleContract.updateAndConvert}
+   **/
+  async updateAndConvert(from, to, amount) {
+    const fromFeed = this.mainPriceFeeds.mustGet(from).priceFeed;
+    const toFeed = this.mainPriceFeeds.mustGet(to).priceFeed;
+    const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs([
+      fromFeed,
+      toFeed
+    ]);
+    const [result] = await simulateWithPriceUpdates(this.sdk.client, {
+      priceUpdates: updates.txs,
+      contracts: [
+        {
+          abi: this.contract.abi,
+          functionName: "convert",
+          args: [amount, from, to],
+          address: this.contract.address
+        }
+      ],
+      strictPrices: true,
+      gas: this.sdk.gasLimit
+    });
+    return result;
+  }
   processLog(log) {
     switch (log.eventName) {
       case "SetPriceFeed":

package/dist/esm/sdk/market/pricefeeds/PriceFeedsRegister.js

@@ -85,6 +85,9 @@ class PriceFeedRegister extends SDKConstruct {
         updateables = this.sdk.marketRegister.priceOracles.flatMap((o) => o.reservePriceFeeds.values()).flatMap((pf) => pf.priceFeed.updatableDependencies());
       }
     }
+    if (updateables.length === 0) {
+      return { txs: [], timestamp: 0 };
+    }
     const txs = [];
     const latestUpdate = {
       updates: [],

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

@@ -1,6 +1,7 @@
 import type { Address } from "viem";
 import { type PublicClient, type Transport } from "viem";
 import type { HttpRpcClientOptions } from "viem/utils";
+import { type ICreditAccountsService } from "./accounts/index.js";
 import type { BaseState, IBaseContract } from "./base/index.js";
 import { ChainContractsRegister } from "./base/index.js";
 import type { GearboxChain, NetworkType } from "./chain/chains.js";
@@ -11,6 +12,7 @@ import { MarketRegister } from "./market/MarketRegister.js";
 import { PriceFeedRegister } from "./market/pricefeeds/index.js";
 import type { PythOptions, RedstoneOptions } from "./market/pricefeeds/updates/index.js";
 import type { PluginsMap } from "./plugins/index.js";
+import { type IPoolsService } from "./pools/index.js";
 import { type IRouterContract } from "./router/index.js";
 import type { GearboxState, GearboxStateHuman, ILogger } from "./types/index.js";
 /**
@@ -177,6 +179,14 @@ export declare class OnchainSDK<const Plugins extends PluginsMap = {}> extends C
      * When `true`, the SDK throws on unrecognised contract types.
      **/
     readonly strictContractTypes: boolean;
+    /**
+     * Namespace for credit accounts operations.
+     */
+    readonly accounts: ICreditAccountsService;
+    /**
+     * Namespace for pool operations.
+     */
+    readonly pools: IPoolsService;
     /**
      * @param network - Gearbox network type (e.g. `"Mainnet"`, `"Monad"`).
      * @param clientOptions - Connection options (RPC URLs, transport, or client).

package/dist/types/sdk/accounts/CreditAccountsServiceV310.d.ts

@@ -1,5 +1,28 @@
-import { AbstractCreditAccountService } from "./AbstractCreditAccountsService.js";
-import type { ClaimFarmRewardsProps, CreditAccountOperationResult, CreditManagerOperationResult, ICreditAccountsService, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, SetBotProps, WithdrawCollateralProps } from "./types.js";
+import type { Address } from "viem";
+import type { CreditAccountData } from "../base/index.js";
+import { SDKConstruct } from "../base/index.js";
+import { type PriceUpdate } from "../market/index.js";
+import type { KYCOpenAccountRequirements } from "../market/kyc/index.js";
+import type { OnchainSDK } from "../OnchainSDK.js";
+import { type RouterCASlice } from "../router/index.js";
+import type { MultiCall, RawTx } from "../types/index.js";
+import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerOperationResult, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
+/**
+ * Options for configuring the credit account service.
+ **/
+export interface CreditAccountServiceOptions {
+    /**
+     * Maximum number of credit accounts to fetch per compressor call.
+     * When set, accounts are loaded in batches of this size until all are fetched.
+     **/
+    batchSize?: number;
+}
+/**
+ * Returns the withdrawal compressor contract address for the given chain, or `undefined` if none is configured.
+ * @param chainId - Numeric chain ID.
+ * @returns Withdrawal compressor address, or `undefined`.
+ **/
+export declare function getWithdrawalCompressorAddress(chainId: number): `0x${string}`;
 /**
  * Service for querying and operating on Gearbox credit accounts.
  *
@@ -9,7 +32,138 @@ import type { ClaimFarmRewardsProps, CreditAccountOperationResult, CreditManager
  *
  * @see {@link ICreditAccountsService}
  **/
-export declare class CreditAccountServiceV310 extends AbstractCreditAccountService implements ICreditAccountsService {
+export declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditAccountsService {
+    #private;
+    constructor(sdk: OnchainSDK, options?: CreditAccountServiceOptions);
+    setBatchSize(batchSize: number): void;
+    /**
+     * {@inheritDoc ICreditAccountsService.getCreditAccountData}
+     **/
+    getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData<true> | undefined>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getCreditAccounts}
+     **/
+    getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData>>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getBorrowerCreditAccounts}
+     **/
+    getBorrowerCreditAccounts(borrower: Address, options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData<true>>>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getRewards}
+     **/
+    getRewards(creditAccount: Address): Promise<Array<Rewards>>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getConnectedBots}
+     **/
+    getConnectedBots(accountsToCheck: Array<AccountToCheck>, legacyMigrationBot: Address | undefined, additionalBots: Array<Address>): Promise<{
+        legacy: GetConnectedBotsResult;
+        legacyMigration: GetConnectedMigrationBotsResult;
+        additionalBots: Array<Omit<NonNullable<GetConnectedMigrationBotsResult>, "botAddress">>;
+    }>;
+    /**
+     * {@inheritDoc ICreditAccountsService.fullyLiquidate}
+     **/
+    fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.calcMinSeizedAmount}
+     */
+    calcMinSeizedAmount(props: PartiallyLiquidateProps): Promise<bigint>;
+    /**
+     * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
+     */
+    partiallyLiquidate(props: PartiallyLiquidateProps): Promise<RawTx>;
+    /**
+     * {@inheritDoc ICreditAccountsService.closeCreditAccount}
+     **/
+    closeCreditAccount({ operation, assetsToWithdraw, creditAccount: ca, to, slippage, closePath, }: CloseCreditAccountProps): Promise<CloseCreditAccountResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.updateQuotas}
+     **/
+    updateQuotas({ minQuota, averageQuota, creditAccount, }: UpdateQuotasProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.addCollateral}
+     **/
+    addCollateral({ creditAccount, asset, permit, ethAmount, minQuota, averageQuota, }: AddCollateralProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.changeDebt}
+     **/
+    changeDebt({ creditAccount, amount, collateral, }: ChangeDeptProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.executeSwap}
+     **/
+    executeSwap({ creditAccount, calls: swapCalls, minQuota, averageQuota, }: ExecuteSwapProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.previewDelayedWithdrawal}
+     **/
+    previewDelayedWithdrawal({ creditAccount, amount, token, }: PreviewDelayedWithdrawalProps): Promise<PreviewDelayedWithdrawalResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
+     **/
+    getPendingWithdrawals({ creditAccount, }: GetPendingWithdrawalsProps): Promise<GetPendingWithdrawalsResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.startDelayedWithdrawal}
+     **/
+    startDelayedWithdrawal({ creditAccount, minQuota, averageQuota, preview, }: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.claimDelayed}
+     **/
+    claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getApprovalAddress}
+     **/
+    getApprovalAddress(options: GetApprovalAddressProps): Promise<Address>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getOpenAccountRequirements}
+     */
+    getOpenAccountRequirements(borrower: Address, creditManager: Address, props: GetOpenAccountRequirementsProps): Promise<KYCOpenAccountRequirements | undefined>;
+    /**
+     * {@inheritDoc ICreditAccountsService.openCA}
+     **/
+    openCA(props: OpenCAProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getBorrowRate}
+     **/
+    getBorrowRate(ca: CreditAccountData): bigint;
+    /**
+     * {@inheritDoc ICreditAccountsService.getOptimalHFForPartialLiquidation}
+     **/
+    getOptimalHFForPartialLiquidation(ca: CreditAccountData): bigint;
+    /**
+     * Returns multicall entries to redeem (unwrap) KYC ERC-4626 vault shares into underlying for the given credit manager.
+     * Used when withdrawing debt from a KYC market: redeems adapter vault shares so the underlying can be withdrawn.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Number of vault shares (adapter tokens) to redeem
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getKYCUnwrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to deposit (wrap) underlying into KYC ERC-4626 vault shares for the given credit manager.
+     * Used when adding debt on a KYC market: deposits underlying into the adapter vault so shares are minted on the account.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Amount of underlying assets to deposit into the vault (in underlying decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getKYCWrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to call redeemDiff on the KYC ERC-4626 adapter for the given credit manager.
+     * Redeems the leftover vault shares (e.g. after repaying debt) so the account does not hold excess KYC vault tokens.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Leftover vault share amount to redeem (in adapter/vault decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getRedeemDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to call depositDiff on the KYC ERC-4626 adapter for the given credit manager.
+     * Deposits the leftover underlying (e.g. after decreasing debt) into the vault so the account does not hold excess underlying.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Leftover underlying amount to deposit into the vault (in underlying decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getDepositDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
     /**
      * {@inheritDoc ICreditAccountsService.setBot}
      */
@@ -30,4 +184,28 @@ export declare class CreditAccountServiceV310 extends AbstractCreditAccountServi
      * {@inheritDoc ICreditAccountsService.claimFarmRewards}
      */
     claimFarmRewards({ calls: externalCalls, creditAccount: ca, minQuota, averageQuota, tokensToClaim, }: ClaimFarmRewardsProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Returns raw txs that are needed to update all price feeds so that all credit accounts (possibly from different markets) compute
+     * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
+     **/
+    getOnDemandPriceUpdates(account: CreditAccountTokensSlice, ignoreReservePrices?: boolean): Promise<PriceUpdate[]>;
+    /**
+     * {@inheritDoc ICreditAccountsService.multicall}
+     */
+    multicall(creditAccount: RouterCASlice, calls: MultiCall[], options?: {
+        ignoreReservePrices?: boolean;
+    }): Promise<RawTx>;
+    /**
+     * {@inheritDoc ICreditAccountsService.botMulticall}
+     */
+    botMulticall(creditAccount: RouterCASlice, calls: MultiCall[], options?: {
+        ignoreReservePrices?: boolean;
+    }): Promise<RawTx>;
+    /**
+     * Returns addresses of market configurators
+     */
+    private get marketConfigurators();
+    private get rewardCompressor();
+    private get peripheryCompressor();
+    private get compressor();
 }

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

@@ -1,4 +1,2 @@
-export * from "./AbstractCreditAccountsService.js";
 export * from "./CreditAccountsServiceV310.js";
-export * from "./createCreditAccountService.js";
 export * from "./types.js";

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

@@ -488,6 +488,42 @@ export interface FullyLiquidateProps {
      */
     debtOnly?: boolean;
 }
+export interface CalcMinSeizedAmountProps {
+    /**
+     * Credit account to liquidate
+     */
+    account: RouterCASlice;
+    /**
+     * Collateral token to seize
+     */
+    token: Address;
+    /**
+     * Amount of underlying token to repay
+     */
+    repaidAmount: bigint;
+}
+export interface PartiallyLiquidateProps {
+    /**
+     * Credit account to liquidate
+     */
+    account: RouterCASlice;
+    /**
+     * Address to transfer underlying left after liquidation
+     */
+    to: Address;
+    /**
+     * Collateral token to seize
+     */
+    token: Address;
+    /**
+     * Amount of underlying token to repay
+     */
+    repaidAmount: bigint;
+    /**
+     * Minimum amount of `token` to seize from `creditAccount`
+     */
+    minSeizedAmount: bigint;
+}
 /**
  * EIP-2612 permit signature data for a token, enabling gasless approval for credit account operations.
  **/
@@ -681,6 +717,26 @@ export interface ICreditAccountsService extends Construct {
      * @returns Transaction data and optional loss policy data
      */
     fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
+    /**
+     * Calculates minimum amount of collateral token to seize from credit account
+     * for partial liquidation, can be passed to {@link partiallyLiquidate} as `minSeizedAmount`
+     * @param props - {@link CalcMinSeizedAmountProps}
+     * @returns Minimum amount of collateral token to seize
+     */
+    calcMinSeizedAmount(props: CalcMinSeizedAmountProps): Promise<bigint>;
+    /**
+     * Generates transaction to partially liquidate credit account;
+     *
+     * Transaction partially liquidates credit account's debt in exchange for discounted collateral
+     * by transferring underlying from the caller (requires approval to the credit manager) and uses it to repay
+     * account's debt and pay fees to the treasury
+     * Transfers chosen collateral token at discounted oracle price to the liquidator (liquidation discount
+     * and fee are the same as for full liquidations, though fees are not deposited into the pool)
+     *
+     * @param props - {@link PartiallyLiquidateProps}
+     * @returns Raw transaction ready to be signed and sent
+     */
+    partiallyLiquidate(props: PartiallyLiquidateProps): Promise<RawTx>;
     /**
      * Closes credit account or closes credit account and keeps it open with zero debt.
      * - Ca is closed in the following order: price update -> close path to swap all tokens into underlying ->

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

@@ -1,6 +1,7 @@
 import type { Address, ContractEventName, Hex, Log } from "viem";
 import type { ConstructOptions, CreditFacadeState, CreditSuiteState } from "../../base/index.js";
 import type { CreditFacadeStateHuman, MultiCall, RawTx } from "../../types/index.js";
+import type { PriceUpdate } from "../pricefeeds/index.js";
 import type { CreditFacadeV310Abi } from "./CreditFacadeV310BaseContract.js";
 import { CreditFacadeV310BaseContract } from "./CreditFacadeV310BaseContract.js";
 type abi = CreditFacadeV310Abi;
@@ -12,6 +13,7 @@ export declare class CreditFacadeV310Contract extends CreditFacadeV310BaseContra
     stateHuman(raw?: boolean): CreditFacadeStateHuman;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
     liquidateCreditAccount(ca: Address, to: Address, calls: MultiCall[], lossPolicyData?: Hex): RawTx;
+    partiallyLiquidateCreditAccount(ca: Address, token: Address, repaidAmount: bigint, minSeizedAmount: bigint, to: Address, updates: PriceUpdate[]): RawTx;
     closeCreditAccount(ca: Address, calls: MultiCall[]): RawTx;
     multicall(ca: Address, calls: MultiCall[]): RawTx;
     botMulticall(ca: Address, calls: MultiCall[]): RawTx;

package/dist/types/sdk/market/oracle/PriceOracleBaseContract.d.ts

@@ -56,6 +56,11 @@ export declare abstract class PriceOracleBaseContract<abi extends Abi | readonly
      * {@inheritDoc IPriceOracleContract.usesPriceFeed}
      **/
     usesPriceFeed(priceFeed: Address): boolean;
+    /**
+     *
+     * {@inheritDoc IPriceOracleContract.updateAndConvert}
+     **/
+    abstract updateAndConvert(from: Address, to: Address, amount: bigint): Promise<bigint>;
     /**
      * {@inheritDoc IPriceOracleContract.convert}
      **/

package/dist/types/sdk/market/oracle/PriceOracleV310Contract.d.ts

@@ -349,6 +349,10 @@ export declare class PriceOracleV310Contract extends PriceOracleBaseContract<abi
      * @returns
      */
     onDemandPriceUpdates(creditFacade: Address, updates?: UpdatePriceFeedsResult): OnDemandPriceUpdates;
+    /**
+     * {@inheritDoc IPriceOracleContract.updateAndConvert}
+     **/
+    updateAndConvert(from: Address, to: Address, amount: bigint): Promise<bigint>;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
 }
 export {};

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

@@ -114,6 +114,15 @@ export interface IPriceOracleContract extends IBaseContract {
      * @param reserve - Use reserve feeds instead of main.
      **/
     convertFromUSD: (to: Address, amount: bigint, reserve?: boolean) => bigint;
+    /**
+     * Unlike {@link convert}, this method will update the price feeds before converting,
+     * and conversion will be peformed onchain using main price feeds
+     * @param from
+     * @param to
+     * @param amount
+     * @returns
+     */
+    updateAndConvert: (from: Address, to: Address, amount: bigint) => Promise<bigint>;
     /**
      * @internal
      **/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.1.1",
+  "version": "15.0.0-next.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",