@gearbox-protocol/sdk 14.12.0-next.65 → 14.12.0-next.67

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

@@ -1,110 +1,42 @@
-import { NetworkType } from "../../chain/chains.js";
-import "../../chain/index.js";
-import { Asset } from "../../base/types.js";
-import { RawTx } from "../../types/transactions.js";
+import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
+import { MultichainNetworkProps, MultichainNetworksProps, WithMultichain } from "../../types/multichain.js";
+import { LiquidatableAccountFilter } from "../../../model/liquidations.js";
+import "../../../model/index.js";
 import "../../types/index.js";
-import "../../base/index.js";
-import { Address } from "viem";
+import { Address, ContractFunctionReturnType } from "viem";
 //#region src/sdk/accounts/liquidations/types.d.ts
 /**
- * Selects the chain for single-account methods of a multichain service.
+ * Raw `LiquidationData` returned by `LiquidationCompressor.getLiquidationData`.
  **/
-interface MultichainNetworkProps {
-  /**
-   * Network the credit account lives on.
-   **/
-  network: NetworkType;
-}
+type OnchainLiquidationData = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "nonpayable", "getLiquidationData">;
 /**
- * Restricts which chains a multichain list method queries.
+ * Single element of {@link OnchainLiquidationData.expectedOutputs}.
  **/
-interface MultichainNetworksProps {
-  /**
-   * Networks to query. All chains configured in {@link MultichainSDK} when
-   * omitted.
-   **/
-  networks?: NetworkType[];
-}
+type OnchainLiquidationOutput = OnchainLiquidationData["expectedOutputs"][number];
 /**
- * Adds chain-scoping props `T` only when the service spans multiple chains.
+ * Single call built by the liquidation compressor.
  **/
-type WithMultichain<Multichain extends boolean, T extends object> = Multichain extends true ? T : {};
+type OnchainLiquidationCall = OnchainLiquidationData["liquidationCall"];
 /**
- * Chain-independent part of {@link GetLiquidatableAccountsProps}.
- * All filters are optional and applied after liquidatable accounts are fetched.
+ * A dedicated RWA liquidator contract (Midas / Securitize) discovered by
+ * `LiquidationCompressor.getRWALiquidators`. `contractType` is the bytes32
+ * contract type of the liquidator itself (e.g. `RWA_LIQUIDATOR::MIDAS`),
+ * not of the phantom token it was found through.
  **/
-interface GetLiquidatableAccountsPropsBase {
-  /**
-   * Only return accounts whose main liquidated {@link LiquidatableAccount.asset}
-   * is one of these tokens.
-   **/
-  assets?: Address[];
-  /**
-   * When set, only return accounts with (`true`) or without (`false`)
-   * delayed (phantom-token) withdrawals.
-   **/
-  delayed?: boolean;
-}
+type RWALiquidatorInfo = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "view", "getRWALiquidators">[number];
 /**
- * Props for {@link ILiquidationsService.getLiquidatableAccounts}.
+ * Chain-independent part of {@link GetLiquidatableAccountsProps}.
+ *
+ * The filter itself lives in the read model, so the chain and the backend
+ * cannot disagree on what a criterion selects. Chain scoping is expressed as
+ * `networks` by {@link MultichainNetworksProps} rather than as the model's
+ * `chainIds`, which is why it is omitted here.
  **/
-type GetLiquidatableAccountsProps<Multichain extends boolean = false> = GetLiquidatableAccountsPropsBase & WithMultichain<Multichain, MultichainNetworksProps>;
+type GetLiquidatableAccountsPropsBase = Omit<LiquidatableAccountFilter, "chainIds">;
 /**
- * A credit account that can be liquidated, with amounts precomputed for
- * manual liquidation via the frontend.
+ * Props for {@link LiquidationsService.getLiquidatableAccounts}.
  **/
-interface LiquidatableAccount {
-  /**
-   * Credit account address.
-   **/
-  creditAccount: Address;
-  /**
-   * Credit manager the account is opened in.
-   **/
-  creditManager: Address;
-  /**
-   * Network the account lives on.
-   **/
-  network: NetworkType;
-  /**
-   * Main asset being liquidated: the most valuable enabled non-underlying
-   * collateral token. For delayed-withdrawal phantom tokens, the source
-   * asset (e.g. ACRED) is reported instead of the phantom token. Falls back
-   * to the underlying when the account holds no other collateral.
-   **/
-  asset: Address;
-  /**
-   * Account total value. The token is the unwrapped asset (e.g. USDC) for
-   * RWA credit managers (1:1 with the wrapped underlying), the credit
-   * manager underlying otherwise.
-   **/
-  totalValue: Asset;
-  /**
-   * Account total value in USD (8 decimals).
-   **/
-  totalValueUSD: bigint;
-  /**
-   * Estimated amount the liquidator pays to fully liquidate the account:
-   * `totalValue * liquidationDiscount`. Same token as {@link totalValue}.
-   **/
-  repaymentAmount: Asset;
-  /**
-   * Estimated liquidator profit: `totalValue * (1 - liquidationDiscount)`.
-   * Same token as {@link totalValue}.
-   **/
-  estimatedProfit: Asset;
-  /**
-   * `true` when the account holds a delayed-withdrawal phantom token above
-   * dust, i.e. the liquidation transfers withdrawal redeemers into the
-   * liquidator's ownership instead of instantly receivable tokens.
-   **/
-  isDelayed: boolean;
-  /**
-   * `true` when the credit manager's facade is paused. Liquidations of such
-   * accounts only succeed for emergency liquidators approved in the market.
-   **/
-  paused: boolean;
-}
+type GetLiquidatableAccountsProps<Multichain extends boolean = false> = GetLiquidatableAccountsPropsBase & WithMultichain<Multichain, MultichainNetworksProps>;
 /**
  * Chain-independent part of {@link GetLiquidationDetailsProps}.
  **/
@@ -128,7 +60,7 @@ interface GetLiquidationDetailsPropsBase {
   ignoreReservePrices?: boolean;
 }
 /**
- * Props for {@link ILiquidationsService.getLiquidationDetails}.
+ * Props for {@link LiquidationsService.getLiquidationDetails}.
  **/
 type GetLiquidationDetailsProps<Multichain extends boolean = false> = GetLiquidationDetailsPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
 /**
@@ -151,57 +83,13 @@ interface BuildLiquidationTxPropsBase {
   ignoreReservePrices?: boolean;
 }
 /**
- * Props for {@link ILiquidationsService.buildLiquidationTx}.
+ * Props for {@link LiquidationsService.buildLiquidationTx}.
  **/
 type BuildLiquidationTxProps<Multichain extends boolean = false> = BuildLiquidationTxPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
 /**
- * A token received directly from the credit account balance upon liquidation.
- **/
-interface InstantReceivedAsset {
-  isDelayed: false;
-  /**
-   * Token received by the liquidator.
-   **/
-  token: Address;
-  /**
-   * Amount of `token` received.
-   **/
-  amount: bigint;
-}
-/**
- * A token produced by a delayed withdrawal whose redeemer is transferred to
- * the liquidator upon liquidation.
- **/
-interface DelayedReceivedAsset {
-  isDelayed: true;
-  /**
-   * Receivable token (e.g. USDC).
-   **/
-  token: Address;
-  /**
-   * Amount of `token`: exact for claimable withdrawals, estimated for
-   * pending ones.
-   **/
-  amount: bigint;
-  /**
-   * Redeemer contract transferred to the liquidator, from which `token`
-   * becomes claimable. `undefined` when the compressor does not report one.
-   **/
-  redeemerAddress?: Address;
-  /**
-   * Estimated unix timestamp (in seconds) when a pending withdrawal becomes
-   * claimable. `undefined` means the withdrawal is claimable now.
-   **/
-  claimableAt?: bigint;
-}
-/**
- * A single asset the liquidator receives when fully liquidating an account.
- **/
-type ReceivedAsset = InstantReceivedAsset | DelayedReceivedAsset;
-/**
- * Chain-independent part of {@link GetLiquidatorWithdrawalsProps}.
+ * Chain-independent part of {@link GetLiquidationPositionsProps}.
  **/
-interface GetLiquidatorWithdrawalsPropsBase {
+interface GetLiquidationPositionsPropsBase {
   /**
    * Liquidator wallet that owns the redemption receipts (redeemer contracts
    * received as a result of liquidations).
@@ -209,176 +97,13 @@ interface GetLiquidatorWithdrawalsPropsBase {
   liquidator: Address;
 }
 /**
- * Props for {@link ILiquidationsService.getLiquidatorWithdrawals}.
+ * Props for {@link LiquidationsService.getLiquidationPositions}.
  **/
-type GetLiquidatorWithdrawalsProps<Multichain extends boolean = false> = GetLiquidatorWithdrawalsPropsBase & WithMultichain<Multichain, MultichainNetworksProps>;
+type GetLiquidationPositionsProps<Multichain extends boolean = false> = GetLiquidationPositionsPropsBase & WithMultichain<Multichain, MultichainNetworksProps>;
 /**
- * Props for {@link ILiquidationsService.loadRWALiquidators}.
+ * Props for {@link MultichainLiquidationsService.loadRWALiquidators}. The
+ * per-chain {@link LiquidationsService.loadRWALiquidators} takes no props.
  **/
 type LoadRWALiquidatorsProps<Multichain extends boolean = false> = WithMultichain<Multichain, MultichainNetworksProps>;
-/**
- * A single delayed-withdrawal position owned by the liquidator.
- **/
-interface LiquidatorWithdrawal {
-  /**
-   * Network the withdrawal lives on.
-   **/
-  network: NetworkType;
-  /**
-   * Chain id the withdrawal lives on.
-   **/
-  chainId: number;
-  /**
-   * Source asset spent by the delayed withdrawal (e.g. ACRED).
-   **/
-  sourceToken: Address;
-  /**
-   * Receivable asset (e.g. USDC) and its amount: exact for claimable
-   * withdrawals, estimated for pending ones.
-   **/
-  output: Asset;
-  /**
-   * Estimated unix timestamp (in seconds) when a pending withdrawal becomes
-   * claimable. `undefined` means the withdrawal is claimable now.
-   **/
-  claimableAt?: bigint;
-  /**
-   * Transaction that claims the withdrawal. `undefined` for pending
-   * withdrawals and when the compressor reports no claim call.
-   **/
-  claimTx?: RawTx;
-  /**
-   * Redeemer contract the withdrawal is claimed from, owned by the liquidator.
-   * `undefined` on compressor versions below 313, which do not report it.
-   **/
-  redeemer?: Address;
-}
-/**
- * ERC-20 approval the liquidator must grant before sending the liquidation
- * transaction.
- **/
-interface LiquidationApproval {
-  /**
-   * Address to approve: the credit manager when the liquidation goes directly
-   * through the credit facade (the facade forwards `msg.sender` as the payer
-   * and the credit manager executes the transfer), or the dedicated liquidator
-   * contract (Midas / Securitize) when the liquidation goes through one, since
-   * such contracts pull the token to themselves first.
-   **/
-  spender: Address;
-  /**
-   * Token pulled from the liquidator, as reported by the compressor for the
-   * liquidation path it selected: the credit manager underlying for standard
-   * liquidations, the unwrapped stablecoin (e.g. USDC) for RWA ones.
-   **/
-  token: Address;
-  /**
-   * Amount to approve: the amount the liquidation transaction pulls plus 0.5%
-   * of headroom. The Securitize liquidator recomputes the amount on-chain, so
-   * the approval must survive price movements after the preview.
-   **/
-  amount: bigint;
-}
-/**
- * Detailed information about a liquidatable credit account, including
- * the full breakdown of assets the liquidator receives.
- *
- **/
-interface LiquidationDetails extends LiquidatableAccount {
-  /**
-   * Exact amount the liquidator pays for the liquidation path the compressor
-   * selected, superseding the estimate of {@link LiquidatableAccount}. The
-   * token is {@link LiquidationApproval.token}, which for RWA markets is the
-   * unwrapped stablecoin rather than {@link LiquidatableAccount.totalValue}'s
-   * token; it falls back to the latter when nothing is pulled.
-   **/
-  repaymentAmount: Asset;
-  /**
-   * Assets the liquidator receives upon full liquidation: direct credit
-   * account balances plus outputs of delayed withdrawals (claimable and
-   * pending).
-   **/
-  receivedAssets: ReceivedAsset[];
-  /**
-   * Whether the liquidator passes the KYC checks of the liquidated assets.
-   * When {@link GetLiquidationDetailsPropsBase.liquidator} was not provided,
-   * `false` only means that the liquidation is KYC-gated, not that a
-   * particular wallet was rejected.
-   **/
-  isLiquidatorEligible: boolean;
-  /**
-   * `true` when the credit account is frozen by the RWA factory
-   * (`isFrozen`) and cannot move its RWA collateral. Always `false` for
-   * non-RWA liquidation paths.
-   **/
-  isCreditAccountFrozen: boolean;
-  /**
-   * Name of the KYC protocol the liquidator must be whitelisted in
-   * (e.g. `"securitize"`). `undefined` when the liquidation is not KYC-gated.
-   **/
-  kycProtocol?: string;
-  /**
-   * Token the liquidator must be whitelisted for in {@link kycProtocol}.
-   * `undefined` when the liquidation is not KYC-gated.
-   **/
-  kycToken?: Address;
-  /**
-   * ERC-20 approval required before sending the liquidation transaction.
-   * `undefined` when the selected liquidation path needs no capital from the
-   * liquidator, i.e. {@link repaymentAmount} is zero.
-   **/
-  approve?: LiquidationApproval;
-}
-/**
- * Service for discovering liquidatable credit accounts and previewing manual
- * liquidations. Implemented per-chain by {@link LiquidationsService} and
- * across all configured chains by {@link MultichainLiquidationsService}.
- *
- * @typeParam Multichain - When `true`, props select the chain to operate on:
- * {@link MultichainNetworkProps} for single-account methods and
- * {@link MultichainNetworksProps} for list methods. A per-chain service
- * operates on the network its SDK is attached to and takes no network props.
- **/
-interface ILiquidationsService<Multichain extends boolean = false> {
-  /**
-   * Returns all liquidatable credit accounts: accounts with health factor
-   * below 1 plus accounts of expired credit managers with outstanding debt.
-   * Accounts whose collateral computation failed are excluded.
-   *
-   * @param props - Optional filters, see {@link GetLiquidatableAccountsProps}
-   **/
-  getLiquidatableAccounts(props?: GetLiquidatableAccountsProps<Multichain>): Promise<LiquidatableAccount[]>;
-  /**
-   * Returns detailed information about a liquidatable credit account,
-   * including the full list of assets the liquidator receives.
-   *
-   * @param props - See {@link GetLiquidationDetailsProps}
-   * @throws When the account is not found or its collateral computation fails.
-   **/
-  getLiquidationDetails(props: GetLiquidationDetailsProps<Multichain>): Promise<LiquidationDetails>;
-  /**
-   * Builds the transaction that fully liquidates a credit account, repaying
-   * the debt from own funds and receiving the collateral from the credit account.
-   *
-   * @param props - See {@link BuildLiquidationTxProps}
-   **/
-  buildLiquidationTx(props: BuildLiquidationTxProps<Multichain>): Promise<RawTx>;
-  /**
-   * Returns the status of delayed-withdrawal positions (redemption receipts)
-   * owned by a liquidator wallet: what is receivable, how much, and when it
-   * becomes claimable.
-   *
-   * @param props - See {@link GetLiquidatorWithdrawalsProps}
-   **/
-  getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps<Multichain>): Promise<LiquidatorWithdrawal[]>;
-  /**
-   * Discovers the dedicated RWA liquidator contracts (Securitize, Midas)
-   * deployed for the markets of the chain and registers them in the SDK
-   * contracts register.
-   *
-   * @param props - See {@link LoadRWALiquidatorsProps}
-   **/
-  loadRWALiquidators(props?: LoadRWALiquidatorsProps<Multichain>): Promise<void>;
-}
 //#endregion
-export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, DelayedReceivedAsset, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidatorWithdrawalsProps, GetLiquidatorWithdrawalsPropsBase, ILiquidationsService, InstantReceivedAsset, LiquidatableAccount, LiquidationApproval, LiquidationDetails, LiquidatorWithdrawal, LoadRWALiquidatorsProps, MultichainNetworkProps, MultichainNetworksProps, ReceivedAsset, WithMultichain };
+export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LoadRWALiquidatorsProps, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, RWALiquidatorInfo };

package/dist/types/sdk/base/MultichainConstruct.d.ts

@@ -0,0 +1,57 @@
+import { NetworkType } from "../chain/chains.js";
+import { MultichainResult } from "../types/multichain.js";
+import { PluginsMap } from "../plugins/types.js";
+import "../plugins/index.js";
+import { OnchainSDK } from "../OnchainSDK.js";
+import "../types/index.js";
+import { MultichainSDK } from "../MultichainSDK.js";
+//#region src/sdk/base/MultichainConstruct.d.ts
+/**
+ * Describes a request that is sent to every queried chain.
+ *
+ * @typeParam T - Payload returned by a single chain.
+ * @typeParam Plugins - Map of attached plugin types.
+ **/
+interface ChainQueryProps<T, Plugins extends PluginsMap = {}> {
+  /**
+   * Networks to query. All configured chains when omitted.
+   **/
+  networks?: NetworkType[];
+  /**
+   * Action description used in warnings, e.g. `"get liquidatable accounts"`.
+   **/
+  label: string;
+  /**
+   * Request sent to a single chain.
+   **/
+  run: (sdk: OnchainSDK<Plugins>) => Promise<T>;
+}
+/**
+ * @internal
+ * Base class for services that fan out over the chains of a
+ * {@link MultichainSDK}, the cross-chain counterpart of {@link SDKConstruct}.
+ *
+ * Requests are soft-failing: a chain that rejects (including a chain that is
+ * not configured in the SDK) is logged as a warning and contributes no payload,
+ * while the remaining chains still return their results. Every queried chain is
+ * reported in {@link MultichainResult.meta}.
+ *
+ * @typeParam Plugins - Map of attached plugin types.
+ **/
+declare abstract class MultichainConstruct<const Plugins extends PluginsMap = {}> {
+  #private;
+  protected readonly sdk: MultichainSDK<Plugins>;
+  constructor(sdk: MultichainSDK<Plugins>);
+  /**
+   * Fans out a request that returns a list, concatenating the lists of all
+   * chains that responded successfully.
+   **/
+  protected queryChains<T>(props: ChainQueryProps<T[], Plugins>): Promise<MultichainResult<T[]>>;
+  /**
+   * Fans out a request with no payload, reporting the outcome of every queried
+   * chain in {@link MultichainResult.meta}.
+   **/
+  protected runChains(props: ChainQueryProps<void, Plugins>): Promise<MultichainResult<void>>;
+}
+//#endregion
+export { ChainQueryProps, MultichainConstruct };

package/dist/types/sdk/base/TokensMeta.d.ts

@@ -1,4 +1,5 @@
 import { ILogger } from "../types/logger.js";
+import { Token } from "../../model/primitives.js";
 import { AddressMap } from "../utils/AddressMap.js";
 import { Asset } from "./types.js";
 import "../utils/index.js";
@@ -68,6 +69,31 @@ declare class TokensMeta extends AddressMap<TokenMetaData> {
    * Throws if token data is not loaded
    */
   get rwaUnderlyings(): AddressMap<RWATokenMeta>;
+  /**
+   * Describes a token the way the shared read model does.
+   *
+   * @param address - Token address.
+   * @throws If the token is not in the registry.
+   */
+  mustGetToken(address: Address): Token;
+  /**
+   * Like {@link mustGetToken}, but returns `undefined` instead of throwing when the
+   * token is not in the registry.
+   *
+   * @param address - Token address.
+   */
+  getToken(address: Address): Token | undefined;
+  /**
+   * The token an RWA wrapper holds, or the token itself when it is not one.
+   *
+   * An RWA market borrows a compliance wrapper (e.g. `dcUSDC`) that converts
+   * one-for-one with the token behind it (`USDC`), and only that token means
+   * anything to a reader. Pricing still goes through the wrapper, which is what
+   * a market's oracle knows.
+   *
+   * @param token - Token address, wrapper or not.
+   */
+  unwrapRWA(token: Address): Address;
   /**
    * Formats a raw token amount into a human-readable decimal string,
    * dividing by `10^decimals` for the token.

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

@@ -5,6 +5,7 @@ import { ChainContractsRegister, ContractOrInterface } from "./ChainContractsReg
 import { Construct, ConstructOptions } from "./Construct.js";
 import { BaseContract, BaseContractArgs, ContractParseError, ContractParseErrorOptions } from "./BaseContract.js";
 import { MissingSerializedParamsError } from "./errors.js";
+import { ChainQueryProps, MultichainConstruct } from "./MultichainConstruct.js";
 import { PlaceholderContract } from "./PlaceholderContract.js";
 import { SDKConstruct } from "./SDKConstruct.js";
-export { AdapterData, AssertAssignable, Asset, BaseContract, BaseContractArgs, BaseParams, BaseState, ChainContractsRegister, ConnectedBotData, Construct, ConstructOptions, ContractOrInterface, ContractParseError, ContractParseErrorOptions, CreditAccountData, CreditAccountDataPayload, CreditConfiguratorState, CreditFacadeState, CreditManagerDebtParams, CreditManagerState, CreditSuiteState, FormatBNOptions, GaugeData, IBaseContract, LPMonopolizedPoolMeta, MarketData, MarketFilter, MissingSerializedParamsError, PHANTOM_TOKEN_CONTRACT_TYPES, ParsedCall, ParsedCallArgs, ParsedCallV2, PhantomTokenContractType, PhantomTokenMeta, PlaceholderContract, PoolState, PriceFeedAnswer, PriceFeedMapEntry, PriceFeedTreeNode, PriceOracleData, QuotaKeeperState, QuotaState, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RateKeeperState, RelaxedBaseParams, RewardInfo, SDKConstruct, SimpleTokenMeta, TokenInfo, TokenMetaData, TokensMeta, Unarray, VotingContractStatus };
+export { AdapterData, AssertAssignable, Asset, BaseContract, BaseContractArgs, BaseParams, BaseState, ChainContractsRegister, ChainQueryProps, ConnectedBotData, Construct, ConstructOptions, ContractOrInterface, ContractParseError, ContractParseErrorOptions, CreditAccountData, CreditAccountDataPayload, CreditConfiguratorState, CreditFacadeState, CreditManagerDebtParams, CreditManagerState, CreditSuiteState, FormatBNOptions, GaugeData, IBaseContract, LPMonopolizedPoolMeta, MarketData, MarketFilter, MissingSerializedParamsError, MultichainConstruct, PHANTOM_TOKEN_CONTRACT_TYPES, ParsedCall, ParsedCallArgs, ParsedCallV2, PhantomTokenContractType, PhantomTokenMeta, PlaceholderContract, PoolState, PriceFeedAnswer, PriceFeedMapEntry, PriceFeedTreeNode, PriceOracleData, QuotaKeeperState, QuotaState, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RateKeeperState, RelaxedBaseParams, RewardInfo, SDKConstruct, SimpleTokenMeta, TokenInfo, TokenMetaData, TokensMeta, Unarray, VotingContractStatus };

package/dist/types/sdk/chain/chains.d.ts

@@ -1,3 +1,4 @@
+import { AssetType } from "../../model/primitives.js";
 import { Address, Chain } from "viem";
 import { z } from "zod/v4";
 //#region src/sdk/chain/chains.d.ts
@@ -6,6 +7,14 @@ import { z } from "zod/v4";
  *
  **/
 type Curator = "Chaos Labs" | "K3" | "cp0x" | "Re7" | "Invariant Group" | "Tulipa" | "M11 Credit" | "KPK" | "Hyperithm" | "UltraYield" | "TelosC" | "Gami Labs" | "Securitize" | "Testnet Curator";
+/**
+ * One strategy of the sunset list, identified the same way a strategy
+ * opportunity is: the credit manager plus the collateral it is built around.
+ **/
+interface SunsetStrategy {
+  creditManager: Address;
+  collateral: Address;
+}
 /**
  * Extended viem {@link Chain} with Gearbox-specific metadata.
  *
@@ -29,6 +38,30 @@ interface GearboxChain extends Chain {
    * Market configurators used in test/staging environments.
    **/
   testMarketConfigurators?: Record<Address, Curator>;
+  /**
+   * Denomination class of the market underlyings on this chain.
+   *
+   * Nothing on-chain says what a token is denominated in, so this is a manually
+   * curated table. It only covers underlyings — there are few of them — and a
+   * token missing from it is simply unclassified. An RWA market's compliance
+   * wrapper does not belong here: it is unwrapped before the lookup, so the
+   * token it holds is what needs an entry.
+   **/
+  underlyingAssetTypes?: Record<Address, AssetType>;
+  /**
+   * Tokens on this chain that represent a real-world asset. A market that
+   * accepts one of them as collateral is reported as an RWA opportunity.
+   **/
+  rwaTokens?: Address[];
+  /**
+   * Pools being wound down. Curated, and unrelated to any on-chain flag.
+   **/
+  sunsetPools?: Address[];
+  /**
+   * Strategies being wound down. Curated, and unrelated to the credit facade's
+   * expiration date.
+   **/
+  sunsetStrategies?: SunsetStrategy[];
   /**
    * Whether this chain is production-ready
    **/
@@ -131,5 +164,39 @@ declare function getCuratorName(marketConfigurator: Address, network?: NetworkTy
  *   has no configurator on this network.
  **/
 declare function findCuratorMarketConfigurator(curator: Curator, network: NetworkType): Address | undefined;
+/**
+ * Looks up the {@link AssetType} of a token in hardcoded classifier.
+ * Not all tokens are classified, only underlyings, so the default answer is `undefined`.
+ *
+ * @param token - Token address
+ * @param network - Network the token lives on.
+ * @returns The asset type, or `undefined` when the token is not classified
+ **/
+declare function getAssetType(token: Address, network: NetworkType): AssetType | undefined;
+/**
+ * Checks whether a token represents a real-world asset, per the curated list of
+ * a network.
+ *
+ * @param token - Token address.
+ * @param network - Network the token lives on.
+ **/
+declare function isRWAToken(token: Address, network: NetworkType): boolean;
+/**
+ * Checks whether a pool is on the sunset list of a network.
+ *
+ * @param pool - Pool address.
+ * @param network - Network the pool lives on.
+ **/
+declare function isSunsetPool(pool: Address, network: NetworkType): boolean;
+/**
+ * Checks whether a strategy is on the sunset list of a network. Both halves of
+ * the strategy key must match: a credit manager can wind down one collateral
+ * and keep the rest.
+ *
+ * @param creditManager - Credit manager address.
+ * @param collateral - Target collateral of the strategy.
+ * @param network - Network the strategy lives on.
+ **/
+declare function isSunsetStrategy(creditManager: Address, collateral: Address, network: NetworkType): boolean;
 //#endregion
-export { Curator, GearboxChain, NetworkType, SUPPORTED_NETWORKS, chains, findCuratorMarketConfigurator, getChain, getCuratorName, getNetworkType, isPublicNetwork, isSupportedNetwork };
+export { Curator, GearboxChain, NetworkType, SUPPORTED_NETWORKS, SunsetStrategy, chains, findCuratorMarketConfigurator, getAssetType, getChain, getCuratorName, getNetworkType, isPublicNetwork, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork };

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

@@ -1,3 +1,3 @@
-import { Curator, GearboxChain, NetworkType, SUPPORTED_NETWORKS, chains, findCuratorMarketConfigurator, getChain, getCuratorName, getNetworkType, isPublicNetwork, isSupportedNetwork } from "./chains.js";
+import { Curator, GearboxChain, NetworkType, SUPPORTED_NETWORKS, SunsetStrategy, chains, findCuratorMarketConfigurator, getAssetType, getChain, getCuratorName, getNetworkType, isPublicNetwork, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork } from "./chains.js";
 import { detectNetwork } from "./detectNetwork.js";
-export { Curator, GearboxChain, NetworkType, SUPPORTED_NETWORKS, chains, detectNetwork, findCuratorMarketConfigurator, getChain, getCuratorName, getNetworkType, isPublicNetwork, isSupportedNetwork };
+export { Curator, GearboxChain, NetworkType, SUPPORTED_NETWORKS, SunsetStrategy, chains, detectNetwork, findCuratorMarketConfigurator, getAssetType, getChain, getCuratorName, getNetworkType, isPublicNetwork, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork };

package/dist/types/sdk/core/errors.d.ts

@@ -41,6 +41,15 @@ declare class SdkMissingChainStateError extends BaseError {
   name: string;
   constructor(network: NetworkType);
 }
+/**
+ * Thrown when a chain that is not configured in {@link MultichainSDK} is
+ * requested.
+ */
+declare class ChainNotConfiguredError extends BaseError {
+  name: string;
+  readonly network: NetworkType | number;
+  constructor(network: NetworkType | number);
+}
 /**
  * Thrown by {@link MultichainSDK.syncState} when one or more per-chain syncs
  * fail. Wraps the individual errors keyed by network.
@@ -51,4 +60,4 @@ declare class SdkSyncFailedError extends BaseError {
   constructor(perChainErrors: Partial<Record<NetworkType, unknown>>);
 }
 //#endregion
-export { SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError };
+export { ChainNotConfiguredError, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError };

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

@@ -1,5 +1,5 @@
 import { AddressProviderAddresses, AddressProviderState, IAddressProviderContract } from "./types.js";
 import { AddressProviderV310Contract } from "./AddressProviderV310Contract.js";
 import { createAddressProvider, hydrateAddressProvider } from "./createAddressProvider.js";
-import { SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./errors.js";
-export { AddressProviderAddresses, AddressProviderState, AddressProviderV310Contract, IAddressProviderContract, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, createAddressProvider, hydrateAddressProvider };
+import { ChainNotConfiguredError, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./errors.js";
+export { AddressProviderAddresses, AddressProviderState, AddressProviderV310Contract, ChainNotConfiguredError, IAddressProviderContract, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, createAddressProvider, hydrateAddressProvider };