@gearbox-protocol/sdk 16.0.0-next.42 → 16.0.0-next.43

package/dist/cjs/model/index.js

@@ -21,6 +21,7 @@ const require_model_previews = require("./previews.js");
 require("./primitives.js");
 require("./response.js");
 const require_model_response_schema = require("./response.schema.js");
+const require_model_result = require("./result.js");
 require("./withdrawals.js");
 const require_model_withdrawals_schema = require("./withdrawals.schema.js");
 exports.CHART_METRIC_UNITS = require_model_charts.CHART_METRIC_UNITS;
@@ -71,6 +72,7 @@ exports.filterAllSchema = require_model_filters_schema.filterAllSchema;
 exports.filterable = require_model_filters_schema.filterable;
 exports.instantReceivedAssetSchema = require_model_liquidations_schema.instantReceivedAssetSchema;
 exports.isFilterSet = require_model_filters.isFilterSet;
+exports.isSDKError = require_model_result.isSDKError;
 exports.leverageSchema = require_model_primitives_schema.leverageSchema;
 exports.liquidatableAccountFilterSchema = require_model_liquidations_schema.liquidatableAccountFilterSchema;
 exports.liquidatableAccountSchema = require_model_liquidations_schema.liquidatableAccountSchema;
@@ -133,6 +135,8 @@ exports.responseMetadataSchema = require_model_response_schema.responseMetadataS
 exports.responseSchema = require_model_response_schema.responseSchema;
 exports.rewardsPnLSchema = require_model_positions_schema.rewardsPnLSchema;
 exports.rewardsSchema = require_model_opportunities_schema.rewardsSchema;
+exports.sdkErr = require_model_result.sdkErr;
+exports.sdkOk = require_model_result.sdkOk;
 exports.strategyOpportunityChartMetricSchema = require_model_charts_schema.strategyOpportunityChartMetricSchema;
 exports.strategyOpportunityDetailSchema = require_model_opportunities_schema.strategyOpportunityDetailSchema;
 exports.strategyOpportunityId = require_model_opportunities.strategyOpportunityId;

package/dist/cjs/model/result.js

@@ -0,0 +1,27 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#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
+exports.isSDKError = isSDKError;
+exports.sdkErr = sdkErr;
+exports.sdkOk = sdkOk;

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

@@ -54,7 +54,7 @@ async function projectTail(args) {
 	const { request, delayed, creditAccount, sdk, quotaReserve } = args;
 	const { claim } = delayed;
 	const queued = request.outputs.find((o) => o.isDelayed);
-	if (!queued || !claim) throw new Error("projectTail: the request queued nothing to claim");
+	if (!queued || !claim) throw new require_onchain_validation_refusal.IntentPreviewError("noRecordedIntent", void 0, "projectTail: the request queued nothing to claim");
 	const next = sliceAfter(creditAccount, delayed.afterRequest);
 	const steps = planTail({
 		intent: delayed.record,

package/dist/cjs/onchain/accounts/withdrawal-compressor/errors.js

@@ -1,20 +1,20 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/onchain/accounts/withdrawal-compressor/errors.ts
+function invalidDelayedIntent(extraData, cause) {
+	const verdict = {
+		code: "invalidDelayedIntent",
+		message: `cannot decode delayed intent from extraData ${extraData}`,
+		extraData
+	};
+	if (cause !== void 0) verdict.cause = cause instanceof Error ? cause : new Error(String(cause));
+	return verdict;
+}
+Object.defineProperty(invalidDelayedIntent, Symbol.hasInstance, { value: (value) => typeof value === "object" && value !== null && value.code === "invalidDelayedIntent" });
 /**
-* Thrown when a delayed-withdrawal request or redemption log carries
-* non-empty `extraData` that cannot be decoded as a `DelayedIntent`.
-* Requests produced by our stack always encode a valid intent, so garbage
-* here means a malformed/foreign transaction that must not be previewed as
-* if it were fine.
+* Builds the verdict. Callable with or without `new`, so pre-declassing raise
+* sites keep compiling; `instanceof` matches on the `code` discriminant, and
+* the answer is never an `Error`.
 */
-var InvalidDelayedIntentError = class extends Error {
-	/** Raw `extraData` that failed to decode. */
-	extraData;
-	constructor(extraData, cause) {
-		super(`cannot decode delayed intent from extraData ${extraData}`, { cause });
-		this.name = "InvalidDelayedIntentError";
-		this.extraData = extraData;
-	}
-};
+const InvalidDelayedIntentError = invalidDelayedIntent;
 //#endregion
 exports.InvalidDelayedIntentError = InvalidDelayedIntentError;

package/dist/cjs/onchain/index.js

@@ -346,7 +346,6 @@ exports.IERC20ZapperContract = require_onchain_market_zapper_IERC20ZapperContrac
 exports.IETHZapperContract = require_onchain_market_zapper_IETHZapperContract.IETHZapperContract;
 exports.InfinifiGatewayAdapterContract = require_onchain_market_adapters_contracts_InfinifiGatewayAdapterContract.InfinifiGatewayAdapterContract;
 exports.InfinifiUnwindingGatewayAdapterContract = require_onchain_market_adapters_contracts_InfinifiUnwindingGatewayAdapterContract.InfinifiUnwindingGatewayAdapterContract;
-exports.IntentPreviewError = require_onchain_validation_refusal.IntentPreviewError;
 exports.InvalidDelayedIntentError = require_onchain_accounts_withdrawal_compressor_errors.InvalidDelayedIntentError;
 exports.KelpLRTDepositPoolAdapterContract = require_onchain_market_adapters_contracts_KelpLRTDepositPoolAdapterContract.KelpLRTDepositPoolAdapterContract;
 exports.KelpLRTWithdrawalManagerAdapterContract = require_onchain_market_adapters_contracts_KelpLRTWithdrawalManagerAdapterContract.KelpLRTWithdrawalManagerAdapterContract;

package/dist/cjs/onchain/market/zapper/errors.js

@@ -1,18 +1,19 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/onchain/market/zapper/errors.ts
+function unsupportedZapperFunction(zapper, functionName) {
+	return {
+		code: "unsupportedZapperFunction",
+		message: `unsupported zapper function "${functionName}" on ${zapper}`,
+		zapper,
+		functionName
+	};
+}
+Object.defineProperty(unsupportedZapperFunction, Symbol.hasInstance, { value: (value) => typeof value === "object" && value !== null && value.code === "unsupportedZapperFunction" });
 /**
-* Thrown when a zapper call uses a function other than a known
-* `deposit`/`redeem` variant.
+* Builds the verdict. Callable with or without `new`, so pre-declassing raise
+* sites keep compiling; `instanceof` matches on the `code` discriminant, and
+* the answer is never an `Error`.
 */
-var UnsupportedZapperFunctionError = class extends Error {
-	zapper;
-	functionName;
-	constructor(zapper, functionName) {
-		super(`unsupported zapper function "${functionName}" on ${zapper}`);
-		this.name = "UnsupportedZapperFunctionError";
-		this.zapper = zapper;
-		this.functionName = functionName;
-	}
-};
+const UnsupportedZapperFunctionError = unsupportedZapperFunction;
 //#endregion
 exports.UnsupportedZapperFunctionError = UnsupportedZapperFunctionError;

package/dist/cjs/onchain/validation/index.js

@@ -2,7 +2,6 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_onchain_validation_checks = require("./checks.js");
 const require_onchain_validation_refusal = require("./refusal.js");
 const require_onchain_validation_token = require("./token.js");
-exports.IntentPreviewError = require_onchain_validation_refusal.IntentPreviewError;
 exports.MIN_HEALTH_FACTOR_FACADE = require_onchain_validation_checks.MIN_HEALTH_FACTOR_FACADE;
 exports.MIN_HEALTH_FACTOR_FORM = require_onchain_validation_checks.MIN_HEALTH_FACTOR_FORM;
 exports.MIN_HF_LIMITED = require_onchain_validation_checks.MIN_HF_LIMITED;

package/dist/cjs/preview/index.js

@@ -1,6 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_onchain_market_zapper_errors = require("../onchain/market/zapper/errors.js");
 const require_onchain_validation_refusal = require("../onchain/validation/refusal.js");
+const require_onchain_accounts_withdrawal_compressor_errors = require("../onchain/accounts/withdrawal-compressor/errors.js");
 const require_preview_trace_errors = require("./trace/errors.js");
 const require_preview_trace_extractAdapterCallTraces = require("./trace/extractAdapterCallTraces.js");
 const require_preview_trace_extractTransfers = require("./trace/extractTransfers.js");
@@ -31,6 +32,7 @@ const require_preview_preview_replayInnerOperations = require("./preview/replayI
 const require_preview_preview_replayMulticall = require("./preview/replayMulticall.js");
 const require_preview_preview_previewAdjustStrategyPosition = require("./preview/previewAdjustStrategyPosition.js");
 const require_preview_preview_previewExitOrRepayStrategyPosition = require("./preview/previewExitOrRepayStrategyPosition.js");
+const require_preview_simulate_errors = require("./simulate/errors.js");
 const require_preview_preview_previewOperation = require("./preview/previewOperation.js");
 require("./preview/index.js");
 require("./types.js");
@@ -40,8 +42,9 @@ require("./validate/index.js");
 exports.AllowancePrerequisite = require_preview_prerequisites_AllowancePrerequisite.AllowancePrerequisite;
 exports.BalancePrerequisite = require_preview_prerequisites_BalancePrerequisite.BalancePrerequisite;
 exports.CreditAccountState = require_preview_preview_CreditAccountState.CreditAccountState;
-exports.IntentPreviewError = require_onchain_validation_refusal.IntentPreviewError;
+exports.InvalidDelayedIntentError = require_onchain_accounts_withdrawal_compressor_errors.InvalidDelayedIntentError;
 exports.Prerequisite = require_preview_prerequisites_Prerequisite.Prerequisite;
+exports.PreviewSimulationError = require_preview_simulate_errors.PreviewSimulationError;
 exports.RWAOpenRequirementsPrerequisite = require_preview_prerequisites_RWAOpenRequirementsPrerequisite.RWAOpenRequirementsPrerequisite;
 exports.TransferAlignmentError = require_preview_trace_errors.TransferAlignmentError;
 exports.UnexpectedFacadeEventOrderError = require_preview_trace_errors.UnexpectedFacadeEventOrderError;

package/dist/cjs/preview/parse/errors.js

@@ -1,32 +1,35 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_onchain_market_zapper_errors = require("../../onchain/market/zapper/errors.js");
-require("../../onchain/index.js");
 //#region src/preview/parse/errors.ts
+function unsupportedTarget(target) {
+	return {
+		code: "unsupportedTarget",
+		message: `unsupported transaction target: ${target}`,
+		target
+	};
+}
+Object.defineProperty(unsupportedTarget, Symbol.hasInstance, { value: (value) => typeof value === "object" && value !== null && value.code === "unsupportedTarget" });
 /**
-* Thrown when the target of a transaction is neither a known Gearbox pool nor a
-* credit facade.
+* Builds the verdict. Callable with or without `new`, so pre-declassing raise
+* sites keep compiling; `instanceof` matches on the `code` discriminant, and
+* the answer is never an `Error`.
 */
-var UnsupportedTargetError = class extends Error {
-	target;
-	constructor(target) {
-		super(`unsupported transaction target: ${target}`);
-		this.name = "UnsupportedTargetError";
-		this.target = target;
-	}
-};
+const UnsupportedTargetError = unsupportedTarget;
+function unsupportedPoolFunction(pool, functionName) {
+	return {
+		code: "unsupportedPoolFunction",
+		message: `unsupported pool function "${functionName}" on ${pool}`,
+		pool,
+		functionName
+	};
+}
+Object.defineProperty(unsupportedPoolFunction, Symbol.hasInstance, { value: (value) => typeof value === "object" && value !== null && value.code === "unsupportedPoolFunction" });
 /**
-* Thrown when a pool call uses a function other than ERC4626 `deposit`/`redeem`.
+* Builds the verdict. Callable with or without `new`, so pre-declassing raise
+* sites keep compiling; `instanceof` matches on the `code` discriminant, and
+* the answer is never an `Error`.
 */
-var UnsupportedPoolFunctionError = class extends Error {
-	pool;
-	functionName;
-	constructor(pool, functionName) {
-		super(`unsupported pool function "${functionName}" on ${pool}`);
-		this.name = "UnsupportedPoolFunctionError";
-		this.pool = pool;
-		this.functionName = functionName;
-	}
-};
+const UnsupportedPoolFunctionError = unsupportedPoolFunction;
 //#endregion
 exports.UnsupportedPoolFunctionError = UnsupportedPoolFunctionError;
 exports.UnsupportedTargetError = UnsupportedTargetError;

package/dist/cjs/preview/preview/errors.js

@@ -1,17 +1,18 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/preview/preview/errors.ts
+function unsupportedOperation(operation) {
+	return {
+		code: "unsupportedOperation",
+		message: `operation "${operation}" is not supported by previewOperation`,
+		operation
+	};
+}
+Object.defineProperty(unsupportedOperation, Symbol.hasInstance, { value: (value) => typeof value === "object" && value !== null && value.code === "unsupportedOperation" });
 /**
-* Thrown by `previewOperation` for parsed operations it cannot preview yet.
-* Currently only pool operations and credit account opening are supported.
+* Builds the verdict. Callable with or without `new`, so pre-declassing raise
+* sites keep compiling; `instanceof` matches on the `code` discriminant, and
+* the answer is never an `Error`.
 */
-var UnsupportedOperationError = class extends Error {
-	/** The parsed operation kind (the `operation` discriminant). */
-	operation;
-	constructor(operation) {
-		super(`operation "${operation}" is not supported by previewOperation`);
-		this.name = "UnsupportedOperationError";
-		this.operation = operation;
-	}
-};
+const UnsupportedOperationError = unsupportedOperation;
 //#endregion
 exports.UnsupportedOperationError = UnsupportedOperationError;

package/dist/cjs/preview/preview/previewOperation.js

@@ -1,4 +1,10 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_model_result = require("../../model/result.js");
+require("../../model/index.js");
+const require_onchain_market_zapper_errors = require("../../onchain/market/zapper/errors.js");
+const require_onchain_accounts_withdrawal_compressor_errors = require("../../onchain/accounts/withdrawal-compressor/errors.js");
+require("../../onchain/index.js");
+const require_preview_parse_errors = require("../parse/errors.js");
 const require_preview_parse_parseOperationCalldata = require("../parse/parseOperationCalldata.js");
 const require_preview_parse_types = require("../parse/types.js");
 require("../parse/index.js");
@@ -11,25 +17,50 @@ const require_preview_preview_estimateClaimableAt = require("./estimateClaimable
 const require_preview_preview_replayMulticall = require("./replayMulticall.js");
 const require_preview_preview_previewAdjustStrategyPosition = require("./previewAdjustStrategyPosition.js");
 const require_preview_preview_previewExitOrRepayStrategyPosition = require("./previewExitOrRepayStrategyPosition.js");
+const require_preview_simulate_errors = require("../simulate/errors.js");
 const require_preview_preview_previewOpenStrategyPosition = require("./previewOpenStrategyPosition.js");
 const require_preview_preview_previewPoolPositionOperation = require("./previewPoolPositionOperation.js");
 //#region src/preview/preview/previewOperation.ts
 /**
+* Narrows a raised value to the verdict vocabulary: a plain non-`Error`
+* object whose `code` is one of the preview verdicts. Genuine exceptions —
+* bugs, outages, calldata the parser cannot read at all — fail the check and
+* keep propagating as throws.
+*/
+function isPreviewVerdict(raised) {
+	if (typeof raised !== "object" || raised === null || raised instanceof Error) return false;
+	return raised instanceof require_preview_parse_errors.UnsupportedTargetError || raised instanceof require_preview_parse_errors.UnsupportedPoolFunctionError || raised instanceof require_onchain_market_zapper_errors.UnsupportedZapperFunctionError || raised instanceof require_preview_preview_errors.UnsupportedOperationError || raised instanceof require_onchain_accounts_withdrawal_compressor_errors.InvalidDelayedIntentError || raised instanceof require_preview_simulate_errors.PreviewSimulationError;
+}
+/**
 * Previews a raw operation calldata: decodes it into a typed operation and
 * assembles an operation-specific, human-displayable preview.
+*
+* Answers an {@link SDKReturn} envelope: the preview behind `ok: true`, or —
+* when the transaction is one the previewer refuses to read — a
+* {@link PreviewVerdictError} behind `ok: false`. A thrown exception still
+* means the SDK could not do its job (a read failed, the targeted credit
+* account could not be resolved), not a verdict on the transaction.
 */
 async function previewOperation(input, options) {
-	const operation = require_preview_parse_parseOperationCalldata.parseOperationCalldata(input);
-	if (require_preview_parse_types.isPoolOperation(operation)) return require_preview_preview_previewPoolPositionOperation.previewPoolPositionOperation(input, operation, options);
-	if (operation.operation === "OpenCreditAccount" || operation.operation === "RWAOpenCreditAccount") return require_preview_preview_previewOpenStrategyPosition.previewOpenStrategyPosition(input, operation);
-	if (operation.operation === "CloseCreditAccount") {
-		const resolved = await resolveCreditAccount(input, operation, options);
-		const preview = require_preview_preview_previewExitOrRepayStrategyPosition.previewExitOrRepayStrategyPosition(input, operation, true, resolved);
-		preview.intent = await require_preview_preview_detectDelayedClaim.resolveDelayedClaimIntent(input.sdk, operation.multicall, options?.blockNumber);
-		return preview;
+	try {
+		const operation = require_preview_parse_parseOperationCalldata.parseOperationCalldata(input);
+		if (require_preview_parse_types.isPoolOperation(operation)) return require_model_result.sdkOk(await require_preview_preview_previewPoolPositionOperation.previewPoolPositionOperation(input, operation, options));
+		if (operation.operation === "OpenCreditAccount" || operation.operation === "RWAOpenCreditAccount") return require_model_result.sdkOk(await require_preview_preview_previewOpenStrategyPosition.previewOpenStrategyPosition(input, operation));
+		if (operation.operation === "CloseCreditAccount") {
+			const resolved = await resolveCreditAccount(input, operation, options);
+			const preview = require_preview_preview_previewExitOrRepayStrategyPosition.previewExitOrRepayStrategyPosition(input, operation, true, resolved);
+			preview.intent = await require_preview_preview_detectDelayedClaim.resolveDelayedClaimIntent(input.sdk, operation.multicall, options?.blockNumber);
+			return require_model_result.sdkOk(preview);
+		}
+		if (operation.operation === "MultiCall" || operation.operation === "BotMulticall" || operation.operation === "RWAMulticall") {
+			const resolved = await resolveCreditAccount(input, operation, options);
+			return require_model_result.sdkOk(await previewMulticallOperation(input, operation, resolved));
+		}
+		return require_model_result.sdkErr(require_preview_preview_errors.UnsupportedOperationError(operation.operation));
+	} catch (raised) {
+		if (isPreviewVerdict(raised)) return require_model_result.sdkErr(raised);
+		throw raised;
 	}
-	if (operation.operation === "MultiCall" || operation.operation === "BotMulticall" || operation.operation === "RWAMulticall") return previewMulticallOperation(input, operation, await resolveCreditAccount(input, operation, options));
-	throw new require_preview_preview_errors.UnsupportedOperationError(operation.operation);
 }
 /**
 * Resolves the pre-state of the credit account an operation targets: uses the

package/dist/cjs/preview/simulate/errors.js

@@ -2,33 +2,34 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_abi_errors = require("../../abi/errors.js");
 let viem = require("viem");
 //#region src/preview/simulate/errors.ts
+function previewSimulationFailed(failures) {
+	const message = failures.length <= 1 ? failures[0]?.detail.reason ?? "simulation failed" : "all simulation flows failed";
+	const cause = failures.find((f) => f.detail.cause instanceof Error)?.detail.cause;
+	const verdict = {
+		code: "previewSimulationFailed",
+		message,
+		failures
+	};
+	if (cause) verdict.cause = cause;
+	return verdict;
+}
+Object.defineProperty(previewSimulationFailed, Symbol.hasInstance, { value: (value) => typeof value === "object" && value !== null && value.code === "previewSimulationFailed" });
 /**
-* Error returned by the pool simulation when it fails. It wraps the flow's
-* decoded revert reason (see {@link failures}).
+* Builds the verdict. Callable with or without `new`, so pre-declassing raise
+* sites keep compiling; `instanceof` matches on the `code` discriminant, and
+* the answer is never an `Error`.
 */
-var PreviewSimulationError = class extends viem.BaseError {
-	name = "PreviewSimulationError";
-	/** Per-flow decoded failures behind this error. */
-	failures;
-	constructor(failures) {
-		const shortMessage = failures.length <= 1 ? failures[0]?.detail.reason ?? "simulation failed" : "all simulation flows failed";
-		const cause = failures.find((f) => f.detail.cause instanceof Error)?.detail.cause;
-		super(shortMessage, {
-			metaMessages: failures.map((f) => `[${f.source}] ${f.detail.reason}`),
-			cause
-		});
-		this.failures = failures;
-	}
-};
+const PreviewSimulationError = previewSimulationFailed;
 /**
 * Normalises an unknown rejection reason into a {@link PreviewSimulationError}.
 * Pass-through when it already is one; otherwise decodes it under `source`.
 */
 function asPreviewSimulationError(reason, source) {
 	if (reason instanceof PreviewSimulationError) return reason;
+	const error = reason instanceof Error ? reason : new Error(String(reason));
 	return new PreviewSimulationError([{
 		source,
-		detail: decodeSimulationError({ error: reason instanceof Error ? reason : new Error(String(reason)) })
+		detail: decodeSimulationError({ error })
 	}]);
 }
 /**

package/dist/cjs/sdk/execute/ExecuteApi.js

@@ -12,7 +12,7 @@ var ExecuteApi = class {
 	* {@inheritDoc IOpportunitiesExecute.buildTx}
 	**/
 	async buildTx(request) {
-		if (!request.sim.success) throw new Error(`cannot build a transaction from a failed ${request.kind} preparation`);
+		if (!request.sim.ok) throw new Error(`cannot build a transaction from a failed ${request.kind} preparation`);
 		const sdk = this.#chainOf(request.chainId);
 		switch (request.kind) {
 			case "pool": return poolTx(sdk, request);

package/dist/cjs/sdk/index.js

@@ -52,5 +52,5 @@ exports.mergeChainOne = require_sdk_utils_mergeChains.mergeChainOne;
 exports.noStrategyTargetCollateral = require_sdk_prepare_errors.noStrategyTargetCollateral;
 exports.raise = require_onchain_validation_refusal.raise;
 exports.refuse = require_onchain_validation_refusal.refuse;
-exports.toPrepareError = require_sdk_prepare_errors.toPrepareError;
+exports.toRefusalError = require_sdk_prepare_errors.toRefusalError;
 exports.unexpectedFailure = require_sdk_prepare_errors.unexpectedFailure;