@gearbox-protocol/sdk 13.4.0-beta.1 → 13.4.0-beta.2

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

@@ -2,47 +2,47 @@ import type { Address } from "viem";
 import type { CreditAccountData } from "../base/index.js";
 import { SDKConstruct } from "../base/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
-import type { PriceUpdateV310, UpdatePriceFeedsResult } from "../market/index.js";
+import { type PriceUpdate, type UpdatePriceFeedsResult } from "../market/index.js";
 import { type Asset, type RouterCASlice } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
-import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, PriceUpdatesOptions, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
+import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } 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}`;
+/**
+ * @internal
+ */
 export declare abstract class AbstractCreditAccountService extends SDKConstruct {
     #private;
     constructor(sdk: GearboxSDK, options?: CreditAccountServiceOptions);
     /**
-     * Returns single credit account data, or undefined if it's not found
-     * Performs all necessary price feed updates under the hood
-     * @param account
-     * @param blockNumber
-     * @returns
-     */
+     * {@inheritDoc ICreditAccountsService.getCreditAccountData}
+     **/
     getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData | undefined>;
     /**
-     * Methods to get all credit accounts with some optional filtering
-     * Performs all necessary price feed updates under the hood
-     *
-     * @param options
-     * @param blockNumber
-     * @returns returned credit accounts are sorted by health factor in ascending order
-     */
+     * {@inheritDoc ICreditAccountsService.getCreditAccounts}
+     **/
     getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData>>;
     /**
-     * Method to get all claimable rewards for credit account (ex. stkUSDS SKY rewards)
-       Assosiates rewards by adapter + stakedPhantomToken
-     * @param {Address} creditAccount - address of credit account to get rewards for
-     * @returns {Array<Rewards>} list of {@link Rewards} that can be claimed
-     */
+     * {@inheritDoc ICreditAccountsService.getRewards}
+     **/
     getRewards(creditAccount: Address): Promise<Array<Rewards>>;
     /**
-     * Method to get all connected bots for credit account
-     * @param {Array<AccountToCheck>} accountsToCheck - list of credit accounts
-        and their credit managers to check connected bots on
-     * @returns call result of getConnectedBots for each credit account
-     */
+     * {@inheritDoc ICreditAccountsService.getConnectedBots}
+     **/
     getConnectedBots(accountsToCheck: Array<AccountToCheck>, legacyMigrationBot: Address | undefined, additionalBots: Array<Address>): Promise<{
         legacy: GetConnectedBotsResult;
         legacyMigration: GetConnectedMigrationBotsResult;
@@ -51,139 +51,61 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
     private getActiveBots;
     private getActiveMigrationBots;
     /**
-     * Generates transaction to liquidate credit account
-     * @param props - {@link FullyLiquidateProps}
-     * @returns
-     */
+     * {@inheritDoc ICreditAccountsService.fullyLiquidate}
+     **/
     fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
     /**
-     * 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 ->
-         -> disable quotas of exiting tokens -> decrease debt -> disable exiting tokens tokens -> withdraw underlying tokenz
-     * @param {CloseOptions} operation - {@link CloseOptions}: close or zeroDebt
-     * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-     * @param {Array<Address>} assetsToWithdraw - tokens to withdraw from credit account.
-        For credit account closing this is the underlying token, because during the closure,
-        all tokens on account are swapped into the underlying,
-        and only the underlying token will remain on the credit account
-     * @param {Address} to - Wallet address to withdraw underlying to
-     * @param {number} slippage  - Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
-     * @default 50n
-     * @param {RouterCloseResult | undefined} closePath - result of findBestClosePath method from router; if omited, calls marketRegister.findCreditManager {@link RouterCloseResult}
-     * @returns All necessary data to execute the transaction (call, credit facade)
-     */
+     * {@inheritDoc ICreditAccountsService.closeCreditAccount}
+     **/
     closeCreditAccount({ operation, assetsToWithdraw, creditAccount: ca, to, slippage, closePath, }: CloseCreditAccountProps): Promise<CloseCreditAccountResult>;
     /**
-     * Updates quota of credit account.
-       - CA quota updated in the following order: price update -> update quotas
-     * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-     * @param {Array<Asset>} averageQuota - average quota for desired tokens {@link Asset}
-     * @param {Array<Asset>} minQuota - minimum quota for desired tokens {@link Asset}
-     * @returns All necessary data to execute the transaction (call, credit facade)
-     */
+     * {@inheritDoc ICreditAccountsService.updateQuotas}
+     **/
     updateQuotas({ minQuota, averageQuota, creditAccount, }: UpdateQuotasProps): Promise<CreditAccountOperationResult>;
     /**
-     * Adds a single collateral to credit account and updates quotas
-       - Collateral is added in the following order: price update -> add collateral (with permit) -> update quotas
-     * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-     * @param {Array<Asset>} averageQuota - average quota for desired token {@link Asset}
-     * @param {Array<Asset>} minQuota - minimum quota for desired token {@link Asset}
-     * @param {Asset} asset - asset to add as collateral {@link Asset}
-     * @param {PermitResult | undefined} permits - permits of collateral asset if it is permittable {@link PermitResult}
-     * @param {bigint} ethAmount - native token amount to attach to tx
-     * @returns All necessary data to execute the transaction (call, credit facade)
-     */
+     * {@inheritDoc ICreditAccountsService.addCollateral}
+     **/
     addCollateral({ creditAccount, asset, permit, ethAmount, minQuota, averageQuota, }: AddCollateralProps): Promise<CreditAccountOperationResult>;
     /**
-     * Increases or decreases debt of credit account; debt decrease uses token ON CREDIT ACCOUNT
-       - Debt is changed in the following order: price update -> (enables underlying if it was disabled) -> change debt
-     * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-     * @param {bigint} amount - amount to change debt by;
-        0 - prohibited value;
-        negative value for debt decrease;
-        positive value for debt increase.
-     * @returns All necessary data to execute the transaction (call, credit facade)
-     */
+     * {@inheritDoc ICreditAccountsService.changeDebt}
+     **/
     changeDebt({ creditAccount, amount, addCollateral, }: ChangeDeptProps): Promise<CreditAccountOperationResult>;
     /**
-     * Executes swap specified by given calls, update quotas of affected tokens
-       - Swap is executed in the following order: price update -> execute swap path -> update quotas
-     * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-     * @param {Array<Asset>} averageQuota - average quota for desired token {@link Asset}
-     * @param {Array<Asset>} minQuota - minimum quota for desired token {@link Asset}
-     * @param {Array<MultiCall>} calls - array of MultiCall from router methods getSingleSwap or getAllSwaps {@link MultiCall}
-     * @returns All necessary data to execute the transaction (call, credit facade)
-     */
+     * {@inheritDoc ICreditAccountsService.executeSwap}
+     **/
     executeSwap({ creditAccount, calls: swapCalls, minQuota, averageQuota, }: ExecuteSwapProps): Promise<CreditAccountOperationResult>;
     /**
-     * Preview delayed withdrawal for given token
-     * @param props - {@link PreviewDelayedWithdrawalProps}
-     * @returns
-     */
+     * {@inheritDoc ICreditAccountsService.previewDelayedWithdrawal}
+     **/
     previewDelayedWithdrawal({ creditAccount, amount, token, }: PreviewDelayedWithdrawalProps): Promise<PreviewDelayedWithdrawalResult>;
     /**
-     * Get claimable and pending withdrawals of an account
-     * @param props - {@link GetPendingWithdrawalsProps}
-     * @returns
-     */
+     * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
+     **/
     getPendingWithdrawals({ creditAccount, }: GetPendingWithdrawalsProps): Promise<GetPendingWithdrawalsResult>;
     /**
-     * Start delayed withdrawal for given token
-       - Withdrawal is executed in the following order: price update -> execute withdraw calls -> update quotas
-     * @param props - {@link StartDelayedWithdrawalProps}
-     * @returns
-    */
+     * {@inheritDoc ICreditAccountsService.startDelayedWithdrawal}
+     **/
     startDelayedWithdrawal({ creditAccount, minQuota, averageQuota, preview, }: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
     /**
-     * Claim tokens with delayed withdrawal
-       - Claim is executed in the following order: price update -> execute claim calls -> update quotas
-     * @param props - {@link ClaimDelayedProps}
-     * @returns
-    */
+     * {@inheritDoc ICreditAccountsService.claimDelayed}
+     **/
     claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
     /**
-     * Executes swap specified by given calls, update quotas of affected tokens
-       - Open credit account is executed in the following order: price update -> increase debt -> add collateral ->
-        -> update quotas -> (optionally: execute swap path for trading/strategy) ->
-        -> (optionally: withdraw debt for lending)
-      - Basic open credit account: price update -> increase debt -> add collateral -> update quotas
-      - Lending: price update -> increase debt -> add collateral -> update quotas -> withdraw debt
-      - Strategy/trading: price update -> increase debt -> add collateral -> update quotas -> execute swap path
-      - In strategy is possible situation when collateral is added, but not swapped; the only swapped value in this case will be debt
-     * @param {bigint} ethAmount - native token amount to attach to tx
-     * @param {Address} creditManager - address of credit manager to open credit account on
-     * @param {Array<Asset>} collateral - array of collateral which can be just directly added or swapped using the path {@link Asset}
-     * @param {Record<Address, PermitResult>} permits - permits of collateral tokens (in any permittable token is present) {@link PermitResult}
-     * @param {bigint} debt - debt to open credit account with
-     * @param {boolean} withdrawDebt - flag to withdraw debt to wallet after opening credit account;
-        used for borrowing functionality
-     * @param {bigint} referralCode - referral code to open credit account with
-     * @param {Address} to - wallet address to transfer credit account to\
-     * @param {Array<MultiCall>} calls - array of MultiCall from router methods findOpenStrategyPath {@link MultiCall}.
-        Used for trading and strategy functionality
-     * @param {Array<Asset>} averageQuota - average quota for tokens after open {@link Asset}
-     * @param {Array<Asset>} minQuota - minimum quota for tokens after open  {@link Asset}
-     * @returns All necessary data to execute the transaction (call, credit facade)
-     */
+     * {@inheritDoc ICreditAccountsService.openCA}
+     **/
     openCA({ ethAmount, creditManager, collateral, permits, debt, withdrawDebt, referralCode, to, calls: openPathCalls, minQuota, averageQuota, }: OpenCAProps): Promise<CreditAccountOperationResult>;
     /**
-     * Returns borrow rate with 4 digits precision (10000 = 100%)
-     * @param ca
-     * @returns
-     */
+     * {@inheritDoc ICreditAccountsService.getBorrowRate}
+     **/
     getBorrowRate(ca: CreditAccountData): bigint;
     /**
-     * Returns optimal HF for partial liquidation with 4 digits precision (10000 = 100%)
-     * @param ca
-     */
+     * {@inheritDoc ICreditAccountsService.getOptimalHFForPartialLiquidation}
+     **/
     getOptimalHFForPartialLiquidation(ca: CreditAccountData): bigint;
-    protected getUpdateForAccount(options: PriceUpdatesOptions): Promise<UpdatePriceFeedsResult>;
     /**
-     * Returns account price updates that can be used in credit facade multicall or liquidator calls
-     * @param options
-     * @returns
-     */
-    getOnDemandPriceUpdates(options: PriceUpdatesOptions): Promise<PriceUpdateV310[]>;
+     * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
+     **/
+    getOnDemandPriceUpdates(account: CreditAccountTokensSlice, ignoreReservePrices?: boolean): Promise<PriceUpdate[]>;
     /**
      * Analyzes a multicall array and prepends necessary on-demand price feed updates.
      *
@@ -199,6 +121,7 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
     protected prependPriceUpdates(creditManager: Address, calls: MultiCall[], ca?: RouterCASlice, options?: {
         ignoreReservePrices?: boolean;
     }): Promise<MultiCall[]>;
+    protected getUpdateForAccount(account: CreditAccountTokensSlice, ignoreReservePrices?: boolean): Promise<UpdatePriceFeedsResult>;
     /**
      * Executes a multicall on a credit account, automatically prepending
      * necessary on-demand price feed updates.

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

@@ -1,24 +1,33 @@
 import { AbstractCreditAccountService } from "./AbstractCreditAccountsService.js";
 import type { ClaimFarmRewardsProps, CreditAccountOperationResult, CreditManagerOperationResult, ICreditAccountsService, LlamathenaProportionalWithdrawProps, PreviewWithdrawLlamathenaProportionallyProps, PreviewWithdrawLlamathenaProportionallyResult, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, SetBotProps, WithdrawCollateralProps } from "./types.js";
+/**
+ * Service for querying and operating on Gearbox credit accounts.
+ *
+ * Provides methods to fetch account data, build transactions for common operations
+ * (open, close, liquidate, swap, manage collateral/debt/quotas), and generate
+ * the price feed updates required by the credit facade.
+ *
+ * @see {@link ICreditAccountsService}
+ **/
 export declare class CreditAccountServiceV310 extends AbstractCreditAccountService implements ICreditAccountsService {
     /**
-     * Implements {@link ICreditAccountsService.setBot}
+     * {@inheritDoc ICreditAccountsService.setBot}
      */
     setBot({ botAddress, permissions: defaultPermissions, targetContract, }: SetBotProps): Promise<CreditAccountOperationResult | CreditManagerOperationResult>;
     /**
-     * Implements {@link ICreditAccountsService.withdrawCollateral}
+     * {@inheritDoc ICreditAccountsService.withdrawCollateral}
      */
     withdrawCollateral({ creditAccount, assetsToWithdraw, to, minQuota, averageQuota, }: WithdrawCollateralProps): Promise<CreditAccountOperationResult>;
     /**
-     * Implements {@link ICreditAccountsService.repayCreditAccount}
+     * {@inheritDoc ICreditAccountsService.repayCreditAccount}
      */
     repayCreditAccount({ operation, collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, }: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
     /**
-     * Implements {@link ICreditAccountsService.repayAndLiquidateCreditAccount}
+     * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
      */
     repayAndLiquidateCreditAccount({ collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, }: RepayAndLiquidateCreditAccountProps): Promise<CreditAccountOperationResult>;
     /**
-     * Implements {@link ICreditAccountsService.claimFarmRewards}
+     * {@inheritDoc ICreditAccountsService.claimFarmRewards}
      */
     claimFarmRewards({ calls: externalCalls, creditAccount: ca, minQuota, averageQuota, tokensToClaim, }: ClaimFarmRewardsProps): Promise<CreditAccountOperationResult>;
     previewWithdrawLlamathenaProportionally(_: PreviewWithdrawLlamathenaProportionallyProps): Promise<PreviewWithdrawLlamathenaProportionallyResult>;

package/dist/types/sdk/accounts/multicall-utils.d.ts

@@ -1,4 +1,4 @@
-import type { PriceUpdateV310 } from "../market/pricefeeds/types.js";
+import type { PriceUpdate } from "../market/pricefeeds/types.js";
 import type { MultiCall } from "../types/index.js";
 import { AddressSet } from "../utils/AddressSet.js";
 /**
@@ -13,7 +13,7 @@ import { AddressSet } from "../utils/AddressSet.js";
  *          `remainingCalls` (everything else, preserving order)
  */
 export declare function extractPriceUpdates(calls: MultiCall[]): {
-    priceUpdates: PriceUpdateV310[];
+    priceUpdates: PriceUpdate[];
     remainingCalls: MultiCall[];
 };
 /**
@@ -36,4 +36,4 @@ export declare function extractQuotaTokens(calls: MultiCall[]): AddressSet;
  * @param generated - Newly generated price updates to merge in
  * @returns Merged array with no duplicate `priceFeed` addresses
  */
-export declare function mergePriceUpdates(existing: PriceUpdateV310[], generated: PriceUpdateV310[]): PriceUpdateV310[];
+export declare function mergePriceUpdates(existing: PriceUpdate[], generated: PriceUpdate[]): PriceUpdate[];