@gearbox-protocol/sdk 15.1.0-next.2 → 15.1.0-next.21

package/dist/esm/dev/mode-parity/fieldDiff.js

@@ -0,0 +1,270 @@
+//#region src/dev/mode-parity/fieldDiff.ts
+/**
+* Relative drift allowed on {@link Amount.valueUsd} before a USD float is a
+* real disagreement: 0.1%.
+**/
+const USD_RELATIVE_EPSILON = .001;
+/**
+* Relative drift allowed on lag-bounded bigint amounts: 0.05%.
+**/
+const AMOUNT_RELATIVE_EPSILON = 5e-4;
+/**
+* Absolute drift allowed on bps rates before rounding and a one-block lag are
+* no longer enough to explain it.
+**/
+const BPS_ABSOLUTE_EPSILON = 1;
+/**
+* Every field two versions of one value disagree on. Nothing is filtered or
+* tagged: the caller marks expected diffs afterwards.
+**/
+function diffValue(path, onchain, offchain, out, options) {
+	if (isAbsent(onchain) && isAbsent(offchain)) return;
+	if (isAbsent(onchain) || isAbsent(offchain)) {
+		out.push({
+			path,
+			onchain,
+			offchain,
+			kind: "presence"
+		});
+		return;
+	}
+	if (Array.isArray(onchain) && Array.isArray(offchain)) {
+		diffArray(path, onchain, offchain, out, options);
+		return;
+	}
+	if (isRecord(onchain) && isRecord(offchain)) {
+		for (const key of union(Object.keys(onchain), Object.keys(offchain))) diffValue(join(path, key), onchain[key], offchain[key], out, options);
+		return;
+	}
+	if (!sameScalar(onchain, offchain)) out.push({
+		path,
+		onchain,
+		offchain,
+		kind: scalarKind(path, onchain)
+	});
+}
+/**
+* Deep-diff two values and return the disagreements, in path order of
+* discovery.
+**/
+function diffObjects(onchain, offchain, options) {
+	const diffs = [];
+	diffValue("", onchain, offchain, diffs, options);
+	return diffs;
+}
+/**
+* Mark a diff expected, so a later `clean` count can ignore it.
+**/
+function withExpected(diff, reason) {
+	return {
+		...diff,
+		expected: true,
+		reason
+	};
+}
+/**
+* How often each field differed, with array keys collapsed so that the same
+* field of a hundred collateral tokens counts as one path. Sorted so the
+* unexpected disagreements come first.
+**/
+function countPaths(diffs) {
+	const counts = /* @__PURE__ */ new Map();
+	for (const { id, diff } of diffs) {
+		const path = collapseArrayKeys(diff.path);
+		const entry = counts.get(path) ?? {
+			path,
+			kinds: [],
+			count: 0,
+			expected: 0,
+			unexpected: 0
+		};
+		entry.count += 1;
+		if (diff.expected) entry.expected += 1;
+		else entry.unexpected += 1;
+		if (!entry.kinds.includes(diff.kind)) entry.kinds.push(diff.kind);
+		recordWorst(entry, id, diff);
+		counts.set(path, entry);
+	}
+	return [...counts.values()].sort((a, b) => b.unexpected - a.unexpected || b.count - a.count || a.path.localeCompare(b.path));
+}
+function recordWorst(entry, id, diff) {
+	const bps = relativeDiffBps(diff.onchain, diff.offchain);
+	if (bps === void 0) return;
+	const worst = {
+		id,
+		path: diff.path,
+		bps,
+		onchain: diff.onchain,
+		offchain: diff.offchain
+	};
+	if (diff.expected) {
+		if (isWorse(worst, entry.worstExpected)) entry.worstExpected = worst;
+		return;
+	}
+	if (isWorse(worst, entry.worstUnexpected)) entry.worstUnexpected = worst;
+}
+function isWorse(candidate, current) {
+	if (!current) return true;
+	return candidate.bps > current.bps || candidate.bps === current.bps && candidate.id.localeCompare(current.id) < 0;
+}
+/**
+* Collapse `collateralTokens[0xa0b8...].symbol` to `collateralTokens[].symbol`.
+**/
+function collapseArrayKeys(path) {
+	return path.replace(/\[[^\]]*\]/g, "[]");
+}
+/**
+* Membership and match totals of one comparison, from already-built lists.
+**/
+function toCompareCounts(onchainRows, offchainRows, onlyOnchain, onlyOffchain, matched) {
+	const identical = matched.filter((match) => match.identical).length;
+	const clean = matched.filter((match) => match.clean).length;
+	return {
+		onchainRows,
+		offchainRows,
+		matched: matched.length,
+		identical,
+		clean,
+		differing: matched.length - identical,
+		onlyOnchain,
+		onlyOffchain
+	};
+}
+/**
+* USD floats within {@link USD_RELATIVE_EPSILON}.
+**/
+function isUsdWithinTolerance(onchain, offchain) {
+	return withinRelative(asFiniteNumber(onchain), asFiniteNumber(offchain), USD_RELATIVE_EPSILON);
+}
+/**
+* Bps rates that differ by at most {@link BPS_ABSOLUTE_EPSILON}.
+**/
+function isBpsWithinTolerance(onchain, offchain) {
+	const left = asFiniteNumber(onchain);
+	const right = asFiniteNumber(offchain);
+	return left !== void 0 && right !== void 0 && Math.abs(left - right) <= 1;
+}
+/**
+* Bigint amounts within {@link AMOUNT_RELATIVE_EPSILON}.
+**/
+function isAmountWithinTolerance(onchain, offchain) {
+	return typeof onchain === "bigint" && typeof offchain === "bigint" && withinRelativeBigint(onchain, offchain, 5e-4);
+}
+/**
+* Finite numbers within a relative epsilon of each other.
+**/
+function withinRelative(onchain, offchain, epsilon) {
+	if (onchain === void 0 || offchain === void 0) return false;
+	const scale = Math.max(Math.abs(onchain), Math.abs(offchain));
+	return scale === 0 ? true : Math.abs(onchain - offchain) / scale <= epsilon;
+}
+/**
+* `diff / max(|a|, |b|) <= epsilon`, computed in integer arithmetic so a
+* 1e18-scale amount does not round through `Number`.
+**/
+function withinRelativeBigint(onchain, offchain, epsilon) {
+	if (onchain === offchain) return true;
+	const diff = onchain > offchain ? onchain - offchain : offchain - onchain;
+	const scale = abs(onchain) > abs(offchain) ? abs(onchain) : abs(offchain);
+	if (scale === 0n) return true;
+	return diff * BigInt(Math.round(1 / epsilon)) <= scale;
+}
+function asFiniteNumber(value) {
+	return typeof value === "number" && Number.isFinite(value) ? value : void 0;
+}
+/**
+* Relative difference of two numbers or bigints, in bps:
+* `|a − b| / max(|a|, |b|) * 10_000`. `undefined` when the values are not
+* a comparable pair of finite numbers or of bigints.
+**/
+function relativeDiffBps(onchain, offchain) {
+	if (typeof onchain === "bigint" && typeof offchain === "bigint") return relativeDiffBpsBigint(onchain, offchain);
+	const left = asFiniteNumber(onchain);
+	const right = asFiniteNumber(offchain);
+	if (left === void 0 || right === void 0) return;
+	const scale = Math.max(Math.abs(left), Math.abs(right));
+	return scale === 0 ? 0 : Math.abs(left - right) / scale * 1e4;
+}
+/**
+* Same formula as {@link relativeDiffBps} for bigints, computed in integer
+* arithmetic to milli-bps so a 1e18-scale amount does not round through
+* `Number`.
+**/
+function relativeDiffBpsBigint(onchain, offchain) {
+	if (onchain === offchain) return 0;
+	const diff = onchain > offchain ? onchain - offchain : offchain - onchain;
+	const scale = abs(onchain) > abs(offchain) ? abs(onchain) : abs(offchain);
+	if (scale === 0n) return 0;
+	return Number(diff * 10000n * 1000n / scale) / 1e3;
+}
+function union(left, right) {
+	return [.../* @__PURE__ */ new Set([...left, ...right])];
+}
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function diffArray(path, onchain, offchain, out, options) {
+	const onchainKeyed = keyElements(path, onchain, options?.keyOf);
+	const offchainKeyed = keyElements(path, offchain, options?.keyOf);
+	if (!onchainKeyed || !offchainKeyed) {
+		if (onchain.length !== offchain.length) {
+			out.push({
+				path,
+				onchain,
+				offchain,
+				kind: "other"
+			});
+			return;
+		}
+		onchain.forEach((element, index) => {
+			diffValue(`${path}[${index}]`, element, offchain[index], out, options);
+		});
+		return;
+	}
+	for (const key of union([...onchainKeyed.keys()], [...offchainKeyed.keys()])) diffValue(`${path}[${key}]`, onchainKeyed.get(key), offchainKeyed.get(key), out, options);
+}
+/**
+* The array indexed by each element's own identity, or `undefined` when its
+* elements have none and order is all there is to go by.
+**/
+function keyElements(path, values, keyOf) {
+	const keyed = /* @__PURE__ */ new Map();
+	for (const value of values) {
+		const identity = keyOf?.(path, value) ?? defaultIdentity(value);
+		if (typeof identity !== "string") return;
+		keyed.set(identity.toLowerCase(), value);
+	}
+	return keyed.size === values.length ? keyed : void 0;
+}
+function defaultIdentity(value) {
+	if (!isRecord(value)) return;
+	if (typeof value.address === "string") return value.address;
+	if (typeof value.id === "string") return value.id;
+	if (typeof value.token === "string") return value.token;
+	if (isRecord(value.token) && typeof value.token.address === "string") return value.token.address;
+}
+const ADDRESS = /^0x[0-9a-f]{40}$/i;
+/**
+* Only addresses are compared case-insensitively: the backend lowercases them
+* while the chain hands out checksummed ones, which is not a disagreement. A
+* symbol or a name spelled differently is.
+**/
+function sameScalar(onchain, offchain) {
+	if (typeof onchain === "string" && typeof offchain === "string" && ADDRESS.test(onchain) && ADDRESS.test(offchain)) return onchain.toLowerCase() === offchain.toLowerCase();
+	return onchain === offchain;
+}
+function scalarKind(path, onchain) {
+	if (path.endsWith("valueUsd")) return "usd";
+	return typeof onchain === "number" || typeof onchain === "bigint" ? "numeric" : "other";
+}
+function isAbsent(value) {
+	return value === void 0 || value === null;
+}
+function join(path, key) {
+	return path ? `${path}.${key}` : key;
+}
+function abs(value) {
+	return value < 0n ? -value : value;
+}
+//#endregion
+export { AMOUNT_RELATIVE_EPSILON, BPS_ABSOLUTE_EPSILON, USD_RELATIVE_EPSILON, asFiniteNumber, collapseArrayKeys, countPaths, diffObjects, diffValue, isAmountWithinTolerance, isBpsWithinTolerance, isRecord, isUsdWithinTolerance, relativeDiffBps, toCompareCounts, union, withExpected, withinRelative, withinRelativeBigint };

package/dist/esm/dev/mode-parity/scriptUtils.js

@@ -0,0 +1,121 @@
+import { getAlchemyUrl } from "../providers.js";
+import { pino } from "pino";
+//#region src/dev/mode-parity/scriptUtils.ts
+const NETWORKS = [
+	"Mainnet",
+	"Monad",
+	"Plasma",
+	"Somnia",
+	"Etherlink"
+];
+const BACKEND_URL = process.env.BACKEND_URL ?? "https://api.gear-dev.dev";
+const TIMEOUT = 48e4;
+function requireEnv(name) {
+	const value = process.env[name];
+	if (!value) throw new Error(`${name} is required to reach the chains this script reads`);
+	return value;
+}
+function rpcUrls() {
+	const alchemyKey = requireEnv("ALCHEMY_KEY");
+	const alchemy = (network) => {
+		const url = getAlchemyUrl(network, alchemyKey);
+		if (!url) throw new Error(`Alchemy serves no URL for ${network}`);
+		return url;
+	};
+	return {
+		Mainnet: alchemy("Mainnet"),
+		Monad: alchemy("Monad"),
+		Plasma: alchemy("Plasma"),
+		Somnia: requireEnv("SOMNIA_PROVIDER"),
+		Etherlink: requireEnv("ETHERLINK_PROVIDER")
+	};
+}
+function createLogger() {
+	return pino({
+		level: process.env.LOG_LEVEL ?? "info",
+		formatters: {
+			bindings: () => ({}),
+			level: (label) => ({ level: label })
+		}
+	});
+}
+function errorMessage(error) {
+	return error instanceof Error ? error.message : String(error);
+}
+/**
+* Runs `fn` over `items` with at most `concurrency` in flight.
+**/
+async function mapPool(items, concurrency, fn) {
+	let next = 0;
+	const workers = Array.from({ length: Math.min(concurrency, items.length) }, async () => {
+		while (true) {
+			const index = next;
+			next += 1;
+			if (index >= items.length) return;
+			await fn(items[index]);
+		}
+	});
+	await Promise.all(workers);
+}
+/**
+* Formats a relative difference in bps as a percent, e.g. 12.5 → `"0.125%"`.
+**/
+function formatBpsAsPercent(bps) {
+	if (!Number.isFinite(bps)) return "";
+	const percent = bps / 100;
+	if (percent === 0) return "0%";
+	return `${Math.abs(percent) >= 1 ? trimTrailingZeros(percent.toFixed(3)) : trimTrailingZeros(percent.toPrecision(4))}%`;
+}
+function trimTrailingZeros(value) {
+	return value.includes(".") ? value.replace(/\.?0+$/, "") : value;
+}
+function worstColumns(worst) {
+	return {
+		"max diff": worst ? formatBpsAsPercent(worst.bps) : "",
+		"worst entity": worst?.id ?? ""
+	};
+}
+/**
+* Prints the shared membership table, the fields that differed most often,
+* and any chain that failed to answer.
+**/
+function printCompareSummary(noun, report, extraLines = []) {
+	const { summary } = report;
+	console.log(`\n${noun} from ${report.backendUrl} vs the chain`);
+	console.table(summary.byChain.map((chain) => ({
+		chain: chain.chainId,
+		onchain: chain.onchainRows,
+		offchain: chain.offchainRows,
+		matched: chain.matched,
+		identical: chain.identical,
+		clean: chain.clean,
+		differing: chain.differing,
+		"only onchain": chain.onlyOnchain,
+		"only offchain": chain.onlyOffchain
+	})));
+	for (const line of extraLines) console.log(line);
+	const unexpected = summary.diffsByPath.filter((entry) => entry.unexpected > 0);
+	const expected = summary.diffsByPath.filter((entry) => entry.unexpected === 0 && entry.expected > 0);
+	if (unexpected.length) {
+		console.log("\nunexpected fields that differed most often:");
+		console.table(unexpected.slice(0, 25).map((entry) => ({
+			field: entry.path,
+			unexpected: entry.unexpected,
+			expected: entry.expected,
+			kinds: entry.kinds.join(", "),
+			...worstColumns(entry.worstUnexpected)
+		})));
+	}
+	if (expected.length) {
+		console.log("\nexpected fields (mode-scoped or within tolerance):");
+		console.table(expected.slice(0, 25).map((entry) => ({
+			field: entry.path,
+			rows: entry.expected,
+			kinds: entry.kinds.join(", "),
+			...worstColumns(entry.worstExpected)
+		})));
+	}
+	for (const chain of [...report.onchainChains, ...report.offchainChains]) if (chain.status === "error") console.log(`chain ${chain.chainId} failed on ${chain.source}:`, chain.error);
+}
+//#endregion
+export { BACKEND_URL, NETWORKS, TIMEOUT, createLogger, errorMessage, formatBpsAsPercent, mapPool, printCompareSummary, requireEnv, rpcUrls };

package/dist/esm/history/assembleOperations.js

@@ -1,5 +1,5 @@
-import { AbstractAdapterContract } from "../plugins/adapters/contracts/AbstractAdapter.js";
-import "../plugins/adapters/index.js";
+import { AbstractAdapterContract } from "../sdk/market/adapters/contracts/AbstractAdapter.js";
+import "../sdk/index.js";
 import { extractAdapterCallTraces } from "../preview/trace/extractAdapterCallTraces.js";
 import "../preview/trace/index.js";
 import { classifyMulticallOperations } from "./classifyMulticallOperations.js";

package/dist/esm/history/classifyMulticallOperations.js

@@ -1,6 +1,6 @@
-import { swapFromTransfers, toNetTransfers } from "../plugins/adapters/transferHelpers.js";
-import { AbstractAdapterContract } from "../plugins/adapters/contracts/AbstractAdapter.js";
-import "../plugins/adapters/index.js";
+import { swapFromTransfers, toNetTransfers } from "../sdk/market/adapters/transferHelpers.js";
+import { AbstractAdapterContract } from "../sdk/market/adapters/contracts/AbstractAdapter.js";
+import "../sdk/index.js";
 import { TransferAlignmentError, UnknownAdapterError, WithdrawCollateralAlignmentError } from "../preview/trace/errors.js";
 import "../preview/trace/index.js";
 import { isAddressEqual } from "viem";

package/dist/esm/history/populateContractsRegister.js

@@ -2,10 +2,10 @@ import { bytes32ToString } from "../sdk/utils/bytes32ToString.js";
 import { getNetworkType } from "../sdk/chain/chains.js";
 import { isV310 } from "../sdk/constants/versions.js";
 import { TokensMeta } from "../sdk/base/TokensMeta.js";
+import { createAdapter } from "../sdk/market/adapters/createAdapter.js";
 import { CreditFacadeV310BaseContract } from "../sdk/market/credit/CreditFacadeV310BaseContract.js";
 import { OnchainSDK } from "../sdk/OnchainSDK.js";
 import "../sdk/index.js";
-import { createAdapter } from "../plugins/adapters/createAdapter.js";
 import { custom, isHex } from "viem";
 //#region src/history/populateContractsRegister.ts
 function populateContractsRegister(options) {

package/dist/esm/model/charts.js

@@ -0,0 +1,140 @@
+//#region src/model/charts.ts
+/**
+* Historical charts of an opportunity or a position.
+*
+* Charts are backend-only by construction: the chain serves the present, and
+* reconstructing a series from it would mean archive-node reads per point.
+*
+* A chart is read as a {@link ChartBundle}: one shared x-axis plus one
+* {@link ChartSeries} per metric, each holding values only. Alignment is
+* therefore structural — series `i` and series `j` describe the same instant at
+* the same index — rather than a property the backend promises and every
+* consumer re-checks.
+**/
+/**
+* Time window a chart covers, ending at the present.
+*
+* `"max"` is the full history the backend retains for the subject.
+**/
+const CHART_RANGES = [
+	"1d",
+	"1w",
+	"1m",
+	"1y",
+	"max"
+];
+/**
+* Every metric a pool opportunity can chart.
+**/
+const POOL_OPPORTUNITY_CHART_METRICS = [
+	"depositApy",
+	"borrowApy",
+	"dieselRate",
+	"supplied",
+	"borrowed",
+	"availableLiquidity"
+];
+/**
+* Every metric a strategy opportunity can chart.
+*
+* `collateralPrice` is the collateral/underlying series a liquidation-price
+* chart draws; the two USD series are the same prices quoted in dollars.
+**/
+const STRATEGY_OPPORTUNITY_CHART_METRICS = [
+	"netApy",
+	"borrowApy",
+	"collateralApy",
+	"tvl",
+	"collateralPrice",
+	"collateralUsdPrice",
+	"underlyingUsdPrice"
+];
+/**
+* Every metric a pool position can chart.
+*
+* Nothing to do with {@link POOL_OPPORTUNITY_CHART_METRICS}: an opportunity charts what the
+* pool did, a position charts what one wallet's deposit did in it. `mwr` and
+* `twr` are cumulative returns since the position opened — money-weighted, so
+* sensitive to when deposits and withdrawals landed, and time-weighted, which
+* strips that timing out. Both are anchored at inception, so a narrow `range`
+* only zooms the visible slice and its first point is rarely zero.
+**/
+const POOL_POSITION_CHART_METRICS = [
+	"value",
+	"apy",
+	"pnl",
+	"mwr",
+	"twr",
+	"underlyingPrice"
+];
+/**
+* Every metric a strategy position can chart.
+*
+* `twrApy` annualizes `twr` over the position's whole life; the two trailing
+* APYs annualize it over a fixed window instead, so they track the current pace
+* rather than the lifetime rate and are comparable across positions of
+* different ages.
+**/
+const STRATEGY_POSITION_CHART_METRICS = [
+	"totalValueUsd",
+	"totalValueUnderlying",
+	"debt",
+	"healthFactor",
+	"leverage",
+	"borrowApy",
+	"underlyingPrice",
+	"pnl",
+	"mwr",
+	"twr",
+	"twrApy",
+	"trailingApy7d",
+	"trailingApy30d"
+];
+/**
+* Unit of every metric, the one place either side decides it.
+*
+* A metric added to a union above fails to compile here until its unit is
+* named, and the wire schema rejects a series whose `unit` disagrees with this
+* table, so the backend cannot drift from it silently.
+**/
+const CHART_METRIC_UNITS = {
+	depositApy: "bps",
+	borrowApy: "bps",
+	netApy: "bps",
+	collateralApy: "bps",
+	supplied: "token",
+	borrowed: "token",
+	availableLiquidity: "token",
+	tvl: "token",
+	dieselRate: "ratio",
+	collateralPrice: "ratio",
+	collateralUsdPrice: "usd",
+	underlyingUsdPrice: "usd",
+	value: "token",
+	apy: "bps",
+	pnl: "token",
+	mwr: "bps",
+	twr: "bps",
+	underlyingPrice: "usd",
+	totalValueUsd: "usd",
+	totalValueUnderlying: "token",
+	debt: "token",
+	healthFactor: "bps",
+	leverage: "scalar",
+	twrApy: "bps",
+	trailingApy7d: "bps",
+	trailingApy30d: "bps"
+};
+/**
+* Reason a series could not be produced at all, which is not the same as a
+* series that has no points in the window.
+**/
+const CHART_UNAVAILABLE_CODES = [
+	"unknown_subject",
+	"unsupported_metric",
+	"no_price_feed",
+	"not_indexed",
+	"internal"
+];
+//#endregion
+export { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS };