@gearbox-protocol/sdk 17.12.2 → 17.13.0-next.10

package/dist/types/sdk/types.d.ts

@@ -20,28 +20,28 @@ import { IRewardsByMode, RewardsKeys } from "./rewards/types.js";
  * Which sources a {@link GearboxSDK} reads from, and therefore which of its
  * methods exist.
  **/
-type Mode = "onchain" | "offchain" | "both";
+export type Mode = "onchain" | "offchain" | "both";
 /**
  * On-chain source of a {@link GearboxSDK}: either an SDK to reuse, which its
  * owner keeps attaching itself, or the options to build one with.
  **/
-type OnchainSource = MultichainSDK | PlainMultichainSDKOptions;
+export type OnchainSource = MultichainSDK | PlainMultichainSDKOptions;
 /**
  * {@link MultichainSDKOptions} without plugin typing.
  **/
-type PlainMultichainSDKOptions = MultichainSDKOptions<{}>;
+export type PlainMultichainSDKOptions = MultichainSDKOptions<{}>;
 /**
  * Off-chain source of a {@link GearboxSDK}: either a client to reuse or the
  * options to build one with. The chains come from
  * {@link GearboxSDKOptions.networks} either way.
  **/
-type OffchainSource = GearboxAPI | Omit<GearboxAPIOptions, "chainIds">;
+export type OffchainSource = GearboxAPI | Omit<GearboxAPIOptions, "chainIds">;
 /**
  * Options for creating a {@link GearboxSDK}.
  *
  * @typeParam M - Mode, which decides which sources are required.
  **/
-interface GearboxSDKOptions<M extends Mode = Mode> {
+export interface GearboxSDKOptions<M extends Mode = Mode> {
   /**
    * Sources to read from, see {@link Mode}.
    **/
@@ -89,11 +89,11 @@ interface GearboxSDKOptions<M extends Mode = Mode> {
  *
  * @internal
  **/
-type EnsureFreshChains = (chainIds?: readonly ChainId[]) => Promise<void>;
+export type EnsureFreshChains = (chainIds?: readonly ChainId[]) => Promise<void>;
 /**
  * What a {@link GearboxSDK} hands every namespace it builds.
  **/
-interface NamespaceOptions {
+export interface NamespaceOptions {
   /**
    * How far the backend may lag the chain, see
    * {@link GearboxSDKOptions.maxOffchainLagSeconds}.
@@ -111,7 +111,7 @@ interface NamespaceOptions {
  *
  * @internal
  **/
-interface OnchainByMode {
+export interface OnchainByMode {
   onchain: MultichainSDK;
   offchain: undefined;
   both: MultichainSDK;
@@ -120,11 +120,11 @@ interface OnchainByMode {
  * The banners the backend attaches to a pool opportunity or a strategy
  * position, see {@link Notice}.
  **/
-type INotices = (subject: NoticeSubject) => Promise<DataResponse<Notice[]>>;
+export type INotices = (subject: NoticeSubject) => Promise<DataResponse<Notice[]>>;
 /**
  * `sdk.notices` per mode: a backend read, absent when the SDK reads no backend.
  **/
-interface INoticesByMode {
+export interface INoticesByMode {
   onchain: undefined;
   offchain: INotices;
   both: INotices;
@@ -136,7 +136,7 @@ interface INoticesByMode {
  *
  * @typeParam M - Mode the instance was built in.
  **/
-interface IGearboxSDK<M extends Mode = Mode> {
+export interface IGearboxSDK<M extends Mode = Mode> {
   /**
    * Sources this instance reads from.
    **/
@@ -190,10 +190,9 @@ interface IGearboxSDK<M extends Mode = Mode> {
  *
  * @internal
  **/
-interface OffchainByMode {
+export interface OffchainByMode {
   onchain: undefined;
   offchain: GearboxAPI;
   both: GearboxAPI;
 }
-//#endregion
-export { EnsureFreshChains, GearboxSDKOptions, IGearboxSDK, INotices, INoticesByMode, Mode, NamespaceOptions, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, PlainMultichainSDKOptions };
+//#endregion

package/dist/types/sdk/utils/filterResponse.d.ts

@@ -14,6 +14,5 @@ import { FilterResult } from "./types.js";
  * @param matches - Whether one row satisfies the filter, e.g.
  *   `matchesOpportunityFilter`.
  **/
-declare function filterResponse<T, F extends ChainScopedFilter, R extends DataResponse<T[]> | undefined>(response: R, filter: F | undefined, matches: (row: T, filter?: F) => boolean): FilterResult<R, T>;
-//#endregion
-export { filterResponse };
+export declare function filterResponse<T, F extends ChainScopedFilter, R extends DataResponse<T[]> | undefined>(response: R, filter: F | undefined, matches: (row: T, filter?: F) => boolean): FilterResult<R, T>;
+//#endregion

package/dist/types/sdk/utils/mergeChains.d.ts

@@ -5,18 +5,17 @@ import { MergeListResult } from "./types.js";
 /**
  * How many seconds the backend may lag the chain and still be used.
  **/
-declare const DEFAULT_MAX_OFFCHAIN_LAG = 120;
+export declare const DEFAULT_MAX_OFFCHAIN_LAG = 120;
 /**
  * Merges two lists chain by chain: a chain is served by the backend when it is
  * within `maxLagSeconds` of the chain, by the chain otherwise, and reported as
  * an error when neither source succeeded. Answers with an envelope as soon as
  * either side has arrived, see {@link MergeListResult}.
  **/
-declare function mergeChainList<T extends ChainScoped, Onchain extends DataResponse<T[]> | undefined, Offchain extends DataResponse<T[]> | undefined>(onchain: Onchain, offchain: Offchain, maxLagSeconds?: number): MergeListResult<Onchain, Offchain, T[]>;
+export declare function mergeChainList<T extends ChainScoped, Onchain extends DataResponse<T[]> | undefined, Offchain extends DataResponse<T[]> | undefined>(onchain: Onchain, offchain: Offchain, maxLagSeconds?: number): MergeListResult<Onchain, Offchain, T[]>;
 /**
  * Merges two versions of one entity under the same freshness rule as
  * {@link mergeChainList}, returning the winning response whole.
  **/
-declare function mergeChainOne<T>(onchain: DataResponse<T> | undefined, offchain: DataResponse<T> | undefined, maxLagSeconds?: number): DataResponse<T> | undefined;
-//#endregion
-export { DEFAULT_MAX_OFFCHAIN_LAG, mergeChainList, mergeChainOne };
+export declare function mergeChainOne<T>(onchain: DataResponse<T> | undefined, offchain: DataResponse<T> | undefined, maxLagSeconds?: number): DataResponse<T> | undefined;
+//#endregion

package/dist/types/sdk/utils/types.d.ts

@@ -14,7 +14,7 @@ type BothMayBeMissing<Onchain, Offchain> = undefined extends Onchain & Offchain
  * @typeParam Offchain - What the backend side was given as.
  * @typeParam T - Payload type of the read.
  **/
-type MergeListResult<Onchain, Offchain, T> = BothMayBeMissing<Onchain, Offchain> extends true ? DataResponse<T> | undefined : DataResponse<T>;
+export type MergeListResult<Onchain, Offchain, T> = BothMayBeMissing<Onchain, Offchain> extends true ? DataResponse<T> | undefined : DataResponse<T>;
 /**
  * What narrowing an already-read list answers with: `undefined` only where the
  * read itself was still in flight.
@@ -22,7 +22,7 @@ type MergeListResult<Onchain, Offchain, T> = BothMayBeMissing<Onchain, Offchain>
  * @typeParam R - What the response was given as.
  * @typeParam T - Row type.
  **/
-type FilterResult<R, T> = R extends undefined ? undefined : DataResponse<T[]>;
+export type FilterResult<R, T> = R extends undefined ? undefined : DataResponse<T[]>;
 /**
  * How a list read combines what the two sources returned. A side still in
  * flight is `undefined`; the merge answers with an envelope as soon as either
@@ -30,7 +30,7 @@ type FilterResult<R, T> = R extends undefined ? undefined : DataResponse<T[]>;
  *
  * @typeParam T - Payload type of the read.
  **/
-type ListMerger<T> = <Onchain extends DataResponse<T> | undefined, Offchain extends DataResponse<T> | undefined>(onchain: Onchain, offchain: Offchain) => MergeListResult<Onchain, Offchain, T>;
+export type ListMerger<T> = <Onchain extends DataResponse<T> | undefined, Offchain extends DataResponse<T> | undefined>(onchain: Onchain, offchain: Offchain) => MergeListResult<Onchain, Offchain, T>;
 /**
  * How a single-entity read combines what the two sources returned. Unlike
  * {@link ListMerger} this stays optional whatever it was given: neither source
@@ -38,6 +38,6 @@ type ListMerger<T> = <Onchain extends DataResponse<T> | undefined, Offchain exte
  *
  * @typeParam T - Payload type of the read.
  **/
-type EntityMerger<T> = (onchain: DataResponse<T> | undefined, offchain: DataResponse<T> | undefined) => DataResponse<T> | undefined;
+export type EntityMerger<T> = (onchain: DataResponse<T> | undefined, offchain: DataResponse<T> | undefined) => DataResponse<T> | undefined;
 //#endregion
-export { EntityMerger, FilterResult, ListMerger, MergeListResult };
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "17.12.2",
+  "version": "17.13.0-next.10",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {
@@ -86,25 +86,25 @@
     "abitype": "^1.3.0",
     "date-fns": "^4.4.0",
     "viem": ">=2.23.15 <3.0.0",
-    "zod": "^4.4.3"
+    "zod": "^4.6.7"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.5.10",
-    "@commitlint/cli": "^21.2.1",
-    "@commitlint/config-conventional": "^21.2.0",
-    "@gearbox-protocol/biome-config": "^1.1.6",
+    "@biomejs/biome": "^2.5.15",
+    "@commitlint/cli": "^21.2.3",
+    "@commitlint/config-conventional": "^21.2.3",
+    "@gearbox-protocol/biome-config": "^1.1.10",
     "husky": "^9.1.7",
-    "lint-staged": "^17.3.0",
-    "pino": "^10.3.1",
-    "pino-pretty": "^13.1.3",
-    "tsdown": "^0.22.14",
-    "tsx": "^4.23.2",
+    "lint-staged": "^17.6.0",
+    "pino": "^10.4.0",
+    "pino-pretty": "^13.2.0",
+    "tsdown": "^0.23.1",
+    "tsx": "^4.23.15",
     "typescript": "^7.0.2",
     "unrun": "^0.3.1",
     "viem-deal": "^2.0.4",
-    "vite": "^8.2.2",
-    "vitest": "^4.1.11",
-    "yaml": "^2.9.0"
+    "vite": "^8.3.4",
+    "vitest": "^5.0.4",
+    "yaml": "^2.9.1"
   },
   "peerDependencies": {
     "viem-deal": "^2.0.4"
@@ -125,5 +125,5 @@
     ]
   },
   "foundryVersion": "1.7.1",
-  "packageManager": "pnpm@11.7.0"
+  "packageManager": "pnpm@12.11.2"
 }