@gearbox-protocol/sdk 14.12.0-next.65 → 14.12.0-next.67

package/dist/esm/sdk/opportunities/OpportunitiesService.js

@@ -0,0 +1,102 @@
+import { SDKConstruct } from "../base/SDKConstruct.js";
+import "../base/index.js";
+import { usdToNumber } from "../market/math.js";
+//#region src/sdk/opportunities/OpportunitiesService.ts
+/**
+* A lookup that knows of no strategy, used when a filter rules strategies out
+* and the credit-account query is skipped altogether.
+**/
+const NO_TOTALS = () => void 0;
+/**
+* Builds the `opportunities` read model from the chain.
+*
+* Everything except the credit-account totals comes from the market state the
+* SDK already holds, so a list costs one RPC round-trip at most. Yield figures
+* that fold in incentives, points or history are deliberately absent: they are
+* the backend's job, and this service never guesses them.
+*
+* The rows themselves are assembled by the market wrappers — see
+* {@link MarketSuite.opportunities} — because every value in them is market
+* state. What is left here is the one thing no single market can answer: how
+* much the credit accounts of a strategy are worth.
+**/
+var OpportunitiesService = class extends SDKConstruct {
+	/**
+	* Every pool and strategy of every loaded market on this chain.
+	*
+	* Strategies are measured by the value locked in their credit accounts, so
+	* the list issues one credit-account query unless the filter rules strategies
+	* out entirely.
+	*
+	* @param filter - Optional narrowing, applied to the built rows.
+	**/
+	async list(filter) {
+		if (filter?.chainIds && !filter.chainIds.includes(this.chainId)) return [];
+		const { markets } = this.sdk.marketRegister;
+		const totals = filter?.kind === "pool" ? NO_TOTALS : await this.#strategyTotals(markets);
+		return markets.flatMap((market) => market.opportunities(totals, filter));
+	}
+	/**
+	* A single pool opportunity plus its interest rate curve and quotas.
+	*
+	* @throws If no loaded market has this pool.
+	**/
+	async getPool(key) {
+		return this.sdk.marketRegister.findByPool(key.pool).poolOpportunityDetail();
+	}
+	/**
+	* A single strategy opportunity plus the rate curve of the pool it borrows
+	* from and the price feeds its liquidation price depends on.
+	*
+	* @throws If the credit manager is unknown, or does not accept the requested
+	* collateral as a strategy.
+	**/
+	async getStrategy(key) {
+		const market = this.sdk.marketRegister.findByCreditManager(key.creditManager);
+		const { suite } = market.mustFindStrategy(key.creditManager, key.targetCollateral);
+		const totals = await this.#strategyTotals([market]);
+		return suite.strategyOpportunityDetail(key.targetCollateral, totals(key.creditManager, key.targetCollateral));
+	}
+	/**
+	* Total value held by the credit accounts backing every strategy of the given
+	* markets.
+	*
+	* An account that holds several strategy collaterals counts in full towards
+	* each of them: the read model reports what a strategy's accounts are worth,
+	* not how that worth splits across the collaterals inside them.
+	**/
+	async #strategyTotals(markets) {
+		const wanted = /* @__PURE__ */ new Map();
+		for (const market of markets) for (const { suite, collateral } of market.strategies) {
+			const cm = suite.creditManager.address.toLowerCase();
+			const tokens = wanted.get(cm) ?? /* @__PURE__ */ new Set();
+			tokens.add(collateral.toLowerCase());
+			wanted.set(cm, tokens);
+		}
+		if (wanted.size === 0) return NO_TOTALS;
+		const accounts = await this.sdk.accounts.getCreditAccounts({ includeZeroDebt: true });
+		const totals = /* @__PURE__ */ new Map();
+		for (const account of accounts) {
+			const tokens = wanted.get(account.creditManager.toLowerCase());
+			if (!tokens) continue;
+			for (const token of account.tokens) {
+				if (token.balance <= 0n || !tokens.has(token.token.toLowerCase())) continue;
+				const key = strategyKey(account.creditManager, token.token);
+				const current = totals.get(key);
+				totals.set(key, {
+					value: (current?.value ?? 0n) + account.totalValue,
+					valueUsd: (current?.valueUsd ?? 0) + usdToNumber(account.totalValueUSD)
+				});
+			}
+		}
+		return (creditManager, collateral) => totals.get(strategyKey(creditManager, collateral));
+	}
+};
+/**
+* Both halves of a strategy key folded into one map key.
+**/
+function strategyKey(creditManager, collateral) {
+	return `${creditManager.toLowerCase()}:${collateral.toLowerCase()}`;
+}
+//#endregion
+export { OpportunitiesService };

package/dist/esm/sdk/opportunities/index.js

@@ -0,0 +1,4 @@
+import { additionalBorrowApyBps, borrowApyBps, maxLeverage, rayToBps, usdToNumber, utilizationBps } from "../market/math.js";
+import { MultichainOpportunitiesService } from "./MultichainOpportunitiesService.js";
+import { OpportunitiesService } from "./OpportunitiesService.js";
+export { MultichainOpportunitiesService, OpportunitiesService, additionalBorrowApyBps, borrowApyBps, maxLeverage, rayToBps, usdToNumber, utilizationBps };

package/dist/esm/sdk/pools/PoolService.js

@@ -1,5 +1,5 @@
-import { AddressSet } from "../utils/AddressSet.js";
 import { ierc20Abi } from "../../abi/iERC20.js";
+import { AddressSet } from "../utils/AddressSet.js";
 import "../constants/addresses.js";
 import "../constants/index.js";
 import { hexEq } from "../utils/hex.js";

package/dist/esm/sdk/types/multichain.js

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

package/dist/esm/{common-utils → sdk}/utils/bigint-math.js

@@ -1,4 +1,4 @@
-//#region src/common-utils/utils/bigint-math.ts
+//#region src/sdk/utils/bigint-math.ts
 /**
 * Utility namespace for common `bigint` operations.
 *
@@ -16,20 +16,20 @@ var BigIntMath = class {
 	static abs = (x) => x < 0n ? -x : x;
 	/**
 	* Returns the greater of two bigint values.
-	*
-	* @param a First candidate value.
-	* @param b Second candidate value.
-	* @returns The larger value between `a` and `b`.
+	* @param values - The values to find the maximum of.
+	* @returns The maximum value.
 	*/
-	static max = (a, b) => a > b ? a : b;
+	static max = (...values) => {
+		return values.reduce((max, v) => v > max ? v : max);
+	};
 	/**
 	* Returns the smaller of two bigint values.
-	*
-	* @param a First candidate value.
-	* @param b Second candidate value.
-	* @returns The smaller value between `a` and `b`.
+	* @param values - The values to find the minimum of.
+	* @returns The minimum value.
 	*/
-	static min = (a, b) => a < b ? a : b;
+	static min = (...values) => {
+		return values.reduce((min, v) => v < min ? v : min);
+	};
 	/**
 	* Returns the negative form of a bigint if it is currently positive.
 	*

package/dist/esm/sdk/utils/index.js

@@ -3,6 +3,7 @@ import { AddressSet } from "./AddressSet.js";
 import { AssetsMap } from "./AssetsMap.js";
 import { json_parse, json_stringify } from "./json.js";
 import { functionArgsToMap, functionArgsToRecord, getFunctionSignature } from "./abi-decode.js";
+import { BigIntMath } from "./bigint-math.js";
 import { bytes32ToString } from "./bytes32ToString.js";
 import { childLogger } from "./childLogger.js";
 import { createRawTx } from "./createRawTx.js";
@@ -15,5 +16,5 @@ import { hexEq } from "./hex.js";
 import { retry } from "./retry.js";
 import { toAddress } from "./toAddress.js";
 import "./type-utils.js";
-import { ZodAddress } from "./zod.js";
-export { AddressMap, AddressSet, AssetsMap, TypedObjectUtils, ZodAddress, bytes32ToString, childLogger, createRawTx, etherscanApiUrl, etherscanUrl, filterDust, filterDustUSD, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, getFunctionSignature, hexEq, isDust, json_parse, json_stringify, numberWithCommas, percentFmt, rayToNumber, retry, shortAddress, shortHash, toAddress, toBN, toBigInt, toSignificant };
+import { ZodAddress, ZodHex } from "./zod.js";
+export { AddressMap, AddressSet, AssetsMap, BigIntMath, TypedObjectUtils, ZodAddress, ZodHex, bytes32ToString, childLogger, createRawTx, etherscanApiUrl, etherscanUrl, filterDust, filterDustUSD, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, getFunctionSignature, hexEq, isDust, json_parse, json_stringify, numberWithCommas, percentFmt, rayToNumber, retry, shortAddress, shortHash, toAddress, toBN, toBigInt, toSignificant };

package/dist/esm/sdk/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/sdk/utils/zod.js

@@ -1,4 +1,4 @@
-import { getAddress, isAddress } from "viem";
+import { getAddress, isAddress, isHex } from "viem";
 import { z } from "zod/v4";
 //#region src/sdk/utils/zod.ts
 /**
@@ -12,5 +12,16 @@ const ZodAddress = () => z.string().transform((val, ctx) => {
 	});
 	return getAddress(val);
 });
+/**
+* A `0x`-prefixed hex string, as viem's Hex.
+*/
+const ZodHex = () => z.string().transform((val, ctx) => {
+	if (!isHex(val)) ctx.issues.push({
+		code: "custom",
+		message: `invalid hex string ${val}`,
+		input: ctx.value
+	});
+	return val;
+});
 //#endregion
-export { ZodAddress };
+export { ZodAddress, ZodHex };

package/dist/types/common-utils/index.d.ts

@@ -1,3 +1,4 @@
+import { BigIntMath } from "../sdk/utils/bigint-math.js";
 import { AxiosCache } from "./axios-cache/AxiosCache.js";
 import "./axios-cache/index.js";
 import { BigNumberish, ChartsCreditManagerPayload } from "./charts/credit-manager-payload.js";
@@ -43,7 +44,6 @@ import { getSafeBaseBorrowRate } from "./utils/apy/get-safe-base-borrow-rate.js"
 import { CalcQuotaBorrowRateProps, calcQuotaBorrowRate } from "./utils/creditAccount/calc-quota-borrow-rate.js";
 import { GetSingleQuotaBorrowRateRate, getSingleQuotaBorrowRate } from "./utils/apy/get-single-quota-borrow-rate.js";
 import { maxAPYFormula } from "./utils/apy/max-apy-formula.js";
-import { BigIntMath } from "./utils/bigint-math.js";
 import { EMPTY_ADDRESS, EMPTY_ARRAY, EMPTY_OBJECT } from "./utils/constants.js";
 import { CalcHealthFactorProps, calcHealthFactor } from "./utils/creditAccount/calc-health-factor.js";
 import { CalcOverallAPYProps, calcOverallAPY } from "./utils/creditAccount/calc-overall-apy.js";

package/dist/types/common-utils/utils/index.d.ts

@@ -1,3 +1,4 @@
+import { BigIntMath } from "../../sdk/utils/bigint-math.js";
 import { AssetUtils, AssetWithAmountInTarget, AssetWithView, WrapResult } from "./assets-math.js";
 import { BONUS_APY_FROM_POINTS } from "./apy/bonus-apy-from-points.js";
 import { AppChains } from "./strategies/types/chains.js";
@@ -28,7 +29,6 @@ import { CalcQuotaBorrowRateProps, calcQuotaBorrowRate } from "./creditAccount/c
 import { GetSingleQuotaBorrowRateRate, getSingleQuotaBorrowRate } from "./apy/get-single-quota-borrow-rate.js";
 import { maxAPYFormula } from "./apy/max-apy-formula.js";
 import "./apy/index.js";
-import { BigIntMath } from "./bigint-math.js";
 import { EMPTY_ADDRESS, EMPTY_ARRAY, EMPTY_OBJECT } from "./constants.js";
 import { CalcHealthFactorProps, calcHealthFactor } from "./creditAccount/calc-health-factor.js";
 import { CalcOverallAPYProps, calcOverallAPY } from "./creditAccount/calc-overall-apy.js";

package/dist/types/dev/index.d.ts

@@ -14,7 +14,7 @@ import { isTransientError } from "./isTransientError.js";
 import { GreenlistMidasGatewayProps, RWAKycFailure, RegisterMidasInvestorProps, RegisterRWAInvestorProps, RegisterRWAInvestorResult, RegisterSecuritizeInvestorProps, greenlistMidasGateway, registerMidasInvestor, registerRWAInvestor, registerSecuritizeInvestor, writeAndWait } from "./kycUtils.js";
 import { LogSplitterTransportOptions, isRangeError, logSplitterTransport } from "./logSplitterTransport.js";
 import { setLTZero, setLTs } from "./ltUtils.js";
-import { PrependMidasReceiveGreenlistProps, prependMidasReceiveGreenlist } from "./midasUtils.js";
+import { PrependMidasReceiveGreenlistProps, RestoreMidasIssuanceVaultPause, UnpauseMidasIssuanceVaultProps, prependMidasReceiveGreenlist, unpauseMidasIssuanceVault } from "./midasUtils.js";
 import { migrateFaucet } from "./migrateFaucet.js";
 import { IMinter } from "./mint/types.js";
 import { createMinter } from "./mint/factory.js";
@@ -26,4 +26,4 @@ import { EnableDSTokenBackDatingProps, RestoreDSTokenBackDating, claimDSToken, c
 import { httpTransportOptionsSchema } from "./transports.js";
 import { ONCHAIN_EXECUTION_ID_ADDRESS, VerifyTestnetParams, verifyTestnet } from "./verifyTestnet.js";
 import { MakePendingWithdrawalsClaimableOptions, makePendingWithdrawalsClaimable } from "./withdrawalUtils.js";
-export { AccountOpener, AccountOpenerOptions, AnvilActions, AnvilClient, AnvilClientConfig, AnvilDealParameters, AnvilNodeInfo, AnvilRPCSchema, CheckMulticallFn, Create2Deployer, Create2Parameters, DEFAULT_CREATE2_SALT, DetectedCall, EnableDSTokenBackDatingProps, EnsureExistsUsingPublicCreate2ReturnType, EthCallMethod, EthCallRequest, EthCallSpy, GetCreate2AddressParameters, GreenlistMidasGatewayProps, IMinter, type LogSplitterTransportOptions, MakePendingWithdrawalsClaimableOptions, NoAvailableTransportsError, ONCHAIN_EXECUTION_ID_ADDRESS, OpenAccountHumanizedPreview, OpenAccountResult, OpenAccountsResult, OpenTxRevertedError, PUBLIC_CREATE2_FACTORY, PoolDepositResult, PrependMidasReceiveGreenlistProps, ProviderConfig, ProviderStatus, RWAKycFailure, RegisterMidasInvestorProps, RegisterRWAInvestorProps, RegisterRWAInvestorResult, RegisterSecuritizeInvestorProps, ReplaceStorageParams, ResilientTransportOptions, RestoreDSTokenBackDating, RevolverTransport, RevolverTransportConfig, RevolverTransportValue, RpcErrorResult, RpcProvider, RpcResponse, RpcSuccessResult, SUPPORTED_RPC_PROVIDERS, SelectionStrategy, TargetAccount, VerifyTestnetParams, anvilNodeInfo, calcLiquidatableLTs, claimDSToken, claimDSTokens, claimFromFaucet, createAnvilClient, createMinter, deployUsingPublicCreate2, detectChain, enableDSTokenBackDating, evmMineDetailed, extendAnvilClient, faucetAbi, getAlchemyUrl, getAnkrUrl, getDrpcUrl, getErpcKey, getPublicCreate2Address, getRpcProviderUrl, getThirdWebUrl, greenlistMidasGateway, httpTransportOptionsSchema, iDegenNftv2Abi, iOnchainExecutionIdAbi, iOwnableAbi, iaclTraitAbi, isAnvil, isDeployedUsingPublicCreate2, isOutOfSyncError, isRangeError, isRateLimitError, isTransientError, logSplitterTransport, makePendingWithdrawalsClaimable, migrateFaucet, prependMidasReceiveGreenlist, providerConfigSchema, registerMidasInvestor, registerRWAInvestor, registerSecuritizeInvestor, replaceStorage, resilientTransport, resilientTransportOptionsSchema, revolverTransportConfigBaseSchema, revolverTransportConfigSchema, rpcProvidersSchema, setLTZero, setLTs, verifyTestnet, writeAndWait };
+export { AccountOpener, AccountOpenerOptions, AnvilActions, AnvilClient, AnvilClientConfig, AnvilDealParameters, AnvilNodeInfo, AnvilRPCSchema, CheckMulticallFn, Create2Deployer, Create2Parameters, DEFAULT_CREATE2_SALT, DetectedCall, EnableDSTokenBackDatingProps, EnsureExistsUsingPublicCreate2ReturnType, EthCallMethod, EthCallRequest, EthCallSpy, GetCreate2AddressParameters, GreenlistMidasGatewayProps, IMinter, type LogSplitterTransportOptions, MakePendingWithdrawalsClaimableOptions, NoAvailableTransportsError, ONCHAIN_EXECUTION_ID_ADDRESS, OpenAccountHumanizedPreview, OpenAccountResult, OpenAccountsResult, OpenTxRevertedError, PUBLIC_CREATE2_FACTORY, PoolDepositResult, PrependMidasReceiveGreenlistProps, ProviderConfig, ProviderStatus, RWAKycFailure, RegisterMidasInvestorProps, RegisterRWAInvestorProps, RegisterRWAInvestorResult, RegisterSecuritizeInvestorProps, ReplaceStorageParams, ResilientTransportOptions, RestoreDSTokenBackDating, RestoreMidasIssuanceVaultPause, RevolverTransport, RevolverTransportConfig, RevolverTransportValue, RpcErrorResult, RpcProvider, RpcResponse, RpcSuccessResult, SUPPORTED_RPC_PROVIDERS, SelectionStrategy, TargetAccount, UnpauseMidasIssuanceVaultProps, VerifyTestnetParams, anvilNodeInfo, calcLiquidatableLTs, claimDSToken, claimDSTokens, claimFromFaucet, createAnvilClient, createMinter, deployUsingPublicCreate2, detectChain, enableDSTokenBackDating, evmMineDetailed, extendAnvilClient, faucetAbi, getAlchemyUrl, getAnkrUrl, getDrpcUrl, getErpcKey, getPublicCreate2Address, getRpcProviderUrl, getThirdWebUrl, greenlistMidasGateway, httpTransportOptionsSchema, iDegenNftv2Abi, iOnchainExecutionIdAbi, iOwnableAbi, iaclTraitAbi, isAnvil, isDeployedUsingPublicCreate2, isOutOfSyncError, isRangeError, isRateLimitError, isTransientError, logSplitterTransport, makePendingWithdrawalsClaimable, migrateFaucet, prependMidasReceiveGreenlist, providerConfigSchema, registerMidasInvestor, registerRWAInvestor, registerSecuritizeInvestor, replaceStorage, resilientTransport, resilientTransportOptionsSchema, revolverTransportConfigBaseSchema, revolverTransportConfigSchema, rpcProvidersSchema, setLTZero, setLTs, unpauseMidasIssuanceVault, verifyTestnet, writeAndWait };

package/dist/types/dev/midasUtils.d.ts

@@ -2,7 +2,8 @@ import { ILogger } from "../sdk/types/logger.js";
 import { CreditSuite } from "../sdk/market/credit/CreditSuite.js";
 import { MultiCall } from "../sdk/types/transactions.js";
 import "../sdk/index.js";
-import { PublicClient } from "viem";
+import { AnvilClient } from "./createAnvilClient.js";
+import { Address, PublicClient } from "viem";
 //#region src/dev/midasUtils.d.ts
 interface PrependMidasReceiveGreenlistProps {
   /**
@@ -35,5 +36,33 @@ interface PrependMidasReceiveGreenlistProps {
  * the gateway is permissionless, or the call is already there.
  */
 declare function prependMidasReceiveGreenlist(props: PrependMidasReceiveGreenlistProps): Promise<MultiCall[]>;
+interface UnpauseMidasIssuanceVaultProps {
+  anvil: AnvilClient;
+  /**
+   * Midas issuance vault (deposit vault) to unpause
+   */
+  vault: Address;
+  /**
+   * Midas access control admin, impersonated on the fork
+   * (MIDAS_ACL_ADMIN in periphery-v3/router-v3 foundry tests)
+   */
+  admin: Address;
+  logger?: ILogger;
+}
+/**
+ * Pauses the vault back when it was unpaused by `unpauseMidasIssuanceVault`,
+ * and does nothing otherwise. Safe to call more than once.
+ */
+type RestoreMidasIssuanceVaultPause = () => Promise<void>;
+/**
+ * Unpauses a globally paused Midas issuance vault on an anvil fork, so that
+ * `depositInstant` stops reverting with `Pausable: paused`, and returns a
+ * callback that restores the original pause state.
+ *
+ * Impersonates `admin` and grants it `pauseAdminRole()` when missing, same as
+ * `greenlistMidasGateway` does with the greenlist roles. The grant is not
+ * reverted by the callback, only the pause state is.
+ */
+declare function unpauseMidasIssuanceVault(props: UnpauseMidasIssuanceVaultProps): Promise<RestoreMidasIssuanceVaultPause>;
 //#endregion
-export { PrependMidasReceiveGreenlistProps, prependMidasReceiveGreenlist };
+export { PrependMidasReceiveGreenlistProps, RestoreMidasIssuanceVaultPause, UnpauseMidasIssuanceVaultProps, prependMidasReceiveGreenlist, unpauseMidasIssuanceVault };

package/dist/types/model/history.d.ts

@@ -0,0 +1,105 @@
+import { Timestamp } from "./primitives.js";
+import { OpportunityKey } from "./opportunities.js";
+//#region src/model/history.d.ts
+/**
+ * Historical time series of an opportunity.
+ *
+ * History is backend-only by construction: the chain serves the present, and
+ * reconstructing a series from it would mean archive-node reads per point.
+ **/
+/**
+ * Time window a series covers, ending at the present.
+ *
+ * `"max"` is the full history the backend retains for the opportunity.
+ **/
+type HistoryRange = "1d" | "1w" | "1m" | "1y" | "max";
+/**
+ * Series available for a pool opportunity.
+ **/
+type PoolHistoryMetric = "depositApy" | "borrowApy" | "dieselRate" | "supplied" | "borrowed" | "availableLiquidity";
+/**
+ * Every {@link PoolHistoryMetric}, for callers that enumerate them.
+ **/
+declare const POOL_HISTORY_METRICS: readonly ["depositApy", "borrowApy", "dieselRate", "supplied", "borrowed", "availableLiquidity"];
+/**
+ * Series available for a strategy opportunity.
+ *
+ * `collateralPrice` is the collateral/underlying series a liquidation-price
+ * chart draws; the two USD series are the same prices quoted in dollars.
+ **/
+type StrategyHistoryMetric = "netApy" | "borrowApy" | "collateralApy" | "tvl" | "collateralPrice" | "collateralUsdPrice" | "underlyingUsdPrice";
+/**
+ * Every {@link StrategyHistoryMetric}, for callers that enumerate them.
+ **/
+declare const STRATEGY_HISTORY_METRICS: readonly ["netApy", "borrowApy", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
+/**
+ * Any series the read model can return.
+ **/
+type HistoryMetric = PoolHistoryMetric | StrategyHistoryMetric;
+/**
+ * One sample of a series.
+ **/
+interface HistoryPoint {
+  /**
+   * When the sample was taken.
+   **/
+  timestamp: Timestamp;
+  /**
+   * Sampled value. The unit follows from the metric: APY metrics are in basis
+   * points, amount metrics are in the underlying's base units expressed as a
+   * float, price metrics are plain prices.
+   *
+   * @example `842` for an 8.42% APY sample
+   **/
+  value: number;
+}
+/**
+ * Annotations the backend ships alongside a series, e.g. what a chart drawn
+ * from it should say beyond the points themselves.
+ *
+ * TODO: the backend has not specified this payload yet. It stays empty until
+ * it does, so that filling it in later is additive rather than a rename.
+ **/
+interface HistoryChartMetadata {}
+/**
+ * A named series of samples ordered by ascending timestamp.
+ *
+ * @typeParam M - Metric the series carries.
+ **/
+interface HistorySeries<M extends string = HistoryMetric> {
+  /**
+   * Metric the samples belong to; it also defines their unit, so no separate
+   * unit field ships.
+   **/
+  metric: M;
+  /**
+   * Samples, oldest first.
+   **/
+  points: HistoryPoint[];
+  /**
+   * What the backend says about the series, see {@link HistoryChartMetadata}.
+   **/
+  metadata: HistoryChartMetadata;
+}
+/**
+ * A request for one series of a single opportunity.
+ *
+ * @typeParam M - Metric requested.
+ **/
+interface OpportunityHistoryQuery<M extends HistoryMetric = HistoryMetric> {
+  /**
+   * Opportunity the series belongs to.
+   **/
+  opportunity: OpportunityKey;
+  /**
+   * Window to cover.
+   **/
+  range: HistoryRange;
+  /**
+   * Metric to return. A metric that does not apply to the opportunity's kind
+   * has no series.
+   **/
+  metric: M;
+}
+//#endregion
+export { HistoryChartMetadata, HistoryMetric, HistoryPoint, HistoryRange, HistorySeries, OpportunityHistoryQuery, POOL_HISTORY_METRICS, PoolHistoryMetric, STRATEGY_HISTORY_METRICS, StrategyHistoryMetric };

package/dist/types/model/history.schema.d.ts

@@ -0,0 +1,66 @@
+import { HistoryChartMetadata } from "./history.js";
+import { z } from "zod/v4";
+//#region src/model/history.schema.d.ts
+/**
+ * Runtime schemas for {@link ./history.js}, see the note in
+ * `primitives.schema.ts` on why they are written by hand.
+ **/
+/**
+ * {@link HistoryRange}
+ **/
+declare const historyRangeSchema: z.ZodUnion<readonly [z.ZodLiteral<"1d">, z.ZodLiteral<"1w">, z.ZodLiteral<"1m">, z.ZodLiteral<"1y">, z.ZodLiteral<"max">]>;
+/**
+ * {@link PoolHistoryMetric}
+ **/
+declare const poolHistoryMetricSchema: z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>;
+/**
+ * {@link StrategyHistoryMetric}
+ **/
+declare const strategyHistoryMetricSchema: z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>;
+/**
+ * {@link HistoryMetric}
+ **/
+declare const historyMetricSchema: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>;
+/**
+ * {@link HistoryPoint}
+ **/
+declare const historyPointSchema: z.ZodObject<{
+  timestamp: z.ZodNumber;
+  value: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * {@link HistoryChartMetadata}
+ *
+ * TODO: empty until the backend specifies the payload.
+ **/
+declare const historyChartMetadataSchema: z.ZodType<HistoryChartMetadata>;
+/**
+ * {@link HistorySeries}
+ **/
+declare const historySeriesSchema: z.ZodObject<{
+  metric: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>;
+  points: z.ZodArray<z.ZodObject<{
+    timestamp: z.ZodNumber;
+    value: z.ZodNumber;
+  }, z.core.$strip>>;
+  metadata: z.ZodType<HistoryChartMetadata, unknown, z.core.$ZodTypeInternals<HistoryChartMetadata, unknown>>;
+}, z.core.$strip>;
+/**
+ * {@link OpportunityHistoryQuery}
+ **/
+declare const opportunityHistoryQuerySchema: z.ZodObject<{
+  opportunity: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    chainId: z.ZodNumber;
+    pool: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    kind: z.ZodLiteral<"pool">;
+  }, z.core.$strip>, z.ZodObject<{
+    chainId: z.ZodNumber;
+    creditManager: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    targetCollateral: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    kind: z.ZodLiteral<"strategy">;
+  }, z.core.$strip>], "kind">;
+  range: z.ZodUnion<readonly [z.ZodLiteral<"1d">, z.ZodLiteral<"1w">, z.ZodLiteral<"1m">, z.ZodLiteral<"1y">, z.ZodLiteral<"max">]>;
+  metric: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>;
+}, z.core.$strip>;
+//#endregion
+export { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, strategyHistoryMetricSchema };

package/dist/types/model/index.d.ts

@@ -0,0 +1,9 @@
+import { Amount, AssetType, Bps, ChainId, Curator, Leverage, Timestamp, Token, TokenAmount, TxCall } from "./primitives.js";
+import { ApyBreakdown, Opportunity, OpportunityBase, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, PointRewards, PointsProgram, PoolOpportunity, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, Rewards, StrategyOpportunity, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, TokenRewards, matchesOpportunityFilter, opportunityId, poolOpportunityId, strategyOpportunityId } from "./opportunities.js";
+import { HistoryChartMetadata, HistoryMetric, HistoryPoint, HistoryRange, HistorySeries, OpportunityHistoryQuery, POOL_HISTORY_METRICS, PoolHistoryMetric, STRATEGY_HISTORY_METRICS, StrategyHistoryMetric } from "./history.js";
+import { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, strategyHistoryMetricSchema } from "./history.schema.js";
+import { DelayedReceivedAsset, InstantReceivedAsset, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, ReceivedAsset, matchesLiquidatableAccountFilter } from "./liquidations.js";
+import { delayedReceivedAssetSchema, instantReceivedAssetSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, receivedAssetSchema } from "./liquidations.schema.js";
+import { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema } from "./opportunities.schema.js";
+import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, curatorSchema, leverageSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema } from "./primitives.schema.js";
+export { Amount, ApyBreakdown, AssetType, Bps, ChainId, Curator, DelayedReceivedAsset, HistoryChartMetadata, HistoryMetric, HistoryPoint, HistoryRange, HistorySeries, InstantReceivedAsset, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Opportunity, OpportunityBase, OpportunityDetail, OpportunityFilter, OpportunityHistoryQuery, OpportunityId, OpportunityKey, OpportunityKind, POOL_HISTORY_METRICS, PointRewards, PointsProgram, PoolHistoryMetric, PoolOpportunity, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, Rewards, STRATEGY_HISTORY_METRICS, StrategyHistoryMetric, StrategyOpportunity, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, Timestamp, Token, TokenAmount, TokenRewards, TxCall, amountSchema, apyBreakdownSchema, assetTypeSchema, bpsSchema, chainIdSchema, curatorSchema, delayedReceivedAssetSchema, historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, instantReceivedAssetSchema, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterSchema, opportunityHistoryQuerySchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pointRewardsSchema, pointsProgramSchema, poolHistoryMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, rewardsSchema, strategyHistoryMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, timestampSchema, tokenAmountSchema, tokenRewardsSchema, tokenSchema, txCallSchema };