@waku/interfaces 0.0.26-ce62600.0 → 0.0.26-f387f59.0

package/src/sharding.ts

@@ -0,0 +1,12 @@
+export type ShardInfo = {
+  clusterId: number;
+  shards: number[];
+};
+
+export type ContentTopicInfo = {
+  clusterId?: number;
+  contentTopics: string[];
+};
+
+export type StaticSharding = ShardInfo;
+export type AutoSharding = ContentTopicInfo;

package/src/store.ts

@@ -1,72 +1,101 @@
-import { proto_store as proto } from "@waku/proto";
-
 import type { IDecodedMessage, IDecoder } from "./message.js";
 import type { IBaseProtocolCore, IBaseProtocolSDK } from "./protocols.js";
 
-export enum PageDirection {
-  BACKWARD = "backward",
-  FORWARD = "forward"
-}
+export type StoreCursor = Uint8Array;
 
-export interface TimeFilter {
-  startTime: Date;
-  endTime: Date;
-}
+/**
+ * Parameters for a store query request, as specified in the Waku Store v3 RFC.
+ */
+export type QueryRequestParams = {
+  /**
+   * Whether to include the full message data in the response.
+   * - `true`: The response will include the message content and associated pubsub topic for each matching message.
+   * - `false`: The response will only include the message hashes for each matching message.
+   * @default true
+   */
+  includeData: boolean;
 
-export interface Cursor {
-  digest: Uint8Array;
-  receiverTime: bigint;
-  senderTime: bigint;
+  /**
+   * The pubsub topic to query. This field is mandatory.
+   * The query will only return messages that were published on this specific pubsub topic.
+   */
   pubsubTopic: string;
-}
 
-export type StoreQueryOptions = {
   /**
-   * The direction in which pages are retrieved:
-   * - { @link PageDirection.BACKWARD }: Most recent page first.
-   * - { @link PageDirection.FORWARD }: Oldest page first.
-   *
-   * Note: This does not affect the ordering of messages with the page
-   * (the oldest message is always first).
-   *
-   * @default { @link PageDirection.BACKWARD }
+   * The content topics to filter the messages.
+   * The query will only return messages that have a content topic included in this array.
+   * This field MUST be populated together with the `pubsubTopic` field for content topic filtering to be applied.
+   * If either `contentTopics` or `pubsubTopic` is not provided or empty, no content topic filtering will be applied.
    */
-  pageDirection?: PageDirection;
+  contentTopics: string[];
+
   /**
-   * The number of message per page.
+   * The start time for the time range filter.
+   * The query will only return messages with a timestamp greater than or equal to `timeStart`.
+   * If not provided, no start time filtering will be applied.
    */
-  pageSize?: number;
+  timeStart?: Date;
+
   /**
-   * Retrieve messages with a timestamp within the provided values.
+   * The end time for the time range filter.
+   * The query will only return messages with a timestamp strictly less than `timeEnd`.
+   * If not provided, no end time filtering will be applied.
    */
-  timeFilter?: TimeFilter;
+  timeEnd?: Date;
+
+  /**
+   * The message hashes to lookup.
+   * If provided, the query will be a message hash lookup query and will only return messages that match the specified hashes.
+   * If not provided or empty, the query will be a content filtered query based on the other filter parameters.
+   * @default undefined
+   */
+  messageHashes?: Uint8Array[];
+
+  /**
+   * The cursor to start the query from.
+   * The cursor represents the message hash of the last message returned in the previous query.
+   * The query will start from the message immediately following the cursor, excluding the message at the cursor itself.
+   * If not provided, the query will start from the beginning or end of the store, depending on the `paginationForward` option.
+   * @default undefined
+   */
+  paginationCursor?: Uint8Array;
+
+  /**
+   * The direction of pagination.
+   * - `true`: Forward pagination, starting from the oldest message and moving towards the newest.
+   * - `false`: Backward pagination, starting from the newest message and moving towards the oldest.
+   * @default false
+   */
+  paginationForward: boolean;
+
   /**
-   * Cursor as an index to start a query from. Must be generated from a Waku
-   * Message.
+   * The maximum number of messages to retrieve per page.
+   * If not provided, the store's default pagination limit will be used.
+   * @default undefined
    */
-  cursor?: proto.Index;
+  paginationLimit?: number;
 };
 
 export type IStoreCore = IBaseProtocolCore;
 
 export type IStoreSDK = IBaseProtocolSDK & {
   protocol: IBaseProtocolCore;
-  createCursor(message: IDecodedMessage): Cursor;
+  createCursor(message: IDecodedMessage): StoreCursor;
   queryGenerator: <T extends IDecodedMessage>(
     decoders: IDecoder<T>[],
-    options?: StoreQueryOptions
+    options?: Partial<QueryRequestParams>
   ) => AsyncGenerator<Promise<T | undefined>[]>;
 
   queryWithOrderedCallback: <T extends IDecodedMessage>(
     decoders: IDecoder<T>[],
     callback: (message: T) => Promise<void | boolean> | boolean | void,
-    options?: StoreQueryOptions
+    options?: Partial<QueryRequestParams>
   ) => Promise<void>;
   queryWithPromiseCallback: <T extends IDecodedMessage>(
     decoders: IDecoder<T>[],
     callback: (
       message: Promise<T | undefined>
     ) => Promise<void | boolean> | boolean | void,
-    options?: StoreQueryOptions
+    options?: Partial<QueryRequestParams>
   ) => Promise<void>;
 };

package/src/waku.ts

@@ -3,6 +3,7 @@ import type { MultiaddrInput } from "@multiformats/multiaddr";
 
 import { IConnectionManager } from "./connection_manager.js";
 import type { IFilterSDK } from "./filter.js";
+import { IHealthManager } from "./health_manager.js";
 import type { Libp2p } from "./libp2p.js";
 import type { ILightPushSDK } from "./light_push.js";
 import { Protocols } from "./protocols.js";
@@ -27,6 +28,8 @@ export interface Waku {
   isStarted(): boolean;
 
   isConnected(): boolean;
+
+  health: IHealthManager;
 }
 
 export interface LightNode extends Waku {