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

package/dist/esm/sdk/chain/chains.js

@@ -1,5 +1,5 @@
 import { TypedObjectUtils } from "../utils/mappers.js";
-import { defineChain } from "viem";
+import { defineChain, isAddressEqual } from "viem";
 import { arbitrum, avalanche, base, berachain, bsc, etherlink, hemi, lisk, mainnet, megaeth, monad, optimism, plasma, somnia, sonic, worldchain } from "viem/chains";
 import { z } from "zod/v4";
 //#region src/sdk/chain/chains.ts
@@ -62,6 +62,19 @@ const chains = {
 			"0xa770ce584adb6491a2138da6eaec33243bdcd248": "Testnet Curator"
 		},
 		rwaFactories: [],
+		underlyingAssetTypes: {
+			"0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0": "ETH",
+			"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2": "ETH",
+			"0x18084fbA666a33d37592fA2633fD49a74DD93a88": "BTC",
+			"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48": "Stable",
+			"0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599": "BTC"
+		},
+		rwaTokens: [
+			"0x17418038ecF73BA4026c4f428547BF099706F27B",
+			"0x51C2d74017390CbBd30550179A16A1c28F7210fc",
+			"0x238a700eD6165261Cf8b2e544ba797BC11e466Ba",
+			"0x7433806912Eae67919e66aea853d46Fa0aef98A8"
+		],
 		isPublic: true,
 		wellKnownToken: {
 			address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
@@ -152,6 +165,12 @@ const chains = {
 			"0x16956912813ab9a38d95730b52a8cf53e860a7c5": "Tulipa",
 			"0x7c6ee1bf9c1eb3ee55bdbdc1e8d0317aab718e0a": "UltraYield"
 		},
+		underlyingAssetTypes: {
+			"0x3bd359C1119dA7Da1D913D1C4D2B7c461115433A": "ETH",
+			"0x754704Bc059F8C67012fEd69BC8A327a5aafb603": "Stable",
+			"0xe7cd86e13AC4309349F30B3435a9d337750fC82D": "Stable",
+			"0x00000000eFE302BEAA2b3e6e1b18d08D69a9012a": "Stable"
+		},
 		rwaFactories: [],
 		isPublic: true,
 		wellKnownToken: {
@@ -223,6 +242,7 @@ const chains = {
 		...etherlink,
 		network: "Etherlink",
 		defaultMarketConfigurators: { "0x577424f0e6f50db668cc1bc76babb87e36732291": "Re7" },
+		underlyingAssetTypes: { "0x796Ea11Fa2dD751eD01b53C372fFDB4AAa8f00F9": "Stable" },
 		rwaFactories: [],
 		isPublic: true,
 		wellKnownToken: {
@@ -269,6 +289,10 @@ const chains = {
 			"0xce1cf71a28837daaa7b92d00ca4ef2fd649c2a67": "Hyperithm",
 			"0x9655f82b585b11cee8a05576ed8efcf755cec04b": "TelosC"
 		},
+		underlyingAssetTypes: {
+			"0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb": "Stable",
+			"0x5d3a1Ff2b6BAb83b63cd9AD0787074081a52ef34": "Stable"
+		},
 		rwaFactories: [],
 		isPublic: true,
 		wellKnownToken: {
@@ -288,6 +312,10 @@ const chains = {
 		blockTime: 200,
 		network: "Somnia",
 		defaultMarketConfigurators: { "0x1ca8b92aa7233a9f8f7ba031ac45c878141adff0": "Invariant Group" },
+		underlyingAssetTypes: {
+			"0x28BEc7E30E6faee657a03e19Bf1128AaD7632A00": "Stable",
+			"0x046EDe9564A72571df6F5e44d0405360c0f4dCab": "ETH"
+		},
 		rwaFactories: [],
 		isPublic: true,
 		wellKnownToken: {
@@ -378,5 +406,49 @@ function findCuratorMarketConfigurator(curator, network) {
 	};
 	for (const [a, c] of TypedObjectUtils.entries(all)) if (c === curator) return a;
 }
+/**
+* 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
+**/
+function getAssetType(token, network) {
+	const table = chains[network].underlyingAssetTypes;
+	if (!table) return;
+	for (const [a, assetType] of TypedObjectUtils.entries(table)) if (isAddressEqual(a, token)) return assetType;
+}
+/**
+* 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.
+**/
+function isRWAToken(token, network) {
+	return !!chains[network].rwaTokens?.some((t) => isAddressEqual(t, token));
+}
+/**
+* Checks whether a pool is on the sunset list of a network.
+*
+* @param pool - Pool address.
+* @param network - Network the pool lives on.
+**/
+function isSunsetPool(pool, network) {
+	return !!chains[network].sunsetPools?.some((p) => isAddressEqual(p, pool));
+}
+/**
+* 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.
+**/
+function isSunsetStrategy(creditManager, collateral, network) {
+	return !!chains[network].sunsetStrategies?.some((s) => isAddressEqual(s.creditManager, creditManager) && isAddressEqual(s.collateral, collateral));
+}
 //#endregion
-export { NetworkType, SUPPORTED_NETWORKS, chains, findCuratorMarketConfigurator, getChain, getCuratorName, getNetworkType, isPublicNetwork, isSupportedNetwork };
+export { NetworkType, SUPPORTED_NETWORKS, chains, findCuratorMarketConfigurator, getAssetType, getChain, getCuratorName, getNetworkType, isPublicNetwork, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork };

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

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

package/dist/esm/sdk/core/errors.js

@@ -51,6 +51,18 @@ var SdkMissingChainStateError = class extends BaseError {
 	}
 };
 /**
+* Thrown when a chain that is not configured in {@link MultichainSDK} is
+* requested.
+*/
+var ChainNotConfiguredError = class extends BaseError {
+	name = "ChainNotConfiguredError";
+	network;
+	constructor(network) {
+		super(`Chain ${String(network)} is not configured in this MultichainSDK`);
+		this.network = network;
+	}
+};
+/**
 * Thrown by {@link MultichainSDK.syncState} when one or more per-chain syncs
 * fail. Wraps the individual errors keyed by network.
 */
@@ -64,4 +76,4 @@ var SdkSyncFailedError = class extends BaseError {
 	}
 };
 //#endregion
-export { SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError };
+export { ChainNotConfiguredError, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError };

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

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

package/dist/esm/sdk/index.js

@@ -3,11 +3,12 @@ import { AddressSet } from "./utils/AddressSet.js";
 import { AssetsMap } from "./utils/AssetsMap.js";
 import { json_parse, json_stringify } from "./utils/json.js";
 import { functionArgsToMap, functionArgsToRecord, getFunctionSignature } from "./utils/abi-decode.js";
+import { BigIntMath } from "./utils/bigint-math.js";
 import { bytes32ToString } from "./utils/bytes32ToString.js";
 import { childLogger } from "./utils/childLogger.js";
 import { createRawTx } from "./utils/createRawTx.js";
 import { TypedObjectUtils } from "./utils/mappers.js";
-import { NetworkType, SUPPORTED_NETWORKS, chains, findCuratorMarketConfigurator, getChain, getCuratorName, getNetworkType, isPublicNetwork, isSupportedNetwork } from "./chain/chains.js";
+import { NetworkType, SUPPORTED_NETWORKS, chains, findCuratorMarketConfigurator, getAssetType, getChain, getCuratorName, getNetworkType, isPublicNetwork, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork } from "./chain/chains.js";
 import { detectNetwork } from "./chain/detectNetwork.js";
 import "./chain/index.js";
 import { etherscanApiUrl, etherscanUrl } from "./utils/etherscan.js";
@@ -25,7 +26,7 @@ import { fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage,
 import { hexEq } from "./utils/hex.js";
 import { retry } from "./utils/retry.js";
 import { toAddress } from "./utils/toAddress.js";
-import { ZodAddress } from "./utils/zod.js";
+import { ZodAddress, ZodHex } from "./utils/zod.js";
 import "./utils/index.js";
 import { generateCastTraceCall, getCastTraceArgs } from "./utils/viem/cast.js";
 import { SimulationError, simulateCall } from "./utils/viem/simulateCall.js";
@@ -34,6 +35,8 @@ import { ChainContractsRegister } from "./base/ChainContractsRegister.js";
 import { Construct } from "./base/Construct.js";
 import { BaseContract, ContractParseError } from "./base/BaseContract.js";
 import { MissingSerializedParamsError } from "./base/errors.js";
+import { ChainNotConfiguredError, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./core/errors.js";
+import { MultichainConstruct } from "./base/MultichainConstruct.js";
 import { PlaceholderContract } from "./base/PlaceholderContract.js";
 import { SDKConstruct } from "./base/SDKConstruct.js";
 import { PHANTOM_TOKEN_CONTRACT_TYPES, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND } from "./base/token-types.js";
@@ -44,6 +47,7 @@ import { createAdapter } from "./market/adapters/createAdapter.js";
 import { CreditConfiguratorV310Contract } from "./market/credit/CreditConfiguratorV310Contract.js";
 import { CreditFacadeV310BaseContract, creditFacadeV310Abi as abi } from "./market/credit/CreditFacadeV310BaseContract.js";
 import { CreditFacadeV310Contract } from "./market/credit/CreditFacadeV310Contract.js";
+import { additionalBorrowApyBps, borrowApyBps, maxLeverage, rayToBps, usdToNumber, utilizationBps } from "./market/math.js";
 import { CreditManagerV310Contract } from "./market/credit/CreditManagerV310Contract.js";
 import { CreditSuite } from "./market/credit/CreditSuite.js";
 import { simulateMulticall } from "./utils/viem/simulateMulticall.js";
@@ -99,7 +103,7 @@ import { RWARegistry } from "./market/rwa/RWARegistry.js";
 import { RWA_FACTORY_TYPES, isRWAFactory } from "./market/rwa/types.js";
 import "./market/index.js";
 import { CreditAccountsServiceV310 } from "./accounts/CreditAccountsServiceV310.js";
-import { LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./accounts/liquidations/constants.js";
+import { DUST_THRESHOLD, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./accounts/liquidations/constants.js";
 import { LiquidationsService } from "./accounts/liquidations/LiquidationsService.js";
 import { MultichainLiquidationsService } from "./accounts/liquidations/MultichainLiquidationsService.js";
 import { DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, decodeDelayedIntent, encodeDelayedIntent } from "./accounts/withdrawal-compressor/intent-codec.js";
@@ -116,8 +120,10 @@ import { createWithdrawalCompressor } from "./accounts/withdrawal-compressor/cre
 import "./accounts/index.js";
 import { AddressProviderV310Contract } from "./core/AddressProviderV310Contract.js";
 import { createAddressProvider, hydrateAddressProvider } from "./core/createAddressProvider.js";
-import { SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./core/errors.js";
 import "./core/index.js";
+import { MultichainOpportunitiesService } from "./opportunities/MultichainOpportunitiesService.js";
+import { OpportunitiesService } from "./opportunities/OpportunitiesService.js";
+import "./opportunities/index.js";
 import { BasePlugin } from "./plugins/BasePlugin.js";
 import { PluginStateVersionError } from "./plugins/errors.js";
 import "./plugins/index.js";
@@ -131,4 +137,4 @@ import { OnchainSDK, STATE_VERSION } from "./OnchainSDK.js";
 import { MultichainSDK } from "./MultichainSDK.js";
 import { attachOptionsSchema, onchainSDKOptionsSchema } from "./options.js";
 import "./types/index.js";
-export { ADDRESS_0X0, ADDRESS_PROVIDER_V310, AP_ACCOUNT_FACTORY, AP_ACL, AP_BOT_LIST, AP_BYTECODE_REPOSITORY, AP_CONTRACTS_REGISTER, AP_CONTROLLER_TIMELOCK, AP_CREDIT_ACCOUNT_COMPRESSOR, AP_CREDIT_SUITE_COMPRESSOR, AP_DATA_COMPRESSOR, AP_DELEVERAGE_BOT_HV, AP_DELEVERAGE_BOT_LV, AP_DELEVERAGE_BOT_PEGGED, AP_GAUGE_COMPRESSOR, AP_GEAR_STAKING, AP_GEAR_TOKEN, AP_INFLATION_ATTACK_BLOCKER, AP_INSOLVENCY_CHECKER, AP_MARKET_COMPRESSOR, AP_MARKET_CONFIGURATOR, AP_PARTIAL_LIQUIDATION_BOT, AP_PERIPHERY_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR, AP_PRICE_FEED_STORE, AP_PRICE_ORACLE, AP_REDEMPTION_LOGGER, AP_REWARDS_COMPRESSOR, AP_ROUTER, AP_RWA_COMPRESSOR, AP_TOKEN_COMPRESSOR, AP_TREASURY, AP_WETH_GATEWAY, AP_WETH_TOKEN, AP_ZAPPER_REGISTER, AP_ZERO_PRICE_FEED, AbstractLPPriceFeedContract, AbstractPriceFeedContract, AbstractWithdrawalCompressorContract, AddressMap, AddressProviderV310Contract, AddressSet, AssetsMap, BLOCKS_PER_WEEK_BY_NETWORK, BalancerStablePriceFeedContract, BalancerWeightedPriceFeedContract, BaseContract, BasePlugin, BotPermissions, BoundedPriceFeedContract, ChainContractsRegister, CompositePriceFeedContract, Construct, ContractParseError, CreditAccountsServiceV310, CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, CurveCryptoPriceFeedContract, CurveStablePriceFeedContract, CurveUSDPriceFeedContract, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, Erc4626PriceFeedContract, ExternalPriceFeedContract, GaugeContract, IERC20ZapperContract, IETHZapperContract, InvalidDelayedIntentError, LEVERAGE_DECIMALS, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LinearInterestRateModelContract, LiquidationsService, MAX_INT, MAX_UINT16, MAX_UINT256, MIN_INT96, MULTICALL_ADDRESS, MarketRegister, MarketSuite, MellowLRTPriceFeedContract, MidasLiquidatorContract, MissingSerializedParamsError, MultichainLiquidationsService, MultichainSDK, NATIVE_ADDRESS, NOT_DEPLOYED, NO_VERSION, NetworkType, OnchainSDK, PERCENTAGE_DECIMALS, PERCENTAGE_FACTOR, PERCENTAGE_FACTOR_1KK, PERIPHERY_CONTRACTS, PHANTOM_TOKEN_CONTRACT_TYPES, PHANTOM_TOKEN_MIDAS_REDEMPTION, PHANTOM_TOKEN_SECURITIZE_REDEMPTION, PRICE_DECIMALS, PRICE_DECIMALS_POW, PartialPriceFeedInitError, PendleTWAPPTPriceFeed, PlaceholderAdapterContract, PlaceholderContract, PluginStateVersionError, PoolService, PoolSuite, PoolV310Contract, PriceFeedRef, PriceFeedRegister, PriceOracleV310Contract, PythPriceFeed, RAMP_DURATION_BY_NETWORK, RAY, RAY_DECIMALS_POW, RWARegistry, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_LIQUIDATOR_MIDAS, RWA_LIQUIDATOR_SECURITIZE, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RedemptionLoggerV310Contract, RedstonePriceFeedContract, RouterV310Contract, SDKConstruct, SECONDS_PER_YEAR, SECURITIZE_REGISTER_VAULT_TYPES, SLIPPAGE_DECIMALS, STATE_VERSION, SUPPORTED_NETWORKS, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, SecuritizeLiquidatorContract, SecuritizeRWAFactory, SimulateWithPriceUpdatesError, SimulationError, TokensMeta, TypedObjectUtils, UnsupportedZapperFunctionError, VERSION_RANGE_310, VotingContractStatus, WAD, WAD_DECIMALS_POW, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WstETHPriceFeedContract, YearnPriceFeedContract, ZapperContract, ZeroPriceFeedContract, ZodAddress, assetsMap, attachOptionsSchema, botPermissionsToString, bytes32ToString, chains, childLogger, createAdapter, createAddressProvider, createPriceOracle, createRawTx, createRedemptionLogger, createRouter, createWithdrawalCompressor, createZapper, abi as creditFacadeV310Abi, decodeDelayedIntent, detectNetwork, encodeDelayedIntent, estimateRawTxGas, etherscanApiUrl, etherscanUrl, executeDelegatedMulticalls, fetchPythPayloads, fetchRedstonePayloads, filterDust, filterDustUSD, findCuratorMarketConfigurator, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, generateCastTraceCall, getCastTraceArgs, getChain, getCuratorName, getFunctionSignature, getNetworkType, getRawPriceUpdates, getSimulateWithPriceUpdatesError, getWithdrawalCompressorAddress, halfRAY, hexEq, hydrateAddressProvider, iCreditAccountAbi, isDust, isLPPriceFeed, isPublicNetwork, isRWAFactory, isSupportedNetwork, isUpdatablePriceFeed, isV310, isVersionRange, json_parse, json_stringify, numberWithCommas, onchainSDKOptionsSchema, percentFmt, rayToNumber, retry, sendRawTx, shortAddress, shortHash, simulateCall, simulateMulticall, simulateWithPriceUpdates, toAddress, toBN, toBigInt, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toSignificant, toWithdrawalStatus, watchBlocksAsync };
+export { ADDRESS_0X0, ADDRESS_PROVIDER_V310, AP_ACCOUNT_FACTORY, AP_ACL, AP_BOT_LIST, AP_BYTECODE_REPOSITORY, AP_CONTRACTS_REGISTER, AP_CONTROLLER_TIMELOCK, AP_CREDIT_ACCOUNT_COMPRESSOR, AP_CREDIT_SUITE_COMPRESSOR, AP_DATA_COMPRESSOR, AP_DELEVERAGE_BOT_HV, AP_DELEVERAGE_BOT_LV, AP_DELEVERAGE_BOT_PEGGED, AP_GAUGE_COMPRESSOR, AP_GEAR_STAKING, AP_GEAR_TOKEN, AP_INFLATION_ATTACK_BLOCKER, AP_INSOLVENCY_CHECKER, AP_MARKET_COMPRESSOR, AP_MARKET_CONFIGURATOR, AP_PARTIAL_LIQUIDATION_BOT, AP_PERIPHERY_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR, AP_PRICE_FEED_STORE, AP_PRICE_ORACLE, AP_REDEMPTION_LOGGER, AP_REWARDS_COMPRESSOR, AP_ROUTER, AP_RWA_COMPRESSOR, AP_TOKEN_COMPRESSOR, AP_TREASURY, AP_WETH_GATEWAY, AP_WETH_TOKEN, AP_ZAPPER_REGISTER, AP_ZERO_PRICE_FEED, AbstractLPPriceFeedContract, AbstractPriceFeedContract, AbstractWithdrawalCompressorContract, AddressMap, AddressProviderV310Contract, AddressSet, AssetsMap, BLOCKS_PER_WEEK_BY_NETWORK, BalancerStablePriceFeedContract, BalancerWeightedPriceFeedContract, BaseContract, BasePlugin, BigIntMath, BotPermissions, BoundedPriceFeedContract, ChainContractsRegister, ChainNotConfiguredError, CompositePriceFeedContract, Construct, ContractParseError, CreditAccountsServiceV310, CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, CurveCryptoPriceFeedContract, CurveStablePriceFeedContract, CurveUSDPriceFeedContract, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, Erc4626PriceFeedContract, ExternalPriceFeedContract, GaugeContract, IERC20ZapperContract, IETHZapperContract, InvalidDelayedIntentError, LEVERAGE_DECIMALS, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LinearInterestRateModelContract, LiquidationsService, MAX_INT, MAX_UINT16, MAX_UINT256, MIN_INT96, MULTICALL_ADDRESS, MarketRegister, MarketSuite, MellowLRTPriceFeedContract, MidasLiquidatorContract, MissingSerializedParamsError, MultichainConstruct, MultichainLiquidationsService, MultichainOpportunitiesService, MultichainSDK, NATIVE_ADDRESS, NOT_DEPLOYED, NO_VERSION, NetworkType, OnchainSDK, OpportunitiesService, PERCENTAGE_DECIMALS, PERCENTAGE_FACTOR, PERCENTAGE_FACTOR_1KK, PERIPHERY_CONTRACTS, PHANTOM_TOKEN_CONTRACT_TYPES, PHANTOM_TOKEN_MIDAS_REDEMPTION, PHANTOM_TOKEN_SECURITIZE_REDEMPTION, PRICE_DECIMALS, PRICE_DECIMALS_POW, PartialPriceFeedInitError, PendleTWAPPTPriceFeed, PlaceholderAdapterContract, PlaceholderContract, PluginStateVersionError, PoolService, PoolSuite, PoolV310Contract, PriceFeedRef, PriceFeedRegister, PriceOracleV310Contract, PythPriceFeed, RAMP_DURATION_BY_NETWORK, RAY, RAY_DECIMALS_POW, RWARegistry, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_LIQUIDATOR_MIDAS, RWA_LIQUIDATOR_SECURITIZE, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RedemptionLoggerV310Contract, RedstonePriceFeedContract, RouterV310Contract, SDKConstruct, SECONDS_PER_YEAR, SECURITIZE_REGISTER_VAULT_TYPES, SLIPPAGE_DECIMALS, STATE_VERSION, SUPPORTED_NETWORKS, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, SecuritizeLiquidatorContract, SecuritizeRWAFactory, SimulateWithPriceUpdatesError, SimulationError, TokensMeta, TypedObjectUtils, UnsupportedZapperFunctionError, VERSION_RANGE_310, VotingContractStatus, WAD, WAD_DECIMALS_POW, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WstETHPriceFeedContract, YearnPriceFeedContract, ZapperContract, ZeroPriceFeedContract, ZodAddress, ZodHex, additionalBorrowApyBps, assetsMap, attachOptionsSchema, borrowApyBps, botPermissionsToString, bytes32ToString, chains, childLogger, createAdapter, createAddressProvider, createPriceOracle, createRawTx, createRedemptionLogger, createRouter, createWithdrawalCompressor, createZapper, abi as creditFacadeV310Abi, decodeDelayedIntent, detectNetwork, encodeDelayedIntent, estimateRawTxGas, etherscanApiUrl, etherscanUrl, executeDelegatedMulticalls, fetchPythPayloads, fetchRedstonePayloads, filterDust, filterDustUSD, findCuratorMarketConfigurator, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, generateCastTraceCall, getAssetType, getCastTraceArgs, getChain, getCuratorName, getFunctionSignature, getNetworkType, getRawPriceUpdates, getSimulateWithPriceUpdatesError, getWithdrawalCompressorAddress, halfRAY, hexEq, hydrateAddressProvider, iCreditAccountAbi, isDust, isLPPriceFeed, isPublicNetwork, isRWAFactory, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork, isUpdatablePriceFeed, isV310, isVersionRange, json_parse, json_stringify, maxLeverage, numberWithCommas, onchainSDKOptionsSchema, percentFmt, rayToBps, rayToNumber, retry, sendRawTx, shortAddress, shortHash, simulateCall, simulateMulticall, simulateWithPriceUpdates, toAddress, toBN, toBigInt, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toSignificant, toWithdrawalStatus, usdToNumber, utilizationBps, watchBlocksAsync };

package/dist/esm/sdk/market/MarketConfiguratorContract.js

@@ -1,4 +1,5 @@
 import { iMarketConfiguratorV310Abi } from "../../abi/310/generated.js";
+import { getCuratorName } from "../chain/chains.js";
 import { AP_MARKET_CONFIGURATOR } from "../constants/address-provider.js";
 import "../constants/index.js";
 import { BaseContract } from "../base/BaseContract.js";
@@ -24,6 +25,19 @@ var MarketConfiguratorContract = class extends BaseContract {
 		});
 		this.register.setAddressLabel(this.address, `Market configurator ${this.#curatorName}`);
 	}
+	/**
+	* The entity operating this configurator, as the shared read model describes
+	* it. The curated per-chain table wins over the name the contract reports,
+	* because the two sources must agree across services and only the table is
+	* shared with the backend.
+	*/
+	get curator() {
+		return {
+			address: this.address,
+			name: getCuratorName(this.address, this.networkType) ?? this.#curatorName ?? "Unknown",
+			url: null
+		};
+	}
 	static async getPeripheryContractBatch(configurators, client, contract, blockNumber) {
 		return await client.multicall({
 			allowFailure: true,

package/dist/esm/sdk/market/MarketSuite.js

@@ -1,14 +1,20 @@
+import { AddressMap } from "../utils/AddressMap.js";
+import { isRWAToken, isSunsetPool } from "../chain/chains.js";
+import "../utils/index.js";
 import { SDKConstruct } from "../base/SDKConstruct.js";
 import "../base/index.js";
 import { CreditSuite } from "./credit/CreditSuite.js";
 import "./credit/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
+import { matchesOpportunityFilter } from "../../model/opportunities.js";
+import "../../model/index.js";
 import { createLossPolicy } from "./loss-policy/createLossPolicy.js";
 import "./loss-policy/index.js";
 import { createPriceOracle } from "./oracle/createPriceOracle.js";
 import "./oracle/index.js";
 import { PoolSuite } from "./pool/PoolSuite.js";
 import "./pool/index.js";
+import { isAddressEqual } from "viem";
 //#region src/sdk/market/MarketSuite.ts
 /**
 * Aggregates all SDK wrappers that make up one Gearbox market.
@@ -100,6 +106,163 @@ var MarketSuite = class extends SDKConstruct {
 		return this.pool.rwaFactory;
 	}
 	/**
+	* {@inheritDoc IPoolContract.unwrappedUnderlying}
+	*/
+	get unwrappedUnderlying() {
+		return this.pool.unwrappedUnderlying;
+	}
+	/**
+	* The market's underlying as the shared read model describes it.
+	*
+	* For an RWA market this is the token the underlying wraps rather than the
+	* wrapper itself, because only that token means anything to a reader. The
+	* wrapper converts one-for-one, so amounts denominated in it stay exact.
+	*/
+	get underlyingToken() {
+		return this.tokensMeta.mustGetToken(this.unwrappedUnderlying);
+	}
+	/**
+	* {@inheritDoc MarketConfiguratorContract.curator}
+	*/
+	get curator() {
+		return this.configurator.curator;
+	}
+	/**
+	* Every `(credit suite, collateral)` pair of this market that qualifies as a
+	* leveraged position.
+	*/
+	get strategies() {
+		return this.creditManagers.flatMap((suite) => suite.strategyCollaterals.map((collateral) => ({
+			suite,
+			collateral
+		})));
+	}
+	/**
+	* Tokens a position can actually be built on in this market, deduplicated
+	* across its credit suites.
+	*/
+	get collateralTokens() {
+		const seen = new AddressMap(void 0, "collateralTokens");
+		for (const { collateral } of this.strategies) seen.upsert(collateral, this.tokensMeta.mustGetToken(collateral));
+		return seen.values();
+	}
+	/**
+	* Whether at least one of {@link collateralTokens} is a real-world-asset
+	* token. Read from a hardcoded per-chain list rather than from the chain.
+	*/
+	get rwa() {
+		return this.strategies.some(({ collateral }) => isRWAToken(collateral, this.sdk.networkType));
+	}
+	/**
+	* Whether this market's pool is being wound down and should no longer be
+	* entered. Read from a hardcoded per-chain list.
+	*/
+	get sunset() {
+		return isSunsetPool(this.pool.pool.address, this.sdk.networkType);
+	}
+	/**
+	* Quota configuration of every token the market quotes: how much of it the
+	* market accepts in total, and what holding it costs.
+	*/
+	quotaAssets() {
+		const oracle = this.priceOracle;
+		const { underlying } = this;
+		return this.pool.pqk.quotas.entries().map(([token, quota]) => ({
+			token: this.tokensMeta.mustGetToken(token),
+			quotaRate: quota.rate,
+			limit: oracle.toAmount(underlying, quota.limit),
+			used: oracle.toAmount(underlying, quota.totalQuoted)
+		}));
+	}
+	/**
+	* Prices and feeds of a collateral token and the market's underlying.
+	*
+	* Pricing goes through the wrapper for an RWA market, since that is what the
+	* market's oracle knows.
+	*
+	* @param collateral - Collateral token to price.
+	*/
+	priceFeedSummary(collateral) {
+		return this.priceOracle.priceFeedSummary(this.underlying, collateral);
+	}
+	/**
+	* Every opportunity this market offers: its pool, plus one row per
+	* `(credit manager, target collateral)` pair.
+	*
+	* @param totals - Resolves the summed worth of the credit accounts backing a
+	* strategy, which only a credit-account query can establish.
+	* @param filter - Optional narrowing. A filter naming a kind skips building
+	* the other kind entirely; every built row is then checked in full by
+	* {@link matchesOpportunityFilter}, so there is one definition of what each
+	* criterion means.
+	*/
+	opportunities(totals, filter) {
+		const rows = [];
+		if (filter?.kind !== "strategy") rows.push(this.poolOpportunity());
+		if (filter?.kind !== "pool") for (const { suite, collateral } of this.strategies) rows.push(suite.strategyOpportunity(collateral, totals(suite.creditManager.address, collateral)));
+		return rows.filter((row) => matchesOpportunityFilter(row, filter));
+	}
+	/**
+	* Passive lending into this market's pool, as the shared read model
+	* describes it.
+	*/
+	poolOpportunity() {
+		const { pool } = this.pool;
+		const oracle = this.priceOracle;
+		return {
+			kind: "pool",
+			chainId: this.chainId,
+			pool: pool.address,
+			title: `${this.underlyingToken.symbol} Pool`,
+			curator: this.curator,
+			underlyingToken: this.underlyingToken,
+			totalSupply: {
+				value: pool.totalSupply,
+				valueUsd: oracle.safeUsdValue(pool.underlying, pool.totalAssets)
+			},
+			totalBorrow: oracle.toAmount(pool.underlying, pool.totalBorrowed),
+			utilization: pool.utilization,
+			collateralTokens: this.collateralTokens,
+			paused: pool.isPaused,
+			rwa: this.rwa,
+			sunset: this.sunset
+		};
+	}
+	/**
+	* {@link poolOpportunity} plus the data only its detail screen needs.
+	*/
+	poolOpportunityDetail() {
+		return {
+			...this.poolOpportunity(),
+			rateCurve: this.pool.rateCurve,
+			quotaAssets: this.quotaAssets()
+		};
+	}
+	/**
+	* Resolves a strategy of this market by its two halves.
+	*
+	* @param creditManager - Credit manager the position is opened in.
+	* @param collateral - Target collateral of the position.
+	* @throws If this market has no such credit manager, or if that manager does
+	* not accept the collateral as a strategy.
+	*/
+	mustFindStrategy(creditManager, collateral) {
+		const strategy = this.strategies.find((s) => isAddressEqual(s.suite.creditManager.address, creditManager) && isAddressEqual(s.collateral, collateral));
+		if (!strategy) throw new Error(`${this.labelAddress(collateral)} is not a strategy collateral of credit manager ${this.labelAddress(creditManager)}`);
+		return strategy;
+	}
+	/**
+	* Detailed view of one leveraged position of this market.
+	*
+	* @param creditManager - Credit manager the position is opened in.
+	* @param collateral - Target collateral of the position.
+	* @param totalSupply - Summed worth of the credit accounts backing it.
+	* @throws If this market has no such strategy, see {@link mustFindStrategy}.
+	*/
+	strategyOpportunityDetail(creditManager, collateral, totalSupply) {
+		return this.mustFindStrategy(creditManager, collateral).suite.strategyOpportunityDetail(collateral, totalSupply);
+	}
+	/**
 	* Whether any child contract wrapper has observed events that require a
 	* market resync.
 	*/

package/dist/esm/sdk/market/credit/CreditManagerV310Contract.js

@@ -1,11 +1,15 @@
 import { iCreditManagerV310Abi } from "../../../abi/310/generated.js";
 import { AddressMap } from "../../utils/AddressMap.js";
+import { PERCENTAGE_FACTOR } from "../../constants/math.js";
+import "../../constants/index.js";
 import { fmtBinaryMask, percentFmt } from "../../utils/formatter.js";
 import "../../utils/index.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
 import { createAdapter } from "../adapters/createAdapter.js";
 import "../adapters/index.js";
+import { maxLeverage } from "../math.js";
+import { isAddressEqual } from "viem";
 //#region src/sdk/market/credit/CreditManagerV310Contract.ts
 const abi = iCreditManagerV310Abi;
 var CreditManagerV310Contract = class extends BaseContract {
@@ -59,6 +63,28 @@ var CreditManagerV310Contract = class extends BaseContract {
 	get collateralTokens() {
 		return this.liquidationThresholds.keys();
 	}
+	/**
+	* {@inheritDoc ICreditManagerContract.leverageableCollaterals}
+	*/
+	get leverageableCollaterals() {
+		return this.collateralTokens.filter((token) => {
+			if (isAddressEqual(token, this.underlying)) return false;
+			const lt = this.liquidationThresholds.get(token);
+			return !!lt && lt > 0 && lt < Number(10000n);
+		});
+	}
+	/**
+	* {@inheritDoc ICreditManagerContract.maxLeverage}
+	*/
+	maxLeverage(collateral) {
+		return maxLeverage(this.liquidationThresholds.mustGet(collateral));
+	}
+	/**
+	* {@inheritDoc ICreditManagerContract.liquidationPremium}
+	*/
+	get liquidationPremium() {
+		return Number(PERCENTAGE_FACTOR) - this.liquidationDiscount;
+	}
 	processLog(log) {
 		switch (log.eventName) {
 			case "SetCreditConfigurator": this.dirty = true;

package/dist/esm/sdk/market/credit/CreditSuite.js

@@ -1,5 +1,10 @@
+import { BigIntMath } from "../../utils/bigint-math.js";
+import { isSunsetStrategy } from "../../chain/chains.js";
+import "../../constants/math.js";
+import "../../constants/index.js";
 import { SDKConstruct } from "../../base/SDKConstruct.js";
 import "../../base/index.js";
+import { additionalBorrowApyBps, borrowApyBps, utilizationBps } from "../math.js";
 import createCreditConfigurator from "./createCreditConfigurator.js";
 import createCreditFacade from "./createCreditFacade.js";
 import createCreditManager from "./createCreditManager.js";
@@ -98,6 +103,103 @@ var CreditSuite = class extends SDKConstruct {
 		return this.creditFacade.expirable && this.creditFacade.expirationDate > 0 && this.creditFacade.expirationDate < this.sdk.timestamp;
 	}
 	/**
+	* Moment the facade expires, after which positions can no longer be opened
+	* and open ones become liquidatable, or `null` when it is not expirable.
+	*
+	* @remarks
+	* The facade stores `0` for a non-expirable suite, which as a timestamp
+	* would read as 1970 rather than as "never".
+	*/
+	get expirationDate() {
+		const { expirationDate } = this.creditFacade;
+		return expirationDate > 0 ? expirationDate : null;
+	}
+	/**
+	* Whether this suite can be used right now. A paused pool blocks borrowing,
+	* so the suite is unusable even when its own facade is live.
+	*/
+	get isPaused() {
+		return this.creditFacade.isPaused || this.market.pool.isPaused;
+	}
+	/**
+	* Collateral tokens a leveraged position can be built around in this suite:
+	* the ones the credit manager can lever up, narrowed to those the market
+	* still accepts quota for.
+	*/
+	get strategyCollaterals() {
+		const { pqk } = this.market.pool;
+		return this.creditManager.leverageableCollaterals.filter((token) => pqk.hasActiveQuota(token));
+	}
+	/**
+	* Largest debt a single new position can take on right now: the tightest of
+	* this manager's remaining debt limit, the pool's free liquidity and the
+	* facade's per-account maximum.
+	*/
+	get maxBorrowAmount() {
+		const { pool } = this.market.pool;
+		const debtParams = pool.creditManagerDebtParams.get(this.creditManager.address);
+		return BigIntMath.min(debtParams?.available ?? 115792089237316195423570985008687907853269984665640564039457584007913129639935n, pool.availableLiquidity, this.creditFacade.maxDebt);
+	}
+	/**
+	* Describes a leveraged position built on one collateral token as the shared
+	* read model does.
+	*
+	* @param collateral - Target collateral of the position.
+	* @param totalSupply - Summed worth of the credit accounts backing it, which
+	* only a credit-account query can establish. Defaults to zero, so a caller
+	* that does not care about size can omit it.
+	* @throws If the credit manager does not value the collateral.
+	*/
+	strategyOpportunity(collateral, totalSupply_) {
+		const totalSupply = totalSupply_ ?? {
+			value: 0n,
+			valueUsd: 0
+		};
+		const { market, creditManager: cm } = this;
+		const { pool } = market.pool;
+		const oracle = market.priceOracle;
+		const liquidationThreshold = cm.liquidationThresholds.mustGet(collateral);
+		const maxLeverage = cm.maxLeverage(collateral);
+		const borrowed = pool.creditManagerDebtParams.get(cm.address)?.borrowed ?? 0n;
+		return {
+			kind: "strategy",
+			chainId: this.chainId,
+			creditManager: cm.address,
+			targetCollateral: this.tokensMeta.mustGetToken(collateral),
+			title: `${this.tokensMeta.symbol(collateral)} / ${market.underlyingToken.symbol}`,
+			curator: market.curator,
+			underlyingToken: market.underlyingToken,
+			totalSupply,
+			totalBorrow: oracle.toAmount(pool.underlying, borrowed),
+			utilization: utilizationBps(borrowed, totalSupply.value),
+			collateralTokens: market.collateralTokens,
+			paused: this.isPaused,
+			rwa: market.rwa,
+			sunset: isSunsetStrategy(cm.address, collateral, this.sdk.networkType),
+			liquidationThreshold,
+			liquidationPremium: cm.liquidationPremium,
+			liquidationFee: cm.feeLiquidation,
+			expirationDate: this.expirationDate,
+			borrowApy: borrowApyBps(pool.baseInterestRate, cm.feeInterest),
+			additionalBorrowApy: additionalBorrowApyBps(market.pool.pqk.quotaRate(collateral), maxLeverage),
+			maxBorrowAmount: oracle.toAmount(pool.underlying, this.maxBorrowAmount),
+			maxLeverage
+		};
+	}
+	/**
+	* {@link strategyOpportunity} plus the data only its detail screen needs.
+	*
+	* @param collateral - Target collateral of the position.
+	* @param totalSupply - Summed worth of the credit accounts backing it.
+	*/
+	strategyOpportunityDetail(collateral, totalSupply) {
+		return {
+			...this.strategyOpportunity(collateral, totalSupply),
+			rateCurve: this.market.pool.rateCurve,
+			priceFeeds: this.market.priceFeedSummary(collateral)
+		};
+	}
+	/**
 	* Whether the facade, manager, or configurator has observed logs that require
 	* a credit-suite resync.
 	*/