@gearbox-protocol/sdk 16.2.0 → 16.3.0-next.1

package/dist/esm/preview/prerequisites/buildRWAPrerequisites.js

@@ -1,38 +0,0 @@
-import { AddressSet } from "../../onchain/utils/AddressSet.js";
-import "../../onchain/index.js";
-import { RWAOpenRequirementsPrerequisite } from "./RWAOpenRequirementsPrerequisite.js";
-//#region src/preview/prerequisites/buildRWAPrerequisites.ts
-/**
-* For RWA-factory open-account operations (e.g. `RWAOpenCreditAccount`),
-* builds a prerequisite per RWA token the multicall touches; each one checks
-* the factory's open-account requirements (issuer-side token registration,
-* EIP-712 signatures) at verify time.
-*
-* The `providedArgs` params are the registration values decoded from the
-* transaction calldata itself: signatures already included there satisfy the
-* signature requirement, so a fully built transaction is not reported as
-* missing signatures. In the template flow they are empty and the verified
-* result's `detail.missing` describes what is still unfulfilled; acting on it
-* (signing, rebuilding calldata) is up to the consumer.
-*
-* Returns nothing for non-RWA markets.
-*/
-function buildRWAPrerequisites(multicall, creditManager, providedArgs, ctx) {
-	const { rwaFactory } = ctx.sdk.marketRegister.findByCreditManager(creditManager);
-	if (!rwaFactory) return [];
-	const rwaTokens = new AddressSet(rwaFactory.getTokens());
-	const candidates = new AddressSet();
-	for (const op of multicall) if (op.operation === "AddCollateral" || op.operation === "UpdateQuota") candidates.add(op.token);
-	const prereqs = [];
-	for (const token of candidates) {
-		if (!rwaTokens.has(token)) continue;
-		prereqs.push(new RWAOpenRequirementsPrerequisite({
-			token,
-			creditManager,
-			factory: rwaFactory.address
-		}, providedArgs));
-	}
-	return prereqs;
-}
-//#endregion
-export { buildRWAPrerequisites };

package/dist/esm/preview/prerequisites/checkPrerequisites.js

@@ -1,73 +0,0 @@
-import { isSDKError, sdkOk } from "../../model/result.js";
-import "../../model/index.js";
-import { parseOperationCalldata } from "../parse/parseOperationCalldata.js";
-import "../parse/index.js";
-import { buildCollateralPrerequisites } from "./buildCollateralPrerequisites.js";
-import { buildPartialLiquidationPrerequisites } from "./buildPartialLiquidationPrerequisites.js";
-import { buildPoolPrerequisites } from "./buildPoolPrerequisites.js";
-import { buildRWAPrerequisites } from "./buildRWAPrerequisites.js";
-//#region src/preview/prerequisites/checkPrerequisites.ts
-/**
-* Derives and verifies the on-chain prerequisites for an operation given its
-* raw calldata: the conditions that must hold for the call not to revert and
-* that we can verify with the SDK (token approvals, wallet balances, RWA
-* open-account requirements).
-*
-* Each prerequisite performs its own reads and resolves into a
-* {@link PrerequisiteResult} (`satisfied` or `error`).
-*
-* Only *sender-actionable* prerequisites belong here: conditions the LP
-* provider or borrower can fix themselves before retrying (e.g. approve a
-* token, sign the RWA factory's messages). Non-actionable protocol/admin state
-* (e.g. pool is paused) is intentionally out of scope, since the user cannot
-* resolve it.
-*/
-async function checkPrerequisites(input, options) {
-	const { sdk, sender: wallet } = input;
-	const tx = parseOperationCalldata(input);
-	if (isSDKError(tx)) return tx;
-	const ctx = {
-		sdk,
-		wallet,
-		blockNumber: options?.blockNumber,
-		value: input.value ?? 0n
-	};
-	const prereqs = await buildPrerequisites(tx.data, ctx);
-	return sdkOk(await Promise.all(prereqs.map((p) => p.verify(ctx))));
-}
-/**
-* Dispatches a parsed operation to the per-operation-family prerequisite
-* builders.
-*/
-async function buildPrerequisites(tx, ctx) {
-	const { wallet } = ctx;
-	switch (tx.operation) {
-		case "Deposit":
-		case "Mint":
-		case "Redeem":
-		case "Withdraw": return buildPoolPrerequisites(tx, wallet);
-		case "MultiCall":
-		case "BotMulticall":
-		case "OpenCreditAccount":
-		case "CloseCreditAccount":
-		case "LiquidateCreditAccount": return buildCollateralPrerequisites(tx.operation === "OpenCreditAccount" ? {
-			creditManager: tx.creditManager,
-			borrower: wallet
-		} : {
-			creditManager: tx.creditManager,
-			creditAccount: tx.creditAccount
-		}, tx.multicall, ctx);
-		case "RWAOpenCreditAccount": return [...await buildCollateralPrerequisites({
-			creditManager: tx.creditManager,
-			borrower: wallet
-		}, tx.multicall, ctx), ...buildRWAPrerequisites(tx.multicall, tx.creditManager, tx.args, ctx)];
-		case "RWAMulticall": return buildCollateralPrerequisites({
-			creditManager: tx.creditManager,
-			creditAccount: tx.creditAccount
-		}, tx.multicall, ctx);
-		case "PartiallyLiquidateCreditAccount": return buildPartialLiquidationPrerequisites(tx, ctx);
-		default: return [];
-	}
-}
-//#endregion
-export { checkPrerequisites };

package/dist/esm/preview/prerequisites/helpers.js

@@ -1,22 +0,0 @@
-import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
-import { BalancePrerequisite } from "./BalancePrerequisite.js";
-//#region src/preview/prerequisites/helpers.ts
-/**
-* The most common prerequisite pair: `owner` must have approved `spender` for
-* `required` of `token` and must hold at least that much of it.
-*/
-function allowanceAndBalance(props) {
-	const { token, owner, spender, required } = props;
-	return [new AllowancePrerequisite({
-		token,
-		owner,
-		spender,
-		required
-	}), new BalancePrerequisite({
-		token,
-		owner,
-		required
-	})];
-}
-//#endregion
-export { allowanceAndBalance };

package/dist/esm/preview/prerequisites/index.js

@@ -1,7 +0,0 @@
-import { Prerequisite } from "./Prerequisite.js";
-import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
-import { BalancePrerequisite } from "./BalancePrerequisite.js";
-import { RWAOpenRequirementsPrerequisite } from "./RWAOpenRequirementsPrerequisite.js";
-import { checkPrerequisites } from "./checkPrerequisites.js";
-import "./types.js";
-export { AllowancePrerequisite, BalancePrerequisite, Prerequisite, RWAOpenRequirementsPrerequisite, checkPrerequisites };

package/dist/esm/preview/preview/errors.js

@@ -1,79 +0,0 @@
-//#region src/preview/preview/errors.ts
-const MALFORMED_BRACKET_MESSAGE = {
-	nested: "nested storeExpectedBalances/compareBalances bracket",
-	unmatchedCompare: "compareBalances without a preceding storeExpectedBalances",
-	unmatchedStore: "storeExpectedBalances without a matching compareBalances"
-};
-/**
-* Builds a {@link MalformedBracketError} for the given bracket invariant.
-**/
-function malformedBracketError(kind) {
-	return {
-		code: "malformedBracket",
-		message: MALFORMED_BRACKET_MESSAGE[kind],
-		kind
-	};
-}
-/**
-* Builds an {@link AdapterCallOutsideBracketError} for `adapter`.
-**/
-function adapterCallOutsideBracketError(adapter) {
-	return {
-		code: "adapterCallOutsideBracket",
-		message: `call to ${adapter} outside of a storeExpectedBalances/compareBalances bracket`,
-		adapter
-	};
-}
-/**
-* Builds a {@link NonAdapterCallInBracketError} for `target`.
-**/
-function nonAdapterCallInBracketError(target) {
-	return {
-		code: "nonAdapterCallInBracket",
-		message: `call to ${target} between storeExpectedBalances and compareBalances is not an adapter call`,
-		target
-	};
-}
-function asCause(cause) {
-	return cause instanceof Error ? cause : new Error(String(cause));
-}
-/**
-* Builds an {@link UnpreviewableAdapterCallError} for a bracketed adapter
-* call that could not be replayed.
-**/
-function unpreviewableAdapterCallError(adapter, cause) {
-	const err = asCause(cause);
-	return {
-		code: "unpreviewableAdapterCall",
-		message: err.message,
-		adapter,
-		cause: err
-	};
-}
-/**
-* Builds an {@link UnsupportedOutOfBracketCallError} for an allowed
-* out-of-bracket adapter call that could not be replayed.
-**/
-function unsupportedOutOfBracketCallError(adapter, cause) {
-	const err = asCause(cause);
-	return {
-		code: "unsupportedOutOfBracketCall",
-		message: err.message,
-		adapter,
-		cause: err
-	};
-}
-/**
-* Builds an {@link InvalidTransactionValueError} when `msg.value` does not
-* fit into the declared WETH collateral.
-**/
-function invalidTransactionValueError(value, wethCollateral) {
-	return {
-		code: "invalidTransactionValue",
-		message: `transaction value ${value} exceeds WETH collateral ${wethCollateral}`,
-		value,
-		wethCollateral
-	};
-}
-//#endregion
-export { adapterCallOutsideBracketError, invalidTransactionValueError, malformedBracketError, nonAdapterCallInBracketError, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError };

package/dist/esm/preview/preview/previewPoolPositionOperation.js

@@ -1,48 +0,0 @@
-import { ierc20Abi } from "../../abi/iERC20.js";
-import { sdkErr, sdkOk } from "../../model/result.js";
-import "../../model/index.js";
-import { asPreviewSimulationError } from "../simulate/errors.js";
-import { amountsInOut, previewContract } from "../simulate/simulatePoolOperation.js";
-//#region src/preview/preview/previewPoolPositionOperation.ts
-async function previewPoolPositionOperation(input, operation, options) {
-	const { sdk } = input;
-	const { tokenIn, tokenOut } = operation;
-	const market = sdk.marketRegister.findByPool(operation.pool);
-	const pool = market.pool.pool;
-	const holder = "owner" in operation ? operation.owner : operation.receiver;
-	let previewAmount;
-	let shares;
-	try {
-		[previewAmount, shares] = await sdk.client.multicall({
-			contracts: [previewContract(operation), {
-				address: operation.pool,
-				abi: ierc20Abi,
-				functionName: "balanceOf",
-				args: [holder]
-			}],
-			allowFailure: false,
-			batchSize: 0,
-			blockNumber: options?.blockNumber
-		});
-	} catch (cause) {
-		const error = asPreviewSimulationError(cause, "multicall");
-		options?.logger?.error(error, "pool operation simulation failed");
-		return sdkErr(error);
-	}
-	const sim = amountsInOut(operation, previewAmount);
-	const inflow = operation.operation === "Deposit" || operation.operation === "Mint";
-	const after = shares + (inflow ? sim.amountOut : -sim.amountIn);
-	return sdkOk({
-		operation: operation.operation,
-		pool: operation.pool,
-		name: sdk.tokensMeta.mustGetToken(operation.pool).name,
-		underlyingToken: market.underlyingToken,
-		shareRate: pool.dieselRate,
-		tokenIn: market.priceOracle.toTokenAmount(tokenIn, sim.amountIn),
-		tokenOut: market.priceOracle.toTokenAmount(tokenOut, sim.amountOut),
-		curator: market.curator,
-		netValue: market.toUnderlyingAmount(pool.sharesToUnderlying(after > 0n ? after : 0n))
-	});
-}
-//#endregion
-export { previewPoolPositionOperation };

package/dist/esm/preview/preview/replayInnerOperations.js

@@ -1,107 +0,0 @@
-import { AssetsMap } from "../../onchain/utils/AssetsMap.js";
-import "../../onchain/constants/math.js";
-import { AbstractAdapterContract } from "../../onchain/market/adapters/contracts/AbstractAdapter.js";
-import "../../onchain/index.js";
-import { adapterCallOutsideBracketError, malformedBracketError, nonAdapterCallInBracketError, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError } from "./errors.js";
-//#region src/preview/preview/replayInnerOperations.ts
-/**
-* Creates a {@link ReplayState} around the given account seed, with empty
-* bookkeeping.
-*/
-function makeReplayState(account) {
-	return {
-		account,
-		collateralAdded: new AssetsMap(),
-		collateralWithdrawn: new AssetsMap()
-	};
-}
-/**
-* Replays a credit-facade multicall over `state`, mutating it in place in
-* facade execution order. The result is the *minimal guaranteed* post-state.
-*
-* The function assumes that the call was generated by our frontend using
-* router/withdrawal compressor, otherwise it returns a warning, but still
-* proceeds best-effort.
-*
-* @returns `undefined` on success, the warning on a malformed multicall.
-*/
-function replayInnerOperations(sdk, multicall, state) {
-	let inBracket = false;
-	let warning;
-	for (const op of multicall) {
-		let opWarning;
-		switch (op.operation) {
-			case "AddCollateral":
-				applyAddCollateral(state, op);
-				break;
-			case "WithdrawCollateral":
-				applyWithdrawCollateral(state, op);
-				break;
-			case "IncreaseBorrowedAmount":
-				state.account.increaseDebt(op.amount);
-				break;
-			case "DecreaseBorrowedAmount":
-				state.account.repay(op.amount);
-				break;
-			case "UpdateQuota":
-				state.account.updateQuota(op.token, op.change);
-				break;
-			case "StoreExpectedBalances":
-				if (inBracket) opWarning = malformedBracketError("nested");
-				inBracket = true;
-				for (const { token, balance } of op.deltas) state.account.balances.inc(token, balance);
-				break;
-			case "CompareBalances":
-				if (!inBracket) opWarning = malformedBracketError("unmatchedCompare");
-				inBracket = false;
-				break;
-			case "Execute": opWarning = applyExecute(sdk, op, inBracket, state.account.balances);
-		}
-		warning ??= opWarning;
-	}
-	if (inBracket) warning ??= malformedBracketError("unmatchedStore");
-	return warning;
-}
-function applyAddCollateral(state, op) {
-	state.collateralAdded.inc(op.token, op.amount);
-	state.account.balances.inc(op.token, op.amount);
-}
-/**
-* `MAX_UINT256` is the facade sentinel for "withdraw the entire balance", so
-* it is resolved against the running balance at the point of the call.
-*/
-function applyWithdrawCollateral(state, op) {
-	const running = state.account.balances.getOrZero(op.token);
-	const amount = op.amount === 115792089237316195423570985008687907853269984665640564039457584007913129639935n ? running > 0n ? running : 0n : op.amount;
-	state.account.balances.dec(op.token, amount);
-	state.collateralWithdrawn.inc(op.token, amount);
-}
-/**
-* Replays an adapter `Execute` call against the running balances.
-*
-* Inside a bracket, the adapter's balance changes are previewed via
-* {@link AbstractAdapterContract.previewBalanceChanges}. Outside a bracket,
-* only calls that {@link AbstractAdapterContract.replayOutOfBracketCall}
-* accepts are allowed; nothing enforces the outcome of any other out-of-bracket
-* adapter call on-chain, so its effect on balances cannot be previewed.
-*/
-function applyExecute(sdk, op, inBracket, balances) {
-	const adapter = sdk.getContract(op.adapter);
-	if (!inBracket) {
-		if (adapter instanceof AbstractAdapterContract) try {
-			if (adapter.replayOutOfBracketCall(balances, op.calldata)) return;
-		} catch (e) {
-			return unsupportedOutOfBracketCallError(op.adapter, e);
-		}
-		return adapterCallOutsideBracketError(op.adapter);
-	}
-	if (!(adapter instanceof AbstractAdapterContract)) return nonAdapterCallInBracketError(op.adapter);
-	try {
-		adapter.previewBalanceChanges(balances, op.calldata);
-		return;
-	} catch (e) {
-		return unpreviewableAdapterCallError(op.adapter, e);
-	}
-}
-//#endregion
-export { makeReplayState, replayInnerOperations };

package/dist/esm/preview/preview/replayMulticall.js

@@ -1,18 +0,0 @@
-import { CreditAccountState } from "./CreditAccountState.js";
-import { makeReplayState, replayInnerOperations } from "./replayInnerOperations.js";
-//#region src/preview/preview/replayMulticall.ts
-/**
-* Replays the operation's multicall over the account's pre-resolved
-* pre-state (`options.creditAccount`) via {@link replayInnerOperations}.
-*/
-function replayMulticall(sdk, operation, options) {
-	const before = CreditAccountState.fromCreditAccountData(options.creditAccount);
-	const after = makeReplayState(before.clone());
-	return {
-		before,
-		after,
-		warning: replayInnerOperations(sdk, operation.multicall, after)
-	};
-}
-//#endregion
-export { replayMulticall };

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

@@ -1,71 +0,0 @@
-import { errorAbis } from "../../abi/errors.js";
-import { BaseError, ContractFunctionRevertedError, decodeErrorResult } from "viem";
-//#region src/preview/simulate/errors.ts
-function isPreviewSimulationError(value) {
-	return typeof value === "object" && value !== null && !(value instanceof Error) && value.code === "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 (isPreviewSimulationError(reason)) return reason;
-	const error = reason instanceof Error ? reason : new Error(String(reason));
-	const detail = decodeSimulationError({ error });
-	return {
-		code: "previewSimulationFailed",
-		message: detail.reason,
-		failures: [{
-			source,
-			detail
-		}],
-		cause: error
-	};
-}
-/**
-* Decodes a simulated call revert into a {@link SimulationError}.
-*
-* We first try to decode any raw return bytes against the SDK's
-* {@link errorAbis} (Gearbox protocol exceptions plus standard ERC-20 custom
-* errors); failing that, we walk viem's error chain for a
-* {@link ContractFunctionRevertedError} (covers `Error(string)` / `Panic`).
-*/
-function decodeSimulationError(revert) {
-	const { error, data } = revert;
-	if (data && data !== "0x") try {
-		const decoded = decodeErrorResult({
-			abi: errorAbis,
-			data
-		});
-		return {
-			reason: formatDecodedError(decoded.errorName, decoded.args),
-			cause: error
-		};
-	} catch {}
-	if (error instanceof BaseError) {
-		const reverted = error.walk((e) => e instanceof ContractFunctionRevertedError);
-		if (reverted instanceof ContractFunctionRevertedError) return {
-			reason: reverted.data?.errorName ?? reverted.reason ?? reverted.shortMessage ?? "reverted",
-			cause: error
-		};
-		return {
-			reason: error.shortMessage ?? error.name,
-			cause: error
-		};
-	}
-	if (error instanceof Error) return {
-		reason: error.message,
-		cause: error
-	};
-	return {
-		reason: "reverted",
-		cause: error
-	};
-}
-/** Renders `Name` or `Name(arg0, arg1)` for a decoded custom error. */
-function formatDecodedError(errorName, args) {
-	if (!args || args.length === 0) return errorName;
-	return `${errorName}(${args.map((arg) => String(arg)).join(", ")})`;
-}
-//#endregion
-export { asPreviewSimulationError, decodeSimulationError };

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

@@ -1,6 +0,0 @@
-import { asPreviewSimulationError } from "./errors.js";
-import { simulatePoolOperation } from "./simulatePoolOperation.js";
-import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
-import { simulateRWAOperation } from "./simulateRWAOperation.js";
-import { simulateOperation } from "./simulateOperation.js";
-export { asPreviewSimulationError, simulateFacadeOperation, simulateOperation, simulatePoolOperation, simulateRWAOperation };

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

@@ -1,14 +0,0 @@
-//#region src/preview/simulate/simulateFacadeOperation.ts
-/**
-* Simulates a credit-facade operation.
-*
-* Not yet implemented: credit-facade simulation requires multicall-aware
-* balance/transfer accounting that the pool simulation does not cover. The
-* signature mirrors {@link simulatePoolOperation} so the
-* {@link simulateOperation} wrapper can delegate uniformly once implemented.
-*/
-async function simulateFacadeOperation(_input, _options) {
-	throw new Error("not yet implemented");
-}
-//#endregion
-export { simulateFacadeOperation };

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

@@ -1,28 +0,0 @@
-import { sdkOk } from "../../model/result.js";
-import "../../model/index.js";
-import { isPoolOperation, isRWAOperation } from "../parse/types.js";
-import "../parse/index.js";
-import { simulatePoolOperation } from "./simulatePoolOperation.js";
-import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
-import { simulateRWAOperation } from "./simulateRWAOperation.js";
-//#region src/preview/simulate/simulateOperation.ts
-/**
-* Simulates a parsed pool or credit account operation
-*/
-async function simulateOperation(input, options) {
-	const { operation } = input;
-	if (isPoolOperation(operation)) return simulatePoolOperation({
-		...input,
-		operation
-	}, options);
-	if (isRWAOperation(operation)) return sdkOk(await simulateRWAOperation({
-		...input,
-		operation
-	}, options));
-	return sdkOk(await simulateFacadeOperation({
-		...input,
-		operation
-	}, options));
-}
-//#endregion
-export { simulateOperation };

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

@@ -1,14 +0,0 @@
-//#region src/preview/simulate/simulateRWAOperation.ts
-/**
-* Simulates an RWA-factory operation.
-*
-* Not yet implemented: like credit-facade simulation, it requires
-* multicall-aware balance/transfer accounting that the pool simulation does
-* not cover. The signature mirrors {@link simulatePoolOperation} so the
-* {@link simulateOperation} wrapper can delegate uniformly once implemented.
-*/
-async function simulateRWAOperation(_input, _options) {
-	throw new Error("not yet implemented");
-}
-//#endregion
-export { simulateRWAOperation };

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

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

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

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

package/dist/esm/preview/types.js

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