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

package/dist/esm/model/history.js

@@ -0,0 +1,26 @@
+//#region src/model/history.ts
+/**
+* Every {@link PoolHistoryMetric}, for callers that enumerate them.
+**/
+const POOL_HISTORY_METRICS = [
+	"depositApy",
+	"borrowApy",
+	"dieselRate",
+	"supplied",
+	"borrowed",
+	"availableLiquidity"
+];
+/**
+* Every {@link StrategyHistoryMetric}, for callers that enumerate them.
+**/
+const STRATEGY_HISTORY_METRICS = [
+	"netApy",
+	"borrowApy",
+	"collateralApy",
+	"tvl",
+	"collateralPrice",
+	"collateralUsdPrice",
+	"underlyingUsdPrice"
+];
+//#endregion
+export { POOL_HISTORY_METRICS, STRATEGY_HISTORY_METRICS };

package/dist/esm/model/history.schema.js

@@ -0,0 +1,76 @@
+import { timestampSchema } from "./primitives.schema.js";
+import { opportunityKeySchema } from "./opportunities.schema.js";
+import { z } from "zod/v4";
+//#region src/model/history.schema.ts
+/**
+* Runtime schemas for {@link ./history.js}, see the note in
+* `primitives.schema.ts` on why they are written by hand.
+**/
+/**
+* {@link HistoryRange}
+**/
+const historyRangeSchema = z.union([
+	z.literal("1d"),
+	z.literal("1w"),
+	z.literal("1m"),
+	z.literal("1y"),
+	z.literal("max")
+]);
+/**
+* {@link PoolHistoryMetric}
+**/
+const poolHistoryMetricSchema = z.union([
+	z.literal("depositApy"),
+	z.literal("borrowApy"),
+	z.literal("dieselRate"),
+	z.literal("supplied"),
+	z.literal("borrowed"),
+	z.literal("availableLiquidity")
+]);
+/**
+* {@link StrategyHistoryMetric}
+**/
+const strategyHistoryMetricSchema = z.union([
+	z.literal("netApy"),
+	z.literal("borrowApy"),
+	z.literal("collateralApy"),
+	z.literal("tvl"),
+	z.literal("collateralPrice"),
+	z.literal("collateralUsdPrice"),
+	z.literal("underlyingUsdPrice")
+]);
+/**
+* {@link HistoryMetric}
+**/
+const historyMetricSchema = z.union([poolHistoryMetricSchema, strategyHistoryMetricSchema]);
+/**
+* {@link HistoryPoint}
+**/
+const historyPointSchema = z.object({
+	timestamp: timestampSchema,
+	value: z.number()
+});
+/**
+* {@link HistoryChartMetadata}
+*
+* TODO: empty until the backend specifies the payload.
+**/
+const historyChartMetadataSchema = z.object({});
+/**
+* {@link HistorySeries}
+**/
+const historySeriesSchema = z.object({
+	metric: historyMetricSchema,
+	points: z.array(historyPointSchema),
+	metadata: historyChartMetadataSchema
+});
+/**
+* {@link OpportunityHistoryQuery}
+**/
+const opportunityHistoryQuerySchema = z.object({
+	opportunity: opportunityKeySchema,
+	range: historyRangeSchema,
+	metric: historyMetricSchema
+});
+//#endregion
+export { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, strategyHistoryMetricSchema };

package/dist/esm/model/index.js

@@ -0,0 +1,9 @@
+import { POOL_HISTORY_METRICS, STRATEGY_HISTORY_METRICS } from "./history.js";
+import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, curatorSchema, leverageSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema } from "./primitives.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 { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, strategyHistoryMetricSchema } from "./history.schema.js";
+import { matchesLiquidatableAccountFilter } from "./liquidations.js";
+import { delayedReceivedAssetSchema, instantReceivedAssetSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, receivedAssetSchema } from "./liquidations.schema.js";
+import { matchesOpportunityFilter, opportunityId, poolOpportunityId, strategyOpportunityId } from "./opportunities.js";
+import "./primitives.js";
+export { POOL_HISTORY_METRICS, STRATEGY_HISTORY_METRICS, 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 };

package/dist/esm/model/liquidations.js

@@ -0,0 +1,22 @@
+//#region src/model/liquidations.ts
+/**
+* Whether a liquidatable account satisfies every criterion of a filter.
+*
+* This is the single definition of what each criterion means: every source
+* builds its rows first and runs them through here, so the chain and the
+* backend cannot disagree on what a filter selects.
+*
+* @param account - Row to test.
+* @param filter - Criteria to test against. An absent filter matches anything.
+**/
+function matchesLiquidatableAccountFilter(account, filter) {
+	if (!filter) return true;
+	if (filter.chainIds && !filter.chainIds.includes(account.chainId)) return false;
+	if (filter.underlyingType && account.totalValue.token.assetType !== filter.underlyingType) return false;
+	if (filter.paused !== void 0 && account.paused !== filter.paused) return false;
+	if (filter.rwa !== void 0 && account.rwa !== filter.rwa) return false;
+	if (filter.delayed !== void 0 && account.isDelayed !== filter.delayed) return false;
+	return true;
+}
+//#endregion
+export { matchesLiquidatableAccountFilter };

package/dist/esm/model/liquidations.schema.js

@@ -0,0 +1,83 @@
+import { ZodAddress } from "../sdk/utils/zod.js";
+import { assetTypeSchema, chainIdSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema } from "./primitives.schema.js";
+import { z } from "zod/v4";
+//#region src/model/liquidations.schema.ts
+/**
+* Runtime schemas for {@link ./liquidations.js}, see the note in
+* `primitives.schema.ts` on why they are written by hand.
+**/
+/**
+* {@link LiquidatableAccountFilter}
+**/
+const liquidatableAccountFilterSchema = z.object({
+	chainIds: z.array(chainIdSchema).optional(),
+	underlyingType: assetTypeSchema.optional(),
+	paused: z.boolean().optional(),
+	rwa: z.boolean().optional(),
+	delayed: z.boolean().optional()
+});
+/**
+* {@link LiquidatableAccount}
+**/
+const liquidatableAccountSchema = z.object({
+	chainId: chainIdSchema,
+	creditAccount: ZodAddress(),
+	creditManager: ZodAddress(),
+	asset: tokenSchema,
+	totalValue: tokenAmountSchema,
+	repaymentAmount: tokenAmountSchema,
+	estimatedProfit: tokenAmountSchema,
+	isDelayed: z.boolean(),
+	paused: z.boolean(),
+	rwa: z.boolean()
+});
+/**
+* {@link InstantReceivedAsset}
+**/
+const instantReceivedAssetSchema = z.object({
+	...tokenAmountSchema.shape,
+	isDelayed: z.literal(false)
+});
+/**
+* {@link DelayedReceivedAsset}
+**/
+const delayedReceivedAssetSchema = z.object({
+	...tokenAmountSchema.shape,
+	isDelayed: z.literal(true),
+	redeemerAddress: ZodAddress().optional(),
+	claimableAt: timestampSchema.optional()
+});
+/**
+* {@link ReceivedAsset}
+**/
+const receivedAssetSchema = z.discriminatedUnion("isDelayed", [instantReceivedAssetSchema, delayedReceivedAssetSchema]);
+/**
+* {@link LiquidationApproval}
+**/
+const liquidationApprovalSchema = tokenAmountSchema.extend({ spender: ZodAddress() });
+/**
+* {@link LiquidationPosition}
+**/
+const liquidationPositionSchema = z.object({
+	chainId: chainIdSchema,
+	sourceToken: tokenSchema,
+	output: tokenAmountSchema,
+	claimableAt: timestampSchema.optional(),
+	claimTx: txCallSchema.optional(),
+	redeemer: ZodAddress().optional()
+});
+/**
+* {@link LiquidationDetails}
+**/
+const liquidationDetailsSchema = z.object({
+	...liquidatableAccountSchema.shape,
+	repaymentAmount: tokenAmountSchema,
+	receivedAssets: z.array(receivedAssetSchema),
+	isLiquidatorEligible: z.boolean(),
+	isCreditAccountFrozen: z.boolean(),
+	kycProtocol: z.string().optional(),
+	kycToken: tokenSchema.optional(),
+	approve: liquidationApprovalSchema.optional()
+});
+//#endregion
+export { delayedReceivedAssetSchema, instantReceivedAssetSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, receivedAssetSchema };

package/dist/esm/model/opportunities.js

@@ -0,0 +1,51 @@
+//#region src/model/opportunities.ts
+/**
+* Builds the canonical id of a pool opportunity.
+*
+* @example
+* ```ts
+* poolOpportunityId(1, "0xda00...") // "1:0xda00..."
+* ```
+**/
+function poolOpportunityId(chainId, pool) {
+	return `${chainId}:${pool.toLowerCase()}`;
+}
+/**
+* Builds the canonical id of a strategy opportunity.
+*
+* @example
+* ```ts
+* strategyOpportunityId(1, "0x3eb9...", "0x7f39...") // "1:0x3eb9...:0x7f39..."
+* ```
+**/
+function strategyOpportunityId(chainId, creditManager, targetCollateral) {
+	return `${chainId}:${creditManager.toLowerCase()}:${targetCollateral.toLowerCase()}`;
+}
+/**
+* Canonical id of any opportunity, dispatching on {@link Opportunity.kind}.
+**/
+function opportunityId(opportunity) {
+	return opportunity.kind === "pool" ? poolOpportunityId(opportunity.chainId, opportunity.pool) : strategyOpportunityId(opportunity.chainId, opportunity.creditManager, opportunity.targetCollateral.address);
+}
+/**
+* Whether an opportunity satisfies every criterion of a filter.
+*
+* This is the single definition of what each criterion means: every source
+* builds its rows first and runs them through here, so the chain and the
+* backend cannot disagree on what a filter selects.
+*
+* @param opportunity - Row to test.
+* @param filter - Criteria to test against. An absent filter matches anything.
+**/
+function matchesOpportunityFilter(opportunity, filter) {
+	if (!filter) return true;
+	if (filter.kind && opportunity.kind !== filter.kind) return false;
+	if (filter.chainIds && !filter.chainIds.includes(opportunity.chainId)) return false;
+	if (filter.underlyingType && opportunity.underlyingToken.assetType !== filter.underlyingType) return false;
+	if (filter.paused !== void 0 && opportunity.paused !== filter.paused) return false;
+	if (filter.sunset !== void 0 && opportunity.sunset !== filter.sunset) return false;
+	if (filter.rwa !== void 0 && opportunity.rwa !== filter.rwa) return false;
+	return true;
+}
+//#endregion
+export { matchesOpportunityFilter, opportunityId, poolOpportunityId, strategyOpportunityId };

package/dist/esm/model/opportunities.schema.js

@@ -0,0 +1,198 @@
+import { ZodAddress } from "../sdk/utils/zod.js";
+import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, curatorSchema, leverageSchema, timestampSchema, tokenSchema } from "./primitives.schema.js";
+import { z } from "zod/v4";
+//#region src/model/opportunities.schema.ts
+/**
+* Runtime schemas for {@link ./opportunities.js}, see the note in
+* `primitives.schema.ts` on why they are written by hand.
+**/
+/**
+* {@link OpportunityKind}
+**/
+const opportunityKindSchema = z.union([z.literal("pool"), z.literal("strategy")]);
+/**
+* {@link PointsProgram}
+**/
+const pointsProgramSchema = z.object({
+	id: z.string(),
+	name: z.string(),
+	multiplier: z.number().nullable()
+});
+/**
+* {@link TokenRewards}
+**/
+const tokenRewardsSchema = z.object({
+	kind: z.literal("token"),
+	token: tokenSchema,
+	supplyApr: bpsSchema.optional(),
+	borrowApr: bpsSchema.optional()
+});
+/**
+* {@link PointRewards}
+**/
+const pointRewardsSchema = z.object({
+	kind: z.literal("point"),
+	points: z.array(pointsProgramSchema)
+});
+/**
+* {@link Rewards}
+**/
+const rewardsSchema = z.discriminatedUnion("kind", [tokenRewardsSchema, pointRewardsSchema]);
+/**
+* {@link ApyBreakdown}
+**/
+const apyBreakdownSchema = z.object({
+	totalApy: bpsSchema,
+	organicApy: bpsSchema,
+	rewards: z.array(rewardsSchema)
+});
+/**
+* {@link OpportunityBase}
+**/
+const opportunityBaseSchema = z.object({
+	chainId: chainIdSchema,
+	title: z.string(),
+	curator: curatorSchema,
+	underlyingToken: tokenSchema,
+	totalSupply: amountSchema,
+	totalBorrow: amountSchema,
+	utilization: bpsSchema,
+	supplyApy: apyBreakdownSchema.optional(),
+	collateralTokens: z.array(tokenSchema),
+	paused: z.boolean(),
+	rwa: z.boolean(),
+	sunset: z.boolean()
+});
+/**
+* {@link PoolOpportunity}
+**/
+const poolOpportunitySchema = z.object({
+	...opportunityBaseSchema.shape,
+	kind: z.literal("pool"),
+	pool: ZodAddress()
+});
+/**
+* {@link StrategyOpportunity}
+**/
+const strategyOpportunitySchema = z.object({
+	...opportunityBaseSchema.shape,
+	kind: z.literal("strategy"),
+	creditManager: ZodAddress(),
+	targetCollateral: tokenSchema,
+	liquidationThreshold: bpsSchema,
+	liquidationPremium: bpsSchema,
+	liquidationFee: bpsSchema,
+	expirationDate: timestampSchema.nullable(),
+	collateralApy: apyBreakdownSchema.optional(),
+	borrowApy: bpsSchema.optional(),
+	additionalBorrowApy: bpsSchema.optional(),
+	maxBorrowAmount: amountSchema,
+	maxLeverage: leverageSchema
+});
+/**
+* {@link Opportunity}
+**/
+const opportunitySchema = z.discriminatedUnion("kind", [poolOpportunitySchema, strategyOpportunitySchema]);
+/**
+* {@link OpportunityFilter}
+**/
+const opportunityFilterSchema = z.object({
+	kind: opportunityKindSchema.optional(),
+	chainIds: z.array(chainIdSchema).optional(),
+	underlyingType: assetTypeSchema.optional(),
+	paused: z.boolean().optional(),
+	sunset: z.boolean().optional(),
+	rwa: z.boolean().optional()
+});
+/**
+* {@link RateCurvePoint}
+**/
+const rateCurvePointSchema = z.object({
+	utilization: bpsSchema,
+	supplyApy: bpsSchema,
+	borrowApy: bpsSchema
+});
+/**
+* {@link RateCurve}
+**/
+const rateCurveSchema = z.object({
+	points: z.array(rateCurvePointSchema),
+	borrowingLimitUtilization: bpsSchema.nullable()
+});
+/**
+* {@link QuotaAsset}
+**/
+const quotaAssetSchema = z.object({
+	token: tokenSchema,
+	quotaRate: bpsSchema,
+	limit: amountSchema,
+	used: amountSchema
+});
+/**
+* {@link PriceFeedData}. Recursive: a composite feed lists the feeds it reads.
+**/
+const priceFeedDataSchema = z.object({
+	name: z.string(),
+	type: z.string(),
+	feedAddress: ZodAddress(),
+	get dependencies() {
+		return z.array(priceFeedDataSchema);
+	}
+});
+/**
+* {@link PriceFeedSummary}
+**/
+const priceFeedSummarySchema = z.object({
+	underlyingPriceInUsd: z.number(),
+	collateralPriceInUsd: z.number(),
+	collateralPriceInUnderlying: z.number(),
+	underlyingFeed: priceFeedDataSchema,
+	collateralFeed: priceFeedDataSchema
+});
+/**
+* {@link PoolOpportunityDetail}
+**/
+const poolOpportunityDetailSchema = z.object({
+	...poolOpportunitySchema.shape,
+	rateCurve: rateCurveSchema,
+	quotaAssets: z.array(quotaAssetSchema)
+});
+/**
+* {@link StrategyOpportunityDetail}
+**/
+const strategyOpportunityDetailSchema = z.object({
+	...strategyOpportunitySchema.shape,
+	rateCurve: rateCurveSchema,
+	priceFeeds: priceFeedSummarySchema
+});
+/**
+* {@link OpportunityDetail}
+**/
+const opportunityDetailSchema = z.discriminatedUnion("kind", [poolOpportunityDetailSchema, strategyOpportunityDetailSchema]);
+/**
+* {@link PoolOpportunityKey}
+**/
+const poolOpportunityKeySchema = z.object({
+	chainId: chainIdSchema,
+	pool: ZodAddress()
+});
+/**
+* {@link StrategyOpportunityKey}
+**/
+const strategyOpportunityKeySchema = z.object({
+	chainId: chainIdSchema,
+	creditManager: ZodAddress(),
+	targetCollateral: ZodAddress()
+});
+/**
+* {@link OpportunityKey}
+**/
+const opportunityKeySchema = z.discriminatedUnion("kind", [z.object({
+	kind: z.literal("pool"),
+	...poolOpportunityKeySchema.shape
+}), z.object({
+	kind: z.literal("strategy"),
+	...strategyOpportunityKeySchema.shape
+})]);
+//#endregion
+export { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema };

package/dist/esm/model/package.json

@@ -0,0 +1 @@
+{"type": "module","sideEffects":false}

package/dist/esm/model/positions.js

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

package/dist/esm/model/primitives.js

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

package/dist/esm/model/primitives.schema.js

@@ -0,0 +1,75 @@
+import { ZodAddress, ZodHex } from "../sdk/utils/zod.js";
+import { z } from "zod/v4";
+//#region src/model/primitives.schema.ts
+/**
+* Runtime schemas for {@link ./primitives.js}.
+*
+* The hand-written types are the contract; these schemas exist so the offchain
+* client can reject a backend response that no longer matches it. The two are
+* kept in sync by the type-level tests in `model.test-d.ts`, not by inferring
+* one from the other.
+**/
+/**
+* {@link ChainId}
+**/
+const chainIdSchema = z.number().int().positive();
+/**
+* {@link Timestamp}
+**/
+const timestampSchema = z.number().int().nonnegative();
+/**
+* {@link Bps}. Integer, not bounded to `0..10000`: rates may exceed 100%.
+**/
+const bpsSchema = z.number().int();
+/**
+* {@link AssetType}
+**/
+const assetTypeSchema = z.union([
+	z.literal("Stable"),
+	z.literal("ETH"),
+	z.literal("BTC")
+]);
+/**
+* {@link Leverage}
+**/
+const leverageSchema = z.number().positive();
+/**
+* {@link Amount}
+**/
+const amountSchema = z.object({
+	value: z.bigint(),
+	valueUsd: z.number().nullable()
+});
+/**
+* {@link Token}
+**/
+const tokenSchema = z.object({
+	chainId: chainIdSchema,
+	address: ZodAddress(),
+	symbol: z.string(),
+	name: z.string(),
+	decimals: z.number().int().nonnegative(),
+	assetType: assetTypeSchema.optional()
+});
+/**
+* {@link TokenAmount}
+**/
+const tokenAmountSchema = amountSchema.extend({ token: tokenSchema });
+/**
+* {@link TxCall}
+**/
+const txCallSchema = z.object({
+	to: ZodAddress(),
+	callData: ZodHex(),
+	value: z.bigint().optional()
+});
+/**
+* {@link Curator}
+**/
+const curatorSchema = z.object({
+	address: ZodAddress(),
+	name: z.string(),
+	url: z.string().nullable()
+});
+//#endregion
+export { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, curatorSchema, leverageSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema };