@gearbox-protocol/sdk 8.6.3 → 8.6.5

package/dist/cjs/sdk/accounts/AbstractCreditAccountsService.js

@@ -94,9 +94,6 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
    * Methods to get all credit accounts with some optional filtering
    * Performs all necessary price feed updates under the hood
    *
-   * TODO: do we want to expose pagination?
-   * TODO: do we want to expose "reverting"?
-   * TODO: do we want to expose MarketFilter in any way? If so, we need to check that the MarketFilter is compatibled with attached markets?
    * @param options
    * @param blockNumber
    * @returns returned credit accounts are sorted by health factor in ascending order

package/dist/cjs/sdk/accounts/createCreditAccountService.js

@@ -24,12 +24,12 @@ module.exports = __toCommonJS(createCreditAccountService_exports);
 var import_constants = require("../constants/index.js");
 var import_CreditAccountsServiceV300 = require("./CreditAccountsServiceV300.js");
 var import_CreditAccountsServiceV310 = require("./CreditAccountsServiceV310.js");
-function createCreditAccountService(sdk, version) {
+function createCreditAccountService(sdk, version, options) {
   if ((0, import_constants.isV300)(version)) {
-    return new import_CreditAccountsServiceV300.CreditAccountServiceV300(sdk);
+    return new import_CreditAccountsServiceV300.CreditAccountServiceV300(sdk, options);
   }
   if ((0, import_constants.isV310)(version)) {
-    return new import_CreditAccountsServiceV310.CreditAccountServiceV310(sdk);
+    return new import_CreditAccountsServiceV310.CreditAccountServiceV310(sdk, options);
   }
   throw new Error(`Unsupported Credit Account Service version ${version}`);
 }

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

@@ -85,9 +85,6 @@ class AbstractCreditAccountService extends SDKConstruct {
    * Methods to get all credit accounts with some optional filtering
    * Performs all necessary price feed updates under the hood
    *
-   * TODO: do we want to expose pagination?
-   * TODO: do we want to expose "reverting"?
-   * TODO: do we want to expose MarketFilter in any way? If so, we need to check that the MarketFilter is compatibled with attached markets?
    * @param options
    * @param blockNumber
    * @returns returned credit accounts are sorted by health factor in ascending order

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

@@ -1,12 +1,12 @@
 import { isV300, isV310 } from "../constants/index.js";
 import { CreditAccountServiceV300 } from "./CreditAccountsServiceV300.js";
 import { CreditAccountServiceV310 } from "./CreditAccountsServiceV310.js";
-function createCreditAccountService(sdk, version) {
+function createCreditAccountService(sdk, version, options) {
   if (isV300(version)) {
-    return new CreditAccountServiceV300(sdk);
+    return new CreditAccountServiceV300(sdk, options);
   }
   if (isV310(version)) {
-    return new CreditAccountServiceV310(sdk);
+    return new CreditAccountServiceV310(sdk, options);
   }
   throw new Error(`Unsupported Credit Account Service version ${version}`);
 }

package/dist/types/dev/AccountOpener.d.ts

@@ -1,6 +1,6 @@
 import type { Address, Hash, PrivateKeyAccount } from "viem";
 import { BaseError } from "viem";
-import type { CreditAccountData, CreditAccountsServiceInstance, RawTx } from "../sdk/index.js";
+import type { CreditAccountData, ICreditAccountsService, RawTx } from "../sdk/index.js";
 import { SDKConstruct } from "../sdk/index.js";
 export declare class OpenTxRevertedError extends BaseError {
     readonly txHash: Hash;
@@ -37,7 +37,7 @@ export interface OpenAccountResult {
 }
 export declare class AccountOpener extends SDKConstruct {
     #private;
-    constructor(service: CreditAccountsServiceInstance, options?: AccountOpenerOptions);
+    constructor(service: ICreditAccountsService, options?: AccountOpenerOptions);
     get borrower(): Address;
     /**
      * Tries to open account with underlying only in each CM

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

@@ -5,6 +5,7 @@ import type { GearboxSDK } from "../GearboxSDK.js";
 import type { OnDemandPriceUpdate, UpdatePriceFeedsResult } from "../market/index.js";
 import { type Asset, type RouterCASlice } from "../router/index.js";
 import type { MultiCall } from "../types/index.js";
+import type { GetConnectedBotsResult } from "./types";
 import type { AddCollateralProps, ChangeDeptProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, EnableTokensProps, ExecuteSwapProps, GetCreditAccountsOptions, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, Rewards, UpdateQuotasProps } from "./types.js";
 export interface CreditAccountServiceOptions {
     batchSize?: number;
@@ -24,9 +25,6 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * Methods to get all credit accounts with some optional filtering
      * Performs all necessary price feed updates under the hood
      *
-     * TODO: do we want to expose pagination?
-     * TODO: do we want to expose "reverting"?
-     * TODO: do we want to expose MarketFilter in any way? If so, we need to check that the MarketFilter is compatibled with attached markets?
      * @param options
      * @param blockNumber
      * @returns returned credit accounts are sorted by health factor in ascending order
@@ -48,26 +46,7 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
     getConnectedBots(accountsToCheck: Array<{
         creditAccount: Address;
         creditManager: Address;
-    }>): Promise<({
-        error: Error;
-        result?: undefined;
-        status: "failure";
-    } | {
-        error?: undefined;
-        result: readonly {
-            baseParams: {
-                addr: `0x${string}`;
-                version: bigint;
-                contractType: `0x${string}`;
-                serializedParams: `0x${string}`;
-            };
-            requiredPermissions: bigint;
-            creditAccount: `0x${string}`;
-            permissions: bigint;
-            forbidden: boolean;
-        }[];
-        status: "success";
-    })[]>;
+    }>): Promise<GetConnectedBotsResult>;
     /**
      * Generates transaction to liquidate credit account
      * @param account
@@ -188,7 +167,7 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * @returns
      */
     getUpdateForAccounts(accounts: Array<RouterCASlice>): Promise<UpdatePriceFeedsResult>;
-    getUpdateForAccount(creditManager: Address, creditAccount: RouterCASlice | undefined, desiredQuotas: Array<Asset> | undefined): Promise<UpdatePriceFeedsResult>;
+    protected getUpdateForAccount(creditManager: Address, creditAccount: RouterCASlice | undefined, desiredQuotas: Array<Asset> | undefined): Promise<UpdatePriceFeedsResult>;
     /**
      * Returns account price updates in a non-encoded format
      * @param acc
@@ -203,7 +182,7 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * @param acc
      * @returns
      */
-    getPriceUpdatesForFacade(creditManager: Address, creditAccount: RouterCASlice | undefined, desiredQuotas: Array<Asset> | undefined): Promise<Array<MultiCall>>;
+    protected getPriceUpdatesForFacade(creditManager: Address, creditAccount: RouterCASlice | undefined, desiredQuotas: Array<Asset> | undefined): Promise<Array<MultiCall>>;
     protected prepareDisableQuotas(ca: RouterCASlice): Array<MultiCall>;
     protected prepareUpdateQuotas(creditFacade: Address, { averageQuota, minQuota }: PrepareUpdateQuotasProps): Array<MultiCall>;
     protected prepareDecreaseDebt(ca: RouterCASlice): Array<MultiCall>;

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

@@ -1,8 +1,9 @@
 import type { GearboxSDK } from "../GearboxSDK.js";
-import type { CreditAccountsServiceInstance } from "./types.js";
+import type { CreditAccountServiceOptions } from "./AbstractCreditAccountsService.js";
+import type { ICreditAccountsService } from "./types.js";
 /**
  * @sdk
  * @version version of desired credit facade; if no credit facade is considered (you only want to get ca list), either v300 or v310 is fine, because ca compressor has nothing to do with credit facade version
  * @returns
  */
-export declare function createCreditAccountService(sdk: GearboxSDK, version: number): CreditAccountsServiceInstance;
+export declare function createCreditAccountService(sdk: GearboxSDK, version: number, options?: CreditAccountServiceOptions): ICreditAccountsService;

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

@@ -1,11 +1,11 @@
 import type { Address, ContractFunctionArgs } from "viem";
 import type { iCreditAccountCompressorAbi } from "../../abi/compressors.js";
 import type { BotType } from "../../plugins/bots/types.js";
+import type { ConnectedBotData, CreditAccountData } from "../base/index.js";
 import type { SDKConstruct } from "../base/SDKConstruct.js";
-import type { CreditSuite } from "../market/index.js";
+import type { CreditSuite, OnDemandPriceUpdate, UpdatePriceFeedsResult } from "../market/index.js";
 import type { Asset, RouterCASlice, RouterCloseResult } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
-import type { AbstractCreditAccountService } from "./AbstractCreditAccountsService.js";
 export type GetCreditAccountsArgs = ContractFunctionArgs<typeof iCreditAccountCompressorAbi, "pure" | "view", "getCreditAccounts">;
 export interface CreditAccountFilter {
     owner: Address;
@@ -37,11 +37,32 @@ export interface CreditAccountOperationResult {
 }
 export type CloseOptions = "close" | "zeroDebt";
 export interface CloseCreditAccountProps {
+    /**
+     * Close or zeroDebt
+     */
     operation: CloseOptions;
+    /**
+     * Minimal credit account data on which operation is performed
+     */
     creditAccount: RouterCASlice;
+    /**
+     * 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
+     */
     assetsToWithdraw: Array<Address>;
+    /**
+     * Wallet address to withdraw underlying to
+     */
     to: Address;
+    /**
+     * Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     */
     slippage?: bigint;
+    /**
+     * Result of findBestClosePath method from router; if omited, calls marketRegister.findCreditManager {@link RouterCloseResult}
+     */
     closePath?: RouterCloseResult;
 }
 export interface RepayCreditAccountProps extends RepayAndLiquidateCreditAccountProps {
@@ -88,12 +109,27 @@ export interface PrepareUpdateQuotasProps {
     minQuota: Array<Asset>;
 }
 export interface UpdateQuotasProps extends PrepareUpdateQuotasProps {
+    /**
+     * Minimal credit account data on which operation is performed
+     */
     creditAccount: RouterCASlice;
 }
 export interface AddCollateralProps extends PrepareUpdateQuotasProps {
+    /**
+     * Asset to add as collateral
+     */
     asset: Asset;
+    /**
+     * Native token amount to attach to tx
+     */
     ethAmount: bigint;
+    /**
+     * Permit of collateral asset if it is permittable
+     */
     permit: PermitResult | undefined;
+    /**
+     * Minimal credit account data on which operation is performed
+     */
     creditAccount: RouterCASlice;
 }
 export interface WithdrawCollateralProps extends PrepareUpdateQuotasProps {
@@ -111,7 +147,13 @@ export interface WithdrawCollateralProps extends PrepareUpdateQuotasProps {
     creditAccount: RouterCASlice;
 }
 export interface ExecuteSwapProps extends PrepareUpdateQuotasProps {
+    /**
+     * Array of MultiCall from router methods getSingleSwap or getAllSwaps
+     */
     calls: Array<MultiCall>;
+    /**
+     * Minimal credit account data on which operation is performed
+     */
     creditAccount: RouterCASlice;
 }
 export interface ClaimFarmRewardsProps extends PrepareUpdateQuotasProps {
@@ -131,23 +173,70 @@ export interface ClaimFarmRewardsProps extends PrepareUpdateQuotasProps {
     creditAccount: RouterCASlice;
 }
 export interface EnableTokensProps {
+    /**
+     * List of tokens to disable
+     */
     disabledTokens: Array<Address>;
+    /**
+     * List of tokens to enable
+     */
     enabledTokens: Array<Address>;
+    /**
+     * Minimal credit account data on which operation is performed
+     */
     creditAccount: RouterCASlice;
 }
 export interface OpenCAProps extends PrepareUpdateQuotasProps {
+    /**
+     * Native token amount to attach to tx
+     */
     ethAmount: bigint;
+    /**
+     * Array of collateral which can be just directly added or swapped using the path {@link Asset}
+     */
     collateral: Array<Asset>;
+    /**
+     * Debt to open credit account with
+     */
     debt: bigint;
+    /**
+     * Flag to withdraw debt to wallet after opening credit account;
+     * used for borrowing functionality
+     */
     withdrawDebt?: boolean;
+    /**
+     * Permits of collateral tokens (in any permittable token is present) {@link PermitResult}
+     */
     permits: Record<string, PermitResult>;
+    /**
+     * Array of MultiCall from router methods findOpenStrategyPath {@link MultiCall}.
+     * Used for trading and strategy functionality
+     */
     calls: Array<MultiCall>;
+    /**
+     * Address of credit manager to open credit account on
+     */
     creditManager: Address;
+    /**
+     * Wallet address to transfer credit account to
+     */
     to: Address;
+    /**
+     * Referral code to open credit account with
+     */
     referralCode: bigint;
 }
 export interface ChangeDeptProps {
+    /**
+     * Minimal credit account data on which operation is performed
+     */
     creditAccount: RouterCASlice;
+    /**
+     * Amount to change debt by
+     * 0 - prohibited value;
+     * negative value for debt decrease;
+     * positive value for debt increase.
+     */
     amount: bigint;
 }
 export interface PermitResult {
@@ -197,48 +286,179 @@ export interface SetBotProps {
      */
     creditAccount: RouterCASlice;
 }
-export type CreditAccountsServiceInstance = ICreditAccountsService & AbstractCreditAccountService;
+export type GetConnectedBotsResult = Array<{
+    error?: undefined;
+    result: readonly ConnectedBotData[];
+    status: "success";
+} | {
+    error: Error;
+    result?: undefined;
+    status: "failure";
+}>;
 export interface ICreditAccountsService extends SDKConstruct {
+    /**
+     * 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
+     */
+    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
+     */
+    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
+     */
+    getRewards(creditAccount: Address): Promise<Array<Rewards>>;
+    /**
+     * Method to get all connected bots for credit account
+     * @param {Array<{ creditAccount: Address; creditManager: Address }>} accountsToCheck - list of credit accounts
+     * and their credit managers to check connected bots on
+     * @returns call result of getConnectedBots for each credit account
+     */
+    getConnectedBots(accountsToCheck: Array<{
+        creditAccount: Address;
+        creditManager: Address;
+    }>): Promise<GetConnectedBotsResult>;
     /**
      * V3.1 method, throws in V3. Connects/disables a bot and updates prices
      * @param props - {@link SetBotProps}
      * @return All necessary data to execute the transaction (call, credit facade)
      */
     setBot: (props: SetBotProps) => Promise<CreditAccountOperationResult>;
+    /**
+     * Generates transaction to liquidate credit account
+     * @param account
+     * @param to Address to transfer underlying left after liquidation
+     * @param slippage
+     * @param force TODO: legacy v3 option to remove
+     * @returns
+     */
+    fullyLiquidate(account: RouterCASlice, to: Address, slippage?: bigint, force?: boolean): Promise<CloseCreditAccountResult>;
+    /**
+     * 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 props - {@link CloseCreditAccountProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    closeCreditAccount(props: CloseCreditAccountProps): Promise<CloseCreditAccountResult>;
+    /**
+     * Updates quota of credit account.
+     * CA quota updated in the following order: price update -> update quotas
+     * @param props - {@link UpdateQuotasProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    updateQuotas(props: 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 props - {@link AddCollateralProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    addCollateral(props: 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 props - {@link ChangeDeptProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    changeDebt(props: 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 props - {@link ExecuteSwapProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    executeSwap(props: ExecuteSwapProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Executes enable/disable tokens specified by given tokens lists and token prices
+     * @param props - {@link EnableTokensProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    enableTokens(props: EnableTokensProps): 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 props - {@link OpenCAProps}
+     * @returns All necessary data to execute the transaction (call, credit facade)
+     */
+    openCA(props: OpenCAProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Returns borrow rate with 4 digits precision (10000 = 100%)
+     * @param ca
+     * @returns
+     */
+    getBorrowRate(ca: CreditAccountData): bigint;
+    /**
+     * Returns optimal HF for partial liquidation with 4 digits precision (10000 = 100%)
+     * @param ca
+     */
+    getOptimalHFForPartialLiquidation(ca: CreditAccountData): bigint;
+    /**
+     * Returns raw txs that are needed to update all price feeds so that all credit accounts (possibly from different markets) compute
+     *
+     * This can be used by batch liquidator
+     * @param accounts
+     * @returns
+     */
+    getUpdateForAccounts(accounts: Array<RouterCASlice>): Promise<UpdatePriceFeedsResult>;
+    /**
+     * Returns account price updates in a non-encoded format
+     * @param acc
+     * @returns
+     */
+    getOnDemandPriceUpdates(creditManager: Address, creditAccount: RouterCASlice | undefined, desiredQuotas: Array<Asset> | undefined): Promise<Array<OnDemandPriceUpdate>>;
     /**
      * Withdraws a single collateral from credit account to wallet to and updates quotas;
-        technically can withdraw several tokens at once
-        - Collateral is withdrawn in the following order: price update -> withdraw token -> update quotas for affected tokens
+     * technically can withdraw several tokens at once
+     *   - Collateral is withdrawn in the following order: price update -> withdraw token -> update quotas for affected tokens
      * @param props - {@link WithdrawCollateralProps}
      * @return All necessary data to execute the transaction (call, credit facade)
      */
     withdrawCollateral(props: WithdrawCollateralProps): Promise<CreditAccountOperationResult>;
     /**
      * Fully repays credit account or repays credit account and keeps it open with zero debt
-       - Repays in the following order: price update -> add collateral to cover the debt ->
-        -> disable quotas for all tokens -> decrease debt -> disable tokens all tokens -> withdraw all tokens
-      - V3.0 claims rewards for tokens which are specified in legacy SDK
-      - V3.1 claims rewards for all tokens IF router is also V3.1
+     * - Repays in the following order: price update -> add collateral to cover the debt ->
+     *   -> disable quotas for all tokens -> decrease debt -> disable tokens all tokens -> withdraw all tokens
+     * - V3.0 claims rewards for tokens which are specified in legacy SDK
+     * - V3.1 claims rewards for all tokens IF router is also V3.1
      * @param props - {@link RepayCreditAccountProps}
      * @return All necessary data to execute the transaction (call, credit facade)
      */
     repayCreditAccount(props: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
     /**
      * Fully repays liquidatable account
-      - Repay and liquidate is executed in the following order: price update -> add collateral to cover the debt ->
-        withdraw all tokens from credit account
-      - V3.0 claims rewards for tokens which are specified in legacy SDK
-      - V3.1 claims rewards for all tokens IF router is also V3.1
+     * - Repay and liquidate is executed in the following order: price update -> add collateral to cover the debt ->
+     *   withdraw all tokens from credit account
+     * - V3.0 claims rewards for tokens which are specified in legacy SDK
+     * - V3.1 claims rewards for all tokens IF router is also V3.1
      * @param props - {@link RepayAndLiquidateCreditAccountProps}
      * @return All necessary data to execute the transaction (call, credit facade)
      */
     repayAndLiquidateCreditAccount(props: RepayAndLiquidateCreditAccountProps): Promise<CreditAccountOperationResult>;
     /**
      * Executes swap specified by given calls, update quotas of affected tokens
-       - Claim rewards is executed in the following order: price update -> execute claim calls ->
-        -> (optionally: disable reward tokens) -> (optionally: update quotas)
-      - V3.0 claims rewards for tokens which are specified in legacy SDK
-      - V3.1 claims rewards for all tokens IF router is also V3.1 and falls back to legacy calls if router is not v3.0
+     *  - Claim rewards is executed in the following order: price update -> execute claim calls ->
+     *   -> (optionally: disable reward tokens) -> (optionally: update quotas)
+     * - V3.0 claims rewards for tokens which are specified in legacy SDK
+     * - V3.1 claims rewards for all tokens IF router is also V3.1 and falls back to legacy calls if router is not v3.0
      * @param props - {@link ClaimFarmRewardsProps}
      * @return All necessary data to execute the transaction (call, credit facade)
      */

package/package.json

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