@gearbox-protocol/sdk 16.0.0-next.5 → 16.0.0-next.50

package/dist/esm/model/result.js

@@ -0,0 +1,24 @@
+//#region src/model/result.ts
+/** The success half, built. */
+function sdkOk(data) {
+	return {
+		ok: true,
+		data
+	};
+}
+/** The failure half, built. */
+function sdkErr(error) {
+	return {
+		ok: false,
+		error
+	};
+}
+/**
+* Narrows a {@link SDKReturn} to its failure half. Trivial over `ok`, but it
+* names the intent at call sites that would otherwise read `!r.ok`.
+**/
+function isSDKError(answer) {
+	return !answer.ok;
+}
+//#endregion
+export { isSDKError, sdkErr, sdkOk };

package/dist/esm/model/withdrawals.schema.js

@@ -0,0 +1,40 @@
+import { ZodAddress } from "../onchain/utils/zod.js";
+import { timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema } from "./primitives.schema.js";
+import { delayedIntentSchema } from "./delayed-intent.schema.js";
+import { z } from "zod/v4";
+//#region src/model/withdrawals.schema.ts
+/**
+* {@link WithdrawalOutputAmount}
+**/
+const withdrawalOutputAmountSchema = tokenAmountSchema.extend({ isDelayed: z.boolean() });
+/**
+* {@link PositionClaimableWithdrawal}
+**/
+const positionClaimableWithdrawalSchema = z.object({
+	sourceToken: tokenSchema,
+	withdrawalPhantomToken: tokenAmountSchema,
+	outputs: z.array(withdrawalOutputAmountSchema),
+	claimCall: txCallSchema,
+	redeemer: ZodAddress().optional(),
+	intent: delayedIntentSchema.optional()
+});
+/**
+* {@link PositionPendingWithdrawal}
+**/
+const positionPendingWithdrawalSchema = z.object({
+	sourceToken: tokenSchema,
+	withdrawalPhantomToken: tokenSchema,
+	expectedOutputs: z.array(withdrawalOutputAmountSchema),
+	claimableAt: timestampSchema,
+	redeemer: ZodAddress().optional(),
+	intent: delayedIntentSchema.optional()
+});
+/**
+* {@link PositionWithdrawals}
+**/
+const positionWithdrawalsSchema = z.object({
+	claimable: z.array(positionClaimableWithdrawalSchema),
+	pending: z.array(positionPendingWithdrawalSchema)
+});
+//#endregion
+export { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema, withdrawalOutputAmountSchema };

package/dist/esm/offchain/opportunities/OffchainOpportunities.js

@@ -1,4 +1,4 @@
-import { opportunityFilterQuerySchema, opportunitySchema, poolOpportunityDetailSchema, strategyOpportunityDetailSchema } from "../../model/opportunities.schema.js";
+import { opportunityFilterQuerySchema, opportunitySchema, opportunityTotalsSchema, poolOpportunityDetailSchema, strategyOpportunityDetailSchema } from "../../model/opportunities.schema.js";
 import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
 import { z } from "zod/v4";
 //#region src/offchain/opportunities/OffchainOpportunities.ts
@@ -11,8 +11,7 @@ var OffchainOpportunities = class extends AbstractOffchainNamespace {
 		super("OffchainOpportunities", options);
 	}
 	/**
-	* Opportunities of the chains this client covers, optionally narrowed further
-	* by {@link OpportunityFilter}.
+	* {@inheritDoc IOffchainOpportunities.list}
 	**/
 	async list(filter) {
 		return this.get({
@@ -25,7 +24,7 @@ var OffchainOpportunities = class extends AbstractOffchainNamespace {
 		});
 	}
 	/**
-	* Detailed view of one pool opportunity.
+	* {@inheritDoc IOffchainOpportunities.getPool}
 	**/
 	async getPool(key) {
 		return this.get({
@@ -34,7 +33,7 @@ var OffchainOpportunities = class extends AbstractOffchainNamespace {
 		});
 	}
 	/**
-	* Detailed view of one strategy opportunity.
+	* {@inheritDoc IOffchainOpportunities.getStrategy}
 	**/
 	async getStrategy(key) {
 		return this.get({
@@ -43,7 +42,16 @@ var OffchainOpportunities = class extends AbstractOffchainNamespace {
 		});
 	}
 	/**
-	* Charts of one opportunity: one series per metric, on a shared grid.
+	* {@inheritDoc IOffchainOpportunities.getTotals}
+	**/
+	async getTotals() {
+		return this.get({
+			path: `${this.#root}/totals`,
+			schema: opportunityTotalsSchema
+		});
+	}
+	/**
+	* {@inheritDoc IOffchainOpportunities.getCharts}
 	**/
 	async getCharts(key, metrics, range) {
 		return this.readCharts(`${this.#chartRoot(key)}/charts`, metrics, range);

package/dist/esm/offchain/opportunities/index.js

@@ -1,2 +1,3 @@
 import { OffchainOpportunities } from "./OffchainOpportunities.js";
+import "./types.js";
 export { OffchainOpportunities };

package/dist/esm/offchain/positions/OffchainPositions.js

@@ -1,4 +1,4 @@
-import { positionFilterQuerySchema, positionSchema } from "../../model/positions.schema.js";
+import { positionFilterQuerySchema, positionSchema, positionTransactionSchema, positionsTotalsSchema } from "../../model/positions.schema.js";
 import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
 import { z } from "zod/v4";
 //#region src/offchain/positions/OffchainPositions.ts
@@ -11,7 +11,7 @@ var OffchainPositions = class extends AbstractOffchainNamespace {
 		super("OffchainPositions", options);
 	}
 	/**
-	* Everything a wallet holds, optionally narrowed by {@link PositionFilter}.
+	* {@inheritDoc IOffchainPositions.list}
 	**/
 	async list(props) {
 		return this.get({
@@ -24,11 +24,29 @@ var OffchainPositions = class extends AbstractOffchainNamespace {
 		});
 	}
 	/**
-	* Charts of one position: one series per metric, on a shared grid.
+	* {@inheritDoc IOffchainPositions.getTotals}
+	**/
+	async getTotals(wallet) {
+		return this.get({
+			path: `${this.#root}/${wallet}/totals`,
+			schema: positionsTotalsSchema
+		});
+	}
+	/**
+	* {@inheritDoc IOffchainPositions.getCharts}
 	**/
 	async getCharts(key, metrics, range) {
 		return this.readCharts(`${this.#chartRoot(key)}/charts`, metrics, range);
 	}
+	/**
+	* {@inheritDoc IOffchainPositions.getTransactions}
+	**/
+	async getTransactions(key) {
+		return this.get({
+			path: `${this.#strategyPath(key)}/transactions`,
+			schema: z.array(positionTransactionSchema)
+		});
+	}
 	#poolPath(key) {
 		return `${this.#root}/pool/${key.chainId}/${key.pool}/${key.wallet}`;
 	}

package/dist/esm/offchain/positions/index.js

@@ -1,2 +1,3 @@
 import { OffchainPositions } from "./OffchainPositions.js";
+import "./types.js";
 export { OffchainPositions };

package/dist/esm/onchain/MultichainSDK.js

@@ -1,9 +1,9 @@
 import { getNetworkType } from "./chain/chains.js";
+import { ChainNotConfiguredError, SdkMissingChainStateError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./core/errors.js";
 import { PriceUpdatesCache } from "./market/pricefeeds/updates/PriceUpdatesCache.js";
 import "./market/pricefeeds/updates/index.js";
 import { MultichainLiquidationsService } from "./accounts/liquidations/MultichainLiquidationsService.js";
 import "./accounts/index.js";
-import { ChainNotConfiguredError, SdkMissingChainStateError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./core/errors.js";
 import "./core/index.js";
 import { MultichainOpportunitiesService } from "./opportunities/MultichainOpportunitiesService.js";
 import "./opportunities/index.js";

package/dist/esm/onchain/OnchainSDK.js

@@ -7,6 +7,7 @@ import "./constants/index.js";
 import { formatTimestamp } from "./utils/formatter.js";
 import { toAddress } from "./utils/toAddress.js";
 import "./utils/index.js";
+import { SdkAlreadyAttachedError, SdkChainMismatchError, SdkNotAttachedError, SdkStateVersionMismatchError } from "./core/errors.js";
 import { executeMulticallBatches } from "./utils/viem/executeMulticallBatches.js";
 import { ChainContractsRegister } from "./base/ChainContractsRegister.js";
 import "./base/index.js";
@@ -23,7 +24,6 @@ import { createRedemptionLogger } from "./accounts/withdrawal-compressor/createR
 import { createWithdrawalCompressor } from "./accounts/withdrawal-compressor/createWithdrawalCompressor.js";
 import "./accounts/index.js";
 import { createAddressProvider, hydrateAddressProvider } from "./core/createAddressProvider.js";
-import { SdkAlreadyAttachedError, SdkChainMismatchError, SdkNotAttachedError, SdkStateVersionMismatchError } from "./core/errors.js";
 import "./core/index.js";
 import { OpportunitiesService } from "./opportunities/OpportunitiesService.js";
 import "./opportunities/index.js";

package/dist/esm/onchain/accounts/CreditAccountsServiceV310.js

@@ -157,16 +157,6 @@ var CreditAccountsServiceV310 = class extends SDKConstruct {
 		});
 	}
 	/**
-	* {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
-	**/
-	async getPendingWithdrawals({ creditAccount }) {
-		const { claimable, pending } = await this.#withdrawalCompressor.getCurrentWithdrawals(creditAccount);
-		return {
-			claimableNow: claimable,
-			pending
-		};
-	}
-	/**
 	* {@inheritDoc ICreditAccountsService.assembleStartDelayedWithdrawalCalls}
 	**/
 	assembleStartDelayedWithdrawalCalls({ creditFacade, preview }) {

package/dist/esm/onchain/accounts/credit-account-compressor/CreditAccountCompressor.js

@@ -43,7 +43,7 @@ var CreditAccountCompressor = class extends SDKConstruct {
 		let investor;
 		if (raw.success) {
 			ca = raw;
-			investor = await factory?.getInvestor(raw.creditAccount, false);
+			investor = await factory?.getInvestor(raw.creditAccount, { blockNumber });
 		} else {
 			const { txs: priceUpdateTxs } = await marketSuite.priceOracle.priceUpdateTxsForAccount(raw);
 			[ca, investor] = await simulateWithPriceUpdates(this.client, {

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

@@ -5,8 +5,10 @@ import { CreditAccountCompressorV310Contract } from "./credit-account-compressor
 import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccountCompressor.js";
 import "./credit-account-compressor/index.js";
 import { CreditAccountsServiceV310 } from "./CreditAccountsServiceV310.js";
-import { IntentPreviewError } from "./intents/types.js";
+import { isPhantomToken } from "./intents/utils/pick-token.js";
+import { borrowable } from "./intents/guards.js";
 import { fetchCreditAccountSlice, toCreditAccountSlice } from "./intents/utils/credit-account-slice.js";
+import { calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, roundUpQuota } from "./quota-utils.js";
 import { CreditAccountOperationsService } from "./intents/index.js";
 import { LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./liquidations/constants.js";
 import { LiquidationsService } from "./liquidations/LiquidationsService.js";
@@ -16,7 +18,6 @@ import "./types.js";
 import { DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, decodeDelayedIntent, encodeDelayedIntent } from "./withdrawal-compressor/intent-codec.js";
 import { AbstractWithdrawalCompressorContract, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal } from "./withdrawal-compressor/AbstractWithdrawalCompressorContract.js";
 import { getWithdrawalCompressorAddress } from "./withdrawal-compressor/addresses.js";
-import { InvalidDelayedIntentError } from "./withdrawal-compressor/errors.js";
 import { RedemptionLoggerV310Contract } from "./withdrawal-compressor/RedemptionLoggerV310Contract.js";
 import { createRedemptionLogger } from "./withdrawal-compressor/createRedemptionLogger.js";
 import { WithdrawalCompressorV310Contract } from "./withdrawal-compressor/WithdrawalCompressorV310Contract.js";
@@ -25,4 +26,4 @@ import { toWithdrawalStatus } from "./withdrawal-compressor/types.js";
 import { WithdrawalCompressorV313Contract } from "./withdrawal-compressor/WithdrawalCompressorV313Contract.js";
 import { createWithdrawalCompressor } from "./withdrawal-compressor/createWithdrawalCompressor.js";
 import "./withdrawal-compressor/index.js";
-export { AbstractWithdrawalCompressorContract, AccountBotsService, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, IntentPreviewError, InvalidDelayedIntentError, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, PeripheryCompressorV310Contract, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };
+export { AbstractWithdrawalCompressorContract, AccountBotsService, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, PeripheryCompressorV310Contract, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, borrowable, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, isPhantomToken, roundUpQuota, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };

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

@@ -1,6 +1,6 @@
-import "../../constants/math.js";
-import "../../constants/index.js";
-import { IntentPreviewError } from "./types.js";
+import { MIN_HEALTH_FACTOR_FACADE, checkBorrowLimit, checkCollateralised, checkCreditManagerPaused, checkForbiddenToken, checkMarketExpired, checkQuotaLimit } from "../../validation/checks.js";
+import { raise } from "../../validation/refusal.js";
+import { toToken } from "../../validation/token.js";
 import { eq } from "./utils/common.js";
 import { isPhantomToken } from "./utils/pick-token.js";
 //#region src/onchain/accounts/intents/guards.ts
@@ -12,14 +12,27 @@ import { isPhantomToken } from "./utils/pick-token.js";
 * pool has run out of what it lends. On-chain those come back as a reverted
 * multicall with a selector no form can explain, so they are read from the
 * loaded market and reported as refusals instead.
+*
+* Every guard here refuses something the market decides rather than something
+* the arithmetic cannot do, which is why all six of their reasons are
+* `blocking`: the walk that hit one still reached an end state, and a caller
+* gets that state alongside the refusal.
 */
 /**
 * The facade takes no multicall while it is paused or past its expiration, so
 * every intent the engine previews would revert on arrival.
 */
 function assertMarketOperable(suite) {
-	if (suite.isPaused) throw new IntentPreviewError("marketPaused", `${suite.creditManager.address} is paused`);
-	if (suite.isExpired) throw new IntentPreviewError("marketExpired", `${suite.creditManager.address} expired at ${suite.creditFacade.expirationDate}`);
+	const creditManager = suite.creditManager.address;
+	raise(checkCreditManagerPaused({
+		isPaused: suite.isPaused,
+		creditManager
+	}), `${creditManager} is paused`);
+	raise(checkMarketExpired({
+		isExpired: suite.isExpired,
+		creditManager,
+		expirationDate: suite.creditFacade.expirationDate
+	}), `${creditManager} expired at ${suite.creditFacade.expirationDate}`);
 }
 /**
 * What the pool will hand this manager in one transaction: the tightest of its
@@ -30,18 +43,35 @@ function assertMarketOperable(suite) {
 function borrowable(suite) {
 	const { pool } = suite.market.pool;
 	const { maxDebtPerBlockMultiplier, maxDebt } = suite.creditFacade;
-	if (maxDebtPerBlockMultiplier === 0) return 0n;
+	if (maxDebtPerBlockMultiplier === 0) return {
+		limit: 0n,
+		binding: "facadePerBlockCap"
+	};
 	const available = pool.creditManagerDebtParams.get(suite.creditManager.address)?.available;
 	return [
-		pool.availableLiquidity,
-		maxDebt * BigInt(maxDebtPerBlockMultiplier),
-		...available === void 0 ? [] : [available]
-	].reduce((a, b) => a < b ? a : b);
+		{
+			limit: pool.availableLiquidity,
+			binding: "poolAvailableLiquidity"
+		},
+		{
+			limit: maxDebt * BigInt(maxDebtPerBlockMultiplier),
+			binding: "facadePerBlockCap"
+		},
+		...available === void 0 ? [] : [{
+			limit: available,
+			binding: "managerDebtAvailable"
+		}]
+	].reduce((a, b) => b.limit < a.limit ? b : a);
 }
 /** The pool has to be able to lend what the plan means to draw. */
-function assertCanBorrow(suite, amount) {
-	const limit = borrowable(suite);
-	if (amount > limit) throw new IntentPreviewError("insufficientPoolLiquidity", `borrow: ${amount} exceeds what the pool can lend now (${limit})`);
+function assertCanBorrow(sdk, suite, amount) {
+	const { limit, binding } = borrowable(suite);
+	raise(checkBorrowLimit({
+		requested: amount,
+		available: limit,
+		binding,
+		underlying: toToken(sdk, suite.market.pool.underlying)
+	}), `borrow: ${amount} exceeds what the pool can lend now (${limit})`);
 }
 /**
 * What the account is allowed to end up holding more of than it started with.
@@ -61,9 +91,17 @@ function assertGrowthAllowed(args) {
 	const underlying = market.pool.underlying;
 	for (const { token, balance } of after) {
 		if (balance <= (before.find((a) => eq(a.token, token))?.balance ?? 0n)) continue;
-		if (forbidden.some((f) => eq(f, token))) throw new IntentPreviewError("forbiddenToken", `${token} is forbidden in this market and the plan buys more of it`);
+		raise(checkForbiddenToken({
+			token: toToken(sdk, token),
+			isForbidden: forbidden.some((f) => eq(f, token))
+		}), `${token} is forbidden in this market and the plan buys more of it`);
 		if (eq(token, underlying) || isPhantomToken(sdk, token)) continue;
-		if (!market.pool.pqk.hasActiveQuota(token)) throw new IntentPreviewError("quotaLimitReached", `${token} takes no quota in this market, so it counts as no collateral`);
+		if (!market.pool.pqk.hasActiveQuota(token)) raise(checkQuotaLimit({
+			token: toToken(sdk, token),
+			requested: void 0,
+			available: 0n,
+			underlying: toToken(sdk, underlying)
+		}), `${token} takes no quota in this market, so it counts as no collateral`);
 	}
 }
 /**
@@ -71,10 +109,23 @@ function assertGrowthAllowed(args) {
 * and reverts if the collateral does not cover it, so a plan that lands the
 * account below water is refused here.
 *
-* The bar is the health factor of the state the plan projects: collateral under
-* liquidation thresholds, capped by quota, against the debt. Note that a
-* position already underwater cannot be nursed back one step at a time — the
-* check is on where the transaction ends, not on whether it improved things.
+* The bar is the facade's own `1.0`, because this guard answers one question:
+* would the transaction revert. It is deliberately not `MIN_HF_LIMITED`, and
+* the three bars in this codebase are three different jobs:
+*
+* - here, `1.0` — what the facade enforces, so what a plan must clear to land;
+* - `maxWithdrawCollateral` sizes at `MIN_HF_LIMITED + 2` — a *sizing* helper
+*   leaving headroom, which is not the same as a validity check;
+* - a form refuses at or below `MIN_HF_LIMITED` (`MIN_HEALTH_FACTOR_FORM`).
+*
+* Raising this one to `MIN_HF_LIMITED` was tried and reverted: it made
+* `maxWithdraw` hand back a ceiling this guard then refused, and it blocked
+* small top-ups of an account sitting in `[1.0, 1.01)` — the very operations
+* that rescue it. A form wanting the stricter bar has `validateHF`.
+*
+* Note that a position already underwater cannot be nursed back one step at a
+* time — the check is on where the transaction ends, not on whether it
+* improved things.
 *
 * @remarks
 * The caller decides the pricing the factor was computed at: main prices, or
@@ -82,20 +133,31 @@ function assertGrowthAllowed(args) {
 * whose reserve feed the SDK cannot read keeps its main price, so a plan can
 * still be refused on-chain after passing here.
 */
-function assertCollateralised(healthFactorBps) {
-	if (healthFactorBps < Number(10000n)) throw new IntentPreviewError("insufficientCollateral", `the account would end at a health factor of ${healthFactorBps}, below 1.0`);
+function assertCollateralised(healthFactorBps, safePrices) {
+	const required = MIN_HEALTH_FACTOR_FACADE;
+	raise(checkCollateralised({
+		healthFactor: healthFactorBps,
+		required,
+		safePrices
+	}), `the account would end at a health factor of ${healthFactorBps}, below ${required}`);
 }
 /**
 * A quota can only be raised as far as the market still has room for: past the
 * token's limit the keeper takes nothing more, whoever is asking.
 */
-function assertQuotaHeadroom(market, increases) {
+function assertQuotaHeadroom(sdk, market, increases) {
+	const underlying = market.pool.underlying;
 	for (const { token, balance } of increases) {
 		if (balance <= 0n) continue;
 		const quota = market.pool.pqk.quotas.get(token);
 		if (!quota) continue;
 		const left = quota.limit - quota.totalQuoted;
-		if (balance > left) throw new IntentPreviewError("quotaLimitReached", `${token} has ${left} of quota left, the plan needs ${balance}`);
+		raise(checkQuotaLimit({
+			token: toToken(sdk, token),
+			requested: balance,
+			available: left,
+			underlying: toToken(sdk, underlying)
+		}), `${token} has ${left} of quota left, the plan needs ${balance}`);
 	}
 }
 //#endregion