@gearbox-protocol/sdk 16.0.0-next.45 → 16.0.0-next.46

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

@@ -45,21 +45,27 @@ var CreditAccountOperationsService = class extends SDKConstruct {
 		}));
 	}
 	/**
-	* Largest `WITHDRAW` amount (in underlying) the account can take out while
-	* keeping leverage and staying inside the facade's debt band — the ceiling a
-	* withdraw form should offer. Taking everything out is the same intent with
-	* `MAX_UINT256` for an amount, and needs none of this arithmetic.
+	* Both ends of what a `WITHDRAW` can take out, in underlying: the largest
+	* partial withdrawal that keeps leverage and stays inside the facade's debt
+	* band, and the net value an exit hands over. They are reported together
+	* because a withdraw form needs both — the range it may offer, and the one
+	* amount past it that is allowed — and because the distance between them is
+	* the account's own, not a constant a caller could assume.
 	*
 	* Takes no target health factor, unlike {@link maxWithdrawCollateral}: a
 	* proportional withdrawal leaves the factor where it found it, and the
 	* facade's `minDebt` is what bounds it.
 	*
 	* @param props - Account slice and the SDK holding its market
-	* @returns Amount in underlying units; `0n` when nothing can leave
+	* @returns The two ceilings, see {@link WithdrawCeilings} for the gap between
+	* them
 	*/
 	maxWithdraw(props) {
 		const view = accountView(props.creditAccount, props.sdk);
-		return maxProportionalWithdrawal(view, view.band);
+		return {
+			partial: maxProportionalWithdrawal(view, view.band),
+			exit: view.collateral > 0n ? view.collateral : 0n
+		};
 	}
 	/**
 	* Debt a `REPAY` would have to cover to settle the account, in underlying
@@ -229,17 +235,36 @@ var CreditAccountOperationsService = class extends SDKConstruct {
 	* whole tail: the tokens land on the account and only their quota has to
 	* catch up.
 	*
+	* A claim that brought only part of what the request queued — a legacy Mellow
+	* multivault, which pays out what it holds liquid and re-queues the rest — is
+	* served in proportion, and what it did not settle comes back as `remainder`:
+	* the withdrawal still in flight and the intent to finish it with.
+	*
 	* @param props - The recorded intent, the account slice as it stands now, and
 	* the matured claimable
-	* @returns Shaped exactly like {@link startIntent}'s result, so both halves of
-	* an operation are consumed the same way
+	* @returns Shaped exactly like {@link startIntent}'s result with the remainder
+	* beside it, so both halves of an operation are consumed the same way
 	*/
 	async finishIntent(props) {
-		return plain(await this.#preview(props, () => planTail({
-			intent: props.intent,
-			claimable: props.claimable,
-			view: accountView(props.creditAccount, props.sdk)
-		})));
+		let remainder;
+		const result = await this.#preview(props, () => {
+			const tail = planTail({
+				intent: props.intent,
+				claimable: props.claimable,
+				view: accountView(props.creditAccount, props.sdk)
+			});
+			remainder = tail.remainder;
+			return tail.steps;
+		});
+		if (!result.ok) return result;
+		const { operations, state, calls } = result;
+		return {
+			ok: true,
+			operations,
+			state,
+			calls,
+			remainder
+		};
 	}
 	/**
 	* Previews opening a brand-new leveraged position.

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

@@ -1,4 +1,6 @@
 import { IntentPreviewError } from "../../validation/refusal.js";
+import { toTokenAmount } from "../../validation/token.js";
+import { toTargetDecimals } from "./utils/common.js";
 import { createOraclePaths } from "./utils/router-path.js";
 import { planFinishClaimOnly, planFinishCloseAccount, planFinishDecreaseLeverage, planFinishWithdraw } from "./plan.js";
 import { instantOutput } from "./operations.js";
@@ -12,6 +14,10 @@ import { accountView } from "./view.js";
 * Shared by the two callers that need it and must not disagree — the tail as
 * it is previewed days later against the account that really exists, and the
 * tail as it is projected the moment the request is made.
+*
+* A claim that brought only part of what was queued is served in proportion,
+* see {@link partialTail}: the intent's payout and its repayment are cut to the
+* share that arrived, and the rest of both is handed to the next claim.
 */
 function planTail(args) {
 	const { intent, claimable, view } = args;
@@ -20,17 +26,118 @@ function planTail(args) {
 		if (!output) throw new IntentPreviewError("insufficientSourceBalance", void 0, "finishIntent: the claim credits nothing to spend");
 		return output;
 	};
+	const queued = claimable.outputs.find((o) => o.isDelayed && o.amount > 0n);
+	if (queued) return partialTail({
+		intent,
+		claimable,
+		queued,
+		view
+	});
 	switch (intent.type) {
-		case "WITHDRAW_COLLATERAL": return planFinishWithdraw(intent, claimable, claimed(), view);
-		case "DECREASE_LEVERAGE": return planFinishDecreaseLeverage(claimable, claimed(), view);
-		case "CLOSE_ACCOUNT": return planFinishCloseAccount(intent, claimable, claimed(), view);
+		case "WITHDRAW_COLLATERAL": return whole(planFinishWithdraw(intent, claimable, claimed(), view));
+		case "DECREASE_LEVERAGE": return whole(planFinishDecreaseLeverage(claimable, claimed(), view));
+		case "CLOSE_ACCOUNT": return whole(planFinishCloseAccount(intent, claimable, claimed(), view));
 		case "ADD_COLLATERAL":
 		case "INCREASE_LEVERAGE":
 		case "DEPOSIT":
-		case "DEPOSIT_AND_INCREASE_LEVERAGE": return planFinishClaimOnly(claimable);
+		case "DEPOSIT_AND_INCREASE_LEVERAGE": return whole(planFinishClaimOnly(claimable));
 		default: throw new Error(`${intent.type} - not implemented`);
 	}
 }
+const whole = (steps) => ({
+	steps,
+	remainder: void 0
+});
+/**
+* The tail of a claim that settled only part of the withdrawal it matured.
+*
+* Only a legacy Mellow multivault answers one this way — it pays out what its
+* subvaults hold liquid and queues the rest — and the engine cannot finish an
+* intent it has been given a fraction of the funds for. So the fraction is what
+* it serves: the payout and the repayment are cut in the proportion that
+* arrived, which keeps the withdrawal at the fixed leverage it was asked for
+* instead of paying the wallet out first and deleveraging a claim later, and
+* the untouched half of each is carried to the next claim by the remainder.
+*
+* Two intents cannot be served in part at all. An exit sells the account whole,
+* and it cannot while a withdrawal is in flight — the phantom is neither
+* sellable nor transferable — so a partial claim only repays what it brought
+* and the account is emptied by the claim that brings the last of it. A claim
+* that credited nothing at all leaves nothing to spend, so it is taken alone:
+* it is still worth sending, since it is what moves the queue.
+*/
+function partialTail(args) {
+	const { intent, claimable, queued, view } = args;
+	const inFlight = toTokenAmount(view.sdk, queued.token, queued.amount);
+	const claimed = instantOutput(claimable.outputs);
+	if (!claimed) return {
+		steps: planFinishClaimOnly(claimable),
+		remainder: {
+			inFlight,
+			intent
+		}
+	};
+	switch (intent.type) {
+		case "WITHDRAW_COLLATERAL": {
+			const served = arrivedShare(claimed, queued, view.sdk);
+			const withdrawAmount = part(intent.withdrawAmount, served);
+			const debtRepaid = part(intent.debtRepaid, served);
+			return {
+				steps: planFinishWithdraw({
+					...intent,
+					withdrawAmount,
+					debtRepaid
+				}, claimable, claimed, view),
+				remainder: {
+					inFlight,
+					intent: {
+						...intent,
+						withdrawAmount: intent.withdrawAmount - withdrawAmount,
+						debtRepaid: intent.debtRepaid - debtRepaid
+					}
+				}
+			};
+		}
+		case "DECREASE_LEVERAGE":
+		case "CLOSE_ACCOUNT": return {
+			steps: planFinishDecreaseLeverage(claimable, claimed, view),
+			remainder: {
+				inFlight,
+				intent
+			}
+		};
+		case "ADD_COLLATERAL":
+		case "INCREASE_LEVERAGE":
+		case "DEPOSIT":
+		case "DEPOSIT_AND_INCREASE_LEVERAGE": return {
+			steps: planFinishClaimOnly(claimable),
+			remainder: {
+				inFlight,
+				intent
+			}
+		};
+		default: throw new Error(`${intent.type} - not implemented`);
+	}
+}
+/**
+* How much of the redemption this claim was: what it credited, over that plus
+* what it left queued.
+*
+* The phantom stands for its payout one for one — the same reading the request
+* side takes when it names the claim it expects — so only the decimals of the
+* two have to be reconciled before they can be added up.
+*/
+function arrivedShare(claimed, queued, sdk) {
+	const rest = toTargetDecimals(queued.amount, queued.token, claimed.token, sdk);
+	return {
+		got: claimed.amount,
+		of: claimed.amount + rest
+	};
+}
+/** A share of an amount, rounded down: a tail never promises more than it has. */
+function part(amount, share) {
+	return share.of > 0n ? amount * share.got / share.of : 0n;
+}
 /**
 * Where a delayed intent ends up, worked out at the moment it is started.
 *
@@ -55,7 +162,7 @@ async function projectTail(args) {
 	const queued = request.outputs.find((o) => o.isDelayed);
 	if (!queued || !claim) throw new IntentPreviewError("noRecordedIntent", void 0, "projectTail: the request queued nothing to claim");
 	const next = sliceAfter(creditAccount, delayed.afterRequest);
-	const steps = planTail({
+	const { steps } = planTail({
 		intent: delayed.record,
 		claimable: projectedClaimable(request, queued.token, queued.amount, claim),
 		view: accountView(next, sdk)

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

@@ -29,6 +29,25 @@ function payoutCeiling(market) {
 	return market.priceOracle.toAmount(pool.underlying, pool.pool.availableLiquidity * LIQUIDITY_SAFETY_NUM / LIQUIDITY_SAFETY_DENOM);
 }
 var PoolService = class extends SDKConstruct {
+	/**
+	* {@inheritDoc IPoolsService.getShareBalance}
+	*/
+	async getShareBalance(props) {
+		return this.client.readContract({
+			address: this.sdk.marketRegister.findByPool(props.pool).pool.pool.address,
+			abi: ierc20Abi,
+			functionName: "balanceOf",
+			args: [props.wallet],
+			blockNumber: props.blockNumber
+		});
+	}
+	/**
+	* {@inheritDoc IPoolsService.sharesToUnderlying}
+	*/
+	sharesToUnderlying(pool, shares) {
+		const market = this.sdk.marketRegister.findByPool(pool);
+		return market.toUnderlyingAmount(shares * market.pool.pool.dieselRate / RAY);
+	}
 	/**
 	* {@inheritDoc IPoolsService.getDepositTokensIn}
 	*/
@@ -414,10 +433,7 @@ var PoolService = class extends SDKConstruct {
 			chainId: this.chainId,
 			pool: pool.address,
 			underlyingToken: market.underlyingToken,
-			netValue: {
-				token: this.sdk.tokensMeta.mustGetToken(market.unwrappedUnderlying),
-				...market.priceOracle.toAmount(market.underlying, shares * pool.dieselRate / RAY)
-			},
+			netValue: this.sharesToUnderlying(pool.address, shares),
 			apy: { organicApy: rayToBps(pool.supplyRate) }
 		};
 	}

package/dist/esm/onchain/positions/PositionsService.js

@@ -372,7 +372,10 @@ var PositionsService = class extends SDKConstruct {
 		return {
 			sourceToken: this.sdk.tokensMeta.mustGetToken(w.token),
 			withdrawalPhantomToken: priceOracle.toTokenAmount(w.withdrawalPhantomToken, w.withdrawalTokenSpent),
-			outputs: w.outputs.map((o) => priceOracle.toTokenAmount(o.token, o.amount)),
+			outputs: w.outputs.map((o) => ({
+				...priceOracle.toTokenAmount(o.token, o.amount),
+				isDelayed: o.isDelayed
+			})),
 			claimCall: this.#claimTx(w.claimCalls, w.token),
 			redeemer: w.redeemer,
 			intent: w.intent
@@ -382,7 +385,10 @@ var PositionsService = class extends SDKConstruct {
 		return {
 			sourceToken: this.sdk.tokensMeta.mustGetToken(w.token),
 			withdrawalPhantomToken: this.sdk.tokensMeta.mustGetToken(w.withdrawalPhantomToken),
-			expectedOutputs: w.expectedOutputs.map((o) => priceOracle.toTokenAmount(o.token, o.amount)),
+			expectedOutputs: w.expectedOutputs.map((o) => ({
+				...priceOracle.toTokenAmount(o.token, o.amount),
+				isDelayed: o.isDelayed
+			})),
 			claimableAt: Number(w.claimableAt),
 			redeemer: w.redeemer,
 			intent: w.intent

package/dist/esm/sdk/prepare/PrepareApi.js

@@ -58,7 +58,7 @@ var PrepareApi = class extends MultichainConstruct {
 			}));
 			const creditAccount = await slice(sdk, position.creditAccount);
 			if (!creditAccount) return sdkErr(creditAccountNotFound(position.creditAccount));
-			return planned(await service(sdk).finishIntent({
+			return finalized(await service(sdk).finishIntent({
 				intent,
 				claimable: toClaimableWithdrawal(params.claimable),
 				creditAccount,
@@ -73,94 +73,106 @@ var PrepareApi = class extends MultichainConstruct {
 	/**
 	* {@inheritDoc IOpportunitiesPrepare.deposit}
 	**/
-	deposit(pool, params) {
-		const chain = this.sdk.chain(pool.chainId);
-		const { marketRegister, pools } = chain;
-		const tokenIn = params.tokenIn ?? marketRegister.findByPool(pool.pool).pool.underlying;
-		const tokenOut = lpRoute(params.tokenOut, () => pools.getDepositTokensOut(pool.pool, tokenIn));
-		if (!tokenOut) return unroutable(chain, tokenIn, void 0);
-		const state = pools.simulateDeposit({
-			pool: pool.pool,
-			amount: params.amount,
-			tokenIn,
-			tokenOut
-		});
-		const call = pools.addLiquidity({
-			collateral: {
-				token: state.tokenIn.token.address,
-				balance: state.tokenIn.value
-			},
-			pool: pool.pool,
-			wallet: params.wallet,
-			meta: pools.getDepositMetadata(pool.pool, tokenIn, tokenOut)
-		});
-		if (!call) return unroutable(chain, tokenIn, tokenOut);
-		return sdkOk({
-			operations: [],
-			state,
-			calls: call.calls,
-			...stateBlock(chain)
-		});
+	async deposit(pool, params) {
+		try {
+			const chain = await this.#chain(pool.chainId);
+			const { marketRegister, pools } = chain;
+			const tokenIn = params.tokenIn ?? marketRegister.findByPool(pool.pool).pool.underlying;
+			const tokenOut = lpRoute(params.tokenOut, () => pools.getDepositTokensOut(pool.pool, tokenIn));
+			if (!tokenOut) return unroutable(chain, tokenIn, void 0);
+			const state = pools.simulateDeposit({
+				pool: pool.pool,
+				amount: params.amount,
+				tokenIn,
+				tokenOut
+			});
+			const call = pools.addLiquidity({
+				collateral: {
+					token: state.tokenIn.token.address,
+					balance: state.tokenIn.value
+				},
+				pool: pool.pool,
+				wallet: params.wallet,
+				meta: pools.getDepositMetadata(pool.pool, tokenIn, tokenOut)
+			});
+			if (!call) return unroutable(chain, tokenIn, tokenOut);
+			return sdkOk({
+				operations: [],
+				state: await lpState(chain, pool.pool, params.wallet, state, { mints: state.tokenOut.value }),
+				calls: call.calls,
+				...stateBlock(chain)
+			});
+		} catch (e) {
+			return sdkErr(unexpectedFailure(e));
+		}
 	}
 	/**
 	* {@inheritDoc IOpportunitiesPrepare.withdraw}
 	**/
-	withdraw(pool, params) {
-		const chain = this.sdk.chain(pool.chainId);
-		const { pools } = chain;
-		const tokenIn = params.tokenIn ?? pool.pool;
-		const tokenOut = lpRoute(params.tokenOut, () => pools.getWithdrawalTokensOut(pool.pool, tokenIn));
-		if (!tokenOut) return unroutable(chain, tokenIn, void 0);
-		const state = pools.simulateWithdraw({
-			pool: pool.pool,
-			amount: params.amount,
-			tokenIn,
-			tokenOut
-		});
-		const { calls } = pools.removeLiquidity({
-			pool: pool.pool,
-			amount: params.amount,
-			wallet: params.wallet,
-			permit: void 0,
-			meta: pools.getWithdrawalMetadata(pool.pool, tokenIn, tokenOut),
-			mode: "withdraw"
-		});
-		return sdkOk({
-			operations: [],
-			state,
-			calls,
-			...stateBlock(chain)
-		});
+	async withdraw(pool, params) {
+		try {
+			const chain = await this.#chain(pool.chainId);
+			const { pools } = chain;
+			const tokenIn = params.tokenIn ?? pool.pool;
+			const tokenOut = lpRoute(params.tokenOut, () => pools.getWithdrawalTokensOut(pool.pool, tokenIn));
+			if (!tokenOut) return unroutable(chain, tokenIn, void 0);
+			const state = pools.simulateWithdraw({
+				pool: pool.pool,
+				amount: params.amount,
+				tokenIn,
+				tokenOut
+			});
+			const { calls } = pools.removeLiquidity({
+				pool: pool.pool,
+				amount: params.amount,
+				wallet: params.wallet,
+				permit: void 0,
+				meta: pools.getWithdrawalMetadata(pool.pool, tokenIn, tokenOut),
+				mode: "withdraw"
+			});
+			return sdkOk({
+				operations: [],
+				state: await lpState(chain, pool.pool, params.wallet, state, { burns: state.tokenIn.value }),
+				calls,
+				...stateBlock(chain)
+			});
+		} catch (e) {
+			return sdkErr(unexpectedFailure(e));
+		}
 	}
 	/**
 	* {@inheritDoc IOpportunitiesPrepare.redeem}
 	**/
-	redeem(pool, params) {
-		const chain = this.sdk.chain(pool.chainId);
-		const { pools } = chain;
-		const tokenIn = params.tokenIn ?? pool.pool;
-		const tokenOut = lpRoute(params.tokenOut, () => pools.getWithdrawalTokensOut(pool.pool, tokenIn));
-		if (!tokenOut) return unroutable(chain, tokenIn, void 0);
-		const state = pools.simulateRedeem({
-			pool: pool.pool,
-			amount: params.amount,
-			tokenIn,
-			tokenOut
-		});
-		const { calls } = pools.removeLiquidity({
-			pool: pool.pool,
-			amount: params.amount,
-			wallet: params.wallet,
-			permit: void 0,
-			meta: pools.getWithdrawalMetadata(pool.pool, tokenIn, tokenOut),
-			mode: "redeem"
-		});
-		return sdkOk({
-			operations: [],
-			state,
-			calls,
-			...stateBlock(chain)
-		});
+	async redeem(pool, params) {
+		try {
+			const chain = await this.#chain(pool.chainId);
+			const { pools } = chain;
+			const tokenIn = params.tokenIn ?? pool.pool;
+			const tokenOut = lpRoute(params.tokenOut, () => pools.getWithdrawalTokensOut(pool.pool, tokenIn));
+			if (!tokenOut) return unroutable(chain, tokenIn, void 0);
+			const state = pools.simulateRedeem({
+				pool: pool.pool,
+				amount: params.amount,
+				tokenIn,
+				tokenOut
+			});
+			const { calls } = pools.removeLiquidity({
+				pool: pool.pool,
+				amount: params.amount,
+				wallet: params.wallet,
+				permit: void 0,
+				meta: pools.getWithdrawalMetadata(pool.pool, tokenIn, tokenOut),
+				mode: "redeem"
+			});
+			return sdkOk({
+				operations: [],
+				state: await lpState(chain, pool.pool, params.wallet, state, { burns: state.tokenIn.value }),
+				calls,
+				...stateBlock(chain)
+			});
+		} catch (e) {
+			return sdkErr(unexpectedFailure(e));
+		}
 	}
 	/**
 	* {@inheritDoc IOpportunitiesPrepare.openNewStrategy}
@@ -412,7 +424,7 @@ function toClaimableWithdrawal(claimable) {
 		outputs: claimable.outputs.map((o) => ({
 			token: o.token.address,
 			amount: o.value,
-			isDelayed: false
+			isDelayed: o.isDelayed
 		})),
 		claimCalls: [{
 			target: claimable.claimCall.to,
@@ -469,6 +481,23 @@ function planned(result, at) {
 }
 /**
 * {@inheritDoc planned}
+*
+* A tail carries one thing the other results do not: whether the claim it was
+* built on finished the withdrawal, or left part of it queued for another one.
+**/
+function finalized(result, at) {
+	if (!result.ok) return refusal(result);
+	const { operations, state, calls, remainder } = result;
+	return sdkOk({
+		operations,
+		state,
+		calls,
+		remainder,
+		...at
+	});
+}
+/**
+* {@inheritDoc planned}
 **/
 function opened(result, at) {
 	return result.ok ? sdkOk({
@@ -511,6 +540,28 @@ function routed(result, at) {
 	});
 }
 /**
+* The pool's own numbers as the namespace reports them: the trade the service
+* priced, the market it belongs to, and where the wallet's position lands.
+*
+* The position is measured in shares and converted once, rather than added up
+* in underlying, so the figure is exactly what a later
+* `sdk.positions.list()` will report — the same balance through the same rate.
+* A withdrawal larger than the position floors at nothing: the transaction
+* would revert long before it got there, and a negative holding is not a thing
+* a screen can show.
+**/
+async function lpState(sdk, pool, wallet, simulation, moved) {
+	const after = await sdk.pools.getShareBalance({
+		pool,
+		wallet
+	}) + (moved.mints ?? -moved.burns);
+	return {
+		...simulation,
+		curator: sdk.marketRegister.findByPool(pool).curator,
+		positionAfter: sdk.pools.sharesToUnderlying(pool, after > 0n ? after : 0n)
+	};
+}
+/**
 * A pool route the market does not offer, as the refusal a caller reads.
 *
 * `to` is absent where {@link lpRoute} found no output to name at all, which

package/dist/types/model/index.d.ts

@@ -21,6 +21,6 @@ import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, leverageSchema
 import { ChainFailed, ChainMetadata, ChainScoped, ChainSucceeded, DataResponse, DataSource, ResponseMetadata } from "./response.js";
 import { chainFailedSchema, chainMetadataSchema, chainSucceededSchema, dataSourceSchema, responseMetadataSchema, responseSchema } from "./response.schema.js";
 import { SDKError, SDKResult, SDKReturn, isSDKError, sdkErr, sdkOk } from "./result.js";
-import { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals } from "./withdrawals.js";
-import { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema } from "./withdrawals.schema.js";
-export { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdjustStrategyPositionPreview, Amount, ApyBreakdown, Asset, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, CompareTag, CompareTolerance, CreditOperationMarket, Curator, CuratorName, DataResponse, DataSource, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedStrategyPositionOperationPreview, DelayedWithdrawCollateralIntent, ERROR_ADAPTER_CALL_OUTSIDE_BRACKET, ERROR_INVALID_TRANSACTION_VALUE, ERROR_MALFORMED_BRACKET, ERROR_NON_ADAPTER_CALL_IN_BRACKET, ERROR_UNPREVIEWABLE_ADAPTER_CALL, ERROR_UNPRICEABLE_TOKEN, ERROR_UNSUPPORTED_OUT_OF_BRACKET_CALL, Estimated, EstimatedProjection, ExitStrategyPositionPreview, FILTER_ALL, FilterAll, Filterable, GridSampling, IGearboxError, InstantReceivedAsset, InstantStrategyPositionOperationPreview, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Notice, NoticeKind, NoticeSubject, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionOperationPreview, PoolPositionRef, Position, PositionChartMetric, PositionClaimableWithdrawal, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionPendingWithdrawal, PositionTransaction, PositionTransactionKind, PositionWithdrawals, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, RepayStrategyPositionPreview, ResponseMetadata, Rewards, RewardsPnL, RoutedField, SDKError, SDKResult, SDKReturn, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, UnderlyingToken, amountSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, isSDKError, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema };
+import { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals, WithdrawalOutputAmount } from "./withdrawals.js";
+import { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema, withdrawalOutputAmountSchema } from "./withdrawals.schema.js";
+export { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdjustStrategyPositionPreview, Amount, ApyBreakdown, Asset, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, CompareTag, CompareTolerance, CreditOperationMarket, Curator, CuratorName, DataResponse, DataSource, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedStrategyPositionOperationPreview, DelayedWithdrawCollateralIntent, ERROR_ADAPTER_CALL_OUTSIDE_BRACKET, ERROR_INVALID_TRANSACTION_VALUE, ERROR_MALFORMED_BRACKET, ERROR_NON_ADAPTER_CALL_IN_BRACKET, ERROR_UNPREVIEWABLE_ADAPTER_CALL, ERROR_UNPRICEABLE_TOKEN, ERROR_UNSUPPORTED_OUT_OF_BRACKET_CALL, Estimated, EstimatedProjection, ExitStrategyPositionPreview, FILTER_ALL, FilterAll, Filterable, GridSampling, IGearboxError, InstantReceivedAsset, InstantStrategyPositionOperationPreview, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Notice, NoticeKind, NoticeSubject, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionOperationPreview, PoolPositionRef, Position, PositionChartMetric, PositionClaimableWithdrawal, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionPendingWithdrawal, PositionTransaction, PositionTransactionKind, PositionWithdrawals, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, RepayStrategyPositionPreview, ResponseMetadata, Rewards, RewardsPnL, RoutedField, SDKError, SDKResult, SDKReturn, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, UnderlyingToken, WithdrawalOutputAmount, amountSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, isSDKError, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, withdrawalOutputAmountSchema };

package/dist/types/model/withdrawals.d.ts

@@ -2,6 +2,21 @@ import { Timestamp, Token, TokenAmount, TxCall } from "./primitives.js";
 import { DelayedIntent } from "./delayed-intents.js";
 import { Address } from "viem";
 //#region src/model/withdrawals.d.ts
+/**
+ * One token amount a delayed withdrawal produces, and when.
+ **/
+interface WithdrawalOutputAmount extends TokenAmount {
+  /**
+   * `false` when the amount lands on the credit account as the withdrawal is
+   * requested or claimed. `true` when it does not: the token is then the
+   * withdrawal phantom standing for a part that has not matured, and another
+   * claim is needed for it.
+   *
+   * A withdrawal that produces both at once is a legacy Mellow multivault: it
+   * serves whatever its subvaults hold liquid and queues the remainder.
+   **/
+  isDelayed: boolean;
+}
 /**
  * A delayed withdrawal of a strategy position that has matured and can be claimed.
  **/
@@ -16,9 +31,12 @@ interface PositionClaimableWithdrawal {
    **/
   withdrawalPhantomToken: TokenAmount;
   /**
-   * Tokens received by the credit account upon claiming.
+   * What the claim credits the account with. Everything a venue that answers
+   * whole produces lands at once; one that pays in instalments credits part of
+   * it as a fresh withdrawal position, see
+   * {@link WithdrawalOutputAmount.isDelayed}.
    **/
-  outputs: TokenAmount[];
+  outputs: WithdrawalOutputAmount[];
   /**
    * Adapter call that executes the claim. Subcompressors always report exactly
    * one call; it is wrapped into a facade multicall by `assembleClaimDelayedCalls`.
@@ -50,9 +68,10 @@ interface PositionPendingWithdrawal {
   withdrawalPhantomToken: Token;
   /**
    * Estimated tokens the position will receive once the withdrawal
-   * matures and is claimed.
+   * matures and is claimed, see {@link WithdrawalOutputAmount.isDelayed} for
+   * the ones a single claim will not bring.
    **/
-  expectedOutputs: TokenAmount[];
+  expectedOutputs: WithdrawalOutputAmount[];
   /**
    * Unix timestamp (in seconds) when the withdrawal becomes claimable.
    **/
@@ -84,4 +103,4 @@ interface PositionWithdrawals {
   pending: PositionPendingWithdrawal[];
 }
 //#endregion
-export { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals };
+export { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals, WithdrawalOutputAmount };