@gearbox-protocol/sdk 14.12.0-next.73 → 14.12.0-next.75

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

@@ -1,13 +1,15 @@
 import { StrategyPosition } from "../../model/positions.js";
 import "../../model/index.js";
 import { RequestableWithdrawal } from "./withdrawal-compressor/types.js";
-import { Asset, CreditAccountData } from "../base/types.js";
+import { Asset, CreditAccountData, CreditAccountTokensSlice } from "../base/types.js";
+import { RWAOpenAccountRequirements } from "../market/rwa/types.js";
+import "../market/rwa/index.js";
 import { RouterCASlice } from "../router/types.js";
 import "../router/index.js";
+import { GetCreditAccountsOptions, ListStrategyPositionsProps } from "./credit-account-compressor/types.js";
+import "./credit-account-compressor/index.js";
 import "./withdrawal-compressor/index.js";
-import { AccountToCheck, AddCollateralProps, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerOperationResult, DefaultPartialLiquidationParams, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, ListStrategyPositionsProps, OpenCAProps, PartiallyLiquidateProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
-import { RWAOpenAccountRequirements } from "../market/rwa/types.js";
-import "../market/rwa/index.js";
+import { AccountToCheck, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, ClaimFarmRewardsProps, CreditAccountOperationResult, CreditManagerOperationResult, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, Rewards, SetBotProps } from "./types.js";
 import { PriceUpdate } from "../market/pricefeeds/types.js";
 import "../market/index.js";
 import { MultiCall, RawTx } from "../types/transactions.js";
@@ -17,16 +19,6 @@ import { SDKConstruct } from "../base/SDKConstruct.js";
 import "../base/index.js";
 import { Address } from "viem";
 //#region src/sdk/accounts/CreditAccountsServiceV310.d.ts
-/**
- * Options for configuring the credit account service.
- **/
-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;
-}
 /**
  * Service for querying and operating on Gearbox credit accounts.
  *
@@ -38,8 +30,7 @@ interface CreditAccountServiceOptions {
  **/
 declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditAccountsService {
   #private;
-  constructor(sdk: OnchainSDK, options?: CreditAccountServiceOptions);
-  setBatchSize(batchSize: number): void;
+  constructor(sdk: OnchainSDK);
   /**
    * {@inheritDoc ICreditAccountsService.getCreditAccountData}
    **/
@@ -72,38 +63,14 @@ declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditA
    * {@inheritDoc ICreditAccountsService.fullyLiquidate}
    **/
   fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
-  /**
-   * {@inheritDoc ICreditAccountsService.defaultPartialLiquidationParams}
-   */
-  defaultPartialLiquidationParams(ca: CreditAccountData): DefaultPartialLiquidationParams;
   /**
    * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
    */
   partiallyLiquidate(props: PartiallyLiquidateProps): Promise<RawTx>;
-  /**
-   * {@inheritDoc ICreditAccountsService.closeCreditAccount}
-   **/
-  closeCreditAccount({ operation, assetsToWithdraw, creditAccount: ca, to, slippage, closePath }: CloseCreditAccountProps): Promise<CloseCreditAccountResult>;
   /**
    * {@inheritDoc ICreditAccountsService.assembleCloseCreditAccountCalls}
    */
   assembleCloseCreditAccountCalls({ creditAccount: ca, routerCalls, assetsToWithdraw, to }: AssembleCloseCreditAccountCallsProps): Promise<Array<MultiCall>>;
-  /**
-   * {@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}
    **/
@@ -112,18 +79,10 @@ declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditA
    * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
    **/
   getPendingWithdrawals({ creditAccount }: GetPendingWithdrawalsProps): Promise<GetPendingWithdrawalsResult>;
-  /**
-   * {@inheritDoc ICreditAccountsService.startDelayedWithdrawal}
-   **/
-  startDelayedWithdrawal({ creditAccount, minQuota, averageQuota, preview }: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
   /**
    * {@inheritDoc ICreditAccountsService.assembleStartDelayedWithdrawalCalls}
    **/
   assembleStartDelayedWithdrawalCalls({ creditFacade, preview }: AssembleStartDelayedWithdrawalCallsProps): Array<MultiCall>;
-  /**
-   * {@inheritDoc ICreditAccountsService.claimDelayed}
-   **/
-  claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
   /**
    * {@inheritDoc ICreditAccountsService.assembleClaimDelayedCalls}
    **/
@@ -139,92 +98,40 @@ declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditA
   /**
    * {@inheritDoc ICreditAccountsService.openCA}
    **/
-  openCA(props: OpenCAProps): Promise<CreditAccountOperationResult>;
+  openCA(props: OpenCAProps): Promise<RawTx>;
   /**
-   * {@inheritDoc ICreditAccountsService.getBorrowRate}
-   **/
-  getBorrowRate(ca: CreditAccountData): bigint;
-  /**
-   * {@inheritDoc ICreditAccountsService.getOptimalHFForPartialLiquidation}
-   **/
-  getOptimalHFForPartialLiquidation(ca: CreditAccountData): bigint;
-  /**
-   * Returns multicall entries to redeem (unwrap) RWA ERC-4626 vault shares into underlying for the given credit manager.
-   * Used when withdrawing debt from a RWA market: redeems adapter vault shares so the underlying can be withdrawn.
-   * Only applies when the credit manager's underlying is RWA-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 RWA or no adapter is configured
+   * {@inheritDoc ICreditAccountsService.assembleRWAUnwrapCalls}
    */
-  getRWAUnwrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-  /**
-   * Returns multicall entries to deposit (wrap) underlying into RWA ERC-4626 vault shares for the given credit manager.
-   * Used when adding debt on a RWA market: deposits underlying into the adapter vault so shares are minted on the account.
-   * Only applies when the credit manager's underlying is RWA-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 RWA or no adapter is configured
-   */
-  getRWAWrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-  /**
-   * Returns multicall entries to call redeemDiff on the RWA 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 RWA vault tokens.
-   * Only applies when the credit manager's underlying is RWA-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 RWA or no adapter is configured
-   */
-  getRedeemDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-  /**
-   * Returns multicall entries to call depositDiff on the RWA 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 RWA-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 RWA or no adapter is configured
+  assembleRWAUnwrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+  /**
+   * {@inheritDoc ICreditAccountsService.assembleRWAWrapCalls}
    */
-  getDepositDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+  assembleRWAWrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
   /**
-   * {@inheritDoc ICreditAccountsService.setBot}
+   * {@inheritDoc ICreditAccountsService.assembleRedeemDiffCalls}
    */
-  setBot({ botAddress, permissions: defaultPermissions, targetContract }: SetBotProps): Promise<CreditAccountOperationResult | CreditManagerOperationResult>;
+  assembleRedeemDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
   /**
-   * {@inheritDoc ICreditAccountsService.withdrawCollateral}
+   * {@inheritDoc ICreditAccountsService.assembleDepositDiffCalls}
    */
-  withdrawCollateral({ creditAccount, assetsToWithdraw, to, minQuota, averageQuota }: WithdrawCollateralProps): Promise<CreditAccountOperationResult>;
+  assembleDepositDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
   /**
-   * {@inheritDoc ICreditAccountsService.repayCreditAccount}
+   * {@inheritDoc ICreditAccountsService.setBot}
    */
-  repayCreditAccount(props: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
+  setBot({ botAddress, permissions: defaultPermissions, targetContract }: SetBotProps): Promise<CreditAccountOperationResult | CreditManagerOperationResult>;
   /**
    * {@inheritDoc ICreditAccountsService.assembleRepayCreditAccountCalls}
    */
   assembleRepayCreditAccountCalls({ collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, calls: wrapCalls }: AssembleRepayCreditAccountCallsProps): Promise<Array<MultiCall>>;
-  /**
-   * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
-   */
-  repayAndLiquidateCreditAccount({ collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim }: RepayAndLiquidateCreditAccountProps): Promise<CreditAccountOperationResult>;
   /**
    * {@inheritDoc ICreditAccountsService.claimFarmRewards}
    */
-  claimFarmRewards({ calls: externalCalls, creditAccount: ca, minQuota, averageQuota, tokensToClaim }: ClaimFarmRewardsProps): Promise<CreditAccountOperationResult>;
+  claimFarmRewards({ calls: externalCalls, creditAccount: ca, minQuota, averageQuota, tokensToClaim }: ClaimFarmRewardsProps): Promise<RawTx>;
   /**
    * 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>;
   /**
    * {@inheritDoc ICreditAccountsService.prependPriceUpdates}
    */
@@ -241,14 +148,11 @@ declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditA
   executeCaUpdate(creditAccount: RouterCASlice, calls: MultiCall[], options?: {
     ignoreReservePrices?: boolean;
     ethAmount?: bigint;
-  }): Promise<{
-    tx: RawTx;
-    calls: MultiCall[];
-  }>;
+  }): Promise<RawTx>;
   /**
    * {@inheritDoc ICreditAccountsService.prepareUpdateQuotas}
    */
-  prepareUpdateQuotas(creditFacade: Address, { averageQuota, minQuota }: PrepareUpdateQuotasProps): Array<MultiCall>;
+  prepareUpdateQuotas(creditFacade: Address, props: PrepareUpdateQuotasProps): Array<MultiCall>;
   /**
    * {@inheritDoc ICreditAccountsService.prepareWithdrawToken}
    */
@@ -265,13 +169,8 @@ declare class CreditAccountsServiceV310 extends SDKConstruct implements ICreditA
    * {@inheritDoc ICreditAccountsService.prepareAddCollateral}
    */
   prepareAddCollateral(creditFacade: Address, assets: Array<Asset>, permits: Record<string, PermitResult>): Array<MultiCall>;
-  /**
-   * Returns addresses of market configurators
-   */
-  private get marketConfigurators();
   private get rewardCompressor();
   private get peripheryCompressor();
-  private get compressor();
 }
 //#endregion
-export { CreditAccountServiceOptions, CreditAccountsServiceV310 };
+export { CreditAccountsServiceV310 };

package/dist/types/sdk/accounts/credit-account-compressor/CreditAccountCompressor.d.ts

@@ -0,0 +1,60 @@
+import { StrategyPosition } from "../../../model/positions.js";
+import "../../../model/index.js";
+import { CreditAccountData } from "../../base/types.js";
+import { GetCreditAccountsOptions, ListStrategyPositionsProps } from "./types.js";
+import { SDKConstruct } from "../../base/SDKConstruct.js";
+import "../../base/index.js";
+import { Address } from "viem";
+//#region src/sdk/accounts/credit-account-compressor/CreditAccountCompressor.d.ts
+/**
+ * Reads credit accounts of the current chain.
+ *
+ * Stitches the credit account compressor together with the RWA factories (for
+ * accounts owned via an investor EOA) and with the withdrawal compressor (for
+ * assets that are on their way out of an account), and describes the result
+ * either as raw account data or as {@link StrategyPosition}s.
+ *
+ * TODO: create and deploy new compressor contract onchain to avoid all this stitching
+ **/
+declare class CreditAccountCompressor extends SDKConstruct {
+  #private;
+  /**
+   * Reads data of a single credit account.
+   *
+   * When the compressor cannot value the account with current prices, the read
+   * is retried with price feed updates applied.
+   *
+   * @param account - Credit account address.
+   * @param blockNumber - Block to read at, defaults to the latest block.
+   * @returns Account data, or `undefined` if the account does not exist.
+   **/
+  getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData<true> | undefined>;
+  /**
+   * Reads all credit accounts matching the options, sorted by health factor
+   * ascending.
+   *
+   * @param options - {@link GetCreditAccountsOptions}
+   * @param blockNumber - Block to read at, defaults to the latest block.
+   **/
+  getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<CreditAccountData[]>;
+  /**
+   * Reads all credit accounts of a borrower, sorted by health factor
+   * ascending.
+   *
+   * Covers accounts the borrower owns directly and RWA accounts they own as an
+   * investor, which are owned on-chain by an RWA factory.
+   *
+   * @param borrower - Wallet address.
+   * @param options - {@link GetCreditAccountsOptions}
+   * @param blockNumber - Block to read at, defaults to the latest block.
+   **/
+  getBorrowerCreditAccounts(borrower: Address, options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<CreditAccountData<true>[]>;
+  /**
+   * Describes all credit accounts of a wallet as strategy positions.
+   *
+   * @param props - {@link ListStrategyPositionsProps}
+   **/
+  listPositions(props: ListStrategyPositionsProps): Promise<StrategyPosition[]>;
+}
+//#endregion
+export { CreditAccountCompressor };