@gearbox-protocol/sdk 15.1.0-next.1 → 15.1.0-next.10

package/dist/cjs/sdk/market/index.js

@@ -5,8 +5,10 @@ require("./adapters/index.js");
 const require_sdk_market_credit_CreditConfiguratorV310Contract = require("./credit/CreditConfiguratorV310Contract.js");
 const require_sdk_market_credit_CreditFacadeV310BaseContract = require("./credit/CreditFacadeV310BaseContract.js");
 const require_sdk_market_credit_CreditFacadeV310Contract = require("./credit/CreditFacadeV310Contract.js");
+const require_sdk_market_math = require("./math.js");
 const require_sdk_market_credit_CreditManagerV310Contract = require("./credit/CreditManagerV310Contract.js");
 const require_sdk_market_credit_dominantCollateral = require("./credit/dominantCollateral.js");
+const require_sdk_market_credit_isStrategyCollateral = require("./credit/isStrategyCollateral.js");
 const require_sdk_market_credit_CreditSuite = require("./credit/CreditSuite.js");
 const require_sdk_market_credit_expectedBalanceDeltas = require("./credit/expectedBalanceDeltas.js");
 require("./credit/index.js");
@@ -80,10 +82,13 @@ exports.GaugeContract = require_sdk_market_pool_GaugeContract.GaugeContract;
 exports.IERC20ZapperContract = require_sdk_market_zapper_IERC20ZapperContract.IERC20ZapperContract;
 exports.IETHZapperContract = require_sdk_market_zapper_IETHZapperContract.IETHZapperContract;
 exports.LinearInterestRateModelContract = require_sdk_market_pool_LinearInterestRateModelContract.LinearInterestRateModelContract;
+exports.MAX_LEVERAGE_BUFFER_BPS = require_sdk_market_math.MAX_LEVERAGE_BUFFER_BPS;
 exports.MarketRegister = require_sdk_market_MarketRegister.MarketRegister;
 exports.MarketSuite = require_sdk_market_MarketSuite.MarketSuite;
 exports.MellowLRTPriceFeedContract = require_sdk_market_pricefeeds_MellowLRTPriceFeed.MellowLRTPriceFeedContract;
 exports.MidasLiquidatorContract = require_sdk_market_rwa_midas_MidasLiquidatorContract.MidasLiquidatorContract;
+exports.NON_STRATEGY_PHANTOM_TOKEN_TYPES = require_sdk_market_credit_isStrategyCollateral.NON_STRATEGY_PHANTOM_TOKEN_TYPES;
+exports.PARTIAL_LIQUIDATION_BUFFER_BPS = require_sdk_market_math.PARTIAL_LIQUIDATION_BUFFER_BPS;
 exports.PHANTOM_TOKEN_MIDAS_REDEMPTION = require_sdk_market_rwa_midas_constants.PHANTOM_TOKEN_MIDAS_REDEMPTION;
 exports.PHANTOM_TOKEN_SECURITIZE_REDEMPTION = require_sdk_market_rwa_securitize_constants.PHANTOM_TOKEN_SECURITIZE_REDEMPTION;
 exports.PartialPriceFeedInitError = require_sdk_market_pricefeeds_AbstractPriceFeed.PartialPriceFeedInitError;
@@ -109,6 +114,11 @@ exports.WstETHPriceFeedContract = require_sdk_market_pricefeeds_WstETHPriceFeed.
 exports.YearnPriceFeedContract = require_sdk_market_pricefeeds_YearnPriceFeed.YearnPriceFeedContract;
 exports.ZapperContract = require_sdk_market_zapper_ZapperContract.ZapperContract;
 exports.ZeroPriceFeedContract = require_sdk_market_pricefeeds_ZeroPriceFeed.ZeroPriceFeedContract;
+exports.calcAdditionalBorrowApy = require_sdk_market_math.calcAdditionalBorrowApy;
+exports.calcBorrowApy = require_sdk_market_math.calcBorrowApy;
+exports.calcMaxLeverage = require_sdk_market_math.calcMaxLeverage;
+exports.calcPositionLeverage = require_sdk_market_math.calcPositionLeverage;
+exports.calcUtilization = require_sdk_market_math.calcUtilization;
 exports.createAdapter = require_sdk_market_adapters_createAdapter.createAdapter;
 exports.createPriceOracle = require_sdk_market_oracle_createPriceOracle.createPriceOracle;
 exports.createZapper = require_sdk_market_zapper_createZapper.createZapper;
@@ -117,7 +127,14 @@ exports.dominantCollateral = require_sdk_market_credit_dominantCollateral.domina
 exports.expectedBalanceDeltas = require_sdk_market_credit_expectedBalanceDeltas.expectedBalanceDeltas;
 exports.fetchRedstonePayloads = require_sdk_market_pricefeeds_updates_fetchRedstonePayloads.fetchRedstonePayloads;
 exports.getRawPriceUpdates = require_sdk_market_pricefeeds_getRawPriceUpdates.getRawPriceUpdates;
+exports.healthFactorBps = require_sdk_market_math.healthFactorBps;
 exports.isLPPriceFeed = require_sdk_market_pricefeeds_AbstractLPPriceFeed.isLPPriceFeed;
 exports.isRWAFactory = require_sdk_market_rwa_types.isRWAFactory;
+exports.isStrategyCollateral = require_sdk_market_credit_isStrategyCollateral.isStrategyCollateral;
 exports.isUpdatablePriceFeed = require_sdk_market_pricefeeds_isUpdatablePriceFeed.isUpdatablePriceFeed;
+exports.minSeizedAmount = require_sdk_market_math.minSeizedAmount;
 exports.mustGetDominantCollateral = require_sdk_market_credit_dominantCollateral.mustGetDominantCollateral;
+exports.optimalHFForPartialLiquidation = require_sdk_market_math.optimalHFForPartialLiquidation;
+exports.optimalRepaidAmount = require_sdk_market_math.optimalRepaidAmount;
+exports.rayToBps = require_sdk_market_math.rayToBps;
+exports.usdToNumber = require_sdk_market_math.usdToNumber;

package/dist/cjs/sdk/market/math.js

@@ -16,7 +16,8 @@ const FULL = Number(require_sdk_constants_math.PERCENTAGE_FACTOR);
 *
 * @example
 * ```ts
-* rayToBps(50_000_000_000_000_000_000_000_000n) // 500, i.e. 5%
+* // ray: 5% (0.05 × 10²⁷)
+* rayToBps(50_000_000_000_000_000_000_000_000n) // 500 bps = 5%
 * ```
 **/
 function rayToBps(ray) {
@@ -27,6 +28,7 @@ function rayToBps(ray) {
 *
 * @example
 * ```ts
+* // usd: $1500.50 in 8-decimal fixed point
 * usdToNumber(150_050_000_000n) // 1500.5
 * ```
 **/
@@ -39,56 +41,66 @@ function usdToNumber(usd) {
 *
 * @example
 * ```ts
-* utilizationBps(750n, 1000n) // 7500, i.e. 75%
+* // borrowed: 750, total: 1000
+* calcUtilization(750n, 1000n) // 750 / 1000 = 7500 bps = 75%
 * ```
 **/
-function utilizationBps(borrowed, total) {
+function calcUtilization(borrowed, total) {
 	if (total <= 0n || borrowed <= 0n) return 0;
 	const utilization = Number(borrowed * require_sdk_constants_math.PERCENTAGE_FACTOR / total);
 	return Math.min(utilization, FULL);
 }
 /**
-* Annual cost of debt for a credit manager, in basis points: the pool's base
-* rate plus the protocol's cut of the accrued interest.
+* Annual cost of debt for a credit manager, in basis points:
+* `baseInterestRate × (1 + feeInterest)` — the pool's base rate plus the
+* protocol's cut of the accrued interest.
 *
 * @param baseInterestRate - Pool base rate in ray.
 * @param feeInterest - Credit manager interest fee in basis points.
 *
 * @example
 * ```ts
-* // 5% base rate, 50% interest fee
-* borrowApyBps(50_000_000_000_000_000_000_000_000n, 5000) // 750, i.e. 7.5%
+* // baseInterestRate: 5% in ray, feeInterest: 5000 bps = 50%
+* calcBorrowApy(50_000_000_000_000_000_000_000_000n, 5000) // 5% × 1.5 = 750 bps = 7.5%
 * ```
 **/
-function borrowApyBps(baseInterestRate, feeInterest) {
+function calcBorrowApy(baseInterestRate, feeInterest) {
 	return rayToBps(baseInterestRate * (require_sdk_constants_math.PERCENTAGE_FACTOR + BigInt(feeInterest)) / require_sdk_constants_math.PERCENTAGE_FACTOR);
 }
 /**
-* Highest leverage a liquidation threshold allows: `1 / (1 - lt)`.
-*
-* A threshold of 100% or more would allow unbounded leverage; such tokens are
-* not strategies and are filtered out before this is called, so the guard here
-* only exists to keep the function total.
+* 5% safety margin subtracted from 100% in {@link calcMaxLeverage}, so a
+* maxed position opens with HF slightly above 1.
+**/
+const MAX_LEVERAGE_BUFFER_BPS = 500;
+/**
+* Highest total-value leverage a liquidation threshold allows:
+* `(100% − buffer) / (100% − liquidationThreshold)`. At HF = 1, debt is
+* `liquidationThreshold × totalValue`, leaving `1 − liquidationThreshold` of
+* equity per unit of exposure; the {@link MAX_LEVERAGE_BUFFER_BPS} buffer
+* keeps the maxed position slightly away from that boundary.
 *
 * @example
 * ```ts
-* maxLeverage(9000) // 10
-* maxLeverage(8000) // 5
+* // liquidationThreshold: 9000 bps = 90%
+* calcMaxLeverage(9000) // (1 − 0.05) / (1 − 0.9) = 9.5x total exposure
 * ```
 **/
-function maxLeverage(liquidationThreshold) {
-	const equity = FULL - liquidationThreshold;
-	return equity > 0 ? FULL / equity : Number.POSITIVE_INFINITY;
+function calcMaxLeverage(liquidationThreshold) {
+	if (liquidationThreshold >= FULL) return 0;
+	const leverage = (FULL - 500) / (FULL - liquidationThreshold);
+	return Math.max(leverage, 1);
 }
 /**
 * Converts a credit account's health factor from the 18-decimal fixed point the
 * contracts store to basis points.
 *
-* An account with no debt return MAX_UINT256 from contract, here we return 0
+* Accounts with no debt store `MAX_UINT256` on-chain; for those this
+* returns `0`.
 *
 * @example
 * ```ts
-* healthFactorBps(1_250_000_000_000_000_000n) // 12500, i.e. 1.25
+* // healthFactor: 1.25 in 18-decimal fixed point
+* healthFactorBps(1_250_000_000_000_000_000n) // 12500 bps = 1.25
 * ```
 **/
 function healthFactorBps(healthFactor) {
@@ -96,39 +108,39 @@ function healthFactorBps(healthFactor) {
 	return Number(healthFactor * require_sdk_constants_math.PERCENTAGE_FACTOR / require_sdk_constants_math.WAD);
 }
 /**
-* Leverage of an open position: `totalDebt / equity`, where equity is what is
-* left of the position's value once its debt is repaid.
-*
-* Returns `0` for a position that carries no debt and for one that is
-* underwater, where there is no equity to lever.
+* Total-value leverage of an open position:
+* `totalValue / (totalValue − totalDebt)`. `1` when unleveraged, `0` when
+* underwater.
 *
-* @param totalDebt - Debt principal plus accrued interest and fees.
-* @param totalValue - Total value of the position, in the same token.
+* @param totalValue - Total value of the position.
+* @param totalDebt - Debt principal plus accrued interest and fees, same token.
 *
 * @example
 * ```ts
-* positionLeverage(800n, 1000n) // 4, i.e. 4x debt per unit of equity
+* // totalValue: 100k, totalDebt: 80k → equity: 100k − 80k = 20k
+* calcPositionLeverage(100_000n, 80_000n) // 100k / 20k = 5x
 * ```
 **/
-function positionLeverage(totalDebt, totalValue) {
+function calcPositionLeverage(totalValue, totalDebt) {
 	const equity = totalValue - totalDebt;
-	if (equity <= 0n || totalDebt <= 0n) return 0;
-	return Number(totalDebt) / Number(equity);
+	if (totalValue <= 0n || equity <= 0n) return 0;
+	if (totalDebt <= 0n) return 1;
+	return Number(totalValue) / Number(equity);
 }
 /**
-* Annual quota cost scaled to the debt a maximally leveraged position carries,
-* in basis points. Every unit of own capital carries `maxLeverage - 1` units of
-* debt, and the quota is paid on the whole quoted position.
+* Annual quota cost on equity, in basis points:
+* `quotaRate × (1 + feeInterest) × leverage`. Quota accrues on the whole
+* quoted position, and the DAO takes `feeInterest` of it as with base interest.
 *
 * @example
 * ```ts
-* // 2.5% quota rate at 5x leverage
-* additionalBorrowApyBps(250, 5) // 1000, i.e. 10%
+* // quotaRate: 200 bps = 2%, feeInterest: 2500 bps = 25%, leverage: 9.5x
+* calcAdditionalBorrowApy(200, 2500, 9.5) // 2% × 1.25 × 9.5 = 2375 bps = 23.75%
 * ```
 **/
-function additionalBorrowApyBps(quotaRate, leverage) {
-	if (!Number.isFinite(leverage)) return 0;
-	return Math.round(quotaRate * Math.max(leverage - 1, 0));
+function calcAdditionalBorrowApy(quotaRate, feeInterest, leverage) {
+	if (!Number.isFinite(leverage) || leverage <= 0) return 0;
+	return Math.round(quotaRate * (1 + feeInterest / FULL) * leverage);
 }
 /**
 * {@link PERCENTAGE_FACTOR} less a 0.1% safety buffer.
@@ -186,15 +198,16 @@ function optimalHFForPartialLiquidation(borrowRate) {
 	return require_sdk_constants_math.PERCENTAGE_FACTOR + (borrowRate < 100n ? borrowRate : 100n);
 }
 //#endregion
+exports.MAX_LEVERAGE_BUFFER_BPS = MAX_LEVERAGE_BUFFER_BPS;
 exports.PARTIAL_LIQUIDATION_BUFFER_BPS = PARTIAL_LIQUIDATION_BUFFER_BPS;
-exports.additionalBorrowApyBps = additionalBorrowApyBps;
-exports.borrowApyBps = borrowApyBps;
+exports.calcAdditionalBorrowApy = calcAdditionalBorrowApy;
+exports.calcBorrowApy = calcBorrowApy;
+exports.calcMaxLeverage = calcMaxLeverage;
+exports.calcPositionLeverage = calcPositionLeverage;
+exports.calcUtilization = calcUtilization;
 exports.healthFactorBps = healthFactorBps;
-exports.maxLeverage = maxLeverage;
 exports.minSeizedAmount = minSeizedAmount;
 exports.optimalHFForPartialLiquidation = optimalHFForPartialLiquidation;
 exports.optimalRepaidAmount = optimalRepaidAmount;
-exports.positionLeverage = positionLeverage;
 exports.rayToBps = rayToBps;
 exports.usdToNumber = usdToNumber;
-exports.utilizationBps = utilizationBps;

package/dist/cjs/sdk/market/oracle/PriceOracleBaseContract.js

@@ -133,17 +133,24 @@ var PriceOracleBaseContract = class extends require_sdk_base_BaseContract.BaseCo
 		return amount * 10n ** BigInt(this.tokensMeta.decimals(to)) / price;
 	}
 	/**
-	* {@inheritDoc IPriceOracleContract.safeUsdValue}
+	* {@inheritDoc IPriceOracleContract.safeConvertToUSD}
 	**/
-	safeUsdValue(token, amount) {
+	safeConvertToUSD(token, amount) {
 		try {
-			return require_sdk_market_math.usdToNumber(this.convertToUSD(token, amount));
+			return this.convertToUSD(token, amount);
 		} catch (e) {
 			this.logger?.debug(`cannot price ${this.labelAddress(token)}: ${e}`);
 			return null;
 		}
 	}
 	/**
+	* {@inheritDoc IPriceOracleContract.safeUsdValue}
+	**/
+	safeUsdValue(token, amount) {
+		const usd = this.safeConvertToUSD(token, amount);
+		return usd === null ? null : require_sdk_market_math.usdToNumber(usd);
+	}
+	/**
 	* {@inheritDoc IPriceOracleContract.toAmount}
 	**/
 	toAmount = (token, value) => {

package/dist/cjs/sdk/market/pool/PoolV310Contract.js

@@ -51,7 +51,7 @@ var PoolV310Contract = class extends require_sdk_base_BaseContract.BaseContract
 	* {@inheritDoc IPoolContract.utilization}
 	*/
 	get utilization() {
-		return require_sdk_market_math.utilizationBps(this.borrowed, this.expectedLiquidity);
+		return require_sdk_market_math.calcUtilization(this.borrowed, this.expectedLiquidity);
 	}
 	/**
 	* {@inheritDoc IPoolContract.unwrappedUnderlying}
@@ -137,6 +137,20 @@ var PoolV310Contract = class extends require_sdk_base_BaseContract.BaseContract
 			]
 		});
 	}
+	/**
+	* Burns as many of the owner's shares as it takes to send `assets` of the
+	* underlying to the receiver.
+	*/
+	withdraw(assets, receiver, owner) {
+		return this.createRawTx({
+			functionName: "withdraw",
+			args: [
+				assets,
+				receiver,
+				owner
+			]
+		});
+	}
 	stringifyFunctionParams(params) {
 		switch (params.functionName) {
 			case "deposit": {

package/dist/cjs/sdk/market/rwa/RWARegistry.js

@@ -25,6 +25,11 @@ var RWARegistry = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 	#state;
 	#factories = new require_sdk_utils_AddressMap.AddressMap();
 	/**
+	* Factories requested during attach; `undefined` when the registry was
+	* hydrated instead, in which case the request was never made on this instance.
+	**/
+	#requestedFactories;
+	/**
 	* @internal
 	*
 	* Returns delegated multicalls for loading all RWA underlying tokens from the on-chain RWA compressor.
@@ -34,6 +39,7 @@ var RWARegistry = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 	* @param rwaFactories - RWA factory contracts to query.
 	*/
 	getLoadMulticalls(configurators, rwaFactories = []) {
+		this.#requestedFactories = rwaFactories;
 		if (!rwaFactories.length) return [];
 		const [rwaCompressorAddress] = this.sdk.addressProvider.mustGetLatest(require_sdk_constants_address_provider.AP_RWA_COMPRESSOR, require_sdk_constants_versions.VERSION_RANGE_310);
 		return [{
@@ -47,6 +53,22 @@ var RWARegistry = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 		}];
 	}
 	/**
+	* @internal
+	*
+	* Returns delegated multicalls that refresh the RWA state. Unlike the other
+	* warmed caches, RWA data carries values that change between blocks (e.g. the
+	* deposit allowance and claimable amount of an on-demand liquidity provider),
+	* so it is refreshed on every SDK sync.
+	*
+	* Factories are the ones requested during attach; after hydration the chain
+	* defaults are used, since the snapshot does not carry the requested list.
+	* An attach that explicitly requested no factories stays disabled.
+	**/
+	getSyncMulticalls() {
+		const factories = this.#requestedFactories ?? this.sdk.chain.rwaFactories;
+		return this.getLoadMulticalls([...this.sdk.marketRegister.marketFilter.configurators], factories);
+	}
+	/**
 	* Fetches decoded investor data from the on-chain RWA compressor.
 	*
 	* Each factory produces its own investor data (e.g. registered tokens,

package/dist/cjs/sdk/opportunities/index.js

@@ -1,18 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_sdk_market_math = require("../market/math.js");
 const require_sdk_opportunities_MultichainOpportunitiesService = require("./MultichainOpportunitiesService.js");
 const require_sdk_opportunities_OpportunitiesService = require("./OpportunitiesService.js");
 exports.MultichainOpportunitiesService = require_sdk_opportunities_MultichainOpportunitiesService.MultichainOpportunitiesService;
 exports.OpportunitiesService = require_sdk_opportunities_OpportunitiesService.OpportunitiesService;
-exports.PARTIAL_LIQUIDATION_BUFFER_BPS = require_sdk_market_math.PARTIAL_LIQUIDATION_BUFFER_BPS;
-exports.additionalBorrowApyBps = require_sdk_market_math.additionalBorrowApyBps;
-exports.borrowApyBps = require_sdk_market_math.borrowApyBps;
-exports.healthFactorBps = require_sdk_market_math.healthFactorBps;
-exports.maxLeverage = require_sdk_market_math.maxLeverage;
-exports.minSeizedAmount = require_sdk_market_math.minSeizedAmount;
-exports.optimalHFForPartialLiquidation = require_sdk_market_math.optimalHFForPartialLiquidation;
-exports.optimalRepaidAmount = require_sdk_market_math.optimalRepaidAmount;
-exports.positionLeverage = require_sdk_market_math.positionLeverage;
-exports.rayToBps = require_sdk_market_math.rayToBps;
-exports.usdToNumber = require_sdk_market_math.usdToNumber;
-exports.utilizationBps = require_sdk_market_math.utilizationBps;

package/dist/cjs/sdk/options.js

@@ -61,11 +61,7 @@ const attachOptionsSchema = zod_v4.z.object({
 	/**
 	* Options for Redstone price-feed updates.
 	**/
-	redstone: require_sdk_market_pricefeeds_updates_RedstoneUpdater.RedstoneOptions.optional(),
-	/**
-	* When `true`, automatically load zappers during attach.
-	**/
-	loadZappers: zod_v4.z.boolean().optional()
+	redstone: require_sdk_market_pricefeeds_updates_RedstoneUpdater.RedstoneOptions.optional()
 });
 //#endregion
 exports.attachOptionsSchema = attachOptionsSchema;

package/dist/cjs/sdk/pools/PoolService.js

@@ -15,6 +15,12 @@ const require_sdk_market_zapper_IERC20ZapperContract = require("../market/zapper
 const require_sdk_market_zapper_IETHZapperContract = require("../market/zapper/IETHZapperContract.js");
 require("../market/index.js");
 //#region src/sdk/pools/PoolService.ts
+/**
+* Haircut on reported pool liquidity, so a withdrawal sized against the reported
+* figure is not defeated by rounding in the share conversion.
+*/
+const LIQUIDITY_SAFETY_NUM = 99999n;
+const LIQUIDITY_SAFETY_DENOM = 100000n;
 var PoolService = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 	/**
 	* {@inheritDoc IPoolsService.getDepositTokensIn}
@@ -116,10 +122,87 @@ var PoolService = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 		return this.#withdrawalTokensOut(pool, tokenIn, true);
 	}
 	/**
+	* {@inheritDoc IPoolsService.simulateDeposit}
+	*/
+	simulateDeposit(props) {
+		const { pool: poolAddr, amount } = props;
+		const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+		const tokenIn = props.tokenIn ?? pool.underlying;
+		const tokenOut = this.#resolveTokenOut(props.tokenOut, () => this.getDepositTokensOut(poolAddr, tokenIn), {
+			poolAddr,
+			tokenIn,
+			operation: "deposit"
+		});
+		const { zapper } = this.getDepositMetadata(poolAddr, tokenIn, tokenOut);
+		return {
+			tokenIn: {
+				token: tokenIn,
+				balance: amount
+			},
+			tokenOut: {
+				token: tokenOut,
+				balance: toShares(pool.pool, amount)
+			},
+			zapper: zapper?.baseParams.addr
+		};
+	}
+	/**
+	* {@inheritDoc IPoolsService.simulateWithdraw}
+	*/
+	simulateWithdraw(props) {
+		const { pool: poolAddr, amount } = props;
+		const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+		const tokenIn = props.tokenIn ?? poolAddr;
+		const tokenOut = this.#resolveTokenOut(props.tokenOut, () => this.getWithdrawalTokensOut(poolAddr, tokenIn), {
+			poolAddr,
+			tokenIn,
+			operation: "withdrawal"
+		});
+		const { zapper } = this.getWithdrawalMetadata(poolAddr, tokenIn, tokenOut);
+		return {
+			tokenIn: {
+				token: tokenIn,
+				balance: toSharesUp(pool.pool, amount)
+			},
+			tokenOut: {
+				token: tokenOut,
+				balance: amount
+			},
+			zapper: zapper?.baseParams.addr,
+			availableLiquidity: pool.pool.availableLiquidity * LIQUIDITY_SAFETY_NUM / LIQUIDITY_SAFETY_DENOM
+		};
+	}
+	/**
+	* {@inheritDoc IPoolsService.simulateRedeem}
+	*/
+	simulateRedeem(props) {
+		const { pool: poolAddr, amount } = props;
+		const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+		const tokenIn = props.tokenIn ?? poolAddr;
+		const tokenOut = this.#resolveTokenOut(props.tokenOut, () => this.getWithdrawalTokensOut(poolAddr, tokenIn), {
+			poolAddr,
+			tokenIn,
+			operation: "withdrawal"
+		});
+		const { zapper } = this.getWithdrawalMetadata(poolAddr, tokenIn, tokenOut);
+		return {
+			tokenIn: {
+				token: tokenIn,
+				balance: amount
+			},
+			tokenOut: {
+				token: tokenOut,
+				balance: toAssets(pool.pool, amount)
+			},
+			zapper: zapper?.baseParams.addr,
+			availableLiquidity: pool.pool.availableLiquidity * LIQUIDITY_SAFETY_NUM / LIQUIDITY_SAFETY_DENOM
+		};
+	}
+	/**
 	* {@inheritDoc IPoolsService.removeLiquidity}
 	*/
 	removeLiquidity(props) {
-		const { pool, amount, meta, wallet, permit } = props;
+		const { pool, amount, meta, wallet, permit, mode = "withdraw" } = props;
 		const underlying = this.#describeUnderlying(pool);
 		if (this.sdk.tokensMeta.isRWAUnderlying(underlying)) {
 			if (underlying.contractType === "RWA_UNDERLYING::ON_DEMAND") {
@@ -140,8 +223,10 @@ var PoolService = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 				};
 			}
 		}
+		const poolContract = this.sdk.marketRegister.findByPool(pool).pool.pool;
 		if (meta.zapper instanceof require_sdk_market_zapper_IETHZapperContract.IETHZapperContract || meta.zapper instanceof require_sdk_market_zapper_IERC20ZapperContract.IERC20ZapperContract) {
-			const tx = permit ? meta.zapper.redeemWithPermit(amount, wallet, permit.deadline, permit.v, permit.r, permit.s) : meta.zapper.redeem(amount, wallet);
+			const shares = mode === "withdraw" ? toSharesUp(poolContract, amount) : amount;
+			const tx = permit ? meta.zapper.redeemWithPermit(shares, wallet, permit.deadline, permit.v, permit.r, permit.s) : meta.zapper.redeem(shares, wallet);
 			return {
 				tx,
 				calls: [{
@@ -150,7 +235,7 @@ var PoolService = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 				}]
 			};
 		}
-		const tx = this.sdk.marketRegister.findByPool(pool).pool.pool.redeem(amount, wallet, wallet);
+		const tx = mode === "withdraw" ? poolContract.withdraw(amount, wallet, wallet) : poolContract.redeem(amount, wallet, wallet);
 		return {
 			tx,
 			calls: [{
@@ -310,6 +395,18 @@ var PoolService = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 			type
 		};
 	}
+	/**
+	* Picks the route output when the caller left it open.
+	*
+	* Only an unambiguous single route can be defaulted: with several outputs the
+	* choice is the caller's, and with none there is no route to preview.
+	*/
+	#resolveTokenOut(requested, candidates, ctx) {
+		if (requested) return requested;
+		const options = candidates();
+		if (options.length !== 1) throw new Error(`tokenOut is required: ${options.length} ${ctx.operation} routes from ${this.labelAddress(ctx.tokenIn)} on pool ${this.labelAddress(ctx.poolAddr)}`);
+		return options[0];
+	}
 	#describeUnderlying(pool) {
 		const market = this.sdk.marketRegister.findByPool(pool);
 		return this.sdk.tokensMeta.mustGet(market.underlying);
@@ -329,5 +426,37 @@ var PoolService = class extends require_sdk_base_SDKConstruct.SDKConstruct {
 		};
 	}
 };
+/**
+* Shares minted for `assets`, as `previewDeposit` would report them.
+*
+* Both directions convert through the diesel rate — underlying per RAY of
+* shares — because that is the rate the pool itself divides by, and the only
+* exact one the SDK holds: `totalAssets` is this rate multiplied out, so
+* converting back through it costs a wei on large amounts. Rounds down, as
+* minting does.
+*/
+function toShares(pool, assets) {
+	const { dieselRate } = pool;
+	return dieselRate === 0n ? assets : assets * require_sdk_constants_math.RAY / dieselRate;
+}
+/**
+* Shares a withdrawal of `assets` burns, as `previewWithdraw` would report
+* them: {@link toShares} rounded the other way, since the burn has to cover
+* the payout the caller asked for.
+*/
+function toSharesUp(pool, assets) {
+	const { dieselRate } = pool;
+	return dieselRate === 0n ? assets : (assets * require_sdk_constants_math.RAY + dieselRate - 1n) / dieselRate;
+}
+/**
+* Underlying paid out for `shares`, as `previewRedeem` would report it:
+* {@link toShares} run backwards, less the pool's withdrawal fee.
+*/
+function toAssets(pool, shares) {
+	const { dieselRate, withdrawFee } = pool;
+	return (dieselRate === 0n ? shares : shares * dieselRate / require_sdk_constants_math.RAY) * (require_sdk_constants_math.PERCENTAGE_FACTOR - withdrawFee) / require_sdk_constants_math.PERCENTAGE_FACTOR;
+}
 //#endregion
 exports.PoolService = PoolService;
+exports.toShares = toShares;
+exports.toSharesUp = toSharesUp;

package/dist/cjs/sdk/pools/index.js

@@ -2,3 +2,5 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_sdk_pools_PoolService = require("./PoolService.js");
 require("./types.js");
 exports.PoolService = require_sdk_pools_PoolService.PoolService;
+exports.toShares = require_sdk_pools_PoolService.toShares;
+exports.toSharesUp = require_sdk_pools_PoolService.toSharesUp;