@gearbox-protocol/sdk 17.0.0 → 17.1.0-next.1

package/dist/cjs/onchain/accounts/intents/math.js

@@ -25,19 +25,27 @@ function proportionalDebt(position, collateralDelta) {
 	return position.debt * collateralDelta / position.collateral;
 }
 /**
+* Headroom on top of the debt read, in `PERCENTAGE_FACTOR`: enough interest for
+* the transaction to sit in the mempool for hours at any sane borrow rate,
+* small enough not to matter to the wallet that fronts it.
+*/
+const SETTLE_MARGIN = 10n;
+/**
 * Largest withdrawal (in underlying) that {@link proportionalDebt} can still
-* pay for: the repayment it implies leaves debt at or above `minDebt`, and
+* pay for: the repayment it implies leaves debt at or above `minDebt` plus
+* {@link SETTLE_MARGIN} of the debt, so the figure survives the interest of the
+* blocks before it is sent, and
 * strictly less than the collateral goes — the last unit closes the account
 * rather than shrinks it. `0n` when the debt already sits below `minDebt`.
 *
-* Solves `floor(D0 · W / C0) ≤ D0 − minDebt` for `W`.
+* Solves `floor(D0 · W / C0) ≤ D0 − minDebt − margin` for `W`.
 */
 function maxProportionalWithdrawal(position, debtLimits) {
 	const { debt, collateral } = position;
 	if (collateral <= 0n) return 0n;
 	const allButLast = collateral - 1n;
 	if (debt === 0n) return allButLast;
-	const repayable = debt - debtLimits.minDebt;
+	const repayable = debt - debtLimits.minDebt - debt * SETTLE_MARGIN / require_onchain_constants_math.PERCENTAGE_FACTOR;
 	if (repayable < 0n) return 0n;
 	const bound = require_onchain_utils_bigint_math.BigIntMath.ceilDiv(collateral * (repayable + 1n), debt) - 1n;
 	return bound < allButLast ? bound : allButLast;
@@ -63,6 +71,7 @@ function assertDebtLimits(sdk, debt, debtLimits, underlying) {
 	}), debt > debtLimits.maxDebt ? `debt ${debt} exceeds maxDebt ${debtLimits.maxDebt}` : `debt ${debt} is below minDebt ${debtLimits.minDebt}`);
 }
 //#endregion
+exports.SETTLE_MARGIN = SETTLE_MARGIN;
 exports.assertDebtLimits = assertDebtLimits;
 exports.assertLeverageAtLeastOne = assertLeverageAtLeastOne;
 exports.debtForLeverage = debtForLeverage;

package/dist/cjs/onchain/accounts/intents/plan.js

@@ -361,14 +361,7 @@ const claim = (claimable) => ({
 	claimable
 });
 const clearQuotas = () => ({ kind: "clearQuotas" });
-/**
-* Headroom a settlement raises on top of the debt it read, in
-* `PERCENTAGE_FACTOR`: enough interest for the transaction to sit in the
-* mempool for hours at any sane borrow rate, small enough not to matter to the
-* wallet that fronts it.
-*/
-const SETTLE_MARGIN = 10n;
-const withMargin = (debt) => debt + debt * SETTLE_MARGIN / require_onchain_constants_math.PERCENTAGE_FACTOR;
+const withMargin = (debt) => debt + debt * require_onchain_accounts_intents_math.SETTLE_MARGIN / require_onchain_constants_math.PERCENTAGE_FACTOR;
 /** The amount that asks for all of it, whatever "all" turns out to be. */
 const everything = (amount) => amount >= require_onchain_constants_math.MAX_UINT256;
 const min = (a, b) => a < b ? a : b;

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

@@ -155,7 +155,7 @@ var PoolService = class extends require_onchain_base_SDKConstruct.SDKConstruct {
 			tokenIn: toTokenAmount(tokenIn, pool.pool.underlyingToShares(amount * require_onchain_constants_math.PERCENTAGE_FACTOR / (require_onchain_constants_math.PERCENTAGE_FACTOR - pool.pool.withdrawFee), true)),
 			tokenOut: toTokenAmount(tokenOut, amount),
 			zapper: zapper?.baseParams.addr,
-			availableLiquidity: this.#withdrawableLiquidity(market)
+			availableLiquidity: this.withdrawableLiquidity(poolAddr)
 		};
 	}
 	/**
@@ -177,7 +177,7 @@ var PoolService = class extends require_onchain_base_SDKConstruct.SDKConstruct {
 			tokenIn: toTokenAmount(tokenIn, amount),
 			tokenOut: toTokenAmount(tokenOut, pool.pool.sharesToUnderlying(amount) * (require_onchain_constants_math.PERCENTAGE_FACTOR - pool.pool.withdrawFee) / require_onchain_constants_math.PERCENTAGE_FACTOR),
 			zapper: zapper?.baseParams.addr,
-			availableLiquidity: this.#withdrawableLiquidity(market)
+			availableLiquidity: this.withdrawableLiquidity(poolAddr)
 		};
 	}
 	/**
@@ -406,12 +406,11 @@ var PoolService = class extends require_onchain_base_SDKConstruct.SDKConstruct {
 		};
 	}
 	/**
-	* The most the pool can actually hand over right now, trimmed slightly so a
-	* withdrawal sized against it does not fail on rounding.
-	**/
-	#withdrawableLiquidity(market) {
-		const { pool } = market;
-		return market.priceOracle.toAmount(pool.underlying, pool.pool.availableLiquidity * 99999n / 100000n);
+	* {@inheritDoc IPoolsService.withdrawableLiquidity}
+	*/
+	withdrawableLiquidity(pool) {
+		const market = this.sdk.marketRegister.findByPool(pool);
+		return market.priceOracle.toAmount(market.pool.underlying, market.pool.pool.availableLiquidity * 99999n / 100000n);
 	}
 };
 //#endregion

package/dist/cjs/onchain/validation/bundles/checkPoolOperation.js

@@ -4,13 +4,7 @@ const require_onchain_validation_checks_checkPoolPaused = require("../checks/che
 const require_onchain_validation_checks_checkPoolSunset = require("../checks/checkPoolSunset.js");
 require("../checks/index.js");
 //#region src/onchain/validation/bundles/checkPoolOperation.ts
-/**
-* What the pool's own state stops, whichever side of it the wallet is on.
-*
-* The liquidity read is the market's rather than the trimmed figure a
-* simulation carries: a withdrawal sized against that figure has to pass the
-* check that follows it.
-*/
+/** What the pool's own state stops, whichever side of it the wallet is on. */
 function checkPoolOperation(args) {
 	const { sdk, pool, isDeposit, tokenOut } = args;
 	const market = sdk.marketRegister.findByPool(pool);
@@ -26,7 +20,7 @@ function checkPoolOperation(args) {
 		}),
 		...isDeposit ? [] : require_onchain_validation_checks_checkPoolLiquidity.checkPoolLiquidity({
 			requested: tokenOut.value,
-			available: market.pool.pool.availableLiquidity,
+			available: sdk.pools.withdrawableLiquidity(pool).value,
 			underlying: tokenOut.token
 		})
 	];

package/dist/cjs/onchain/validation/checks/checkPoolLiquidity.js

@@ -4,17 +4,10 @@ require("../../../model/index.js");
 const require_onchain_validation_helpers_amount = require("../helpers/amount.js");
 require("../helpers/index.js");
 //#region src/onchain/validation/checks/checkPoolLiquidity.ts
-/**
-* What the pool holds, against what is being taken out of it.
-*
-* The operator is not `checkBorrowLimit`'s: a pool holding exactly the amount
-* requested still cannot serve it, so equality is already a refusal. That is
-* the rule the legacy withdrawal validator enforced and it is preserved to the
-* unit.
-*/
+/** What the pool can hand over, against what is being taken out of it. */
 function checkPoolLiquidity(args) {
 	const { requested, available, underlying } = args;
-	if (requested < available) return [];
+	if (requested <= available) return [];
 	return [require_model_errors_operation_errors.insufficientPoolLiquidity({
 		requested: require_onchain_validation_helpers_amount.amountOf(underlying, requested),
 		available: require_onchain_validation_helpers_amount.amountOf(underlying, available),

package/dist/esm/onchain/accounts/intents/math.js

@@ -1,5 +1,5 @@
 import { BigIntMath } from "../../utils/bigint-math.js";
-import { LEVERAGE_DECIMALS } from "../../constants/math.js";
+import { LEVERAGE_DECIMALS, PERCENTAGE_FACTOR } from "../../constants/math.js";
 import { insufficientBalance } from "../../../model/errors/operation-errors.js";
 import "../../../model/index.js";
 import { toToken } from "../../validation/helpers/token.js";
@@ -24,19 +24,27 @@ function proportionalDebt(position, collateralDelta) {
 	return position.debt * collateralDelta / position.collateral;
 }
 /**
+* Headroom on top of the debt read, in `PERCENTAGE_FACTOR`: enough interest for
+* the transaction to sit in the mempool for hours at any sane borrow rate,
+* small enough not to matter to the wallet that fronts it.
+*/
+const SETTLE_MARGIN = 10n;
+/**
 * Largest withdrawal (in underlying) that {@link proportionalDebt} can still
-* pay for: the repayment it implies leaves debt at or above `minDebt`, and
+* pay for: the repayment it implies leaves debt at or above `minDebt` plus
+* {@link SETTLE_MARGIN} of the debt, so the figure survives the interest of the
+* blocks before it is sent, and
 * strictly less than the collateral goes — the last unit closes the account
 * rather than shrinks it. `0n` when the debt already sits below `minDebt`.
 *
-* Solves `floor(D0 · W / C0) ≤ D0 − minDebt` for `W`.
+* Solves `floor(D0 · W / C0) ≤ D0 − minDebt − margin` for `W`.
 */
 function maxProportionalWithdrawal(position, debtLimits) {
 	const { debt, collateral } = position;
 	if (collateral <= 0n) return 0n;
 	const allButLast = collateral - 1n;
 	if (debt === 0n) return allButLast;
-	const repayable = debt - debtLimits.minDebt;
+	const repayable = debt - debtLimits.minDebt - debt * SETTLE_MARGIN / PERCENTAGE_FACTOR;
 	if (repayable < 0n) return 0n;
 	const bound = BigIntMath.ceilDiv(collateral * (repayable + 1n), debt) - 1n;
 	return bound < allButLast ? bound : allButLast;
@@ -62,4 +70,4 @@ function assertDebtLimits(sdk, debt, debtLimits, underlying) {
 	}), debt > debtLimits.maxDebt ? `debt ${debt} exceeds maxDebt ${debtLimits.maxDebt}` : `debt ${debt} is below minDebt ${debtLimits.minDebt}`);
 }
 //#endregion
-export { assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, maxProportionalWithdrawal, proportionalDebt };
+export { SETTLE_MARGIN, assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, maxProportionalWithdrawal, proportionalDebt };

package/dist/esm/onchain/accounts/intents/plan.js

@@ -6,7 +6,7 @@ import "../../../model/index.js";
 import { toToken, toTokenAmount } from "../../validation/helpers/token.js";
 import { IntentPreviewError } from "../../validation/raise.js";
 import { eq } from "./utils/common.js";
-import { assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, proportionalDebt } from "./math.js";
+import { SETTLE_MARGIN, assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, proportionalDebt } from "./math.js";
 //#region src/onchain/accounts/intents/plan.ts
 /** Whatever the previous convert produced. */
 const RAISED = { raised: true };
@@ -360,13 +360,6 @@ const claim = (claimable) => ({
 	claimable
 });
 const clearQuotas = () => ({ kind: "clearQuotas" });
-/**
-* Headroom a settlement raises on top of the debt it read, in
-* `PERCENTAGE_FACTOR`: enough interest for the transaction to sit in the
-* mempool for hours at any sane borrow rate, small enough not to matter to the
-* wallet that fronts it.
-*/
-const SETTLE_MARGIN = 10n;
 const withMargin = (debt) => debt + debt * SETTLE_MARGIN / PERCENTAGE_FACTOR;
 /** The amount that asks for all of it, whatever "all" turns out to be. */
 const everything = (amount) => amount >= MAX_UINT256;

package/dist/esm/onchain/pools/PoolService.js

@@ -154,7 +154,7 @@ var PoolService = class extends SDKConstruct {
 			tokenIn: toTokenAmount(tokenIn, pool.pool.underlyingToShares(amount * PERCENTAGE_FACTOR / (PERCENTAGE_FACTOR - pool.pool.withdrawFee), true)),
 			tokenOut: toTokenAmount(tokenOut, amount),
 			zapper: zapper?.baseParams.addr,
-			availableLiquidity: this.#withdrawableLiquidity(market)
+			availableLiquidity: this.withdrawableLiquidity(poolAddr)
 		};
 	}
 	/**
@@ -176,7 +176,7 @@ var PoolService = class extends SDKConstruct {
 			tokenIn: toTokenAmount(tokenIn, amount),
 			tokenOut: toTokenAmount(tokenOut, pool.pool.sharesToUnderlying(amount) * (PERCENTAGE_FACTOR - pool.pool.withdrawFee) / PERCENTAGE_FACTOR),
 			zapper: zapper?.baseParams.addr,
-			availableLiquidity: this.#withdrawableLiquidity(market)
+			availableLiquidity: this.withdrawableLiquidity(poolAddr)
 		};
 	}
 	/**
@@ -405,12 +405,11 @@ var PoolService = class extends SDKConstruct {
 		};
 	}
 	/**
-	* The most the pool can actually hand over right now, trimmed slightly so a
-	* withdrawal sized against it does not fail on rounding.
-	**/
-	#withdrawableLiquidity(market) {
-		const { pool } = market;
-		return market.priceOracle.toAmount(pool.underlying, pool.pool.availableLiquidity * 99999n / 100000n);
+	* {@inheritDoc IPoolsService.withdrawableLiquidity}
+	*/
+	withdrawableLiquidity(pool) {
+		const market = this.sdk.marketRegister.findByPool(pool);
+		return market.priceOracle.toAmount(market.pool.underlying, market.pool.pool.availableLiquidity * 99999n / 100000n);
 	}
 };
 //#endregion

package/dist/esm/onchain/validation/bundles/checkPoolOperation.js

@@ -3,13 +3,7 @@ import { checkPoolPaused } from "../checks/checkPoolPaused.js";
 import { checkPoolSunset } from "../checks/checkPoolSunset.js";
 import "../checks/index.js";
 //#region src/onchain/validation/bundles/checkPoolOperation.ts
-/**
-* What the pool's own state stops, whichever side of it the wallet is on.
-*
-* The liquidity read is the market's rather than the trimmed figure a
-* simulation carries: a withdrawal sized against that figure has to pass the
-* check that follows it.
-*/
+/** What the pool's own state stops, whichever side of it the wallet is on. */
 function checkPoolOperation(args) {
 	const { sdk, pool, isDeposit, tokenOut } = args;
 	const market = sdk.marketRegister.findByPool(pool);
@@ -25,7 +19,7 @@ function checkPoolOperation(args) {
 		}),
 		...isDeposit ? [] : checkPoolLiquidity({
 			requested: tokenOut.value,
-			available: market.pool.pool.availableLiquidity,
+			available: sdk.pools.withdrawableLiquidity(pool).value,
 			underlying: tokenOut.token
 		})
 	];

package/dist/esm/onchain/validation/checks/checkPoolLiquidity.js

@@ -3,17 +3,10 @@ import "../../../model/index.js";
 import { amountOf } from "../helpers/amount.js";
 import "../helpers/index.js";
 //#region src/onchain/validation/checks/checkPoolLiquidity.ts
-/**
-* What the pool holds, against what is being taken out of it.
-*
-* The operator is not `checkBorrowLimit`'s: a pool holding exactly the amount
-* requested still cannot serve it, so equality is already a refusal. That is
-* the rule the legacy withdrawal validator enforced and it is preserved to the
-* unit.
-*/
+/** What the pool can hand over, against what is being taken out of it. */
 function checkPoolLiquidity(args) {
 	const { requested, available, underlying } = args;
-	if (requested < available) return [];
+	if (requested <= available) return [];
 	return [insufficientPoolLiquidity({
 		requested: amountOf(underlying, requested),
 		available: amountOf(underlying, available),

package/dist/types/onchain/accounts/intents/math.d.ts

@@ -28,13 +28,21 @@ declare function debtForLeverage(collateral: bigint, leverage: bigint): bigint;
  * it, so no rounding is introduced on the way.
  */
 declare function proportionalDebt(position: Position, collateralDelta: bigint): bigint;
+/**
+ * Headroom on top of the debt read, in `PERCENTAGE_FACTOR`: enough interest for
+ * the transaction to sit in the mempool for hours at any sane borrow rate,
+ * small enough not to matter to the wallet that fronts it.
+ */
+declare const SETTLE_MARGIN = 10n;
 /**
  * Largest withdrawal (in underlying) that {@link proportionalDebt} can still
- * pay for: the repayment it implies leaves debt at or above `minDebt`, and
+ * pay for: the repayment it implies leaves debt at or above `minDebt` plus
+ * {@link SETTLE_MARGIN} of the debt, so the figure survives the interest of the
+ * blocks before it is sent, and
  * strictly less than the collateral goes — the last unit closes the account
  * rather than shrinks it. `0n` when the debt already sits below `minDebt`.
  *
- * Solves `floor(D0 · W / C0) ≤ D0 − minDebt` for `W`.
+ * Solves `floor(D0 · W / C0) ≤ D0 − minDebt − margin` for `W`.
  */
 declare function maxProportionalWithdrawal(position: Position, debtLimits: DebtLimits): bigint;
 /** Total leverage cannot drop below 1x — that would be negative debt. */
@@ -45,4 +53,4 @@ declare function assertLeverageAtLeastOne(leverage: bigint): void;
  */
 declare function assertDebtLimits(sdk: OnchainSDK, debt: bigint, debtLimits: DebtLimits, underlying: Address): void;
 //#endregion
-export { DebtLimits, Position, assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, maxProportionalWithdrawal, proportionalDebt };
+export { DebtLimits, Position, SETTLE_MARGIN, assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, maxProportionalWithdrawal, proportionalDebt };

package/dist/types/onchain/pools/PoolService.d.ts

@@ -1,3 +1,4 @@
+import { Amount } from "../../model/primitives.js";
 import { PoolPosition } from "../../model/positions.js";
 import "../../model/index.js";
 import { AddLiquidityProps, DepositMetadata, IPoolsService, ListPoolPositionsProps, PoolServiceCallResult, PoolSimulation, RemoveLiquidityProps, SimulatePoolOperationProps, WithdrawalMetadata } from "./types.js";
@@ -55,6 +56,10 @@ declare class PoolService extends SDKConstruct implements IPoolsService {
    * {@inheritDoc IPoolsService.listPositions}
    */
   listPositions(props: ListPoolPositionsProps): Promise<PoolPosition[]>;
+  /**
+   * {@inheritDoc IPoolsService.withdrawableLiquidity}
+   */
+  withdrawableLiquidity(pool: Address): Amount;
 }
 //#endregion
 export { PoolService };

package/dist/types/onchain/pools/types.d.ts

@@ -147,8 +147,7 @@ interface PoolSimulation {
    **/
   zapper?: Address;
   /**
-   * Withdrawals only: underlying the pool can actually hand over right now,
-   * trimmed slightly so a withdrawal sized against it does not fail on rounding.
+   * Withdrawals only: {@link IPoolsService.withdrawableLiquidity}.
    *
    * The conversion is a rate, not a promise that the pool is liquid enough, so
    * compare `tokenOut.value` against `availableLiquidity.value` to see if the
@@ -265,6 +264,14 @@ interface IPoolsService {
    * several routes exist.
    **/
   simulateRedeem(props: SimulatePoolOperationProps): PoolSimulation;
+  /**
+   * The most the pool can hand over right now, trimmed so a share-sized
+   * withdrawal (redeem, zapper) survives the share price accruing before it is
+   * sent.
+   *
+   * @param pool - Pool address
+   **/
+  withdrawableLiquidity(pool: Address): Amount;
   /**
    * Returns contract call parameters for adding liquidity to a pool
    * Or undefined if no deposit action is required (e.g. for RWA underlying on demand)

package/dist/types/onchain/validation/bundles/checkPoolOperation.d.ts

@@ -19,13 +19,7 @@ interface PoolOperationArgs {
    */
   tokenOut: TokenAmount;
 }
-/**
- * What the pool's own state stops, whichever side of it the wallet is on.
- *
- * The liquidity read is the market's rather than the trimmed figure a
- * simulation carries: a withdrawal sized against that figure has to pass the
- * check that follows it.
- */
+/** What the pool's own state stops, whichever side of it the wallet is on. */
 declare function checkPoolOperation(args: PoolOperationArgs): PoolOperationError[];
 //#endregion
 export { PoolOperationArgs, PoolOperationError, checkPoolOperation };

package/dist/types/onchain/validation/checks/checkPoolLiquidity.d.ts

@@ -7,14 +7,7 @@ interface PoolLiquidityArgs {
   available: bigint;
   underlying: Token;
 }
-/**
- * What the pool holds, against what is being taken out of it.
- *
- * The operator is not `checkBorrowLimit`'s: a pool holding exactly the amount
- * requested still cannot serve it, so equality is already a refusal. That is
- * the rule the legacy withdrawal validator enforced and it is preserved to the
- * unit.
- */
+/** What the pool can hand over, against what is being taken out of it. */
 declare function checkPoolLiquidity(args: PoolLiquidityArgs): InsufficientPoolLiquidityError[];
 //#endregion
 export { PoolLiquidityArgs, checkPoolLiquidity };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "17.0.0",
+  "version": "17.1.0-next.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {