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

package/dist/types/sdk/utils/assetsMath.d.ts

@@ -0,0 +1,42 @@
+import type { Address } from "viem";
+import { type Asset } from "../index.js";
+interface TokenDataSlice {
+    symbol: string;
+    decimals: number;
+}
+export interface AssetWithView extends Asset {
+    balanceView: string;
+}
+export interface AssetWithAmountInTarget extends Asset {
+    amountInTarget: bigint;
+}
+interface NextAssetProps<T extends Asset> {
+    allowedTokens: Array<Address>;
+    selectedAssets: Array<T>;
+    balances: Record<Address, bigint>;
+    tokensList: Record<Address, TokenDataSlice>;
+    prices?: Record<Address, bigint>;
+}
+export type WrapResult = [Array<Asset>, bigint, bigint];
+export declare class AssetUtils {
+    static nextAsset<T extends Asset>({ allowedTokens, selectedAssets, balances, tokensList, prices, }: NextAssetProps<T>): Address | undefined;
+    private static getBalances;
+    static constructAssetRecord<A extends Asset>(a: Array<A>): Record<`0x${string}`, A>;
+    static memoWrap: (unwrappedAddress: Address, wrappedAddress: Address, prices: Record<Address, bigint>, tokensList: Record<Address, TokenDataSlice>) => (assets: Array<Asset>) => WrapResult;
+    /**
+     * Sums the the second assets list into the first assets list
+     * Balances cant be negative; creates new assets.
+     */
+    static sumAssets<A extends Asset, B extends Asset>(a: Array<A>, b: Array<B>): Array<A | B>;
+    /**
+     * Sums the the second assets list into the first assets list
+     * Balances cant be negative; doesn't create new assets.
+     */
+    static addBalances<A extends Asset, B extends Asset>(a: Array<A>, b: Array<B>): Array<A | B>;
+    /**
+     * Subtracts the the second assets list from the first assets list
+     * Balances cant be negative; doesn't create new assets.
+     */
+    static subAssets<A extends Asset, B extends Asset>(a: Array<A>, b: Array<B>): Array<A>;
+}
+export {};

package/dist/types/sdk/utils/bigintMath.d.ts

@@ -0,0 +1,6 @@
+export declare class BigIntMath {
+    static abs: (x: bigint) => bigint;
+    static max: (a: bigint, b: bigint) => bigint;
+    static min: (a: bigint, b: bigint) => bigint;
+    static neg: (a: bigint) => bigint;
+}

package/dist/types/sdk/utils/creditAccount.d.ts

@@ -0,0 +1,127 @@
+import type { Address } from "viem";
+import { type Asset } from "../index.js";
+interface TokenDataSlice {
+    symbol: string;
+    decimals: number;
+}
+interface QuotaInfoIsActiveSlice {
+    isActive: boolean;
+}
+interface QuotaInfoTokenSlice extends QuotaInfoIsActiveSlice {
+    token: Address;
+}
+interface QuotaInfoSlice extends QuotaInfoIsActiveSlice {
+    rate: bigint;
+}
+interface AssetWithAmountInTarget extends Asset {
+    amountInTarget: bigint;
+}
+export interface CalcOverallAPYProps {
+    caAssets: Array<Asset>;
+    lpAPY: Record<Address, number> | undefined;
+    quotas: Record<Address, Asset>;
+    quotaRates: Record<Address, QuotaInfoSlice>;
+    feeInterest: number;
+    prices: Record<Address, bigint>;
+    totalValue: bigint | undefined;
+    debt: bigint | undefined;
+    baseRateWithFee: number;
+    underlyingToken: Address;
+    tokensList: Record<Address, TokenDataSlice>;
+}
+export interface CalcMaxLendingDebtProps {
+    assets: Array<Asset>;
+    prices: Record<Address, bigint>;
+    liquidationThresholds: Record<Address, bigint>;
+    underlyingToken: Address;
+    tokensList: Record<Address, TokenDataSlice>;
+    targetHF?: bigint;
+}
+export interface CalcHealthFactorProps {
+    assets: Array<Asset>;
+    quotas: Record<Address, Asset>;
+    quotasInfo: Record<Address, QuotaInfoIsActiveSlice>;
+    prices: Record<Address, bigint>;
+    liquidationThresholds: Record<Address, bigint>;
+    underlyingToken: Address;
+    debt: bigint;
+    tokensList: Record<Address, TokenDataSlice>;
+}
+export interface CalcDefaultQuotaProps {
+    amount: bigint;
+    lt: bigint;
+    quotaReserve: bigint;
+}
+export interface CalcRecommendedQuotaProps {
+    amount: bigint;
+    debt: bigint;
+    lt: bigint;
+    quotaReserve: bigint;
+}
+export interface CalcQuotaUpdateProps {
+    quotas: Record<Address, QuotaInfoTokenSlice>;
+    initialQuotas: Record<Address, {
+        quota: bigint;
+    }>;
+    liquidationThresholds: Record<Address, bigint>;
+    assetsAfterUpdate: Record<Address, AssetWithAmountInTarget>;
+    maxDebt: bigint;
+    calcModification?: {
+        type: "recommendedQuota";
+        debt: bigint;
+    };
+    allowedToSpend: Record<Address, {}>;
+    allowedToObtain: Record<Address, {}>;
+    quotaReserve: bigint;
+}
+interface CalcQuotaUpdateReturnType {
+    desiredQuota: Record<Address, Asset>;
+    quotaIncrease: Array<Asset>;
+    quotaDecrease: Array<Asset>;
+}
+export interface CalcQuotaBorrowRateProps {
+    quotas: Record<Address, Asset>;
+    quotaRates: Record<Address, QuotaInfoSlice>;
+}
+export interface CalcRelativeBaseBorrowRateProps {
+    debt: bigint;
+    baseRateWithFee: number;
+    assetAmountInUnderlying: bigint;
+}
+interface LiquidationPriceProps {
+    liquidationThresholds: Record<Address, bigint>;
+    debt: bigint;
+    underlyingToken: Address;
+    targetToken: Address;
+    assets: Record<Address, Asset>;
+    tokensList: Record<Address, TokenDataSlice>;
+}
+export interface TimeToLiquidationProps {
+    totalBorrowRate_debt: bigint;
+    healthFactor: number;
+}
+export declare class CreditAccountDataUtils {
+    static sortBalances(balances: Record<Address, bigint>, prices: Record<Address, bigint>, tokens: Record<Address, TokenDataSlice>): Array<[Address, bigint]>;
+    static sortAssets<T extends Asset>(balances: Array<T>, prices: Record<Address, bigint>, tokens: Record<Address, TokenDataSlice>): T[];
+    static assetComparator<T extends Asset>(t1: T, t2: T, prices1: Record<Address, bigint> | undefined, prices2: Record<Address, bigint> | undefined, tokens1: Record<Address, TokenDataSlice> | undefined, tokens2: Record<Address, TokenDataSlice> | undefined): 1 | 0 | -1;
+    static tokensAbcComparator(t1?: TokenDataSlice, t2?: TokenDataSlice): 1 | 0 | -1;
+    static amountAbcComparator(t1: bigint, t2: bigint): 1 | -1;
+    static calcMaxDebtIncrease(healthFactor: number, debt: bigint, underlyingLT: number, minHf?: number): bigint;
+    static calcMaxLendingDebt({ assets, liquidationThresholds, underlyingToken, prices, tokensList, targetHF, }: CalcMaxLendingDebtProps): bigint;
+    static calcOverallAPY({ caAssets, lpAPY, prices, quotas, quotaRates, feeInterest, totalValue, debt, baseRateWithFee, underlyingToken, tokensList, }: CalcOverallAPYProps): bigint | undefined;
+    static calcHealthFactor({ assets, quotas, quotasInfo, liquidationThresholds, underlyingToken, debt, prices, tokensList, }: CalcHealthFactorProps): number;
+    static roundUpQuota(quotaChange: bigint): bigint;
+    static calcRecommendedQuota({ amount, debt, lt, quotaReserve, }: CalcRecommendedQuotaProps): bigint;
+    static calcDefaultQuota({ amount, lt, quotaReserve }: CalcDefaultQuotaProps): bigint;
+    static calcQuotaUpdate(props: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
+    private static getSingleQuotaChange;
+    static calcQuotaBorrowRate({ quotas, quotaRates }: CalcQuotaBorrowRateProps): bigint;
+    static calcRelativeBaseBorrowRate({ debt, baseRateWithFee, assetAmountInUnderlying, }: CalcRelativeBaseBorrowRateProps): bigint;
+    static liquidationPrice({ liquidationThresholds, debt, underlyingToken, targetToken, assets, tokensList, }: LiquidationPriceProps): bigint;
+    /**
+     * Calculates the time remaining until liquidation for a credit account.
+     * @returns The time remaining until liquidation in milliseconds.
+     */
+    static getTimeToLiquidation({ healthFactor, totalBorrowRate_debt, }: TimeToLiquidationProps): bigint | null;
+}
+export {};

package/dist/types/sdk/utils/formatter.d.ts

@@ -10,3 +10,12 @@ export declare function numberWithCommas(x: number | bigint): string;
 export declare function formatDuration(seconds: number, raw?: boolean): string;
 export declare function formatNumberToString_(value: bigint | number): string;
 export declare function formatTimestamp(timestamp: number, raw?: boolean): string;
+type BigNumberish = bigint | number | string;
+export declare function rayToNumber(num: BigNumberish): number;
+export declare function toSignificant(num: bigint, decimals: number, precision?: number): string;
+export declare function toBN(num: string, decimals: number): bigint;
+export declare function shortAddress(address?: string): string;
+export declare function shortHash(address?: string): string;
+export declare function formatPercentage(healthFactor: number, decimals?: number): string;
+export declare function formatLeverage(leverage: number, decimals?: number): string;
+export {};

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

@@ -1,9 +1,12 @@
 export * from "./AddressMap.js";
 export * from "./AddressSet.js";
 export * from "./abi-decode.js";
+export * from "./assetsMath.js";
+export * from "./bigintMath.js";
 export * from "./bytes32ToString.js";
 export * from "./childLogger.js";
 export * from "./createRawTx.js";
+export * from "./creditAccount.js";
 export * from "./etherscan.js";
 export * from "./filterDust.js";
 export * from "./formatter.js";
@@ -11,6 +14,7 @@ export * from "./hex.js";
 export * from "./isDust.js";
 export * from "./json.js";
 export * from "./mappers.js";
+export * from "./priceMath.js";
 export * from "./retry.js";
 export * from "./toAddress.js";
 export * from "./type-utils.js";

package/dist/types/sdk/utils/priceMath.d.ts

@@ -0,0 +1,9 @@
+interface Target {
+    price: bigint;
+    decimals: number | undefined;
+}
+export declare class PriceUtils {
+    static calcTotalPrice: (price: bigint, amount: bigint, decimals?: number | undefined) => bigint;
+    static convertByPrice(totalMoney: bigint, { price: targetPrice, decimals: targetDecimals }: Target): bigint;
+}
+export {};

package/package.json

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