@waku/interfaces 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
 import type { Stream } from "@libp2p/interface-connection";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Peer } from "@libp2p/interface-peer-store";
+import type { PeerStore } from "@libp2p/interface-peer-store";
 import type { Multiaddr } from "@multiformats/multiaddr";
 import type { Libp2p } from "libp2p";
 export declare enum Protocols {
@@ -11,9 +12,15 @@ export declare enum Protocols {
     Filter = "filter"
 }
 export interface PointToPointProtocol {
-    libp2p: Libp2p;
+    peerStore: PeerStore;
     peers: () => Promise<Peer[]>;
 }
+export interface Index {
+    digest?: Uint8Array;
+    receivedTime?: bigint;
+    senderTime?: bigint;
+    pubsubTopic?: string;
+}
 export declare type ProtocolOptions = {
     pubSubTopic?: string;
     /**
@@ -56,6 +63,10 @@ export declare type StoreQueryOptions = {
      * Retrieve messages with a timestamp within the provided values.
      */
     timeFilter?: TimeFilter;
+    /**
+     * Cursor as an index to start a query from.
+     */
+    cursor?: Index;
 } & ProtocolOptions;
 export interface Store extends PointToPointProtocol {
     queryOrderedCallback: <T extends DecodedMessage>(decoders: Decoder<T>[], callback: (message: T) => Promise<void | boolean> | boolean | void, options?: StoreQueryOptions) => Promise<void>;
@@ -74,7 +85,6 @@ export interface Waku {
     filter?: Filter;
     lightPush?: LightPush;
     dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
-    addPeerToAddressBook(peerId: PeerId | string, multiaddrs: Multiaddr[] | string[]): void;
     start(): Promise<void>;
     stop(): Promise<void>;
     isStarted(): boolean;
@@ -116,6 +126,7 @@ export interface ProtoMessage {
     version: number | undefined;
     timestamp: bigint | undefined;
     rateLimitProof: RateLimitProof | undefined;
+    ephemeral: boolean | undefined;
 }
 /**
  * Interface for messages to encode and send.
@@ -127,6 +138,7 @@ export interface Message {
 }
 export interface Encoder {
     contentTopic: string;
+    ephemeral: boolean;
     toWire: (message: Message) => Promise<Uint8Array | undefined>;
     toProtoObj: (message: Message) => Promise<ProtoMessage | undefined>;
 }
@@ -135,6 +147,7 @@ export interface DecodedMessage {
     contentTopic: string | undefined;
     timestamp: Date | undefined;
     rateLimitProof: RateLimitProof | undefined;
+    ephemeral: boolean | undefined;
 }
 export interface Decoder<T extends DecodedMessage> {
     contentTopic: string;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAiCD,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;AACrB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAuCD,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;AACrB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/interfaces",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Definition of Waku interfaces",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -48,12 +48,12 @@
     "node": ">=16"
   },
   "dependencies": {
-    "@chainsafe/libp2p-gossipsub": "^4.1.1",
+    "@chainsafe/libp2p-gossipsub": "^5.2.1",
     "@libp2p/interface-connection": "^3.0.2",
     "@libp2p/interface-peer-id": "^1.0.5",
-    "@libp2p/interface-peer-store": "^1.2.2",
+    "@libp2p/interface-peer-store": "^1.2.3",
     "@multiformats/multiaddr": "^11.0.6",
-    "libp2p": "0.39.2"
+    "libp2p": "0.40.0"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.8.1",

package/src/index.ts

@@ -2,6 +2,7 @@ import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
 import type { Stream } from "@libp2p/interface-connection";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Peer } from "@libp2p/interface-peer-store";
+import type { PeerStore } from "@libp2p/interface-peer-store";
 import type { Multiaddr } from "@multiformats/multiaddr";
 import type { Libp2p } from "libp2p";
 
@@ -13,9 +14,15 @@ export enum Protocols {
 }
 
 export interface PointToPointProtocol {
-  libp2p: Libp2p;
+  peerStore: PeerStore;
   peers: () => Promise<Peer[]>;
 }
+export interface Index {
+  digest?: Uint8Array;
+  receivedTime?: bigint;
+  senderTime?: bigint;
+  pubsubTopic?: string;
+}
 
 export type ProtocolOptions = {
   pubSubTopic?: string;
@@ -73,6 +80,10 @@ export type StoreQueryOptions = {
    * Retrieve messages with a timestamp within the provided values.
    */
   timeFilter?: TimeFilter;
+  /**
+   * Cursor as an index to start a query from.
+   */
+  cursor?: Index;
 } & ProtocolOptions;
 
 export interface Store extends PointToPointProtocol {
@@ -112,11 +123,6 @@ export interface Waku {
 
   dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
 
-  addPeerToAddressBook(
-    peerId: PeerId | string,
-    multiaddrs: Multiaddr[] | string[]
-  ): void;
-
   start(): Promise<void>;
 
   stop(): Promise<void>;
@@ -165,6 +171,7 @@ export interface ProtoMessage {
   version: number | undefined;
   timestamp: bigint | undefined;
   rateLimitProof: RateLimitProof | undefined;
+  ephemeral: boolean | undefined;
 }
 
 /**
@@ -178,6 +185,7 @@ export interface Message {
 
 export interface Encoder {
   contentTopic: string;
+  ephemeral: boolean;
   toWire: (message: Message) => Promise<Uint8Array | undefined>;
   toProtoObj: (message: Message) => Promise<ProtoMessage | undefined>;
 }
@@ -187,6 +195,7 @@ export interface DecodedMessage {
   contentTopic: string | undefined;
   timestamp: Date | undefined;
   rateLimitProof: RateLimitProof | undefined;
+  ephemeral: boolean | undefined;
 }
 
 export interface Decoder<T extends DecodedMessage> {