@gearbox-protocol/sdk 18.2.0-next.13 → 18.2.0-next.14

package/dist/cjs/permissionless/api/oracles/stress/run.js

@@ -72,18 +72,7 @@ async function readForest(client, compressor, oracles) {
 			return;
 		}
 		const { priceFeedTree } = state.result;
-		for (const node of priceFeedTree) {
-			const address = node.baseParams.addr.toLowerCase();
-			if (nodes.has(address)) continue;
-			nodes.set(address, {
-				address,
-				contractType: typeName(node.baseParams.contractType),
-				version: Number(node.baseParams.version),
-				description: node.description,
-				underlyingFeeds: node.underlyingFeeds.map((feed) => feed.toLowerCase())
-			});
-			answers.set(address, node.answer.success ? node.answer.price : null);
-		}
+		addTree(priceFeedTree, nodes, answers);
 	});
 	return {
 		nodes,
@@ -92,6 +81,43 @@ async function readForest(client, compressor, oracles) {
 	};
 }
 /**
+* The trees under a handful of feeds, flattened, whether or not any oracle
+* holds them.
+*
+* One call for all of them: the compressor walks the feeds it is given the
+* way it walks an oracle's, and answers with the same nodes.
+*/
+async function readFeedTrees(client, compressor, feeds) {
+	const tree = await client.readContract({
+		address: compressor,
+		abi: require_abi_compressors_priceFeedCompressor.priceFeedCompressorAbi,
+		functionName: "loadPriceFeedTree",
+		args: [feeds]
+	});
+	const nodes = /* @__PURE__ */ new Map();
+	const answers = /* @__PURE__ */ new Map();
+	addTree(tree, nodes, answers);
+	return {
+		nodes,
+		answers
+	};
+}
+/** A tree's nodes into the flattened forest, the first copy of each kept. */
+function addTree(tree, nodes, answers) {
+	for (const node of tree) {
+		const address = node.baseParams.addr.toLowerCase();
+		if (nodes.has(address)) continue;
+		nodes.set(address, {
+			address,
+			contractType: typeName(node.baseParams.contractType),
+			version: Number(node.baseParams.version),
+			description: node.description,
+			underlyingFeeds: node.underlyingFeeds.map((feed) => feed.toLowerCase())
+		});
+		answers.set(address, node.answer.success ? node.answer.price : null);
+	}
+}
+/**
 * Where each rate-bearing feed reads its rate, and what it will accept.
 *
 * The baseline a rate source is perturbed from is the feed's own `lowerBound`
@@ -153,6 +179,18 @@ async function readRateTargets(client, feeds) {
 		bounds
 	};
 }
+/** Tries after the first before a refused read is given up on. */
+const READ_RETRIES = 3;
+/**
+* A multicall failure that is the node's and not the feed's.
+*
+* A call that reverted inside the multicall is decoded from its own return
+* data and carries no error of the `eth_call` around it; a chunk the node
+* refused carries exactly that, for every call in the chunk.
+*/
+function isRefusal(error) {
+	return error instanceof viem.BaseError && error.walk((cause) => cause instanceof viem.CallExecutionError) !== null;
+}
 /**
 * What every feed answers with one group's sources overridden.
 *
@@ -165,7 +203,7 @@ async function readUnder(client, feeds, sources, multiplier, updatedAt, freshen
 	const driven = require_permissionless_api_oracles_stress_override.groupOverride(sources, multiplier, updatedAt);
 	const taken = new Set(driven.map((override) => override.address.toLowerCase()));
 	const overrides = [...require_permissionless_api_oracles_stress_override.groupOverride(freshen, 1, updatedAt).filter((override) => !taken.has(override.address.toLowerCase())), ...driven];
-	const results = await client.multicall({
+	const readOnce = () => client.multicall({
 		contracts: feeds.map((address) => ({
 			address,
 			abi: aggregatorAbi,
@@ -174,6 +212,17 @@ async function readUnder(client, feeds, sources, multiplier, updatedAt, freshen
 		allowFailure: true,
 		stateOverride: overrides.length > 0 ? overrides : void 0
 	});
+	let results = [];
+	for (let attempt = 0;; attempt++) {
+		results = await readOnce();
+		const refused = results.find((result) => result.status === "failure" && isRefusal(result.error));
+		if (!refused) break;
+		if (attempt >= READ_RETRIES) {
+			const reason = refused.error instanceof viem.BaseError ? refused.error.walk().shortMessage : String(refused.error);
+			throw new Error(`the node would not answer a read of ${feeds.length} feeds after 4 tries: ${reason}`, { cause: refused.error });
+		}
+		await new Promise((resolve) => setTimeout(resolve, 500 * 2 ** attempt));
+	}
 	return new Map(feeds.map((feed, i) => {
 		const result = results[i];
 		return [feed, result?.status === "success" ? result.result[1] ?? null : null];
@@ -429,6 +478,7 @@ async function runStressTest({ client, chainId, slots, compressor, scenarios = D
 //#endregion
 exports.DEFAULT_SCENARIOS = DEFAULT_SCENARIOS;
 exports.RATE_FEED_TYPE = RATE_FEED_TYPE;
+exports.readFeedTrees = readFeedTrees;
 exports.readForest = readForest;
 exports.readRateTargets = readRateTargets;
 exports.readUnder = readUnder;

package/dist/cjs/permissionless/index.js

@@ -91,7 +91,6 @@ exports.PriceFeedSaltMissingError = require_permissionless_api_errors.PriceFeedS
 exports.PriceFeedStalenessUnknownError = require_permissionless_api_errors.PriceFeedStalenessUnknownError;
 exports.PriceFeedStoreContract = require_permissionless_bindings_price_feed_store.PriceFeedStoreContract;
 exports.RATE_FEED_TYPE = require_permissionless_api_oracles_stress_run.RATE_FEED_TYPE;
-exports.REVERT_SCORE = require_permissionless_api_oracles_score_formula.REVERT_SCORE;
 exports.RoutingManagerContract = require_permissionless_bindings_router_routing_manager.RoutingManagerContract;
 exports.SCORE_MULTIPLIER = require_permissionless_api_oracles_score_formula.SCORE_MULTIPLIER;
 exports.TOKEN_COMPRESSOR = require_permissionless_utils_literals.TOKEN_COMPRESSOR;
@@ -137,11 +136,13 @@ exports.perturb = require_permissionless_api_oracles_stress_override.perturb;
 exports.priceFeedSalt = require_permissionless_api_deploy_PermissionlessDeploy.priceFeedSalt;
 exports.priceFeedSetupParams = require_permissionless_bindings_pricefeeds_index.priceFeedSetupParams;
 exports.rateStub = require_permissionless_api_oracles_stress_override.rateStub;
+exports.readFeedTrees = require_permissionless_api_oracles_stress_run.readFeedTrees;
 exports.readForest = require_permissionless_api_oracles_stress_run.readForest;
 exports.readRateTargets = require_permissionless_api_oracles_stress_run.readRateTargets;
 exports.readUnder = require_permissionless_api_oracles_stress_run.readUnder;
 exports.roundDataStub = require_permissionless_api_oracles_stress_override.roundDataStub;
 exports.runAssetScores = require_permissionless_api_oracles_score_run.runAssetScores;
+exports.runFeedPairScore = require_permissionless_api_oracles_score_run.runFeedPairScore;
 exports.runStressTest = require_permissionless_api_oracles_stress_run.runStressTest;
 exports.scoreGroup = require_permissionless_api_oracles_stress_score.scoreGroup;
 exports.scoreOfFactor = require_permissionless_api_oracles_score_formula.scoreOfFactor;

package/dist/esm/permissionless/api/index.js

@@ -9,13 +9,13 @@ import "./deploy/index.js";
 import { classifySources, sourcesByFeed } from "./oracles/stress/classify.js";
 import { UNBOUNDED_DOWN, UNBOUNDED_UP, groupOverride, perturb, rateStub, roundDataStub } from "./oracles/stress/override.js";
 import { scoreGroup, slotHarm, verdictOf } from "./oracles/stress/score.js";
-import { DEFAULT_SCENARIOS, RATE_FEED_TYPE, readForest, readRateTargets, readUnder, runStressTest } from "./oracles/stress/run.js";
-import { REVERT_SCORE, SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf } from "./oracles/score/formula.js";
-import { runAssetScores } from "./oracles/score/run.js";
+import { DEFAULT_SCENARIOS, RATE_FEED_TYPE, readFeedTrees, readForest, readRateTargets, readUnder, runStressTest } from "./oracles/stress/run.js";
+import { SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf } from "./oracles/score/formula.js";
+import { runAssetScores, runFeedPairScore } from "./oracles/score/run.js";
 import { GET_PRICES_CHUNK_SIZE, GET_PRICES_GAS_LIMIT_BY_CHAIN_ID, PermissionlessOracles } from "./oracles/PermissionlessOracles.js";
 import { InstanceOwnerTransactions } from "./transactions/InstanceOwnerTransactions.js";
 import { GearboxPermissionless } from "./GearboxPermissionless.js";
 import "./oracles/index.js";
 import "./transactions/index.js";
 import "./types.js";
-export { ChainsNamespace, DEFAULT_DEPLOY_SALT, DEFAULT_SCENARIOS, GET_PRICES_CHUNK_SIZE, GET_PRICES_GAS_LIMIT_BY_CHAIN_ID, GearboxPermissionless, InstanceOwnerTransactions, PermissionlessAnalytics, PermissionlessChainUnreachableError, PermissionlessDeploy, PermissionlessNotAttachedError, PermissionlessOracles, PriceFeedNotInStoreError, PriceFeedSaltMissingError, PriceFeedStalenessUnknownError, RATE_FEED_TYPE, REVERT_SCORE, SCORE_MULTIPLIER, UNBOUNDED_DOWN, UNBOUNDED_UP, classifySources, deriveEffectiveStalenessPeriod, factorOf, finalPrice, groupOverride, perturb, priceFeedSalt, rateStub, readForest, readRateTargets, readUnder, roundDataStub, runAssetScores, runStressTest, scoreGroup, scoreOfFactor, slotHarm, sourcesByFeed, verdictOf, worstOf };
+export { ChainsNamespace, DEFAULT_DEPLOY_SALT, DEFAULT_SCENARIOS, GET_PRICES_CHUNK_SIZE, GET_PRICES_GAS_LIMIT_BY_CHAIN_ID, GearboxPermissionless, InstanceOwnerTransactions, PermissionlessAnalytics, PermissionlessChainUnreachableError, PermissionlessDeploy, PermissionlessNotAttachedError, PermissionlessOracles, PriceFeedNotInStoreError, PriceFeedSaltMissingError, PriceFeedStalenessUnknownError, RATE_FEED_TYPE, SCORE_MULTIPLIER, UNBOUNDED_DOWN, UNBOUNDED_UP, classifySources, deriveEffectiveStalenessPeriod, factorOf, finalPrice, groupOverride, perturb, priceFeedSalt, rateStub, readFeedTrees, readForest, readRateTargets, readUnder, roundDataStub, runAssetScores, runFeedPairScore, runStressTest, scoreGroup, scoreOfFactor, slotHarm, sourcesByFeed, verdictOf, worstOf };

package/dist/esm/permissionless/api/oracles/PermissionlessOracles.js

@@ -10,7 +10,7 @@ import { getFeedDecimals, getLatestPrices, getPrices } from "../../utils/price-u
 import { byCentrality, feedKey, pricesByFeed, toCap, totalQuotas } from "./enrich.js";
 import { assetDetailsSchema, assetSummariesSchema, marketSlotsSchema, priceFeedDetailsSchema, priceFeedStoresSchema } from "./schemas.js";
 import { runStressTest } from "./stress/run.js";
-import { runAssetScores } from "./score/run.js";
+import { runAssetScores, runFeedPairScore } from "./score/run.js";
 import { erc20Abi } from "viem";
 //#region src/permissionless/api/oracles/PermissionlessOracles.ts
 const GET_PRICES_GAS_LIMIT_BY_CHAIN_ID = { 143: 100000000n };
@@ -359,14 +359,16 @@ var PermissionlessOracles = class extends AbstractOffchainNamespace {
 	* three leaves anything to simulate.
 	**/
 	/**
-	* Every asset's score out of 10 for how its markets guard its price.
+	* Every asset's manipulation resistance: how far, from 1 to 10 times, a
+	* lying source can push the price its markets hold for it.
 	*
 	* Each source group behind an asset's feeds — Chainlink, Redstone, Lido and
-	* so on — is made in turn to answer five times what it answers now, and a
+	* so on — is made in turn to answer ten times what it answers now, and a
 	* market scores by how far that moves its final price, `min(main,
-	* reserve)`: 10 for not at all, 0 for the full five times, on a log scale.
-	* A price that stops answering scores 5. An asset scores its worst running
-	* market that takes it as collateral.
+	* reserve)`, as a multiple either way: 1 for not at all, 1.04 for 4%, 10
+	* for the whole lie. A group under which the price stops answering moves
+	* nothing and is listed rather than scored. An asset scores its worst
+	* running market, underlying or collateral.
 	*
 	* Simulated on the chain as it stands, through state overrides in
 	* `eth_call`: one call per source group per chain, so the node behind the
@@ -408,6 +410,39 @@ var PermissionlessOracles = class extends AbstractOffchainNamespace {
 			}
 		}))).flat();
 	}
+	/**
+	* The manipulation resistance of any main feed and reserve on a chain,
+	* scored the way {@link assetScores} scores a market holding them — for
+	* trying a pair before any market does.
+	*
+	* ```ts
+	* const pair = await permissionless.oracles.feedPairScore({
+	*   chainId: 1,
+	*   main: "0x…",
+	*   reserve: "0x…",
+	* });
+	* ```
+	*
+	* Reads the chain directly, through state overrides in `eth_call`, so the
+	* client has to have attached and the node behind it has to accept them.
+	*
+	* @throws When the client has not attached, when the chain has no client or
+	* no PriceFeedCompressor, or when there is nothing to score: a feed the
+	* compressor cannot read, a `ZeroPriceFeed` main, or a final price that does
+	* not answer.
+	**/
+	async feedPairScore({ chainId, main, reserve }) {
+		const client = this.#chains.client(chainId);
+		const compressor = await new AddressProviderContract("0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38", client).getLatestVersionAddress(AP_PRICE_FEED_COMPRESSOR);
+		return runFeedPairScore({
+			client,
+			chainId,
+			compressor,
+			main,
+			reserve,
+			logger: this.logger ?? void 0
+		});
+	}
 	async stressTest({ chainId, ...options }) {
 		const client = this.#chains.client(chainId);
 		const compressor = await new AddressProviderContract("0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38", client).getLatestVersionAddress(AP_PRICE_FEED_COMPRESSOR);

package/dist/esm/permissionless/api/oracles/index.js

@@ -1,11 +1,11 @@
 import { classifySources, sourcesByFeed } from "./stress/classify.js";
 import { UNBOUNDED_DOWN, UNBOUNDED_UP, groupOverride, perturb, rateStub, roundDataStub } from "./stress/override.js";
 import { scoreGroup, slotHarm, verdictOf } from "./stress/score.js";
-import { DEFAULT_SCENARIOS, RATE_FEED_TYPE, readForest, readRateTargets, readUnder, runStressTest } from "./stress/run.js";
-import { REVERT_SCORE, SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf } from "./score/formula.js";
-import { runAssetScores } from "./score/run.js";
+import { DEFAULT_SCENARIOS, RATE_FEED_TYPE, readFeedTrees, readForest, readRateTargets, readUnder, runStressTest } from "./stress/run.js";
+import { SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf } from "./score/formula.js";
+import { runAssetScores, runFeedPairScore } from "./score/run.js";
 import { GET_PRICES_CHUNK_SIZE, GET_PRICES_GAS_LIMIT_BY_CHAIN_ID, PermissionlessOracles } from "./PermissionlessOracles.js";
 import "./score/index.js";
 import "./stress/index.js";
 import "./types.js";
-export { DEFAULT_SCENARIOS, GET_PRICES_CHUNK_SIZE, GET_PRICES_GAS_LIMIT_BY_CHAIN_ID, PermissionlessOracles, RATE_FEED_TYPE, REVERT_SCORE, SCORE_MULTIPLIER, UNBOUNDED_DOWN, UNBOUNDED_UP, classifySources, factorOf, finalPrice, groupOverride, perturb, rateStub, readForest, readRateTargets, readUnder, roundDataStub, runAssetScores, runStressTest, scoreGroup, scoreOfFactor, slotHarm, sourcesByFeed, verdictOf, worstOf };
+export { DEFAULT_SCENARIOS, GET_PRICES_CHUNK_SIZE, GET_PRICES_GAS_LIMIT_BY_CHAIN_ID, PermissionlessOracles, RATE_FEED_TYPE, SCORE_MULTIPLIER, UNBOUNDED_DOWN, UNBOUNDED_UP, classifySources, factorOf, finalPrice, groupOverride, perturb, rateStub, readFeedTrees, readForest, readRateTargets, readUnder, roundDataStub, runAssetScores, runFeedPairScore, runStressTest, scoreGroup, scoreOfFactor, slotHarm, sourcesByFeed, verdictOf, worstOf };

package/dist/esm/permissionless/api/oracles/score/formula.js

@@ -1,25 +1,19 @@
 //#region src/permissionless/api/oracles/score/formula.ts
 /** What every source of a group is made to answer, as a multiple of now. */
-const SCORE_MULTIPLIER = 5;
+const SCORE_MULTIPLIER = 10;
 /**
-* The score of a price that stops answering under the lie.
+* How far the final price moved, as a multiple of where it was, either way:
+* 1 for a price that did not move, 1.04 for one 4% off, and
+* {@link SCORE_MULTIPLIER} for one that took the whole lie — the most it can
+* take from one leg, and where a price over two legs of one group, moved
+* further, is held too.
 *
-* Half marks: nobody can borrow against a wrong number, but nobody can be
-* liquidated either until the feed is replaced.
-*/
-const REVERT_SCORE = 5;
-/**
-* 0 to 10 by how far the final price moved, on a log scale against the lie
-* itself: 10 for a price that did not move, 0 for one that moved by the full
-* {@link SCORE_MULTIPLIER} or more, either way. Rounded to a half point.
-*
-* A bound holding a price within a few percent keeps a 10; a price that let
-* half the lie through, ×√5, scores 5.
+* `null` for a price that stopped answering, which is not a move.
 */
 function scoreOfFactor(factor) {
-	if (factor === null || !Number.isFinite(factor) || factor <= 0) return 5;
-	const moved = Math.abs(Math.log(factor)) / Math.log(5);
-	return Math.round(10 * Math.max(0, 1 - moved) * 2) / 2;
+	if (factor === null || !Number.isFinite(factor) || factor <= 0) return null;
+	const move = factor >= 1 ? factor : 1 / factor;
+	return Math.min(10, move);
 }
 /**
 * The price a market settles on: the lower of main and reserve, or the main
@@ -37,19 +31,21 @@ function factorOf(base, stressed) {
 	return Number(stressed) / Number(base);
 }
 /**
-* The market's score and the group it comes from: the lowest of its groups,
-* ties going to the group that moved the price further. 10 where no source
-* feeds the price at all, since nothing can be made to lie about it.
+* The market's score and the group it comes from: the furthest any group
+* moved its price. 1 where nothing moved it — no group did, or no source
+* feeds the price at all.
+*
+* A group under which the price stops answering moves nothing and does not
+* set the score; it is listed after those that do, for a reader to see.
 */
 function worstOf(impacts) {
-	const distance = (impact) => impact.factor === null ? Infinity : Math.abs(Math.log(impact.factor));
-	const sorted = [...impacts].sort((a, b) => a.score - b.score || distance(b) - distance(a));
-	const worst = sorted[0] ?? null;
+	const sorted = [...impacts].sort((a, b) => (b.score ?? 0) - (a.score ?? 0));
+	const worst = sorted.find((impact) => impact.score !== null) ?? null;
 	return {
-		score: worst?.score ?? 10,
+		score: worst?.score ?? 1,
 		impacts: sorted,
 		worst
 	};
 }
 //#endregion
-export { REVERT_SCORE, SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf };
+export { SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf };

package/dist/esm/permissionless/api/oracles/score/index.js

@@ -1,4 +1,4 @@
-import { REVERT_SCORE, SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf } from "./formula.js";
-import { runAssetScores } from "./run.js";
+import { SCORE_MULTIPLIER, factorOf, finalPrice, scoreOfFactor, worstOf } from "./formula.js";
+import { runAssetScores, runFeedPairScore } from "./run.js";
 import "./types.js";
-export { REVERT_SCORE, SCORE_MULTIPLIER, factorOf, finalPrice, runAssetScores, scoreOfFactor, worstOf };
+export { SCORE_MULTIPLIER, factorOf, finalPrice, runAssetScores, runFeedPairScore, scoreOfFactor, worstOf };