@waku/core 0.0.4 → 0.0.6

package/src/lib/waku_light_push/index.ts

@@ -1,7 +1,10 @@
+import { ConnectionManager } from "@libp2p/interface-connection-manager";
 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 {
   Encoder,
+  LightPush,
   Message,
   ProtocolOptions,
   SendResult,
@@ -10,7 +13,6 @@ import debug from "debug";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
-import { Libp2p } from "libp2p";
 import { Uint8ArrayList } from "uint8arraylist";
 
 import { PushResponse } from "../../proto/light_push";
@@ -29,6 +31,11 @@ const log = debug("waku:light-push");
 export const LightPushCodec = "/vac/waku/lightpush/2.0.0-beta1";
 export { PushResponse };
 
+export interface LightPushComponents {
+  peerStore: PeerStore;
+  connectionManager: ConnectionManager;
+}
+
 export interface CreateOptions {
   /**
    * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}.
@@ -44,10 +51,10 @@ export interface CreateOptions {
 /**
  * Implements the [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).
  */
-export class WakuLightPush {
+class WakuLightPush implements LightPush {
   pubSubTopic: string;
 
-  constructor(public libp2p: Libp2p, options?: CreateOptions) {
+  constructor(public components: LightPushComponents, options?: CreateOptions) {
     this.pubSubTopic = options?.pubSubTopic ?? DefaultPubSubTopic;
   }
 
@@ -59,7 +66,7 @@ export class WakuLightPush {
     const pubSubTopic = opts?.pubSubTopic ? opts.pubSubTopic : this.pubSubTopic;
 
     const res = await selectPeerForProtocol(
-      this.libp2p.peerStore,
+      this.components.peerStore,
       [LightPushCodec],
       opts?.peerId
     );
@@ -69,7 +76,9 @@ export class WakuLightPush {
     }
     const { peer } = res;
 
-    const connections = this.libp2p.connectionManager.getConnections(peer.id);
+    const connections = this.components.connectionManager.getConnections(
+      peer.id
+    );
     const connection = selectConnection(connections);
 
     if (!connection) throw "Failed to get a connection to the peer";
@@ -123,7 +132,7 @@ export class WakuLightPush {
    * peers.
    */
   async peers(): Promise<Peer[]> {
-    return getPeersForProtocol(this.libp2p.peerStore, [LightPushCodec]);
+    return getPeersForProtocol(this.components.peerStore, [LightPushCodec]);
   }
 
   /**
@@ -134,4 +143,15 @@ export class WakuLightPush {
   async randomPeer(): Promise<Peer | undefined> {
     return selectRandomPeer(await this.peers());
   }
+
+  get peerStore(): PeerStore {
+    return this.components.peerStore;
+  }
+}
+
+export function wakuLightPush(
+  init: Partial<CreateOptions> = {}
+): (components: LightPushComponents) => LightPush {
+  return (components: LightPushComponents) =>
+    new WakuLightPush(components, init);
 }

package/src/lib/waku_message/topic_only_message.ts

@@ -1,14 +1,15 @@
-import type { Decoder, Message, ProtoMessage } from "@waku/interfaces";
+import type { DecodedMessage, Decoder, ProtoMessage } from "@waku/interfaces";
 import debug from "debug";
 
 import * as proto from "../../proto/topic_only_message";
 
 const log = debug("waku:message:topic-only");
 
-export class TopicOnlyMessage implements Message {
+export class TopicOnlyMessage implements DecodedMessage {
   public payload: undefined;
   public rateLimitProof: undefined;
   public timestamp: undefined;
+  public ephemeral: undefined;
 
   constructor(private proto: proto.TopicOnlyMessage) {}
 
@@ -29,6 +30,7 @@ export class TopicOnlyDecoder implements Decoder<TopicOnlyMessage> {
       rateLimitProof: undefined,
       timestamp: undefined,
       version: undefined,
+      ephemeral: undefined,
     });
   }
 

package/src/lib/waku_message/version_0.ts

@@ -26,6 +26,10 @@ export class MessageV0 implements DecodedMessage {
     return;
   }
 
+  get ephemeral(): boolean {
+    return Boolean(this.proto.ephemeral);
+  }
+
   get payload(): Uint8Array | undefined {
     return this._rawPayload;
   }
@@ -68,7 +72,7 @@ export class MessageV0 implements DecodedMessage {
 }
 
 export class EncoderV0 implements Encoder {
-  constructor(public contentTopic: string) {}
+  constructor(public contentTopic: string, public ephemeral: boolean = false) {}
 
   async toWire(message: Partial<Message>): Promise<Uint8Array> {
     return proto.WakuMessage.encode(await this.toProtoObj(message));
@@ -83,12 +87,13 @@ export class EncoderV0 implements Encoder {
       contentTopic: this.contentTopic,
       timestamp: BigInt(timestamp.valueOf()) * OneMillion,
       rateLimitProof: message.rateLimitProof,
+      ephemeral: this.ephemeral,
     };
   }
 }
 
 export class DecoderV0 implements Decoder<MessageV0> {
-  constructor(public contentTopic: string) {}
+  constructor(public contentTopic: string, public ephemeral: boolean = false) {}
 
   fromWireToProtoObj(bytes: Uint8Array): Promise<ProtoMessage | undefined> {
     const protoMessage = proto.WakuMessage.decode(bytes);
@@ -99,6 +104,7 @@ export class DecoderV0 implements Decoder<MessageV0> {
       version: protoMessage.version ?? undefined,
       timestamp: protoMessage.timestamp ?? undefined,
       rateLimitProof: protoMessage.rateLimitProof ?? undefined,
+      ephemeral: protoMessage.ephemeral ?? false,
     });
   }
 

package/src/lib/waku_relay/index.ts

@@ -1,5 +1,6 @@
 import {
   GossipSub,
+  GossipSubComponents,
   GossipsubMessage,
   GossipsubOpts,
 } from "@chainsafe/libp2p-gossipsub";
@@ -55,7 +56,7 @@ export type CreateOptions = {
  *
  * @implements {require('libp2p-interfaces/src/pubsub')}
  */
-export class WakuRelay extends GossipSub implements Relay {
+class WakuRelay extends GossipSub implements Relay {
   pubSubTopic: string;
   defaultDecoder: Decoder<DecodedMessage>;
   public static multicodec: string = constants.RelayCodecs[0];
@@ -66,13 +67,16 @@ export class WakuRelay extends GossipSub implements Relay {
    */
   public observers: Map<string, Set<Observer<any>>>;
 
-  constructor(options?: Partial<CreateOptions>) {
+  constructor(
+    components: GossipSubComponents,
+    options?: Partial<CreateOptions>
+  ) {
     options = Object.assign(options ?? {}, {
       // Ensure that no signature is included nor expected in the messages.
       globalSignaturePolicy: SignaturePolicy.StrictNoSign,
       fallbackToFloodsub: false,
     });
-    super(options);
+    super(components, options);
     this.multicodecs = constants.RelayCodecs;
 
     this.observers = new Map();
@@ -188,3 +192,9 @@ export class WakuRelay extends GossipSub implements Relay {
 }
 
 WakuRelay.multicodec = constants.RelayCodecs[constants.RelayCodecs.length - 1];
+
+export function wakuRelay(
+  init: Partial<CreateOptions> = {}
+): (components: GossipSubComponents) => Relay {
+  return (components: GossipSubComponents) => new WakuRelay(components, init);
+}

package/src/lib/waku_store/index.ts

@@ -1,12 +1,14 @@
 import type { Connection } from "@libp2p/interface-connection";
+import type { ConnectionManager } from "@libp2p/interface-connection-manager";
 import type { PeerId } from "@libp2p/interface-peer-id";
-import { Peer } from "@libp2p/interface-peer-store";
-import { DecodedMessage, Decoder } from "@waku/interfaces";
+import type { Peer, PeerStore } from "@libp2p/interface-peer-store";
+import { sha256 } from "@noble/hashes/sha256";
+import { concat, utf8ToBytes } from "@waku/byte-utils";
+import { DecodedMessage, Decoder, Index, Store } from "@waku/interfaces";
 import debug from "debug";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
-import { Libp2p } from "libp2p";
 import { Uint8ArrayList } from "uint8arraylist";
 
 import * as proto from "../../proto/store";
@@ -27,6 +29,11 @@ export const DefaultPageSize = 10;
 
 export { PageDirection };
 
+export interface StoreComponents {
+  peerStore: PeerStore;
+  connectionManager: ConnectionManager;
+}
+
 export interface CreateOptions {
   /**
    * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}.
@@ -75,6 +82,10 @@ export interface QueryOptions {
    * Retrieve messages with a timestamp within the provided values.
    */
   timeFilter?: TimeFilter;
+  /**
+   * Cursor as an index to start a query from.
+   */
+  cursor?: Index;
 }
 
 /**
@@ -82,10 +93,10 @@ export interface QueryOptions {
  *
  * The Waku Store protocol can be used to retrieved historical messages.
  */
-export class WakuStore {
+class WakuStore implements Store {
   pubSubTopic: string;
 
-  constructor(public libp2p: Libp2p, options?: CreateOptions) {
+  constructor(public components: StoreComponents, options?: CreateOptions) {
     this.pubSubTopic = options?.pubSubTopic ?? DefaultPubSubTopic;
   }
 
@@ -227,12 +238,12 @@ export class WakuStore {
     );
 
     log("Querying history with the following options", {
-      peerId: options?.peerId?.toString(),
       ...options,
+      peerId: options?.peerId?.toString(),
     });
 
     const res = await selectPeerForProtocol(
-      this.libp2p.peerStore,
+      this.components.peerStore,
       [StoreCodec],
       options?.peerId
     );
@@ -242,7 +253,9 @@ export class WakuStore {
     }
     const { peer, protocol } = res;
 
-    const connections = this.libp2p.connectionManager.getConnections(peer.id);
+    const connections = this.components.connectionManager.getConnections(
+      peer.id
+    );
     const connection = selectConnection(connections);
 
     if (!connection) throw "Failed to get a connection to the peer";
@@ -251,7 +264,8 @@ export class WakuStore {
       connection,
       protocol,
       queryOpts,
-      decodersAsMap
+      decodersAsMap,
+      options?.cursor
     )) {
       yield messages;
     }
@@ -262,7 +276,11 @@ export class WakuStore {
    * store protocol. Waku may or  may not be currently connected to these peers.
    */
   async peers(): Promise<Peer[]> {
-    return getPeersForProtocol(this.libp2p.peerStore, [StoreCodec]);
+    return getPeersForProtocol(this.components.peerStore, [StoreCodec]);
+  }
+
+  get peerStore(): PeerStore {
+    return this.components.peerStore;
   }
 }
 
@@ -270,7 +288,8 @@ async function* paginate<T extends DecodedMessage>(
   connection: Connection,
   protocol: string,
   queryOpts: Params,
-  decoders: Map<string, Decoder<T>>
+  decoders: Map<string, Decoder<T>>,
+  cursor?: Index
 ): AsyncGenerator<Promise<T | undefined>[]> {
   if (
     queryOpts.contentTopics.toString() !==
@@ -281,7 +300,6 @@ async function* paginate<T extends DecodedMessage>(
     );
   }
 
-  let cursor = undefined;
   while (true) {
     queryOpts = Object.assign(queryOpts, { cursor });
 
@@ -370,3 +388,36 @@ async function* paginate<T extends DecodedMessage>(
 export function isDefined<T>(msg: T | undefined): msg is T {
   return !!msg;
 }
+
+export async function createCursor(
+  message: DecodedMessage,
+  pubsubTopic: string = DefaultPubSubTopic
+): Promise<Index> {
+  if (
+    !message ||
+    !message.timestamp ||
+    !message.payload ||
+    !message.contentTopic
+  ) {
+    throw new Error("Message is missing required fields");
+  }
+
+  const contentTopicBytes = utf8ToBytes(message.contentTopic);
+
+  const digest = sha256(concat([contentTopicBytes, message.payload]));
+
+  const messageTime = BigInt(message.timestamp.getTime()) * BigInt(1000000);
+
+  return {
+    digest,
+    pubsubTopic,
+    senderTime: messageTime,
+    receivedTime: messageTime,
+  };
+}
+
+export function wakuStore(
+  init: Partial<CreateOptions> = {}
+): (components: StoreComponents) => Store {
+  return (components: StoreComponents) => new WakuStore(components, init);
+}

package/src/proto/filter.ts

@@ -501,6 +501,7 @@ export interface WakuMessage {
   timestampDeprecated?: number;
   timestamp?: bigint;
   rateLimitProof?: RateLimitProof;
+  ephemeral?: boolean;
 }
 
 export namespace WakuMessage {
@@ -544,6 +545,11 @@ export namespace WakuMessage {
             RateLimitProof.codec().encode(obj.rateLimitProof, writer);
           }
 
+          if (obj.ephemeral != null) {
+            writer.uint32(248);
+            writer.bool(obj.ephemeral);
+          }
+
           if (opts.lengthDelimited !== false) {
             writer.ldelim();
           }
@@ -578,6 +584,9 @@ export namespace WakuMessage {
                   reader.uint32()
                 );
                 break;
+              case 31:
+                obj.ephemeral = reader.bool();
+                break;
               default:
                 reader.skipType(tag & 7);
                 break;

package/src/proto/light_push.ts

@@ -425,6 +425,7 @@ export interface WakuMessage {
   timestampDeprecated?: number;
   timestamp?: bigint;
   rateLimitProof?: RateLimitProof;
+  ephemeral?: boolean;
 }
 
 export namespace WakuMessage {
@@ -468,6 +469,11 @@ export namespace WakuMessage {
             RateLimitProof.codec().encode(obj.rateLimitProof, writer);
           }
 
+          if (obj.ephemeral != null) {
+            writer.uint32(248);
+            writer.bool(obj.ephemeral);
+          }
+
           if (opts.lengthDelimited !== false) {
             writer.ldelim();
           }
@@ -502,6 +508,9 @@ export namespace WakuMessage {
                   reader.uint32()
                 );
                 break;
+              case 31:
+                obj.ephemeral = reader.bool();
+                break;
               default:
                 reader.skipType(tag & 7);
                 break;

package/src/proto/message.ts

@@ -203,6 +203,7 @@ export interface WakuMessage {
   timestampDeprecated?: number;
   timestamp?: bigint;
   rateLimitProof?: RateLimitProof;
+  ephemeral?: boolean;
 }
 
 export namespace WakuMessage {
@@ -246,6 +247,11 @@ export namespace WakuMessage {
             RateLimitProof.codec().encode(obj.rateLimitProof, writer);
           }
 
+          if (obj.ephemeral != null) {
+            writer.uint32(248);
+            writer.bool(obj.ephemeral);
+          }
+
           if (opts.lengthDelimited !== false) {
             writer.ldelim();
           }
@@ -280,6 +286,9 @@ export namespace WakuMessage {
                   reader.uint32()
                 );
                 break;
+              case 31:
+                obj.ephemeral = reader.bool();
+                break;
               default:
                 reader.skipType(tag & 7);
                 break;

package/src/proto/store.ts

@@ -743,6 +743,7 @@ export interface WakuMessage {
   timestampDeprecated?: number;
   timestamp?: bigint;
   rateLimitProof?: RateLimitProof;
+  ephemeral?: boolean;
 }
 
 export namespace WakuMessage {
@@ -786,6 +787,11 @@ export namespace WakuMessage {
             RateLimitProof.codec().encode(obj.rateLimitProof, writer);
           }
 
+          if (obj.ephemeral != null) {
+            writer.uint32(248);
+            writer.bool(obj.ephemeral);
+          }
+
           if (opts.lengthDelimited !== false) {
             writer.ldelim();
           }
@@ -820,6 +826,9 @@ export namespace WakuMessage {
                   reader.uint32()
                 );
                 break;
+              case 31:
+                obj.ephemeral = reader.bool();
+                break;
               default:
                 reader.skipType(tag & 7);
                 break;