@gearbox-protocol/sdk 16.0.0-next.20 → 16.0.0-next.21

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

@@ -4,7 +4,7 @@ import "../../model/index.js";
 /**
  * On-chain preview of a raw operation calldata.
  **/
-interface Preview {
+interface IPreview {
   /**
    * Decodes a raw operation and assembles an operation-specific,
    * human-displayable preview. Throws when the operation is unsupported or
@@ -14,13 +14,11 @@ interface Preview {
 }
 /**
  * `sdk.preview` per mode: an on-chain read, absent when the SDK reads no chain.
- *
- * @internal
  **/
-interface PreviewByMode {
-  onchain: Preview;
+interface IPreviewByMode {
+  onchain: IPreview;
   offchain: undefined;
-  both: Preview;
+  both: IPreview;
 }
 //#endregion
-export { Preview, PreviewByMode };
+export { IPreview, IPreviewByMode };

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

@@ -9,6 +9,10 @@ import "../onchain/index.js";
 import { GearboxAPIOptions } from "../offchain/types.js";
 import { GearboxAPI } from "../offchain/GearboxAPI.js";
 import "../offchain/index.js";
+import { ILiquidationsByMode } from "./liquidations/types.js";
+import { IOpportunities } from "./opportunities/types.js";
+import { IPositions } from "./positions/types.js";
+import { IPreviewByMode } from "./preview/types.js";
 //#region src/sdk/types.d.ts
 /**
  * Which sources a {@link GearboxSDK} reads from, and therefore which of its
@@ -106,15 +110,70 @@ interface OnchainByMode {
   offchain: undefined;
   both: MultichainSDK;
 }
+/**
+ * The banners the backend attaches to a pool opportunity or a strategy
+ * position, see {@link Notice}.
+ **/
+interface INotices {
+  (subject: NoticeSubject): Promise<DataResponse<Notice[]>>;
+}
 /**
  * `sdk.notices` per mode: a backend read, absent when the SDK reads no backend.
- *
- * @internal
  **/
-interface NoticesByMode {
+interface INoticesByMode {
   onchain: undefined;
-  offchain: (subject: NoticeSubject) => Promise<DataResponse<Notice[]>>;
-  both: (subject: NoticeSubject) => Promise<DataResponse<Notice[]>>;
+  offchain: INotices;
+  both: INotices;
+}
+/**
+ * Public contract of {@link GearboxSDK}: every namespace and sub-construction,
+ * gated by {@link Mode}. Escape hatches `onchain` and `offchain` are not part
+ * of this surface.
+ *
+ * @typeParam M - Mode the instance was built in.
+ **/
+interface IGearboxSDK<M extends Mode = Mode> {
+  /**
+   * Sources this instance reads from.
+   **/
+  readonly mode: M;
+  /**
+   * Chains this instance covers, which every read is scoped to.
+   **/
+  readonly networks: readonly NetworkType[];
+  /**
+   * Whether the on-chain source is ready to be read from. Always `true` in
+   * `offchain` mode.
+   **/
+  readonly attached: boolean;
+  /**
+   * Attaches the on-chain SDK when this instance owns one; a no-op in
+   * `offchain` mode and when an already-attached SDK was injected.
+   **/
+  attach(): Promise<void>;
+  /**
+   * Namespace for pool and strategy opportunities.
+   **/
+  readonly opportunities: IOpportunities<M>;
+  /**
+   * Namespace for the positions a wallet holds.
+   **/
+  readonly positions: IPositions<M>;
+  /**
+   * Namespace for liquidatable credit accounts and delayed-withdrawal
+   * positions a liquidator holds. Absent in `offchain` mode.
+   **/
+  readonly liquidations: ILiquidationsByMode[M];
+  /**
+   * Namespace for on-chain previews of raw operation calldata. Absent in
+   * `offchain` mode.
+   **/
+  readonly preview: IPreviewByMode[M];
+  /**
+   * The banners the backend attaches to a pool opportunity or a strategy
+   * position, see {@link Notice}. Absent in `onchain` mode.
+   **/
+  readonly notices: INoticesByMode[M];
 }
 /**
  * Off-chain escape hatch per mode: absent when the SDK reads no backend.
@@ -127,4 +186,4 @@ interface OffchainByMode {
   both: GearboxAPI;
 }
 //#endregion
-export { EnsureFreshChains, GearboxSDKOptions, Mode, NamespaceOptions, NoticesByMode, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, PlainMultichainSDKOptions };
+export { EnsureFreshChains, GearboxSDKOptions, IGearboxSDK, INotices, INoticesByMode, Mode, NamespaceOptions, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, PlainMultichainSDKOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "16.0.0-next.20",
+  "version": "16.0.0-next.21",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {