@gearbox-protocol/sdk 18.3.0 → 18.4.0

package/dist/cjs/permissionless/api/oracles/enrich.js

@@ -0,0 +1,99 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let viem = require("viem");
+//#region src/permissionless/api/oracles/enrich.ts
+/**
+* What the oracles namespace works out for itself once the backend has
+* answered.
+*
+* All of it used to be the backend's, and all of it needs the chain: a quota
+* is denominated in its market's own underlying and a market cap is a supply
+* times a price, so none of these can be indexed — they can only be read at
+* the block the reader is on. Keeping them here means one description of each
+* rule rather than one per service that wants it, and a backend that holds no
+* viem client at all.
+**/
+/** Identifies a feed across chains, since an address alone does not. */
+function feedKey(chainId, address) {
+	return `${chainId}:${address.toLowerCase()}`;
+}
+/** Prices looked up the way {@link totalQuotas} and the caps need them. */
+function pricesByFeed(prices) {
+	return new Map(prices.map(({ chainId, address, price }) => [feedKey(chainId, address), price]));
+}
+/**
+* The asset's quota across its markets, totalled in USD.
+*
+* Each market's figures are converted at the price that market's own oracle
+* holds for its underlying, which is the same number that market's accounting
+* uses.
+*
+* Limits count only the markets still running, because a shut down market's
+* limit is not borrowable; what is already quoted counts everywhere, because
+* debt outstanding is exposure either way. A market whose underlying could not
+* be priced is skipped, which makes both figures floors, and `null` is nothing
+* to total rather than a zero.
+*
+* @param priceOf - The price each underlying feed reports, in the 8 decimals
+* every Gearbox feed uses.
+*/
+function totalQuotas(quotas, priceOf) {
+	let limit = 0;
+	let used = 0;
+	let anyLimit = false;
+	let anyUsed = false;
+	for (const quota of quotas) {
+		const raw = quota.underlyingPriceFeed === null ? null : priceOf(quota.underlyingPriceFeed);
+		if (raw === null || raw === void 0) continue;
+		const price = Number((0, viem.formatUnits)(raw, 8));
+		if (quota.quotaUsed !== null) {
+			used += quota.quotaUsed * price;
+			anyUsed = true;
+		}
+		if (quota.quotaLimit !== null && !quota.isShutdown) {
+			limit += quota.quotaLimit * price;
+			anyLimit = true;
+		}
+	}
+	return {
+		quotaLimitUsd: anyLimit ? limit : null,
+		quotaUsedUsd: anyUsed ? used : null
+	};
+}
+/**
+* What one feed values one asset's supply at: `price × totalSupply`.
+*
+* Multiplied as integers and formatted once, rather than through two floats:
+* an 8-decimal price times an 18-decimal supply loses its small end to a JS
+* number long before it loses the large one, and the figure is a total rather
+* than an estimate.
+*
+* `null` if either side could not be read — an asset nobody could price is
+* not an asset worth nothing.
+*/
+function toCap(price, totalSupply, decimals) {
+	if (price === null || price === void 0 || totalSupply === null || totalSupply === void 0) return null;
+	return (0, viem.formatUnits)(price * totalSupply, 8 + decimals);
+}
+/** Larger first, with `null` after every figure including a real zero. */
+function descending(a, b) {
+	return (b ?? -1) - (a ?? -1);
+}
+/**
+* Assets ordered the way a reader scans them: what the protocol is built on
+* first, then what is actually borrowed against it, then what it is merely
+* allowed to be borrowed against.
+*
+* Applied here and not by the backend because the two middle terms are the
+* converted quotas, which only exist once the chain has been read. The
+* backend orders by the first term and the tie-breakers, so a caller reading
+* the route directly still gets a stable order; this refines it.
+*/
+function byCentrality(a, b) {
+	return b.underlyingMarketCount - a.underlyingMarketCount || descending(a.quotaUsedUsd, b.quotaUsedUsd) || descending(a.quotaLimitUsd, b.quotaLimitUsd) || a.symbol.localeCompare(b.symbol) || a.address.localeCompare(b.address) || a.chainId - b.chainId;
+}
+//#endregion
+exports.byCentrality = byCentrality;
+exports.feedKey = feedKey;
+exports.pricesByFeed = pricesByFeed;
+exports.toCap = toCap;
+exports.totalQuotas = totalQuotas;

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

@@ -1,6 +1,39 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_permissionless_api_oracles_stress_classify = require("./stress/classify.js");
+const require_permissionless_api_oracles_stress_override = require("./stress/override.js");
+const require_permissionless_api_oracles_stress_score = require("./stress/score.js");
+const require_permissionless_api_oracles_stress_run = require("./stress/run.js");
+const require_permissionless_api_oracles_score_formula = require("./score/formula.js");
+const require_permissionless_api_oracles_score_run = require("./score/run.js");
 const require_permissionless_api_oracles_PermissionlessOracles = require("./PermissionlessOracles.js");
+require("./score/index.js");
+require("./stress/index.js");
 require("./types.js");
+exports.DEFAULT_SCENARIOS = require_permissionless_api_oracles_stress_run.DEFAULT_SCENARIOS;
 exports.GET_PRICES_CHUNK_SIZE = require_permissionless_api_oracles_PermissionlessOracles.GET_PRICES_CHUNK_SIZE;
 exports.GET_PRICES_GAS_LIMIT_BY_CHAIN_ID = require_permissionless_api_oracles_PermissionlessOracles.GET_PRICES_GAS_LIMIT_BY_CHAIN_ID;
 exports.PermissionlessOracles = require_permissionless_api_oracles_PermissionlessOracles.PermissionlessOracles;
+exports.RATE_FEED_TYPE = require_permissionless_api_oracles_stress_run.RATE_FEED_TYPE;
+exports.SCORE_MULTIPLIER = require_permissionless_api_oracles_score_formula.SCORE_MULTIPLIER;
+exports.UNBOUNDED_DOWN = require_permissionless_api_oracles_stress_override.UNBOUNDED_DOWN;
+exports.UNBOUNDED_UP = require_permissionless_api_oracles_stress_override.UNBOUNDED_UP;
+exports.classifySources = require_permissionless_api_oracles_stress_classify.classifySources;
+exports.factorOf = require_permissionless_api_oracles_score_formula.factorOf;
+exports.finalPrice = require_permissionless_api_oracles_score_formula.finalPrice;
+exports.groupOverride = require_permissionless_api_oracles_stress_override.groupOverride;
+exports.perturb = require_permissionless_api_oracles_stress_override.perturb;
+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;
+exports.slotHarm = require_permissionless_api_oracles_stress_score.slotHarm;
+exports.sourcesByFeed = require_permissionless_api_oracles_stress_classify.sourcesByFeed;
+exports.verdictOf = require_permissionless_api_oracles_stress_score.verdictOf;
+exports.worstOf = require_permissionless_api_oracles_score_formula.worstOf;

package/dist/cjs/permissionless/api/oracles/onchain-feed.js

@@ -0,0 +1,25 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let viem = require("viem");
+//#region src/permissionless/api/oracles/onchain-feed.ts
+/**
+* What the store would say about a feed, from what the chain says instead.
+*
+* Two fields are the store's alone and are answered as unknown rather than
+* guessed: who deployed it is a store row, so it is the zero address, and the
+* staleness period is a store setting a feed that was never added does not
+* have, so it is 0. The compressor reports `PRICE_FEED::EXTERNAL` for a
+* contract it cannot otherwise place; an empty type is the same thing said
+* less clearly.
+*/
+function onchainPriceFeed(node) {
+	return {
+		address: (0, viem.getAddress)(node.address),
+		contractType: node.contractType.trim() || "PRICE_FEED::EXTERNAL",
+		version: node.version,
+		deployedBy: viem.zeroAddress,
+		stalenessPeriod: 0,
+		name: node.description.trim()
+	};
+}
+//#endregion
+exports.onchainPriceFeed = onchainPriceFeed;

package/dist/cjs/permissionless/api/oracles/schemas.js

@@ -1,4 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_permissionless_api_chains_schemas = require("../chains/schemas.js");
 const require_permissionless_api_schemas = require("../schemas.js");
 let zod_v4 = require("zod/v4");
 //#region src/permissionless/api/oracles/schemas.ts
@@ -19,111 +20,135 @@ const priceFeedSchema = zod_v4.z.looseObject({
 	stalenessPeriod: zod_v4.z.number(),
 	name: zod_v4.z.string()
 });
-/** {@link PermissionlessAsset} */
-const assetSchema = zod_v4.z.looseObject({
+/**
+* {@link PermissionlessPriceFeedAsset}
+*
+* What identifies an asset, which is all a feed's own listing of one says.
+**/
+const priceFeedAssetSchema = zod_v4.z.looseObject({
 	address: require_permissionless_api_schemas.addressSchema,
 	symbol: zod_v4.z.string(),
 	name: zod_v4.z.string(),
-	decimals: zod_v4.z.number(),
+	decimals: zod_v4.z.number()
+});
+/** {@link PermissionlessAsset} — identified as above, plus what prices it. */
+const assetSchema = priceFeedAssetSchema.extend({
 	owner: require_permissionless_api_schemas.addressSchema,
 	priceFeeds: zod_v4.z.array(priceFeedSchema)
 });
-/** {@link PermissionlessPriceFeedStore} */
-const priceFeedStoreSchema = zod_v4.z.looseObject({
-	chainId: zod_v4.z.number(),
-	name: zod_v4.z.string(),
-	isPublic: zod_v4.z.boolean(),
-	isActivated: zod_v4.z.boolean(),
-	explorerUrl: zod_v4.z.string(),
+/**
+* {@link PermissionlessPriceFeedStore}
+*
+* A store is a chain's, and is described by the same five fields the chain
+* list answers with, so those are extended rather than restated.
+**/
+const priceFeedStoreSchema = require_permissionless_api_chains_schemas.chainSchema.extend({
 	assets: zod_v4.z.array(assetSchema),
 	priceFeeds: zod_v4.z.array(priceFeedSchema)
 });
-/** {@link PermissionlessPrices} */
-const pricesSchema = zod_v4.z.looseObject({
-	prices: require_permissionless_api_schemas.addressRecord(zod_v4.z.string().nullable()),
-	marketCaps: require_permissionless_api_schemas.addressRecord(require_permissionless_api_schemas.addressRecord(zod_v4.z.string().nullable())),
-	time: zod_v4.z.number()
-});
-/** {@link PermissionlessPriceFeedAsset} */
-const priceFeedAssetSchema = zod_v4.z.looseObject({
-	address: require_permissionless_api_schemas.addressSchema,
-	symbol: zod_v4.z.string(),
-	name: zod_v4.z.string(),
-	decimals: zod_v4.z.number()
-});
-/** {@link PermissionlessPriceFeedMarket} */
-const priceFeedMarketSchema = zod_v4.z.looseObject({
+/** Every chain's {@link PermissionlessPriceFeedStore}, one per chain. */
+const priceFeedStoresSchema = zod_v4.z.array(priceFeedStoreSchema);
+/**
+* What names a market, whichever side it is being listed from.
+*
+* A feed's markets and an asset's markets are different reads, but they
+* answer with the same market: who curates it, what it is denominated in and
+* how much of the quota is taken. Only what the read is about differs, which
+* is what each of the two below adds.
+**/
+const marketSchema = zod_v4.z.looseObject({
 	market: require_permissionless_api_schemas.addressSchema,
 	marketConfigurator: require_permissionless_api_schemas.addressSchema,
 	curatorName: zod_v4.z.string().nullable(),
 	marketName: zod_v4.z.string().nullable(),
-	token: require_permissionless_api_schemas.addressSchema,
-	tokenSymbol: zod_v4.z.string().nullable(),
 	underlyingSymbol: zod_v4.z.string().nullable(),
-	reserve: zod_v4.z.boolean(),
 	isUnderlying: zod_v4.z.boolean(),
 	quotaLimit: zod_v4.z.number().nullable(),
-	quotaUsed: zod_v4.z.number().nullable(),
-	marketStalenessPeriod: zod_v4.z.number().nullable()
+	quotaUsed: zod_v4.z.number().nullable()
+});
+/**
+* {@link PermissionlessIndexedPriceFeedMarket} — the market as the feed's slot
+* in it, before the oracle is asked what period it holds for the slot.
+**/
+const priceFeedMarketSchema = marketSchema.extend({
+	token: require_permissionless_api_schemas.addressSchema,
+	tokenSymbol: zod_v4.z.string().nullable(),
+	reserve: zod_v4.z.boolean(),
+	priceOracle: require_permissionless_api_schemas.addressSchema
+});
+/**
+* {@link PermissionlessMarketSlot} — the same slot read from the chain's end,
+* so the feed is a column rather than what was asked for.
+**/
+const marketSlotSchema = priceFeedMarketSchema.extend({
+	chainId: zod_v4.z.number(),
+	underlyingToken: require_permissionless_api_schemas.addressSchema,
+	isShutdown: zod_v4.z.boolean(),
+	priceFeed: require_permissionless_api_schemas.addressSchema,
+	priceFeedName: zod_v4.z.string().nullable(),
+	priceFeedInStore: zod_v4.z.boolean(),
+	underlyingPriceFeed: require_permissionless_api_schemas.addressSchema.nullable()
 });
-/** {@link PermissionlessPriceFeedDetails} */
+/** Every slot in scope, across whichever chains the read covered. */
+const marketSlotsSchema = zod_v4.z.array(marketSlotSchema);
+/** {@link PermissionlessIndexedPriceFeedDetails} */
 const priceFeedDetailsSchema = zod_v4.z.looseObject({
 	chainId: zod_v4.z.number(),
 	priceFeed: priceFeedSchema,
 	assets: zod_v4.z.array(priceFeedAssetSchema),
 	markets: zod_v4.z.array(priceFeedMarketSchema)
 });
-/** {@link PermissionlessPriceFeedMarketCaps} */
-const priceFeedMarketCapsSchema = zod_v4.z.looseObject({
-	marketCaps: require_permissionless_api_schemas.addressRecord(zod_v4.z.string().nullable()),
-	time: zod_v4.z.number()
-});
 /** {@link PermissionlessAssetMarketFeed} */
 const assetMarketFeedSchema = zod_v4.z.looseObject({
 	address: require_permissionless_api_schemas.addressSchema,
 	name: zod_v4.z.string().nullable(),
 	inStore: zod_v4.z.boolean()
 });
-/** {@link PermissionlessAssetMarket} */
-const assetMarketSchema = zod_v4.z.looseObject({
-	market: require_permissionless_api_schemas.addressSchema,
-	marketConfigurator: require_permissionless_api_schemas.addressSchema,
-	curatorName: zod_v4.z.string().nullable(),
-	marketName: zod_v4.z.string().nullable(),
+/** {@link PermissionlessAssetMarket} — the market as what prices the asset in it. */
+const assetMarketSchema = marketSchema.extend({
 	underlyingToken: require_permissionless_api_schemas.addressSchema,
-	underlyingSymbol: zod_v4.z.string().nullable(),
-	isUnderlying: zod_v4.z.boolean(),
+	underlyingPriceFeed: require_permissionless_api_schemas.addressSchema.nullable(),
 	isShutdown: zod_v4.z.boolean(),
 	mainFeed: assetMarketFeedSchema.nullable(),
-	reserveFeed: assetMarketFeedSchema.nullable(),
-	quotaLimit: zod_v4.z.number().nullable(),
-	quotaUsed: zod_v4.z.number().nullable()
+	reserveFeed: assetMarketFeedSchema.nullable()
 });
-/** {@link PermissionlessAssetDetails} */
+/** {@link PermissionlessIndexedAssetDetails} */
 const assetDetailsSchema = zod_v4.z.looseObject({
 	chainId: zod_v4.z.number(),
 	asset: priceFeedAssetSchema,
 	priceFeeds: zod_v4.z.array(priceFeedSchema),
-	markets: zod_v4.z.array(assetMarketSchema),
-	quotaLimitUsd: zod_v4.z.number().nullable(),
-	quotaUsedUsd: zod_v4.z.number().nullable()
+	markets: zod_v4.z.array(assetMarketSchema)
 });
-/** {@link PermissionlessAssetPrices} */
-const assetPricesSchema = zod_v4.z.looseObject({
-	prices: require_permissionless_api_schemas.addressRecord(zod_v4.z.string().nullable()),
-	marketCaps: require_permissionless_api_schemas.addressRecord(zod_v4.z.string().nullable()),
-	time: zod_v4.z.number()
+/** {@link PermissionlessAssetQuota} */
+const assetQuotaSchema = zod_v4.z.looseObject({
+	quotaLimit: zod_v4.z.number().nullable(),
+	quotaUsed: zod_v4.z.number().nullable(),
+	isShutdown: zod_v4.z.boolean(),
+	underlyingPriceFeed: require_permissionless_api_schemas.addressSchema.nullable()
+});
+/** {@link PermissionlessIndexedAssetSummary} */
+const assetSummarySchema = zod_v4.z.looseObject({
+	chainId: zod_v4.z.number(),
+	address: require_permissionless_api_schemas.addressSchema,
+	symbol: zod_v4.z.string(),
+	underlyingMarketCount: zod_v4.z.number(),
+	marketQuotas: zod_v4.z.array(assetQuotaSchema)
 });
+/** The list of {@link PermissionlessAssetSummary}, already ordered. */
+const assetSummariesSchema = zod_v4.z.array(assetSummarySchema);
 //#endregion
 exports.assetDetailsSchema = assetDetailsSchema;
 exports.assetMarketFeedSchema = assetMarketFeedSchema;
 exports.assetMarketSchema = assetMarketSchema;
-exports.assetPricesSchema = assetPricesSchema;
+exports.assetQuotaSchema = assetQuotaSchema;
 exports.assetSchema = assetSchema;
+exports.assetSummariesSchema = assetSummariesSchema;
+exports.assetSummarySchema = assetSummarySchema;
+exports.marketSlotSchema = marketSlotSchema;
+exports.marketSlotsSchema = marketSlotsSchema;
 exports.priceFeedAssetSchema = priceFeedAssetSchema;
 exports.priceFeedDetailsSchema = priceFeedDetailsSchema;
-exports.priceFeedMarketCapsSchema = priceFeedMarketCapsSchema;
 exports.priceFeedMarketSchema = priceFeedMarketSchema;
 exports.priceFeedSchema = priceFeedSchema;
 exports.priceFeedStoreSchema = priceFeedStoreSchema;
-exports.pricesSchema = pricesSchema;
+exports.priceFeedStoresSchema = priceFeedStoresSchema;

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

@@ -0,0 +1,56 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#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 = 10;
+/**
+* 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.
+*
+* `null` for a price that stopped answering, which is not a move.
+*/
+function scoreOfFactor(factor) {
+	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
+* feed's alone where there is no reserve to compare it with. `null` where a
+* feed it needs does not answer.
+*/
+function finalPrice(main, reserve) {
+	if (main === null || reserve === null) return null;
+	if (reserve === void 0) return main;
+	return main < reserve ? main : reserve;
+}
+/** `stressed / base` as a float, `null` where the stressed price is gone. */
+function factorOf(base, stressed) {
+	if (stressed === null) return null;
+	return Number(stressed) / Number(base);
+}
+/**
+* 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 sorted = [...impacts].sort((a, b) => (b.score ?? 0) - (a.score ?? 0));
+	const worst = sorted.find((impact) => impact.score !== null) ?? null;
+	return {
+		score: worst?.score ?? 1,
+		impacts: sorted,
+		worst
+	};
+}
+//#endregion
+exports.SCORE_MULTIPLIER = SCORE_MULTIPLIER;
+exports.factorOf = factorOf;
+exports.finalPrice = finalPrice;
+exports.scoreOfFactor = scoreOfFactor;
+exports.worstOf = worstOf;

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

@@ -0,0 +1,11 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_permissionless_api_oracles_score_formula = require("./formula.js");
+const require_permissionless_api_oracles_score_run = require("./run.js");
+require("./types.js");
+exports.SCORE_MULTIPLIER = require_permissionless_api_oracles_score_formula.SCORE_MULTIPLIER;
+exports.factorOf = require_permissionless_api_oracles_score_formula.factorOf;
+exports.finalPrice = require_permissionless_api_oracles_score_formula.finalPrice;
+exports.runAssetScores = require_permissionless_api_oracles_score_run.runAssetScores;
+exports.runFeedPairScore = require_permissionless_api_oracles_score_run.runFeedPairScore;
+exports.scoreOfFactor = require_permissionless_api_oracles_score_formula.scoreOfFactor;
+exports.worstOf = require_permissionless_api_oracles_score_formula.worstOf;