@gearbox-protocol/sdk 16.0.0-next.40 → 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/dev/AccountOpener.js

@@ -1,5 +1,5 @@
-import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
 import { ierc20Abi } from "../abi/iERC20.js";
+import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
 import { AddressMap } from "../onchain/utils/AddressMap.js";
 import { AddressSet } from "../onchain/utils/AddressSet.js";
 import { AssetsMap } from "../onchain/utils/AssetsMap.js";

package/dist/esm/dev/withdrawalUtils.js

@@ -1,6 +1,6 @@
+import { iWithdrawalCompressorV313Abi } from "../abi/IWithdrawalCompressorV313.js";
 import { getNetworkType } from "../onchain/chain/chains.js";
 import { getWithdrawalCompressorAddress } from "../onchain/accounts/withdrawal-compressor/addresses.js";
-import { iWithdrawalCompressorV313Abi } from "../abi/IWithdrawalCompressorV313.js";
 import "../onchain/index.js";
 import { iMidasDataFeedAbi, iMidasRedemptionVaultAbi, midasGatewayAbi, midasRedeemerAbi, midasRedemptionVaultPhantomTokenAbi, securitizeRedeemerAbi, securitizeRedemptionGatewayAbi, securitizeRedemptionPhantomTokenAbi } from "./withdrawalAbi.js";
 import { erc20Abi, hexToString, parseAbi, parseEther } from "viem";

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/CreditAccountsServiceV310.js

@@ -1,3 +1,5 @@
+import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
+import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
 import { AP_REWARDS_COMPRESSOR } from "../constants/address-provider.js";
 import { ADDRESS_0X0 } from "../constants/addresses.js";
 import { MAX_UINT256 } from "../constants/math.js";
@@ -8,8 +10,6 @@ import "../base/index.js";
 import { AccountBotsService } from "./bots/AccountBotsService.js";
 import "./bots/index.js";
 import { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
-import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
-import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
 import { expectedBalanceDeltas } from "../market/credit/expectedBalanceDeltas.js";
 import "../market/index.js";
 import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccountCompressor.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/onchain/accounts/liquidations/LiquidationsService.js

@@ -1,3 +1,4 @@
+import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
 import { AddressSet } from "../../utils/AddressSet.js";
 import { bytes32ToString } from "../../utils/bytes32ToString.js";
 import { ADDRESS_0X0 } from "../../constants/addresses.js";
@@ -19,7 +20,6 @@ import { SecuritizeLiquidatorContract } from "../../market/rwa/securitize/Securi
 import "../../market/rwa/securitize/index.js";
 import "../../market/index.js";
 import { LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./constants.js";
-import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
 import { skipLiquidatableAccount } from "./skipLiquidatableAccount.js";
 //#region src/onchain/accounts/liquidations/LiquidationsService.ts
 /**

package/dist/esm/onchain/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.js

@@ -1,7 +1,7 @@
+import { iRedemptionLoggerV310Abi } from "../../../abi/iRedemptionLoggerV310.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
 import { decodeDelayedIntent } from "./intent-codec.js";
-import { iRedemptionLoggerV310Abi } from "../../../abi/iRedemptionLoggerV310.js";
 import { InvalidDelayedIntentError } from "./errors.js";
 //#region src/onchain/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.ts
 const abi = iRedemptionLoggerV310Abi;

package/dist/esm/onchain/accounts/withdrawal-compressor/WithdrawalCompressorV310Contract.js

@@ -1,5 +1,5 @@
-import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 import { iWithdrawalCompressorV310Abi } from "../../../abi/IWithdrawalCompressorV310.js";
+import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 //#region src/onchain/accounts/withdrawal-compressor/WithdrawalCompressorV310Contract.ts
 const abi = iWithdrawalCompressorV310Abi;
 /**

package/dist/esm/onchain/accounts/withdrawal-compressor/WithdrawalCompressorV311Contract.js

@@ -1,5 +1,5 @@
-import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 import { iWithdrawalCompressorV311Abi } from "../../../abi/IWithdrawalCompressorV311.js";
+import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 //#region src/onchain/accounts/withdrawal-compressor/WithdrawalCompressorV311Contract.ts
 const abi = iWithdrawalCompressorV311Abi;
 /**

package/dist/esm/onchain/accounts/withdrawal-compressor/WithdrawalCompressorV313Contract.js

@@ -1,6 +1,6 @@
+import { iWithdrawalCompressorV313Abi } from "../../../abi/IWithdrawalCompressorV313.js";
 import { encodeDelayedIntent } from "./intent-codec.js";
 import { AbstractWithdrawalCompressorContract, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal } from "./AbstractWithdrawalCompressorContract.js";
-import { iWithdrawalCompressorV313Abi } from "../../../abi/IWithdrawalCompressorV313.js";
 import { toWithdrawalStatus } from "./types.js";
 //#region src/onchain/accounts/withdrawal-compressor/WithdrawalCompressorV313Contract.ts
 const abi = iWithdrawalCompressorV313Abi;

package/dist/esm/onchain/base/TokensMeta.js

@@ -1,12 +1,12 @@
+import { iExpirableAbi } from "../../abi/iExpirable.js";
+import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
+import { iVersionAbi } from "../../abi/iVersion.js";
 import { AddressMap } from "../utils/AddressMap.js";
 import { AddressSet } from "../utils/AddressSet.js";
 import { bytes32ToString } from "../utils/bytes32ToString.js";
 import { getAssetType } from "../chain/chains.js";
 import { formatBN } from "../utils/formatter.js";
 import "../utils/index.js";
-import { iExpirableAbi } from "../../abi/iExpirable.js";
-import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
-import { iVersionAbi } from "../../abi/iVersion.js";
 import { SdkRWADataNotLoadedError } from "../core/errors.js";
 import { executeMulticallBatches } from "../utils/viem/executeMulticallBatches.js";
 //#region src/onchain/base/TokensMeta.ts

package/dist/esm/onchain/core/createAddressProvider.js

@@ -1,8 +1,8 @@
+import { iVersionAbi } from "../../abi/iVersion.js";
 import { AP_MARKET_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR } from "../constants/address-provider.js";
 import { isV310 } from "../constants/versions.js";
 import "../constants/index.js";
 import { hexEq } from "../utils/hex.js";
-import { iVersionAbi } from "../../abi/iVersion.js";
 import { AddressProviderV310Contract } from "./AddressProviderV310Contract.js";
 //#region src/onchain/core/createAddressProvider.ts
 const OVERRIDE_ADDRESSES = { Mainnet: {

package/dist/esm/onchain/market/adapters/contracts/AccountMigratorAdapterContract.js

@@ -1,5 +1,5 @@
-import { AbstractAdapterContract } from "./AbstractAdapter.js";
 import { accountMigratorAbi } from "../../../../abi/AccountMigrator.js";
+import { AbstractAdapterContract } from "./AbstractAdapter.js";
 //#region src/onchain/market/adapters/contracts/AccountMigratorAdapterContract.ts
 const abi = accountMigratorAbi;
 const protocolAbi = accountMigratorAbi;

package/dist/esm/onchain/market/adapters/contracts/ERC4626AdapterContract.js

@@ -1,6 +1,6 @@
+import { ierc4626AdapterAbi } from "../../../../abi/ierc4626Adapter.js";
 import { MissingSerializedParamsError } from "../../../base/errors.js";
 import "../../../base/index.js";
-import { ierc4626AdapterAbi } from "../../../../abi/ierc4626Adapter.js";
 import { iERC4626Abi } from "../abi/targetContractAbi.js";
 import { fnSigToName, swapFromTransfers } from "../transferHelpers.js";
 import { AbstractAdapterContract } from "./AbstractAdapter.js";

package/dist/esm/onchain/market/credit/CreditFacadeV310BaseContract.js

@@ -1,7 +1,7 @@
+import { iPausableAbi } from "../../../abi/iPausable.js";
 import { iCreditFacadeMulticallV310Abi, iCreditFacadeV310Abi } from "../../../abi/310/generated.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
-import { iPausableAbi } from "../../../abi/iPausable.js";
 //#region src/onchain/market/credit/CreditFacadeV310BaseContract.ts
 const abi = [
 	...iCreditFacadeV310Abi,

package/dist/esm/onchain/market/pool/PoolV310Contract.js

@@ -1,3 +1,4 @@
+import { iPausableAbi } from "../../../abi/iPausable.js";
 import { iPoolV310Abi } from "../../../abi/310/generated.js";
 import { AddressMap } from "../../utils/AddressMap.js";
 import { RAY } from "../../constants/math.js";
@@ -7,7 +8,6 @@ import "../../utils/index.js";
 import { SdkRWADataNotLoadedError } from "../../core/errors.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
-import { iPausableAbi } from "../../../abi/iPausable.js";
 //#region src/onchain/market/pool/PoolV310Contract.ts
 const abi = [...iPoolV310Abi, ...iPausableAbi];
 var PoolV310Contract = class extends BaseContract {

package/dist/esm/onchain/market/zapper/IETHZapperContract.js

@@ -1,5 +1,5 @@
-import { ZapperContract } from "./ZapperContract.js";
 import { iethZapperAbi } from "../../../abi/iETHZapper.js";
+import { ZapperContract } from "./ZapperContract.js";
 //#region src/onchain/market/zapper/IETHZapperContract.ts
 const abi = iethZapperAbi;
 var IETHZapperContract = class extends ZapperContract {

package/dist/esm/onchain/market/zapper/ZapperContract.js

@@ -1,6 +1,6 @@
+import { iZapperAbi } from "../../../abi/iZapper.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
-import { iZapperAbi } from "../../../abi/iZapper.js";
 import { UnsupportedZapperFunctionError } from "./errors.js";
 //#region src/onchain/market/zapper/ZapperContract.ts
 /**

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

@@ -68,14 +68,6 @@ var PositionsService = class extends SDKConstruct {
 	}
 	/**
 	* Returns delayed withdrawals of a strategy position
-	*
-	* Empty when this chain has no withdrawal compressor, or when the account's
-	* credit manager has no withdrawal config — no config, no withdrawal, and
-	* nothing to ask the chain about.
-	*
-	* The manager comes from the caller. It used to be read off the account
-	* here, which cost an uncached read of the whole account to learn one field
-	* every caller already knows.
 	**/
 	async getCurrentWithdrawals(props) {
 		const { creditAccount, creditManager, blockNumber } = props;
@@ -84,9 +76,7 @@ var PositionsService = class extends SDKConstruct {
 			pending: []
 		};
 		const compressor = this.sdk.withdrawalCompressor;
-		if (!compressor) return empty;
-		await compressor.loadWithdrawableAssets();
-		if (compressor.getWithdrawableAssets(creditManager).length === 0) return empty;
+		if (!compressor?.getWithdrawableAssets(creditManager).length) return empty;
 		const { priceOracle } = this.sdk.marketRegister.findByCreditManager(creditManager);
 		return this.#toPositionWithdrawals(await compressor.getCurrentWithdrawals(creditAccount, blockNumber), priceOracle);
 	}

package/dist/esm/onchain/utils/viem/simulateWithPriceUpdates.js

@@ -1,6 +1,6 @@
 import { errorAbis } from "../../../abi/errors.js";
-import { generateCastTraceCall } from "./cast.js";
 import { iUpdatablePriceFeedAbi } from "../../../abi/iUpdatablePriceFeed.js";
+import { generateCastTraceCall } from "./cast.js";
 import { simulateMulticall } from "./simulateMulticall.js";
 import { BaseError, CallExecutionError, ContractFunctionRevertedError, decodeFunctionData, decodeFunctionResult, encodeFunctionData, parseAbi } from "viem";
 import { getAction, parseAccount } from "viem/utils";

package/dist/esm/preview/simulate/simulatePoolOperation.js

@@ -1,5 +1,5 @@
-import { iPoolV310Abi } from "../../abi/310/generated.js";
 import { iZapperAbi } from "../../abi/iZapper.js";
+import { iPoolV310Abi } from "../../abi/310/generated.js";
 import { asPreviewSimulationError } from "./errors.js";
 //#region src/preview/simulate/simulatePoolOperation.ts
 function previewRead(operation) {

package/dist/esm/preview/trace/extractTransfers.js

@@ -1,5 +1,5 @@
-import { iCreditFacadeV310Abi } from "../../abi/310/generated.js";
 import { ierc20Abi } from "../../abi/iERC20.js";
+import { iCreditFacadeV310Abi } from "../../abi/310/generated.js";
 import { AddressMap } from "../../onchain/utils/AddressMap.js";
 import "../../onchain/index.js";
 import { UnexpectedFacadeEventOrderError } from "./errors.js";

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 };