@gearbox-protocol/sdk 14.10.1 → 14.10.2-next.1

package/dist/esm/common-utils/utils/strategies/strategy-info/get-strategy-you-can-earn.js

@@ -0,0 +1,84 @@
+import { isStrategyCMDisabled } from "../../strategies/strategy-info/is-strategy-cm-disabled.js";
+import { getChainPhantomTokens } from "../tokens/get-chain-phantom-tokens.js";
+import { getNativeTokenAddress } from "../tokens/get-native-token-address.js";
+import { getCMYouCanEarn } from "./get-cm-you-can-earn.js";
+function getStrategyYouCanEarn({
+  strategy,
+  creditManagers,
+  sdkState,
+  apyList,
+  quotaReserve,
+  slippage,
+  allPrices,
+  walletBalances
+}) {
+  const strategyCMs = creditManagers;
+  const baseInfo = {
+    strategy: strategy.name,
+    strategyChainId: strategy.chainId,
+    strategyNetwork: strategy.network,
+    strategyType: strategy.strategyType,
+    strategyTokenOutAddress: strategy.tokenOutAddress
+  };
+  if (!strategyCMs || !walletBalances || !allPrices || !apyList || !sdkState) {
+    return [
+      {
+        status: "error",
+        description: "No strategy cms or wallet balances or all prices or apy list or sdk state",
+        otherInfo: baseInfo,
+        data: void 0
+      }
+    ];
+  }
+  const openableCMsList = Object.values(strategyCMs).filter(
+    (cm) => !isStrategyCMDisabled(cm, cm.quotas[strategy.tokenOutAddress])
+  );
+  if (openableCMsList.length === 0) {
+    return [
+      {
+        status: "error",
+        description: "No openable cms list",
+        otherInfo: baseInfo,
+        data: void 0
+      }
+    ];
+  }
+  const pools = sdkState.pools;
+  const tokensList = sdkState.tokens?.tokenDataList;
+  if (!tokensList || !pools || Object.keys(pools).length === 0) {
+    return [
+      {
+        status: "error",
+        description: "No pools or tokens list",
+        otherInfo: baseInfo,
+        data: void 0
+      }
+    ];
+  }
+  const ap = sdkState.addressProvider;
+  const nativeTokenAddress = getNativeTokenAddress();
+  const delayedPhantoms = getChainPhantomTokens(sdkState.withdrawableAssets);
+  const results = openableCMsList.map(
+    (creditManager) => {
+      const info = getCMYouCanEarn({
+        allPrices,
+        creditManager,
+        tokensList,
+        delayedPhantoms,
+        nativeTokenAddress,
+        wrappedNativeTokenAddress: ap.wrappedNativeToken,
+        walletBalances,
+        strategy,
+        slippage,
+        quotaReserve,
+        apyList,
+        pools
+      });
+      return info;
+    }
+  );
+  return results;
+}
+export {
+  getStrategyYouCanEarn
+};

package/dist/esm/common-utils/utils/strategies/tokens/add-amount-in-target.js

@@ -0,0 +1,17 @@
+import { PriceUtils } from "../../price-math.js";
+function addAmountInTarget(asset, tokensList, prices, toPrice, toDecimals) {
+  const { balance: fromAmount, token: fromToken } = asset;
+  const { decimals: fromDecimals = 18, address: fromAddress } = tokensList[fromToken] || {};
+  const fromPrice = prices[fromAddress] || 0n;
+  const inTarget = PriceUtils.convertByPrice(
+    PriceUtils.calcTotalPrice(fromPrice, fromAmount, fromDecimals),
+    {
+      price: toPrice,
+      decimals: toDecimals
+    }
+  );
+  return { ...asset, amountInTarget: inTarget };
+}
+export {
+  addAmountInTarget
+};

package/dist/esm/common-utils/utils/strategies/tokens/add-amount-in-target.spec.js

@@ -0,0 +1,41 @@
+import { describe, expect, it } from "vitest";
+import {
+  mockPrices,
+  mockToken1,
+  mockTokenData
+} from "../../../test-utils/index.js";
+import { getDefaultAsset } from "../assets/assets.js";
+import { addAmountInTarget } from "./add-amount-in-target.js";
+describe("addAmountInTarget", () => {
+  const fromToken = mockToken1;
+  const toPrice = 4n;
+  const toDecimals = 18;
+  it("converts amount to target token using prices", () => {
+    const asset = {
+      ...getDefaultAsset(fromToken),
+      balance: 10n ** 18n
+    };
+    const result = addAmountInTarget(
+      asset,
+      mockTokenData,
+      mockPrices,
+      toPrice,
+      toDecimals
+    );
+    expect(result.amountInTarget).toBe(75000000000000000000000000n);
+  });
+  it("handles missing price data gracefully", () => {
+    const asset = { ...getDefaultAsset(fromToken), balance: 10n ** 18n };
+    const tokensList = {
+      [fromToken]: mockTokenData[fromToken]
+    };
+    const result = addAmountInTarget(
+      asset,
+      tokensList,
+      {},
+      toPrice,
+      toDecimals
+    );
+    expect(result.amountInTarget).toBe(0n);
+  });
+});

package/dist/esm/common-utils/utils/strategies/tokens/get-chain-phantom-tokens.js

@@ -0,0 +1,11 @@
+function getChainPhantomTokens(config) {
+  const allConfigs = Object.values(config || {}).flat(1);
+  const r = allConfigs.reduce((acc, cfg) => {
+    acc[cfg.withdrawalPhantomToken] = true;
+    return acc;
+  }, {});
+  return r;
+}
+export {
+  getChainPhantomTokens
+};

package/dist/esm/common-utils/utils/strategies/tokens/get-list-with-amount-in-target.js

@@ -0,0 +1,18 @@
+import { addAmountInTarget } from "./add-amount-in-target.js";
+function getListWithAmountInTarget({
+  assets,
+  targetToken,
+  prices,
+  tokensList
+}) {
+  const { decimals: toDecimals = 18 } = tokensList[targetToken] || {};
+  const toPrice = prices[targetToken] || 0n;
+  const withAmount = assets.map((asset) => {
+    const a = addAmountInTarget(asset, tokensList, prices, toPrice, toDecimals);
+    return a;
+  });
+  return withAmount;
+}
+export {
+  getListWithAmountInTarget
+};

package/dist/esm/common-utils/utils/strategies/tokens/get-list-with-amount-in-target.spec.js

@@ -0,0 +1,36 @@
+import { describe, expect, it } from "vitest";
+import {
+  mockPrices,
+  mockToken1,
+  mockToken2,
+  mockTokenData
+} from "../../../test-utils/index.js";
+import { getDefaultAsset } from "../assets/assets.js";
+import { getListWithAmountInTarget } from "./get-list-with-amount-in-target.js";
+describe("getListWithAmountInTarget", () => {
+  const targetToken = mockToken2;
+  it("converts multiple assets to target token using prices", () => {
+    const assets = [
+      { ...getDefaultAsset(mockToken1), balance: 10n ** 18n },
+      { ...getDefaultAsset(mockToken2), balance: 10n ** 18n }
+    ];
+    const result = getListWithAmountInTarget({
+      assets,
+      targetToken,
+      prices: mockPrices,
+      tokensList: mockTokenData
+    });
+    expect(result).toHaveLength(2);
+    expect(result[0].amountInTarget).toBe(1500000000000000000n);
+    expect(result[1].amountInTarget).toBe(1000000000000000000n);
+  });
+  it("returns empty array for empty assets", () => {
+    const result = getListWithAmountInTarget({
+      assets: [],
+      targetToken,
+      prices: mockPrices,
+      tokensList: mockTokenData
+    });
+    expect(result).toEqual([]);
+  });
+});

package/dist/esm/common-utils/utils/strategies/tokens/get-native-token-address.js

@@ -0,0 +1,7 @@
+const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE".toLowerCase();
+function getNativeTokenAddress() {
+  return NATIVE_ADDRESS;
+}
+export {
+  getNativeTokenAddress
+};

package/dist/esm/common-utils/utils/strategies/tokens/is-apy-with-points-exception.js

@@ -0,0 +1,11 @@
+const RST_ETH_ADDRESS = "0x7a4EffD87C2f3C55CA251080b1343b605f327E3a".toLowerCase();
+const SHOW_APY_FOR_TOKENS_WITH_POINTS = {
+  [RST_ETH_ADDRESS]: RST_ETH_ADDRESS
+};
+function isApyWithPointsException(token) {
+  return !!SHOW_APY_FOR_TOKENS_WITH_POINTS[(token || "").toLowerCase()];
+}
+export {
+  RST_ETH_ADDRESS,
+  isApyWithPointsException
+};

package/dist/esm/common-utils/utils/strategies/tokens/is-collateral-token.js

@@ -0,0 +1,35 @@
+import { isObtainableToken } from "./is-obtainable-token.js";
+import { isValidExtraCollateralToken } from "./is-valid-extra-collateral-token.js";
+function isCollateralToken({
+  address,
+  tokensList,
+  creditManager,
+  zeroDebt = false,
+  delayedPhantoms,
+  extraCollateralConfigs,
+  prices
+}) {
+  if (creditManager && address === creditManager.underlyingToken) return true;
+  if (zeroDebt && creditManager) return false;
+  const token = tokensList[address];
+  const cmCheckPassed = isObtainableToken({
+    address,
+    creditManager,
+    delayedPhantoms
+  });
+  const { isPhantom = false } = token || {};
+  const allowedAsMain = !isPhantom && cmCheckPassed;
+  const allowedAsExtra = isValidExtraCollateralToken({
+    address,
+    extraCollateralConfigs,
+    creditManager,
+    delayedPhantoms,
+    tokensList,
+    zeroDebt,
+    prices
+  });
+  return allowedAsMain || allowedAsExtra;
+}
+export {
+  isCollateralToken
+};

package/dist/esm/common-utils/utils/strategies/tokens/is-collateral-token.spec.js

@@ -0,0 +1,137 @@
+import { describe, expect, it } from "vitest";
+import {
+  buildCreditManager,
+  buildTokenData
+} from "../../../test-utils/index.js";
+import { isCollateralToken } from "./is-collateral-token.js";
+const buildAllPrices = (_, token, value = 100n) => {
+  return {
+    [token]: value
+  };
+};
+describe("isCollateralToken", () => {
+  const underlying = "0xunderlying";
+  const token = "0xtoken";
+  const tokensList = {
+    [token]: buildTokenData(token, "TOKEN")
+  };
+  const baseCM = buildCreditManager({
+    underlyingToken: underlying,
+    quotas: {}
+  });
+  it("returns true for underlying token", () => {
+    const result = isCollateralToken({
+      address: underlying,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: void 0,
+      prices: void 0
+    });
+    expect(result).toBe(true);
+  });
+  it("returns false when zeroDebt is true", () => {
+    const result = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: true,
+      delayedPhantoms: {},
+      extraCollateralConfigs: void 0,
+      prices: void 0
+    });
+    expect(result).toBe(false);
+  });
+  it("returns false when cm check fails", () => {
+    const result = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: void 0,
+      prices: void 0
+    });
+    expect(result).toBe(false);
+  });
+  it("returns true when not obtainable but listed as extra collateral for cm and has price", () => {
+    const result = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: [{ token, cm: baseCM.address }],
+      prices: buildAllPrices(baseCM, token)
+    });
+    expect(result).toBe(true);
+  });
+  it("returns false when not obtainable but listed as extra collateral for cm and has no price", () => {
+    const zeroPriceResult = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: [{ token, cm: baseCM.address }],
+      prices: buildAllPrices(baseCM, token, 0n)
+    });
+    expect(zeroPriceResult).toBe(false);
+    const undefinedPriceResult = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: [{ token, cm: baseCM.address }],
+      prices: void 0
+    });
+    expect(undefinedPriceResult).toBe(false);
+  });
+  it("returns false when extra collateral config targets different credit manager", () => {
+    const result = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: [{ token, cm: "0xother" }],
+      prices: buildAllPrices(baseCM, token)
+    });
+    expect(result).toBe(false);
+  });
+  it("returns false when token is phantom", () => {
+    const phantomTokenList = {
+      [token]: buildTokenData(token, "TOKEN", 18, true)
+    };
+    const result = isCollateralToken({
+      address: token,
+      tokensList: phantomTokenList,
+      creditManager: baseCM,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: void 0,
+      prices: void 0
+    });
+    expect(result).toBe(false);
+  });
+  it("returns true when obtainable, non-phantom, not underlying", () => {
+    const cmWithSupportedToken = buildCreditManager({
+      underlyingToken: underlying,
+      supportedTokens: { [token]: true },
+      liquidationThresholds: { [token]: 8000n },
+      quotas: {}
+    });
+    const result = isCollateralToken({
+      address: token,
+      tokensList,
+      creditManager: cmWithSupportedToken,
+      zeroDebt: false,
+      delayedPhantoms: {},
+      extraCollateralConfigs: void 0,
+      prices: void 0
+    });
+    expect(result).toBe(true);
+  });
+});

package/dist/esm/common-utils/utils/strategies/tokens/is-obtainable-token.js

@@ -0,0 +1,18 @@
+import { isUsableToken } from "../../strategies/tokens/is-usable-token.js";
+function isObtainableToken({
+  address,
+  creditManager,
+  delayedPhantoms
+}) {
+  const {
+    isActive,
+    limit = 0n,
+    totalQuoted = 0n
+  } = creditManager.quotas[address] || {};
+  const realLimit = isActive ? limit || 0n : 0n;
+  const quotaLeft = realLimit - totalQuoted;
+  return (creditManager.isQuoted(address) ? quotaLeft > 0 : true) && isUsableToken({ address, creditManager }) && !delayedPhantoms[address];
+}
+export {
+  isObtainableToken
+};

package/dist/esm/common-utils/utils/strategies/tokens/is-obtainable-token.spec.js

@@ -0,0 +1,161 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { buildCreditManager } from "../../../test-utils/index.js";
+import { isUsableToken } from "../../strategies/tokens/is-usable-token.js";
+import { isObtainableToken } from "./is-obtainable-token.js";
+vi.mock("../../utils/strategies/tokens/is-usable-token.js", async () => {
+  const actual = await vi.importActual(
+    "../../utils/strategies/tokens/is-usable-token.js"
+  );
+  return {
+    ...actual,
+    isUsableToken: vi.fn(
+      actual.isUsableToken
+    )
+  };
+});
+const mockIsUsableToken = vi.mocked(isUsableToken);
+describe("isObtainableToken", () => {
+  const tokenAddr = "0xtoken";
+  beforeEach(async () => {
+    mockIsUsableToken.mockReset();
+    const actual = await vi.importActual(
+      "../../utils/strategies/tokens/is-usable-token.js"
+    );
+    mockIsUsableToken.mockImplementation(
+      actual.isUsableToken
+    );
+  });
+  it("returns true when usable, not delayed phantom, and quota has room", () => {
+    const cm = buildCreditManager({
+      quotas: {
+        [tokenAddr]: {
+          token: tokenAddr,
+          rate: 0n,
+          limit: 100n,
+          totalQuoted: 0n,
+          isActive: true,
+          quotaIncreaseFee: 0n
+        }
+      },
+      isQuoted: vi.fn().mockReturnValue(true)
+    });
+    mockIsUsableToken.mockReturnValue(true);
+    const result = isObtainableToken({
+      address: tokenAddr,
+      creditManager: {
+        quotas: cm.quotas,
+        isQuoted: cm.isQuoted.bind(cm),
+        forbiddenTokens: cm.forbiddenTokens,
+        liquidationThresholds: cm.liquidationThresholds,
+        supportedTokens: cm.supportedTokens
+      },
+      delayedPhantoms: {}
+    });
+    expect(cm.isQuoted).toHaveBeenCalledWith(tokenAddr);
+    expect(result).toBe(true);
+  });
+  it("returns true when usable, not delayed phantom, and not quoted", () => {
+    const cm = buildCreditManager({
+      quotas: {},
+      isQuoted: vi.fn().mockReturnValue(false)
+    });
+    mockIsUsableToken.mockReturnValue(true);
+    const result = isObtainableToken({
+      address: tokenAddr,
+      creditManager: {
+        quotas: cm.quotas,
+        isQuoted: cm.isQuoted.bind(cm),
+        forbiddenTokens: cm.forbiddenTokens,
+        liquidationThresholds: cm.liquidationThresholds,
+        supportedTokens: cm.supportedTokens
+      },
+      delayedPhantoms: {}
+    });
+    expect(cm.isQuoted).toHaveBeenCalledWith(tokenAddr);
+    expect(result).toBe(true);
+  });
+  it("returns false when isUsableToken is false", () => {
+    const cm = buildCreditManager({
+      quotas: {
+        [tokenAddr]: {
+          token: tokenAddr,
+          rate: 0n,
+          limit: 100n,
+          totalQuoted: 0n,
+          isActive: true,
+          quotaIncreaseFee: 0n
+        }
+      },
+      isQuoted: vi.fn().mockReturnValue(true)
+    });
+    mockIsUsableToken.mockReturnValue(false);
+    const result = isObtainableToken({
+      address: tokenAddr,
+      creditManager: {
+        quotas: cm.quotas,
+        isQuoted: cm.isQuoted.bind(cm),
+        forbiddenTokens: cm.forbiddenTokens,
+        liquidationThresholds: cm.liquidationThresholds,
+        supportedTokens: cm.supportedTokens
+      },
+      delayedPhantoms: {}
+    });
+    expect(result).toBe(false);
+  });
+  it("returns false when quotaLeft is zero or negative", () => {
+    const cm = buildCreditManager({
+      quotas: {
+        [tokenAddr]: {
+          token: tokenAddr,
+          rate: 0n,
+          limit: 0n,
+          totalQuoted: 10n,
+          isActive: true,
+          quotaIncreaseFee: 0n
+        }
+      },
+      isQuoted: vi.fn().mockReturnValue(true)
+    });
+    mockIsUsableToken.mockReturnValue(true);
+    const result = isObtainableToken({
+      address: tokenAddr,
+      creditManager: {
+        quotas: cm.quotas,
+        isQuoted: cm.isQuoted.bind(cm),
+        forbiddenTokens: cm.forbiddenTokens,
+        liquidationThresholds: cm.liquidationThresholds,
+        supportedTokens: cm.supportedTokens
+      },
+      delayedPhantoms: {}
+    });
+    expect(result).toBe(false);
+  });
+  it("returns false when token is delayed phantom", () => {
+    const cm = buildCreditManager({
+      quotas: {
+        [tokenAddr]: {
+          token: tokenAddr,
+          rate: 0n,
+          limit: 100n,
+          totalQuoted: 0n,
+          isActive: true,
+          quotaIncreaseFee: 0n
+        }
+      },
+      isQuoted: vi.fn().mockReturnValue(true)
+    });
+    mockIsUsableToken.mockReturnValue(true);
+    const result = isObtainableToken({
+      address: tokenAddr,
+      creditManager: {
+        quotas: cm.quotas,
+        isQuoted: cm.isQuoted.bind(cm),
+        forbiddenTokens: cm.forbiddenTokens,
+        liquidationThresholds: cm.liquidationThresholds,
+        supportedTokens: cm.supportedTokens
+      },
+      delayedPhantoms: { [tokenAddr]: true }
+    });
+    expect(result).toBe(false);
+  });
+});

package/dist/esm/common-utils/utils/strategies/tokens/is-valid-extra-collateral-token.js

@@ -0,0 +1,27 @@
+import { isForbiddenToken } from "../../strategies/tokens/is-forbidden-token.js";
+function isValidExtraCollateralToken({
+  address,
+  extraCollateralConfigs,
+  prices,
+  creditManager,
+  tokensList,
+  delayedPhantoms,
+  zeroDebt
+}) {
+  if (!extraCollateralConfigs || extraCollateralConfigs.length === 0 || !prices || !creditManager)
+    return false;
+  if (creditManager && address === creditManager.underlyingToken) return true;
+  if (zeroDebt && creditManager) return false;
+  const forbidden = isForbiddenToken({ address, creditManager });
+  const delayed = !!delayedPhantoms[address];
+  const { isPhantom = false } = tokensList[address] || {};
+  const isCMValid = extraCollateralConfigs.some((config) => {
+    const targetCM = typeof config === "string" ? creditManager.address : config.cm;
+    const price = prices?.[address] || 0n;
+    return targetCM === creditManager.address && price > 0n;
+  });
+  return !isPhantom && !forbidden && !delayed && isCMValid;
+}
+export {
+  isValidExtraCollateralToken
+};

package/dist/esm/common-utils/utils/strategies/tokens/wrap-token-address.js

@@ -0,0 +1,9 @@
+function wrapTokenAddress(tokenAddress, nativeTokenAddress, wrappedNativeTokenAddress) {
+  if (wrappedNativeTokenAddress && tokenAddress === nativeTokenAddress) {
+    return wrappedNativeTokenAddress;
+  }
+  return tokenAddress;
+}
+export {
+  wrapTokenAddress
+};

package/dist/esm/common-utils/utils/strategies/tokens/wrap-token-address.spec.js

@@ -0,0 +1,12 @@
+import { describe, expect, it } from "vitest";
+import { wrapTokenAddress } from "./wrap-token-address.js";
+describe("wrapTokenAddress", () => {
+  const native = "0xeeee";
+  const wrapped = "0xweth";
+  it("returns wrapped when token matches native", () => {
+    expect(wrapTokenAddress(native, native, wrapped)).toBe(wrapped);
+  });
+  it("returns token when it does not match native", () => {
+    expect(wrapTokenAddress("0xother", native, wrapped)).toBe("0xother");
+  });
+});

package/dist/esm/common-utils/utils/validation/is-zero-balance.js

@@ -0,0 +1,6 @@
+function isZeroBalance(balance) {
+  return (balance ?? 0n) <= 10n;
+}
+export {
+  isZeroBalance
+};

package/dist/esm/common-utils/utils/validation/validate-balance.js

@@ -0,0 +1,23 @@
+import { EMPTY_ADDRESS } from "../constants.js";
+import { isZeroBalance } from "./is-zero-balance.js";
+function validateBalance({
+  amount,
+  tokenAddress,
+  maxAmount = 0n,
+  zeroCheck = true,
+  single
+}) {
+  const safeAddress = tokenAddress || EMPTY_ADDRESS;
+  if (!safeAddress) return { message: "unknownToken", token: safeAddress };
+  if (maxAmount < amount)
+    return { message: "insufficientFunds", token: safeAddress };
+  if (zeroCheck && isZeroBalance(amount))
+    return {
+      message: single ? "enterAmount" : "zeroBalance",
+      token: safeAddress
+    };
+  return null;
+}
+export {
+  validateBalance
+};