@gearbox-protocol/sdk 14.12.0-next.79 → 14.12.0-next.80

package/dist/cjs/model/filters.schema.js

@@ -16,6 +16,8 @@ const filterAllSchema = zod_v4.z.literal("all");
 function filterable(schema) {
 	return zod_v4.z.union([schema, filterAllSchema]);
 }
+const booleanParamSchema = zod_v4.z.enum(["true", "false"]);
 //#endregion
+exports.booleanParamSchema = booleanParamSchema;
 exports.filterAllSchema = filterAllSchema;
 exports.filterable = filterable;

package/dist/cjs/model/index.js

@@ -21,6 +21,7 @@ exports.STRATEGY_POSITION_HISTORY_METRICS = require_model_history.STRATEGY_POSIT
 exports.amountSchema = require_model_primitives_schema.amountSchema;
 exports.apyBreakdownSchema = require_model_opportunities_schema.apyBreakdownSchema;
 exports.assetTypeSchema = require_model_primitives_schema.assetTypeSchema;
+exports.booleanParamSchema = require_model_filters_schema.booleanParamSchema;
 exports.bpsSchema = require_model_primitives_schema.bpsSchema;
 exports.chainIdSchema = require_model_primitives_schema.chainIdSchema;
 exports.curatorNameSchema = require_model_curators_schema.curatorNameSchema;
@@ -47,6 +48,8 @@ exports.matchesOpportunityFilter = require_model_opportunities.matchesOpportunit
 exports.matchesPositionFilter = require_model_positions.matchesPositionFilter;
 exports.opportunityBaseSchema = require_model_opportunities_schema.opportunityBaseSchema;
 exports.opportunityDetailSchema = require_model_opportunities_schema.opportunityDetailSchema;
+exports.opportunityFilterQueryParamsSchema = require_model_opportunities_schema.opportunityFilterQueryParamsSchema;
+exports.opportunityFilterQuerySchema = require_model_opportunities_schema.opportunityFilterQuerySchema;
 exports.opportunityFilterSchema = require_model_opportunities_schema.opportunityFilterSchema;
 exports.opportunityHistoryQuerySchema = require_model_history_schema.opportunityHistoryQuerySchema;
 exports.opportunityId = require_model_opportunities.opportunityId;

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

@@ -1,6 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_sdk_utils_zod = require("../sdk/utils/zod.js");
 const require_model_curators_schema = require("./curators.schema.js");
+const require_model_filters = require("./filters.js");
 const require_model_filters_schema = require("./filters.schema.js");
 const require_model_primitives_schema = require("./primitives.schema.js");
 let zod_v4 = require("zod/v4");
@@ -112,6 +113,48 @@ const opportunityFilterSchema = zod_v4.z.object({
 	rwa: require_model_filters_schema.filterable(zod_v4.z.boolean()).optional()
 });
 /**
+* {@link OpportunityFilter} as a URL can carry it: every condition is a string,
+* and a condition that does not narrow is absent rather than empty.
+**/
+const opportunityFilterQueryParamsSchema = zod_v4.z.object({
+	kind: opportunityKindSchema.optional(),
+	chainIds: zod_v4.z.string().regex(/^$|^\d+(,\d+)*$/).optional(),
+	underlyingType: require_model_primitives_schema.assetTypeSchema.optional(),
+	paused: require_model_filters_schema.booleanParamSchema.optional(),
+	sunset: require_model_filters_schema.booleanParamSchema.optional(),
+	rwa: require_model_filters_schema.booleanParamSchema.optional()
+});
+/**
+* Code for {@link OpportunityFilter} to encode/decode to/from url query parameters.
+**/
+const opportunityFilterQuerySchema = zod_v4.z.codec(opportunityFilterQueryParamsSchema, opportunityFilterSchema, {
+	decode: (params) => {
+		const filter = {};
+		if (params.kind !== void 0) filter.kind = params.kind;
+		if (params.chainIds !== void 0) filter.chainIds = decodeChainIds(params.chainIds);
+		if (params.underlyingType !== void 0) filter.underlyingType = params.underlyingType;
+		if (params.paused !== void 0) filter.paused = params.paused === "true";
+		if (params.sunset !== void 0) filter.sunset = params.sunset === "true";
+		if (params.rwa !== void 0) filter.rwa = params.rwa === "true";
+		return filter;
+	},
+	encode: (filter) => ({
+		kind: require_model_filters.isFilterSet(filter.kind) ? filter.kind : void 0,
+		chainIds: require_model_filters.isFilterSet(filter.chainIds) ? filter.chainIds.join(",") : void 0,
+		underlyingType: require_model_filters.isFilterSet(filter.underlyingType) ? filter.underlyingType : void 0,
+		paused: encodeFlag(filter.paused),
+		sunset: encodeFlag(filter.sunset),
+		rwa: encodeFlag(filter.rwa)
+	})
+});
+function decodeChainIds(param) {
+	return param === "" ? [] : param.split(",").map(Number);
+}
+function encodeFlag(condition) {
+	if (!require_model_filters.isFilterSet(condition)) return;
+	return condition ? "true" : "false";
+}
+/**
 * {@link RateCurvePoint}
 **/
 const rateCurvePointSchema = zod_v4.z.object({
@@ -205,6 +248,8 @@ const opportunityKeySchema = zod_v4.z.discriminatedUnion("kind", [zod_v4.z.objec
 exports.apyBreakdownSchema = apyBreakdownSchema;
 exports.opportunityBaseSchema = opportunityBaseSchema;
 exports.opportunityDetailSchema = opportunityDetailSchema;
+exports.opportunityFilterQueryParamsSchema = opportunityFilterQueryParamsSchema;
+exports.opportunityFilterQuerySchema = opportunityFilterQuerySchema;
 exports.opportunityFilterSchema = opportunityFilterSchema;
 exports.opportunityKeySchema = opportunityKeySchema;
 exports.opportunityKindSchema = opportunityKindSchema;

package/dist/cjs/offchain/AbstractOffchainNamespace.js

@@ -0,0 +1,132 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_model_history_schema = require("../model/history.schema.js");
+const require_offchain_types = require("./types.js");
+let zod_v4 = require("zod/v4");
+//#region src/offchain/AbstractOffchainNamespace.ts
+const DEFAULT_TIMEOUT = 3e4;
+/**
+* Common logic of every {@link GearboxAPI} namespace.
+*
+* A namespace is a set of routes: it knows which path answers which read and
+* which schema describes the payload. Everything under that — where the
+* backend is, how long a request may take, how a failure is reported and how a
+* response becomes read model values — lives here, so a namespace holds
+* nothing but its routes.
+**/
+var AbstractOffchainNamespace = class {
+	logger;
+	#baseUrl;
+	#timeout;
+	constructor(name, options) {
+		this.#baseUrl = options?.baseUrl?.replace(/\/+$/, "");
+		this.#timeout = options?.timeout ?? DEFAULT_TIMEOUT;
+		this.logger = options?.logger?.child?.({ name }) ?? options?.logger;
+	}
+	/**
+	* Base URL every read of this namespace is issued against.
+	**/
+	get baseUrl() {
+		return this.#baseUrl;
+	}
+	/**
+	* Reads one endpoint and decodes its payload.
+	*
+	* The envelope is built here rather than by the caller: the status is
+	* `"success"` whenever this returns at all, because anything else has
+	* already thrown.
+	**/
+	async get(request) {
+		const url = this.#url(request.path, request.query);
+		this.logger?.debug(`reading ${url}`);
+		const payload = await this.#fetchJson(url);
+		const parsed = request.schema.safeParse(payload);
+		if (!parsed.success) {
+			this.logger?.error({
+				url,
+				issues: parsed.error.issues
+			}, "offchain response does not match the read model");
+			throw new require_offchain_types.OffchainValidationError(url, parsed.error.issues);
+		}
+		return {
+			result: parsed.data,
+			meta: { status: "success" }
+		};
+	}
+	/**
+	* Reads one historical series.
+	*
+	* The requested metric is pinned in the schema, which is what upholds the
+	* `HistorySeries<M>` a caller gets back: a response carrying a different
+	* metric is version skew and fails validation like any other mismatch,
+	* rather than being cast into the requested shape.
+	**/
+	async readHistory(request) {
+		return this.get({
+			path: request.path,
+			query: { range: request.range },
+			schema: require_model_history_schema.historySeriesSchema.extend({ metric: zod_v4.z.literal(request.metric) })
+		});
+	}
+	/**
+	* Full URL of a read, with the conditions that do not narrow left out.
+	**/
+	#url(path, query) {
+		if (!this.#baseUrl) throw new require_offchain_types.OffchainNotConfiguredError(path);
+		const url = new URL(`${this.#baseUrl}${path}`);
+		for (const [key, value] of Object.entries(query ?? {})) if (value !== void 0) url.searchParams.set(key, value);
+		return url.toString();
+	}
+	/**
+	* Body of a successful read, still undecoded.
+	**/
+	async #fetchJson(url) {
+		let response;
+		try {
+			response = await fetch(url, {
+				headers: { accept: "application/json" },
+				signal: AbortSignal.timeout(this.#timeout)
+			});
+		} catch (error) {
+			throw new require_offchain_types.OffchainTransportError(url, describe(error));
+		}
+		if (!response.ok) throw new require_offchain_types.OffchainTransportError(url, await failureReason(response), response.status);
+		try {
+			return await response.json();
+		} catch (error) {
+			throw new require_offchain_types.OffchainTransportError(url, `the body is not JSON (${describe(error)})`, response.status);
+		}
+	}
+};
+/**
+* Why a non-2xx response failed, in the backend's own words when it said.
+**/
+async function failureReason(response) {
+	const status = `the backend answered ${response.status}`;
+	let body;
+	try {
+		body = await response.text();
+	} catch {
+		return status;
+	}
+	const message = backendMessage(body) ?? body.trim();
+	return message ? `${status}: ${truncate(message)}` : status;
+}
+/**
+* The `message` of a Gearbox backend error body, or nothing when the body is
+* not one.
+**/
+function backendMessage(body) {
+	try {
+		const parsed = JSON.parse(body);
+		if (typeof parsed === "object" && parsed !== null && "message" in parsed && typeof parsed.message === "string") return parsed.message;
+	} catch {}
+}
+function describe(error) {
+	if (error instanceof Error) return error.name === "TimeoutError" ? "the request timed out" : error.message;
+	return String(error);
+}
+function truncate(text) {
+	return text.length > 200 ? `${text.slice(0, 200)}…` : text;
+}
+//#endregion
+exports.AbstractOffchainNamespace = AbstractOffchainNamespace;

package/dist/cjs/offchain/index.js

@@ -1,11 +1,16 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_offchain_types = require("./types.js");
+const require_offchain_AbstractOffchainNamespace = require("./AbstractOffchainNamespace.js");
 const require_offchain_opportunities_OffchainOpportunities = require("./opportunities/OffchainOpportunities.js");
 require("./opportunities/index.js");
 const require_offchain_positions_OffchainPositions = require("./positions/OffchainPositions.js");
 require("./positions/index.js");
 const require_offchain_GearboxAPI = require("./GearboxAPI.js");
+exports.AbstractOffchainNamespace = require_offchain_AbstractOffchainNamespace.AbstractOffchainNamespace;
 exports.GearboxAPI = require_offchain_GearboxAPI.GearboxAPI;
+exports.OffchainNotConfiguredError = require_offchain_types.OffchainNotConfiguredError;
 exports.OffchainNotImplementedError = require_offchain_types.OffchainNotImplementedError;
 exports.OffchainOpportunities = require_offchain_opportunities_OffchainOpportunities.OffchainOpportunities;
 exports.OffchainPositions = require_offchain_positions_OffchainPositions.OffchainPositions;
+exports.OffchainTransportError = require_offchain_types.OffchainTransportError;
+exports.OffchainValidationError = require_offchain_types.OffchainValidationError;

package/dist/cjs/offchain/opportunities/OffchainOpportunities.js

@@ -1,85 +1,63 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_offchain_types = require("../types.js");
+const require_model_opportunities_schema = require("../../model/opportunities.schema.js");
+const require_offchain_AbstractOffchainNamespace = require("../AbstractOffchainNamespace.js");
+let zod_v4 = require("zod/v4");
 //#region src/offchain/opportunities/OffchainOpportunities.ts
 /**
 * Backend counterpart of the `opportunities` namespace.
-*
-* This is a stub: the HTTP client is not written yet, so list reads answer with
-* an empty list and detail reads throw. Every signature is already the final
-* one, because the backend returns the read model types directly — there is no
-* wire DTO and no mapper between the two.
-*
-* When the transport lands, each method will validate the response against the
-* matching schema from `src/model` before returning it. A validation failure is
-* a version-skew error and is handled exactly like a transport error: the
-* combined SDK drops the backend's contribution in `both` mode and rethrows in
-* `offchain` mode.
 **/
-var OffchainOpportunities = class {
-	#baseUrl;
-	#logger;
+var OffchainOpportunities = class extends require_offchain_AbstractOffchainNamespace.AbstractOffchainNamespace {
+	#root = "/v2/opportunities";
 	constructor(options) {
-		this.#baseUrl = options?.baseUrl;
-		this.#logger = options?.logger?.child?.({ name: "OffchainOpportunities" });
-	}
-	/**
-	* Base URL the client will call once the transport is implemented.
-	**/
-	get baseUrl() {
-		return this.#baseUrl;
+		super("OffchainOpportunities", options);
 	}
 	/**
 	* All opportunities the backend knows about, optionally narrowed by
 	* {@link OpportunityFilter}.
-	*
-	* @returns An empty list until the backend client is implemented.
 	**/
 	async list(filter) {
-		this.#logger?.debug({ filter }, "offchain opportunities list is not implemented, serving empty list");
-		return {
-			result: [],
-			meta: { status: "success" }
-		};
+		return this.get({
+			path: this.#root,
+			query: filter ? zod_v4.z.encode(require_model_opportunities_schema.opportunityFilterQuerySchema, filter) : void 0,
+			schema: zod_v4.z.array(require_model_opportunities_schema.opportunitySchema)
+		});
 	}
 	/**
 	* Detailed view of one pool opportunity.
-	*
-	* @throws {@link OffchainNotImplementedError} until the backend client is
-	* implemented.
 	**/
 	async getPool(key) {
-		throw new require_offchain_types.OffchainNotImplementedError("opportunities.getPool");
+		return this.get({
+			path: this.#poolPath(key),
+			schema: require_model_opportunities_schema.poolOpportunityDetailSchema
+		});
 	}
 	/**
 	* Detailed view of one strategy opportunity.
-	*
-	* @throws {@link OffchainNotImplementedError} until the backend client is
-	* implemented.
 	**/
 	async getStrategy(key) {
-		throw new require_offchain_types.OffchainNotImplementedError("opportunities.getStrategy");
+		return this.get({
+			path: this.#strategyPath(key),
+			schema: require_model_opportunities_schema.strategyOpportunityDetailSchema
+		});
 	}
 	/**
-	* One historical series of one opportunity. History exists only here:
-	* rebuilding it from the chain would mean an archive read per point.
-	*
-	* The requested metric types the response, so a caller asking for one metric
-	* does not have to narrow the union back down. When the transport lands,
-	* validation is what upholds it: a response carrying a different metric than
-	* the one asked for is a version-skew error like any other.
-	*
-	* @returns An empty series until the backend client is implemented.
+	* One historical series of one opportunity
 	**/
 	async getHistory(query) {
-		this.#logger?.debug({ query }, "offchain opportunities history is not implemented, serving empty series");
-		return {
-			result: {
-				metric: query.metric,
-				points: [],
-				metadata: {}
-			},
-			meta: { status: "success" }
-		};
+		return this.readHistory({
+			path: `${this.#historyRoot(query.opportunity)}/history/${query.metric}`,
+			metric: query.metric,
+			range: query.range
+		});
+	}
+	#poolPath(key) {
+		return `${this.#root}/pools/${key.chainId}/${key.pool}`;
+	}
+	#strategyPath(key) {
+		return `${this.#root}/strategies/${key.chainId}/${key.creditManager}/${key.targetCollateral}`;
+	}
+	#historyRoot(key) {
+		return key.kind === "pool" ? this.#poolPath(key) : this.#strategyPath(key);
 	}
 };
 //#endregion

package/dist/cjs/offchain/positions/OffchainPositions.js

@@ -1,31 +1,12 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_offchain_AbstractOffchainNamespace = require("../AbstractOffchainNamespace.js");
 //#region src/offchain/positions/OffchainPositions.ts
 /**
 * Backend counterpart of the `positions` namespace.
-*
-* This is a stub: the HTTP client is not written yet, so reads answer with an
-* empty payload. Every signature is already the final one, because the backend
-* returns the read model types directly — there is no wire DTO and no mapper
-* between the two.
-*
-* When the transport lands, each method will validate the response against the
-* matching schema from `src/model` before returning it. A validation failure is
-* a version-skew error and is handled exactly like a transport error: the
-* combined SDK drops the backend's contribution in `both` mode and rethrows in
-* `offchain` mode.
 **/
-var OffchainPositions = class {
-	#baseUrl;
-	#logger;
+var OffchainPositions = class extends require_offchain_AbstractOffchainNamespace.AbstractOffchainNamespace {
 	constructor(options) {
-		this.#baseUrl = options?.baseUrl;
-		this.#logger = options?.logger?.child?.({ name: "OffchainPositions" });
-	}
-	/**
-	* Base URL the client will call once the transport is implemented.
-	**/
-	get baseUrl() {
-		return this.#baseUrl;
+		super("OffchainPositions", options);
 	}
 	/**
 	* Everything a wallet holds, optionally narrowed by {@link PositionFilter}.
@@ -33,7 +14,7 @@ var OffchainPositions = class {
 	* @returns An empty list until the backend client is implemented.
 	**/
 	async list(wallet, filter) {
-		this.#logger?.debug({
+		this.logger?.debug({
 			wallet,
 			filter
 		}, "offchain positions list is not implemented, serving empty list");
@@ -54,7 +35,7 @@ var OffchainPositions = class {
 	* @returns An empty series until the backend client is implemented.
 	**/
 	async getHistory(query) {
-		this.#logger?.debug({ query }, "offchain positions history is not implemented, serving empty series");
+		this.logger?.debug({ query }, "offchain positions history is not implemented, serving empty series");
 		return {
 			result: {
 				metric: query.metric,

package/dist/cjs/offchain/types.js

@@ -14,5 +14,63 @@ var OffchainNotImplementedError = class extends Error {
 		this.name = "OffchainNotImplementedError";
 	}
 };
+/**
+* Thrown when a read is issued against a client that was never told where the
+* backend is.
+**/
+var OffchainNotConfiguredError = class extends Error {
+	constructor(path) {
+		super(`GearboxAPI: cannot read ${path}, no baseUrl was configured`);
+		this.name = "OffchainNotConfiguredError";
+	}
+};
+/**
+* Thrown when the backend could not be reached, or answered with a status
+* outside the 2xx range.
+**/
+var OffchainTransportError = class extends Error {
+	/**
+	* URL that was requested, query included.
+	**/
+	url;
+	/**
+	* Status the backend answered with, absent when the request never completed.
+	**/
+	status;
+	constructor(url, reason, status) {
+		super(`GearboxAPI: request to ${url} failed, ${reason}`);
+		this.name = "OffchainTransportError";
+		this.url = url;
+		this.status = status;
+	}
+};
+/**
+* Thrown when the backend answered, but with a payload the read model does not
+* describe.
+*
+* This is version skew rather than a bad request, and it is deliberately
+* handled like a transport error: the combined SDK drops the backend's
+* contribution in `both` mode and fails the read in `offchain` mode.
+**/
+var OffchainValidationError = class extends Error {
+	/**
+	* URL whose payload failed to validate.
+	**/
+	url;
+	/**
+	* What did not match, in the order zod reported it.
+	**/
+	issues;
+	constructor(url, issues) {
+		const summary = issues.map((issue) => `${issue.path.join(".") || "<root>"}: ${issue.message}`).join("; ");
+		super(`GearboxAPI: response from ${url} does not match the model, ${summary}`);
+		this.name = "OffchainValidationError";
+		this.url = url;
+		this.issues = issues;
+	}
+};
 //#endregion
+exports.OffchainNotConfiguredError = OffchainNotConfiguredError;
 exports.OffchainNotImplementedError = OffchainNotImplementedError;
+exports.OffchainTransportError = OffchainTransportError;
+exports.OffchainValidationError = OffchainValidationError;

package/dist/esm/dev/AccountOpener.js

@@ -1,9 +1,9 @@
+import { ierc20Abi } from "../abi/iERC20.js";
 import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
 import { AddressMap } from "../sdk/utils/AddressMap.js";
 import { AddressSet } from "../sdk/utils/AddressSet.js";
 import { AssetsMap } from "../sdk/utils/AssetsMap.js";
 import { childLogger } from "../sdk/utils/childLogger.js";
-import { ierc20Abi } from "../abi/iERC20.js";
 import "../sdk/constants/addresses.js";
 import { MAX_UINT256, PERCENTAGE_FACTOR } from "../sdk/constants/math.js";
 import { SDKConstruct } from "../sdk/base/SDKConstruct.js";

package/dist/esm/dev/withdrawalUtils.js

@@ -1,6 +1,6 @@
+import { iWithdrawalCompressorV313Abi } from "../abi/IWithdrawalCompressorV313.js";
 import { getNetworkType } from "../sdk/chain/chains.js";
 import { getWithdrawalCompressorAddress } from "../sdk/accounts/withdrawal-compressor/addresses.js";
-import { iWithdrawalCompressorV313Abi } from "../abi/IWithdrawalCompressorV313.js";
 import "../sdk/index.js";
 import { iMidasDataFeedAbi, iMidasRedemptionVaultAbi, midasGatewayAbi, midasRedeemerAbi, midasRedemptionVaultPhantomTokenAbi, securitizeRedeemerAbi, securitizeRedemptionGatewayAbi, securitizeRedemptionPhantomTokenAbi } from "./withdrawalAbi.js";
 import { erc20Abi, hexToString, parseAbi, parseEther } from "viem";

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

@@ -15,5 +15,6 @@ const filterAllSchema = z.literal("all");
 function filterable(schema) {
 	return z.union([schema, filterAllSchema]);
 }
+const booleanParamSchema = z.enum(["true", "false"]);
 //#endregion
-export { filterAllSchema, filterable };
+export { booleanParamSchema, filterAllSchema, filterable };

package/dist/esm/model/index.js

@@ -1,10 +1,10 @@
 import "./curators.js";
 import { curatorNameSchema, curatorSchema } from "./curators.schema.js";
 import { FILTER_ALL, isFilterSet } from "./filters.js";
-import { filterAllSchema, filterable } from "./filters.schema.js";
+import { booleanParamSchema, filterAllSchema, filterable } from "./filters.schema.js";
 import { POOL_HISTORY_METRICS, POOL_POSITION_HISTORY_METRICS, STRATEGY_HISTORY_METRICS, STRATEGY_POSITION_HISTORY_METRICS } from "./history.js";
 import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, 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 { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema } from "./opportunities.schema.js";
 import { delayedReceivedAssetSchema, instantReceivedAssetSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, receivedAssetSchema } from "./liquidations.schema.js";
 import { pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenRewardsPnLSchema } from "./positions.schema.js";
 import { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, poolPositionHistoryMetricSchema, positionHistoryMetricSchema, positionHistoryQuerySchema, strategyHistoryMetricSchema, strategyPositionHistoryMetricSchema } from "./history.schema.js";
@@ -12,4 +12,4 @@ import { matchesLiquidatableAccountFilter } from "./liquidations.js";
 import { matchesOpportunityFilter, opportunityId, poolOpportunityId, strategyOpportunityId } from "./opportunities.js";
 import { liquidationPositionId, matchesPositionFilter, poolPositionId, positionId, strategyPositionId } from "./positions.js";
 import "./primitives.js";
-export { FILTER_ALL, POOL_HISTORY_METRICS, POOL_POSITION_HISTORY_METRICS, STRATEGY_HISTORY_METRICS, STRATEGY_POSITION_HISTORY_METRICS, amountSchema, apyBreakdownSchema, assetTypeSchema, bpsSchema, chainIdSchema, curatorNameSchema, curatorSchema, delayedReceivedAssetSchema, filterAllSchema, filterable, historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, instantReceivedAssetSchema, isFilterSet, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterSchema, opportunityHistoryQuerySchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolHistoryMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionHistoryMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterSchema, positionHistoryMetricSchema, positionHistoryQuerySchema, positionId, positionKeySchema, positionKindSchema, positionSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, rewardsPnLSchema, rewardsSchema, strategyHistoryMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionHistoryMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, txCallSchema };
+export { FILTER_ALL, POOL_HISTORY_METRICS, POOL_POSITION_HISTORY_METRICS, STRATEGY_HISTORY_METRICS, STRATEGY_POSITION_HISTORY_METRICS, amountSchema, apyBreakdownSchema, assetTypeSchema, booleanParamSchema, bpsSchema, chainIdSchema, curatorNameSchema, curatorSchema, delayedReceivedAssetSchema, filterAllSchema, filterable, historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, instantReceivedAssetSchema, isFilterSet, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityHistoryQuerySchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolHistoryMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionHistoryMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterSchema, positionHistoryMetricSchema, positionHistoryQuerySchema, positionId, positionKeySchema, positionKindSchema, positionSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, rewardsPnLSchema, rewardsSchema, strategyHistoryMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionHistoryMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, txCallSchema };

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

@@ -1,6 +1,7 @@
 import { ZodAddress } from "../sdk/utils/zod.js";
 import { curatorSchema } from "./curators.schema.js";
-import { filterable } from "./filters.schema.js";
+import { isFilterSet } from "./filters.js";
+import { booleanParamSchema, filterable } from "./filters.schema.js";
 import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, leverageSchema, timestampSchema, tokenSchema } from "./primitives.schema.js";
 import { z } from "zod/v4";
 //#region src/model/opportunities.schema.ts
@@ -111,6 +112,48 @@ const opportunityFilterSchema = z.object({
 	rwa: filterable(z.boolean()).optional()
 });
 /**
+* {@link OpportunityFilter} as a URL can carry it: every condition is a string,
+* and a condition that does not narrow is absent rather than empty.
+**/
+const opportunityFilterQueryParamsSchema = z.object({
+	kind: opportunityKindSchema.optional(),
+	chainIds: z.string().regex(/^$|^\d+(,\d+)*$/).optional(),
+	underlyingType: assetTypeSchema.optional(),
+	paused: booleanParamSchema.optional(),
+	sunset: booleanParamSchema.optional(),
+	rwa: booleanParamSchema.optional()
+});
+/**
+* Code for {@link OpportunityFilter} to encode/decode to/from url query parameters.
+**/
+const opportunityFilterQuerySchema = z.codec(opportunityFilterQueryParamsSchema, opportunityFilterSchema, {
+	decode: (params) => {
+		const filter = {};
+		if (params.kind !== void 0) filter.kind = params.kind;
+		if (params.chainIds !== void 0) filter.chainIds = decodeChainIds(params.chainIds);
+		if (params.underlyingType !== void 0) filter.underlyingType = params.underlyingType;
+		if (params.paused !== void 0) filter.paused = params.paused === "true";
+		if (params.sunset !== void 0) filter.sunset = params.sunset === "true";
+		if (params.rwa !== void 0) filter.rwa = params.rwa === "true";
+		return filter;
+	},
+	encode: (filter) => ({
+		kind: isFilterSet(filter.kind) ? filter.kind : void 0,
+		chainIds: isFilterSet(filter.chainIds) ? filter.chainIds.join(",") : void 0,
+		underlyingType: isFilterSet(filter.underlyingType) ? filter.underlyingType : void 0,
+		paused: encodeFlag(filter.paused),
+		sunset: encodeFlag(filter.sunset),
+		rwa: encodeFlag(filter.rwa)
+	})
+});
+function decodeChainIds(param) {
+	return param === "" ? [] : param.split(",").map(Number);
+}
+function encodeFlag(condition) {
+	if (!isFilterSet(condition)) return;
+	return condition ? "true" : "false";
+}
+/**
 * {@link RateCurvePoint}
 **/
 const rateCurvePointSchema = z.object({
@@ -201,4 +244,4 @@ const opportunityKeySchema = z.discriminatedUnion("kind", [z.object({
 	...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 };
+export { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema };