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

package/dist/esm/new-sdk/types.js

@@ -0,0 +1,21 @@
+//#region src/new-sdk/types.ts
+/**
+* Thrown when a read had sources to ask and none of them answered.
+*
+* A read that partially succeeded never throws: it returns what it has and
+* reports the rest in {@link SourceMeta}.
+**/
+var AllSourcesFailedError = class extends Error {
+	/**
+	* Outcome of every source the failed read asked.
+	**/
+	meta;
+	constructor(action, meta) {
+		const reasons = [...meta.chains.filter((c) => c.status === "error").map((c) => `${c.network}: ${c.error}`), ...meta.offchain?.status === "error" ? [`offchain: ${meta.offchain.error}`] : []];
+		super(`cannot ${action}, every source failed (${reasons.join("; ")})`);
+		this.name = "AllSourcesFailedError";
+		this.meta = meta;
+	}
+};
+//#endregion
+export { AllSourcesFailedError };

package/dist/esm/new-sdk/utils/history.js

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

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

@@ -0,0 +1,2 @@
+import "./history.js";
+export {};

package/dist/esm/offchain/GearboxAPI.js

@@ -0,0 +1,32 @@
+import { OffchainOpportunities } from "./opportunities/OffchainOpportunities.js";
+import "./opportunities/index.js";
+//#region src/offchain/GearboxAPI.ts
+/**
+* Client for the Gearbox backend, the off-chain source of the read model.
+*
+* It mirrors the namespace layout of the combined `GearboxSDK`, so the same
+* call reads the same way against either source:
+*
+* ```ts
+* const api = new GearboxAPI({ baseUrl: "https://api.gearbox.fi" });
+* const { result } = await api.opportunities.list({ kind: "strategy" });
+* ```
+*
+* The backend imports the read model from this package and its endpoints
+* return those types directly, so there is no wire DTO layer here — only
+* transport and schema validation.
+*
+* The transport is not implemented yet; see {@link OffchainOpportunities} for
+* what each stubbed endpoint currently answers.
+**/
+var GearboxAPI = class {
+	/**
+	* Namespace for pool and strategy opportunities.
+	**/
+	opportunities;
+	constructor(options) {
+		this.opportunities = new OffchainOpportunities(options);
+	}
+};
+//#endregion
+export { GearboxAPI };

package/dist/esm/offchain/index.js

@@ -0,0 +1,5 @@
+import { OffchainNotImplementedError, OffchainOpportunities } from "./opportunities/OffchainOpportunities.js";
+import "./opportunities/index.js";
+import { GearboxAPI } from "./GearboxAPI.js";
+import "./types.js";
+export { GearboxAPI, OffchainNotImplementedError, OffchainOpportunities };

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

@@ -0,0 +1,95 @@
+//#region src/offchain/opportunities/OffchainOpportunities.ts
+/**
+* Thrown by the endpoints that have no stub answer, so that a caller in
+* `offchain` mode fails loudly instead of reading an empty detail page as a
+* missing opportunity.
+**/
+var OffchainNotImplementedError = class extends Error {
+	constructor(endpoint) {
+		super(`GearboxAPI: ${endpoint} is not implemented yet`);
+		this.name = "OffchainNotImplementedError";
+	}
+};
+/**
+* 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;
+	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;
+	}
+	/**
+	* 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" }
+		};
+	}
+	/**
+	* Detailed view of one pool opportunity.
+	*
+	* @throws {@link OffchainNotImplementedError} until the backend client is
+	* implemented.
+	**/
+	async getPool(key) {
+		throw new OffchainNotImplementedError("opportunities.getPool");
+	}
+	/**
+	* Detailed view of one strategy opportunity.
+	*
+	* @throws {@link OffchainNotImplementedError} until the backend client is
+	* implemented.
+	**/
+	async getStrategy(key) {
+		throw new OffchainNotImplementedError("opportunities.getStrategy");
+	}
+	/**
+	* 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.
+	**/
+	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" }
+		};
+	}
+};
+//#endregion
+export { OffchainNotImplementedError, OffchainOpportunities };

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

@@ -0,0 +1,2 @@
+import { OffchainNotImplementedError, OffchainOpportunities } from "./OffchainOpportunities.js";
+export { OffchainNotImplementedError, OffchainOpportunities };

package/dist/esm/offchain/package.json

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

package/dist/esm/offchain/types.js

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

package/dist/esm/preview/preview/buildDelayedPreview.js

@@ -1,6 +1,6 @@
 import { AssetsMap } from "../../sdk/utils/AssetsMap.js";
+import { BigIntMath } from "../../sdk/utils/bigint-math.js";
 import "../../sdk/index.js";
-import { BigIntMath } from "../../common-utils/utils/bigint-math.js";
 import "../../common-utils/index.js";
 import { ERROR_UNPRICEABLE_TOKEN, PREVIEW_DUST } from "./types.js";
 import { isAddressEqual } from "viem";

package/dist/esm/rewards/rewards/api.js

@@ -1,7 +1,7 @@
+import { BigIntMath } from "../../sdk/utils/bigint-math.js";
 import { chains } from "../../sdk/chain/chains.js";
 import { toBigInt } from "../../sdk/utils/formatter.js";
 import "../../sdk/index.js";
-import { BigIntMath } from "../../common-utils/utils/bigint-math.js";
 import "../../common-utils/index.js";
 import { MerkleXYZApi } from "./merkl-api.js";
 import { getAddress } from "viem";

package/dist/esm/rewards/rewards/extra-apy.js

@@ -1,8 +1,8 @@
+import { BigIntMath } from "../../sdk/utils/bigint-math.js";
 import { chains } from "../../sdk/chain/chains.js";
 import { PERCENTAGE_FACTOR } from "../../sdk/constants/math.js";
 import { toBN } from "../../sdk/utils/formatter.js";
 import "../../sdk/index.js";
-import { BigIntMath } from "../../common-utils/utils/bigint-math.js";
 import "../../common-utils/index.js";
 import axios from "axios";
 //#region src/rewards/rewards/extra-apy.ts

package/dist/esm/sdk/MultichainSDK.js

@@ -1,10 +1,12 @@
 import { getNetworkType } from "./chain/chains.js";
+import { ChainNotConfiguredError, SdkMissingChainStateError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./core/errors.js";
 import { PriceUpdatesCache } from "./market/pricefeeds/updates/PriceUpdatesCache.js";
 import "./market/pricefeeds/updates/index.js";
 import { MultichainLiquidationsService } from "./accounts/liquidations/MultichainLiquidationsService.js";
 import "./accounts/index.js";
-import { SdkMissingChainStateError, SdkStateVersionMismatchError, SdkSyncFailedError } from "./core/errors.js";
 import "./core/index.js";
+import { MultichainOpportunitiesService } from "./opportunities/MultichainOpportunitiesService.js";
+import "./opportunities/index.js";
 import { OnchainSDK } from "./OnchainSDK.js";
 //#region src/sdk/MultichainSDK.ts
 /**
@@ -22,6 +24,11 @@ var MultichainSDK = class {
 	* configured chains.
 	*/
 	liquidations;
+	/**
+	* Namespace for the pool and strategy opportunities of all configured
+	* chains.
+	*/
+	opportunities;
 	constructor(options) {
 		this.#chains = /* @__PURE__ */ new Map();
 		this.#logger = options.logger;
@@ -39,6 +46,7 @@ var MultichainSDK = class {
 			this.#chains.set(network, sdk);
 		}
 		this.liquidations = new MultichainLiquidationsService(this);
+		this.opportunities = new MultichainOpportunitiesService(this);
 	}
 	/**
 	* Attach all configured chains in parallel.
@@ -127,7 +135,7 @@ var MultichainSDK = class {
 		if (typeof networkOrChainId === "number") network = getNetworkType(networkOrChainId);
 		else network = networkOrChainId;
 		const sdk = this.#chains.get(network);
-		if (!sdk) throw new Error(`Chain ${String(networkOrChainId)} is not configured in this MultichainSDK`);
+		if (!sdk) throw new ChainNotConfiguredError(networkOrChainId);
 		return sdk;
 	}
 	/**
@@ -137,6 +145,14 @@ var MultichainSDK = class {
 		return this.#chains;
 	}
 	/**
+	* Shared logger, used for messages that are not attributable to a single
+	* chain. Per-chain messages should use the logger of the corresponding
+	* {@link OnchainSDK}.
+	**/
+	get logger() {
+		return this.#logger;
+	}
+	/**
 	* Sync state for all chains in parallel.
 	*
 	* @param opts - Sync options.

package/dist/esm/sdk/OnchainSDK.js

@@ -8,6 +8,7 @@ import { formatTimestamp } from "./utils/formatter.js";
 import { toAddress } from "./utils/toAddress.js";
 import "./utils/index.js";
 import { ChainContractsRegister } from "./base/ChainContractsRegister.js";
+import { SdkAlreadyAttachedError, SdkChainMismatchError, SdkNotAttachedError, SdkStateVersionMismatchError } from "./core/errors.js";
 import "./base/index.js";
 import { executeDelegatedMulticalls } from "./utils/viem/executeDelegatedMulticalls.js";
 import "./utils/viem/index.js";
@@ -22,8 +23,9 @@ import { createRedemptionLogger } from "./accounts/withdrawal-compressor/createR
 import { createWithdrawalCompressor } from "./accounts/withdrawal-compressor/createWithdrawalCompressor.js";
 import "./accounts/index.js";
 import { createAddressProvider, hydrateAddressProvider } from "./core/createAddressProvider.js";
-import { SdkAlreadyAttachedError, SdkChainMismatchError, SdkNotAttachedError, SdkStateVersionMismatchError } from "./core/errors.js";
 import "./core/index.js";
+import { OpportunitiesService } from "./opportunities/OpportunitiesService.js";
+import "./opportunities/index.js";
 import { PluginStateVersionError } from "./plugins/errors.js";
 import "./plugins/index.js";
 import { PoolService } from "./pools/PoolService.js";
@@ -106,6 +108,10 @@ var OnchainSDK = class extends ChainContractsRegister {
 	*/
 	liquidations;
 	/**
+	* Namespace for the pool and strategy opportunities of this chain.
+	*/
+	opportunities;
+	/**
 	* @param network - Gearbox network type (e.g. `"Mainnet"`, `"Monad"`).
 	* @param clientOptions - Connection options (RPC URLs, transport, or client).
 	* @param options - SDK configuration options.
@@ -126,6 +132,7 @@ var OnchainSDK = class extends ChainContractsRegister {
 		this.accounts = new CreditAccountsServiceV310(this);
 		this.pools = new PoolService(this);
 		this.liquidations = new LiquidationsService(this);
+		this.opportunities = new OpportunitiesService(this);
 		this.#withdrawalCompressor = createWithdrawalCompressor(this);
 	}
 	/**

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

@@ -1,5 +1,5 @@
 import { CreditAccountsServiceV310 } from "./CreditAccountsServiceV310.js";
-import { LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./liquidations/constants.js";
+import { DUST_THRESHOLD, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./liquidations/constants.js";
 import { LiquidationsService } from "./liquidations/LiquidationsService.js";
 import { MultichainLiquidationsService } from "./liquidations/MultichainLiquidationsService.js";
 import "./liquidations/index.js";
@@ -16,4 +16,4 @@ import { toWithdrawalStatus } from "./withdrawal-compressor/types.js";
 import { WithdrawalCompressorV313Contract } from "./withdrawal-compressor/WithdrawalCompressorV313Contract.js";
 import { createWithdrawalCompressor } from "./withdrawal-compressor/createWithdrawalCompressor.js";
 import "./withdrawal-compressor/index.js";
-export { AbstractWithdrawalCompressorContract, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, InvalidDelayedIntentError, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };
+export { AbstractWithdrawalCompressorContract, CreditAccountsServiceV310, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, InvalidDelayedIntentError, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, MultichainLiquidationsService, RedemptionLoggerV310Contract, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };