@gearbox-protocol/sdk 11.9.0-next.2 → 11.10.0

package/dist/esm/sdk/market/pricefeeds/updates/RedstoneUpdater.js

@@ -6,7 +6,7 @@ import {
 import { encodeAbiParameters, toBytes } from "viem";
 import { z } from "zod/v4";
 import { SDKConstruct } from "../../../base/index.js";
-import { AddressMap, retry } from "../../../utils/index.js";
+import { AddressMap, childLogger, retry } from "../../../utils/index.js";
 import { PriceUpdatesCache } from "./PriceUpdatesCache.js";
 import { PriceUpdateTx } from "./PriceUpdateTx.js";
 class RedstoneUpdateTx extends PriceUpdateTx {
@@ -39,6 +39,7 @@ const RedstoneOptions = z.object({
   enableLogging: z.boolean().optional()
 });
 class RedstoneUpdater extends SDKConstruct {
+  #logger;
   #cache;
   #historicalTimestampMs;
   #gateways;
@@ -46,6 +47,7 @@ class RedstoneUpdater extends SDKConstruct {
   #enableLogging;
   constructor(sdk, opts = {}) {
     super(sdk);
+    this.#logger = childLogger("RedstoneUpdater", sdk.logger);
     this.#ignoreMissingFeeds = opts.ignoreMissingFeeds;
     this.#enableLogging = opts.enableLogging;
     this.#gateways = opts.gateways?.length ? opts.gateways : void 0;
@@ -53,7 +55,7 @@ class RedstoneUpdater extends SDKConstruct {
     if (ts) {
       ts = ts === true ? Number(this.sdk.timestamp) * 1e3 : ts;
       this.#historicalTimestampMs = 6e4 * Math.floor(ts / 6e4);
-      this.logger?.debug(
+      this.#logger?.debug(
         `using historical timestamp ${this.#historicalTimestampMs}`
       );
     }
@@ -69,7 +71,7 @@ class RedstoneUpdater extends SDKConstruct {
     if (feeds.length === 0) {
       return [];
     }
-    this.logger?.debug(
+    this.#logger?.debug(
       `generating update transactions for ${feeds.length} redstone price feeds`
     );
     const groupedFeeds = {};
@@ -126,7 +128,7 @@ class RedstoneUpdater extends SDKConstruct {
         tsRange = `${tsRange} - ${maxTimestamp} (${maxDelta})`;
       }
     }
-    this.logger?.debug(
+    this.#logger?.debug(
       `generated ${results.length} update transactions for redstone price feeds: ${Array.from(priceFeeds.keys()).join(", ")}${tsRange}`
     );
     return results;
@@ -151,7 +153,7 @@ class RedstoneUpdater extends SDKConstruct {
     for (const { timestamp, dataFeedId } of result) {
       const delta = Number(this.sdk.timestamp) - timestamp;
       if (delta >= 240 && delta < 255) {
-        this.logger?.warn(
+        this.#logger?.warn(
           `payload for ${dataFeedId} has expired by ${delta} seconds`
         );
         expired = true;
@@ -175,7 +177,7 @@ class RedstoneUpdater extends SDKConstruct {
    * @returns
    */
   async #getPayloads(dataServiceId, dataFeedsIds, uniqueSignersCount) {
-    this.logger?.debug(
+    this.#logger?.debug(
       `getting redstone payloads for ${dataFeedsIds.size} data feeds in ${dataServiceId} with ${uniqueSignersCount} signers: ${Array.from(dataFeedsIds).join(", ")}`
     );
     const fromCache = [];
@@ -200,7 +202,7 @@ class RedstoneUpdater extends SDKConstruct {
     for (const resp of fromRedstone) {
       this.#cache.set(resp, dataServiceId, resp.dataFeedId, uniqueSignersCount);
     }
-    this.logger?.debug(
+    this.#logger?.debug(
       `got ${fromRedstone.length} new redstone updates and ${fromCache.length} from cache`
     );
     return [...fromCache, ...fromRedstone];
@@ -219,7 +221,7 @@ class RedstoneUpdater extends SDKConstruct {
     }
     const dataPackagesIds = Array.from(dataFeedsIds);
     const tsStr = this.#historicalTimestampMs ? ` with historical timestamp ${this.#historicalTimestampMs}` : "";
-    this.logger?.debug(
+    this.#logger?.debug(
       `fetching redstone payloads for ${dataFeedsIds.size} data feeds in ${dataServiceId} with ${uniqueSignersCount} signers: ${dataPackagesIds.join(", ")}${tsStr}`
     );
     const wrapper = new DataServiceWrapper({
@@ -248,14 +250,14 @@ class RedstoneUpdater extends SDKConstruct {
       const signedDataPackages = packagesByDataFeedId[dataFeedId];
       if (!signedDataPackages) {
         if (this.#ignoreMissingFeeds) {
-          this.logger?.warn(`cannot find data packages for ${dataFeedId}`);
+          this.#logger?.warn(`cannot find data packages for ${dataFeedId}`);
           continue;
         }
         throw new Error(`cannot find data packages for ${dataFeedId}`);
       }
       if (signedDataPackages.length !== uniqueSignersCount) {
         if (this.#ignoreMissingFeeds) {
-          this.logger?.warn(
+          this.#logger?.warn(
             `got ${signedDataPackages.length} data packages for ${dataFeedId}, but expected ${uniqueSignersCount}`
           );
           continue;

package/dist/esm/sdk/router/AbstractRouterContract.js

@@ -1,18 +1,18 @@
 import { BaseContract } from "../base/index.js";
-import { AddressMap, isDust } from "../utils/index.js";
+import { PERCENTAGE_FACTOR } from "../constants/math.js";
+import { AddressMap, AddressSet, formatBN, isDust } from "../utils/index.js";
 import { Hooks } from "../utils/internal/index.js";
 import { limitLeftover } from "./helpers.js";
 class AbstractRouterContract extends BaseContract {
   hooks = new Hooks();
   addHook = this.hooks.addHook.bind(this.hooks);
   removeHook = this.hooks.removeHook.bind(this.hooks);
-  sdk;
-  constructor(sdk, args) {
-    super(sdk, args);
-    this.sdk = sdk;
-  }
-  getExpectedAndLeftover(ca, cm, balances, keepAssets) {
-    const b = balances || this.getDefaultExpectedAndLeftover(ca, keepAssets);
+  getExpectedAndLeftover(ca, cm, options = {}) {
+    const b = options.balances ? options.balances : this.getDefaultExpectedAndLeftover(
+      ca,
+      options.keepAssets,
+      options.debtOnly
+    );
     const { leftoverBalances, expectedBalances, tokensToClaim } = b;
     const expected = new AddressMap();
     const leftover = new AddressMap();
@@ -30,15 +30,22 @@ class AbstractRouterContract extends BaseContract {
       tokensToClaim
     };
   }
-  getDefaultExpectedAndLeftover(ca, keepAssets) {
+  getDefaultExpectedAndLeftover(ca, keepAssets, debtOnly) {
     const expectedBalances = new AddressMap();
     const leftoverBalances = new AddressMap();
-    const keepAssetsSet = new Set(keepAssets?.map((a) => a.toLowerCase()));
-    for (const { token: t, balance, mask } of ca.tokens) {
-      const token = t;
+    const keepAssetsSet = new AddressSet(keepAssets);
+    if (debtOnly) {
+      const result = this.getLeftoversAfterBuyingDebt(ca, keepAssetsSet);
+      if (result) {
+        return result;
+      } else {
+        this.logger?.warn("no token found to cover debt");
+      }
+    }
+    for (const { token, balance, mask } of ca.tokens) {
       const isEnabled = (mask & ca.enabledTokensMask) !== 0n;
       expectedBalances.upsert(token, { token, balance });
-      if (keepAssetsSet.has(token.toLowerCase()) || !isEnabled || isDust({
+      if (keepAssetsSet.has(token) || !isEnabled || isDust({
         sdk: this.sdk,
         token,
         balance,
@@ -56,6 +63,101 @@ class AbstractRouterContract extends BaseContract {
       tokensToClaim: new AddressMap()
     };
   }
+  /**
+   * Tries to sell just enought of most valuable token to cover debt
+   * @param ca
+   * @param keepAssets
+   * @returns
+   */
+  getLeftoversAfterBuyingDebt(ca, keepAssets) {
+    const { priceOracle } = this.sdk.marketRegister.findByCreditManager(
+      ca.creditManager
+    );
+    const expectedBalances = new AddressMap();
+    const leftoverBalances = new AddressMap();
+    const usdBalances = [];
+    for (const { token, balance, mask } of ca.tokens) {
+      const isEnabled = (mask & ca.enabledTokensMask) !== 0n;
+      expectedBalances.upsert(token, { token, balance });
+      leftoverBalances.upsert(token, {
+        token,
+        balance: limitLeftover(balance, token) ?? balance
+      });
+      if (isEnabled && !keepAssets.has(token)) {
+        usdBalances.push({
+          token,
+          balance: this.safeConvertToUSD(priceOracle, token, balance)
+        });
+      }
+    }
+    usdBalances.sort((a, b) => {
+      if (a.balance > b.balance) return -1;
+      if (a.balance < b.balance) return 1;
+      return 0;
+    });
+    if (usdBalances.length === 0) {
+      return void 0;
+    }
+    const highestToken = usdBalances[0];
+    const lt = this.sdk.marketRegister.findCreditManager(ca.creditManager).creditManager.liquidationThresholds.mustGet(highestToken.token);
+    const requiredDebtUSD = ca.totalDebtUSD * PERCENTAGE_FACTOR / BigInt(lt);
+    if (highestToken.balance < requiredDebtUSD) {
+      return void 0;
+    }
+    const tokenAmount = this.safeConvertFromUSD(
+      priceOracle,
+      highestToken.token,
+      requiredDebtUSD
+    );
+    if (tokenAmount === 0n) {
+      return void 0;
+    }
+    let leftoverBalance = leftoverBalances.get(highestToken.token)?.balance ?? 0n;
+    leftoverBalance -= tokenAmount;
+    if (leftoverBalance < 0n) {
+      return void 0;
+    }
+    leftoverBalances.upsert(highestToken.token, {
+      token: highestToken.token,
+      balance: leftoverBalance
+    });
+    const tokenAmountStr = this.sdk.tokensMeta.formatBN(
+      highestToken.token,
+      tokenAmount,
+      { symbol: true }
+    );
+    const totalDebtUSDStr = formatBN(ca.totalDebtUSD, 8);
+    this.logger?.debug(
+      `will sell ${tokenAmountStr} (LT=${lt}) to cover debt of ${totalDebtUSDStr} USD`
+    );
+    return {
+      expectedBalances,
+      leftoverBalances,
+      tokensToClaim: new AddressMap()
+    };
+  }
+  safeConvertToUSD(priceOracle, token, balance) {
+    try {
+      return priceOracle.convertToUSD(token, balance);
+    } catch {
+      try {
+        return priceOracle.convertToUSD(token, balance, true);
+      } catch {
+        return 0n;
+      }
+    }
+  }
+  safeConvertFromUSD(priceOracle, token, balance) {
+    try {
+      return priceOracle.convertFromUSD(token, balance);
+    } catch {
+      try {
+        return priceOracle.convertFromUSD(token, balance, true);
+      } catch {
+        return 0n;
+      }
+    }
+  }
 }
 export {
   AbstractRouterContract

package/dist/esm/sdk/router/RouterV300Contract.js

@@ -179,22 +179,22 @@ class RouterV300Contract extends AbstractRouterContract {
     creditAccount: ca,
     creditManager: cm,
     slippage,
-    balances
+    balances,
+    debtOnly
   }) {
     const {
       pathOptions,
       expected,
       leftover: leftoverUnsafe,
       connectors
-    } = this.getFindClosePathInput(
-      ca,
-      cm,
-      balances ? {
+    } = this.getFindClosePathInput(ca, cm, {
+      balances: balances ? {
         expectedBalances: assetsMap(balances.expectedBalances),
         leftoverBalances: assetsMap(balances.leftoverBalances),
         tokensToClaim: assetsMap(balances.tokensToClaim || [])
-      } : void 0
-    );
+      } : void 0,
+      debtOnly
+    });
     const leftover = leftoverUnsafe.map((a) => ({
       ...a,
       balance: limitLeftover(a.balance, a.token) ?? 0n
@@ -254,12 +254,11 @@ class RouterV300Contract extends AbstractRouterContract {
   /**
    * Implements {@link IRouterContract.getFindClosePathInput}
    */
-  getFindClosePathInput(ca, cm, balances, keepAssets) {
+  getFindClosePathInput(ca, cm, options) {
     const { expectedBalances, leftoverBalances } = this.getExpectedAndLeftover(
       ca,
       cm,
-      balances,
-      keepAssets
+      options
     );
     const leftover = leftoverBalances.values().map((a) => ({
       ...a,

package/dist/esm/sdk/router/RouterV310Contract.js

@@ -159,18 +159,18 @@ class RouterV310Contract extends AbstractRouterContract {
       creditManager: cm,
       slippage,
       balances,
-      keepAssets
+      keepAssets,
+      debtOnly
     } = props;
-    const { expectedBalances, leftoverBalances, tokensToClaim } = this.getExpectedAndLeftover(
-      ca,
-      cm,
-      balances ? {
+    const { expectedBalances, leftoverBalances, tokensToClaim } = this.getExpectedAndLeftover(ca, cm, {
+      balances: balances ? {
         expectedBalances: assetsMap(balances.expectedBalances),
         leftoverBalances: assetsMap(balances.leftoverBalances),
         tokensToClaim: assetsMap(balances.tokensToClaim || [])
       } : void 0,
-      keepAssets
-    );
+      keepAssets: balances ? void 0 : keepAssets,
+      debtOnly
+    });
     const getNumSplits = this.#numSplitsGetter(cm, expectedBalances.values());
     const tData = [];
     for (const token of cm.collateralTokens) {
@@ -276,15 +276,15 @@ class RouterV310Contract extends AbstractRouterContract {
    * @returns
    */
   #convertToUSDForSort(oracle, token, amount) {
-    const scale = 10n ** BigInt(this.tokensMeta.get(token)?.decimals ?? 0);
+    const scale = 10n ** BigInt(this.sdk.tokensMeta.get(token)?.decimals ?? 0);
     const price = oracle.mainPrices.get(token)?.price || oracle.reservePrices.get(token)?.price || scale;
     return amount * price / scale;
   }
   #debugTokenData(tData) {
     return tData.map((t) => ({
       token: this.labelAddress(t.token),
-      balance: `${this.tokensMeta.formatBN(t.token, t.balance)} (${t.balance})`,
-      leftoverBalance: this.tokensMeta.formatBN(t.token, t.leftoverBalance) + ` (${t.leftoverBalance})`,
+      balance: `${this.sdk.tokensMeta.formatBN(t.token, t.balance)} (${t.balance})`,
+      leftoverBalance: this.sdk.tokensMeta.formatBN(t.token, t.leftoverBalance) + ` (${t.leftoverBalance})`,
       numSplits: t.numSplits,
       claimRewards: t.claimRewards
     }));

package/dist/esm/sdk/router/createRouter.js

@@ -2,10 +2,6 @@ import { isV300, isV310 } from "../constants/index.js";
 import { RouterV300Contract } from "./RouterV300Contract.js";
 import { RouterV310Contract } from "./RouterV310Contract.js";
 function createRouter(sdk, address, version) {
-  const contract = sdk.getContract(address);
-  if (contract) {
-    return contract;
-  }
   if (isV300(version)) {
     return new RouterV300Contract(sdk, address, version);
   }

package/dist/esm/sdk/utils/index.js

@@ -1,6 +1,5 @@
 export * from "./AddressMap.js";
 export * from "./AddressSet.js";
-export * from "./abi-decode.js";
 export * from "./bytes32ToString.js";
 export * from "./childLogger.js";
 export * from "./createRawTx.js";

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

@@ -1,7 +1,7 @@
 import type { Abi } from "abitype";
 import type { Account, Address, Chain, Client, ContractConstructorArgs, GetChainParameter, Hash, Hex, SendTransactionParameters, SendTransactionReturnType, Transport, UnionEvaluate, UnionOmit, WalletClient } from "viem";
 import type { GearboxSDK } from "../sdk/index.js";
-import { Construct } from "../sdk/index.js";
+import { SDKConstruct } from "../sdk/index.js";
 export declare const PUBLIC_CREATE2_FACTORY: Address;
 export declare const DEFAULT_CREATE2_SALT = "GEARBOX";
 export type Create2Parameters<abi extends Abi | readonly unknown[] = Abi, chain extends Chain = Chain, account extends Account = Account, chainOverride extends Chain | undefined = Chain | undefined, allArgs = ContractConstructorArgs<abi>> = UnionOmit<SendTransactionParameters<chain, account, chainOverride>, "accessList" | "chain" | "to" | "data"> & GetChainParameter<chain, chainOverride> & UnionEvaluate<readonly [] extends allArgs ? {
@@ -24,7 +24,7 @@ export interface EnsureExistsUsingPublicCreate2ReturnType {
     address: Address;
     hash?: Hash;
 }
-export declare class Create2Deployer<transport extends Transport = Transport, chain extends Chain = Chain, account extends Account = Account> extends Construct {
+export declare class Create2Deployer<transport extends Transport = Transport, chain extends Chain = Chain, account extends Account = Account> extends SDKConstruct {
     #private;
     constructor(sdk: GearboxSDK, walletClient: WalletClient<transport, chain, account>);
     ensureExists<abi extends Abi | readonly unknown[], chainOverride extends Chain | undefined = Chain | undefined>(parameters: Create2Parameters<abi, chain, account, chainOverride>): Promise<EnsureExistsUsingPublicCreate2ReturnType>;

package/dist/types/dev/mint/AbstractMinter.d.ts

@@ -1,11 +1,12 @@
 import { type Address } from "viem";
-import { type GearboxSDK, SDKConstruct } from "../../sdk/index.js";
+import { type GearboxSDK, type ILogger, SDKConstruct } from "../../sdk/index.js";
 import type { AnvilClient } from "../createAnvilClient.js";
 import type { IMinter } from "./types.js";
 export default abstract class AbstractMinter extends SDKConstruct implements IMinter {
     protected readonly anvil: AnvilClient;
-    name: string;
-    constructor(sdk: GearboxSDK, anvil: AnvilClient);
+    protected readonly logger?: ILogger;
+    readonly name: string;
+    constructor(sdk: GearboxSDK, anvil: AnvilClient, name?: string);
     tryMint(token: Address, dest: Address, amount: bigint): Promise<bigint>;
     abstract mint(token: Address, dest: Address, amount: bigint): Promise<void>;
     protected getOwner(address: Address): Promise<Address>;

package/dist/types/dev/mint/DealMinter.d.ts

@@ -1,6 +1,9 @@
 import type { Address } from "viem";
+import type { GearboxSDK } from "../../sdk/index.js";
+import type { AnvilClient } from "../createAnvilClient.js";
 import AbstractMinter from "./AbstractMinter.js";
 import type { IMinter } from "./types.js";
 export declare class DealMinter extends AbstractMinter implements IMinter {
+    constructor(sdk: GearboxSDK, anvil: AnvilClient);
     mint(token: Address, dest: Address, amount: bigint): Promise<void>;
 }

package/dist/types/dev/mint/DirectMinter.d.ts

@@ -1,6 +1,9 @@
 import { type Address } from "viem";
+import type { GearboxSDK } from "../../sdk/index.js";
+import type { AnvilClient } from "../createAnvilClient.js";
 import AbstractMinter from "./AbstractMinter.js";
 import type { IMinter } from "./types.js";
 export declare class DirectMinter extends AbstractMinter implements IMinter {
+    constructor(sdk: GearboxSDK, anvil: AnvilClient);
     mint(token: Address, dest: Address, amount: bigint): Promise<void>;
 }

package/dist/types/dev/mint/TransferMinter.d.ts

@@ -1,6 +1,9 @@
 import { type Address } from "viem";
+import type { GearboxSDK } from "../../sdk/index.js";
+import type { AnvilClient } from "../createAnvilClient.js";
 import AbstractMinter from "./AbstractMinter.js";
 import type { IMinter } from "./types.js";
 export declare class TransferMinter extends AbstractMinter implements IMinter {
+    constructor(sdk: GearboxSDK, anvil: AnvilClient);
     mint(token: Address, dest: Address, amount: bigint): Promise<void>;
 }