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

package/dist/cjs/sdk/prepare/errors.js

@@ -0,0 +1,90 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/sdk/prepare/errors.ts
+/**
+* One sentence per refusal, naming what was ruled out rather than restating the
+* numbers the error already carries.
+*
+* English and loggable, not a string to put on a screen: a form renders the
+* code and the amounts in its own words, see {@link IGearboxError.message}.
+**/
+const MESSAGES = {
+	debtOutOfRange: "The debt this request implies is outside the market's band.",
+	leverageOutOfRange: "The leverage asked for cannot be expressed as a plan.",
+	insufficientSourceBalance: "Neither the account nor the wallet holds enough to fund this request.",
+	unsupportedCollateralToken: "This flow does not accept that token.",
+	unsupportedTokenPair: "No route exists between these two tokens.",
+	noDelayedRoute: "This request cannot be served as a delayed redemption.",
+	multipleDelayedWithdrawals: "The source asset has several redemption venues and none was named.",
+	withdrawalInProgress: "A redemption of this asset is already in flight on the account.",
+	noRecordedIntent: "The claim names no operation to resume.",
+	marketPaused: "The market is paused.",
+	marketExpired: "The market is past its expiration date.",
+	insufficientPoolLiquidity: "The pool cannot lend what this plan draws.",
+	quotaLimitReached: "The market takes no more quota for a token this plan holds.",
+	forbiddenToken: "This plan would increase the balance of a forbidden token.",
+	insufficientCollateral: "The account would end this transaction under-collateralised.",
+	poolSunset: "The pool is winding down and takes no more deposits.",
+	quotaCountExceeded: "The account would hold more quoted tokens than the facade enables at once.",
+	malformedTransaction: "The transaction could not be replayed."
+};
+/**
+* The engine's refusal, as the error the namespace answers with.
+*
+* One place does the lifting, so the two shapes cannot drift: `reason` becomes
+* `code`, the detail is spread onto the error, and the sentence comes from
+* {@link MESSAGES}. A malformed transaction is spelled out rather than spread,
+* because its detail names a `code` and a `message` of its own and they are not
+* the envelope's.
+**/
+function toPrepareError(issue) {
+	if (issue.reason === "malformedTransaction") return {
+		code: "malformedTransaction",
+		message: MESSAGES.malformedTransaction,
+		previewCode: issue.detail.code,
+		detail: issue.detail.message
+	};
+	return {
+		code: issue.reason,
+		message: MESSAGES[issue.reason],
+		...issue.detail
+	};
+}
+/**
+* {@inheritDoc NoStrategyTargetCollateralError}
+**/
+function noStrategyTargetCollateral(creditManager) {
+	return {
+		code: "noStrategyTargetCollateral",
+		message: `Credit manager ${creditManager} has no strategy target collateral, and none was named.`,
+		creditManager
+	};
+}
+/**
+* {@inheritDoc CreditAccountNotFoundError}
+**/
+function creditAccountNotFound(creditAccount) {
+	return {
+		code: "creditAccountNotFound",
+		message: `Credit account not found: ${creditAccount}.`,
+		creditAccount
+	};
+}
+/**
+* {@inheritDoc UnexpectedFailureError}
+*
+* Takes what was thrown, whatever that is: a `throw` is not obliged to raise an
+* `Error`, and `cause` promises one.
+**/
+function unexpectedFailure(thrown) {
+	const cause = thrown instanceof Error ? thrown : new Error(String(thrown));
+	return {
+		code: "unexpectedFailure",
+		message: `The SDK could not prepare this operation: ${cause.message}`,
+		cause
+	};
+}
+//#endregion
+exports.creditAccountNotFound = creditAccountNotFound;
+exports.noStrategyTargetCollateral = noStrategyTargetCollateral;
+exports.toPrepareError = toPrepareError;
+exports.unexpectedFailure = unexpectedFailure;

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

@@ -1,8 +1,13 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_onchain_validation_refusal = require("../../onchain/validation/refusal.js");
+const require_sdk_prepare_errors = require("./errors.js");
 const require_sdk_prepare_PrepareApi = require("./PrepareApi.js");
 require("./types.js");
 exports.IntentPreviewError = require_onchain_validation_refusal.IntentPreviewError;
 exports.PrepareApi = require_sdk_prepare_PrepareApi.PrepareApi;
+exports.creditAccountNotFound = require_sdk_prepare_errors.creditAccountNotFound;
+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.unexpectedFailure = require_sdk_prepare_errors.unexpectedFailure;

package/dist/esm/model/errors.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/model/index.js

@@ -5,6 +5,7 @@ import { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chart
 import "./curators.js";
 import { curatorNameSchema, curatorSchema } from "./curators.schema.js";
 import "./delayed-intents.js";
+import "./errors.js";
 import { FILTER_ALL, isFilterSet } from "./filters.js";
 import { booleanParamSchema, encodeFlag, filterAllSchema, filterable } from "./filters.schema.js";
 import { matchesLiquidatableAccountFilter } from "./liquidations.js";

package/dist/esm/onchain/accounts/intents/open-strategy.js

@@ -10,7 +10,7 @@ import "./utils/index.js";
 const NO_ACCOUNT = "0x0000000000000000000000000000000000000000";
 /**
 * Builds the state opening a leveraged position out of wallet collateral would
-* land in.
+* reach.
 *
 * Debt follows from the target leverage against the supplied margin
 * (`debt = margin * (L - 1)`, `totalValue = margin * L`); the collateral and the

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

@@ -11,7 +11,7 @@ var ExecuteApi = class {
 	* {@inheritDoc IOpportunitiesExecute.buildTx}
 	**/
 	async buildTx(request) {
-		if (!request.sim.ok) throw new Error(`cannot build a transaction from a failed ${request.kind} preparation`);
+		if (!request.sim.success) 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);
@@ -22,7 +22,7 @@ var ExecuteApi = class {
 };
 function poolTx(sdk, request) {
 	const { pool, wallet, sim } = request;
-	const { tokenIn, tokenOut } = sim.state;
+	const { tokenIn, tokenOut } = sim.data.state;
 	if (request.op === "deposit") {
 		const meta = sdk.pools.getDepositMetadata(pool, tokenIn.token.address, tokenOut.token.address);
 		const result = sdk.pools.addLiquidity({
@@ -49,7 +49,7 @@ function poolTx(sdk, request) {
 }
 async function openTx(sdk, request) {
 	const { creditManager, wallet, collateral, ethAmount, sim } = request;
-	const { state } = sim;
+	const { state } = sim.data;
 	return sdk.accounts.openCA({
 		creditManager,
 		to: wallet,
@@ -82,7 +82,7 @@ async function openRwaOptions(sdk, request) {
 async function accountTx(sdk, request) {
 	const account = await sdk.accounts.getCreditAccountData(request.creditAccount);
 	if (!account) throw new Error(`credit account not found: ${request.creditAccount}`);
-	return sdk.accounts.executeCaUpdate(account, request.sim.calls, { ethAmount: nativeValue(request.sim.operations) });
+	return sdk.accounts.executeCaUpdate(account, request.sim.data.calls, { ethAmount: nativeValue(request.sim.data.operations) });
 }
 /**
 * The coin the preparation asked the wallet for, which the facade wraps out of

package/dist/esm/sdk/index.js

@@ -12,6 +12,7 @@ import { LiquidationsNamespace } from "./liquidations/LiquidationsNamespace.js";
 import "./liquidations/index.js";
 import { ExecuteApi } from "./execute/ExecuteApi.js";
 import "./execute/index.js";
+import { creditAccountNotFound, noStrategyTargetCollateral, toPrepareError, unexpectedFailure } from "./prepare/errors.js";
 import { PrepareApi } from "./prepare/PrepareApi.js";
 import "./prepare/index.js";
 import { filterResponse } from "./utils/filterResponse.js";
@@ -25,4 +26,4 @@ import { PreviewNamespace } from "./preview/PreviewNamespace.js";
 import "./preview/index.js";
 import { DEFAULT_MAX_STATE_AGE, GearboxSDK } from "./GearboxSDK.js";
 import "./types.js";
-export { AbstractNamespace, AllSourcesFailedError, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, ExecuteApi, GearboxSDK, IntentPreviewError, LiquidationsNamespace, MissingSourceError, NoSourceServedError, OpportunitiesNamespace, PositionsNamespace, PrepareApi, PreviewNamespace, SourceChainMismatchError, SourceUnavailableError, assertSameChains, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, raise, refuse };
+export { AbstractNamespace, AllSourcesFailedError, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, ExecuteApi, GearboxSDK, IntentPreviewError, LiquidationsNamespace, MissingSourceError, NoSourceServedError, OpportunitiesNamespace, PositionsNamespace, PrepareApi, PreviewNamespace, SourceChainMismatchError, SourceUnavailableError, assertSameChains, creditAccountNotFound, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, noStrategyTargetCollateral, raise, refuse, toPrepareError, unexpectedFailure };