Merge branch 'master' into chore/libp2p-v2

waku-org · Oct 16, 2024 · 649943b · 649943b
2 parents 426bfa4 + ded994f
commit 649943b
Show file tree

Hide file tree

Showing 18 changed files with 467 additions and 365 deletions.
diff --git a/packages/interfaces/src/filter.ts b/packages/interfaces/src/filter.ts
@@ -20,7 +20,7 @@ export type SubscriptionCallback<T extends IDecodedMessage> = {
 export type SubscribeOptions = {
   keepAlive?: number;
   pingsBeforePeerRenewed?: number;
-  maxMissedMessagesThreshold?: number;
+  enableLightPushFilterCheck?: boolean;
 };
 
 export interface ISubscription {

diff --git a/packages/interfaces/src/light_push.ts b/packages/interfaces/src/light_push.ts
@@ -1,5 +1,4 @@
-import { IBaseProtocolCore, IBaseProtocolSDK } from "./protocols.js";
+import { IBaseProtocolCore } from "./protocols.js";
 import type { ISender } from "./sender.js";
 
-export type ILightPush = ISender &
-  IBaseProtocolSDK & { protocol: IBaseProtocolCore };
+export type ILightPush = ISender & { protocol: IBaseProtocolCore };
diff --git a/packages/interfaces/src/sender.ts b/packages/interfaces/src/sender.ts
@@ -1,10 +1,23 @@
 import type { IEncoder, IMessage } from "./message.js";
-import { ProtocolUseOptions, SDKProtocolResult } from "./protocols.js";
+import { SDKProtocolResult } from "./protocols.js";
+
+export type ISenderOptions = {
+  /**
+   * Enables retry of a message that was failed to be sent.
+   * @default false
+   */
+  autoRetry?: boolean;
+  /**
+   * Sets number of attempts if `autoRetry` is enabled.
+   * @default 3
+   */
+  maxAttempts?: number;
+};
 
 export interface ISender {
   send: (
     encoder: IEncoder,
     message: IMessage,
-    sendOptions?: ProtocolUseOptions
+    sendOptions?: ISenderOptions
   ) => Promise<SDKProtocolResult>;
 }
diff --git a/packages/message-hash/src/index.ts b/packages/message-hash/src/index.ts
@@ -2,7 +2,7 @@ import { sha256 } from "@noble/hashes/sha256";
 import type { IDecodedMessage, IProtoMessage } from "@waku/interfaces";
 import { isDefined } from "@waku/utils";
 import {
-  bytesToUtf8,
+  bytesToHex,
   concat,
   numberToBytes,
   utf8ToBytes
@@ -56,6 +56,6 @@ export function messageHashStr(
   message: IProtoMessage | IDecodedMessage
 ): string {
   const hash = messageHash(pubsubTopic, message);
-  const hashStr = bytesToUtf8(hash);
+  const hashStr = bytesToHex(hash);
   return hashStr;
 }
diff --git a/packages/sdk/src/protocols/base_protocol.ts b/packages/sdk/src/protocols/base_protocol.ts
@@ -11,7 +11,7 @@ interface Options {
   maintainPeersInterval?: number;
 }
 
-const DEFAULT_NUM_PEERS_TO_USE = 2;
+export const DEFAULT_NUM_PEERS_TO_USE = 2;
 const DEFAULT_MAINTAIN_PEERS_INTERVAL = 30_000;
 
 export class BaseProtocolSDK implements IBaseProtocolSDK {
@@ -29,20 +29,20 @@ export class BaseProtocolSDK implements IBaseProtocolSDK {
   ) {
     this.log = new Logger(`sdk:${core.multicodec}`);
 
-    this.peerManager = new PeerManager(connectionManager, core, this.log);
-
     this.numPeersToUse = options?.numPeersToUse ?? DEFAULT_NUM_PEERS_TO_USE;
     const maintainPeersInterval =
       options?.maintainPeersInterval ?? DEFAULT_MAINTAIN_PEERS_INTERVAL;
 
+    this.peerManager = new PeerManager(connectionManager, core, this.log);
+
     this.log.info(
       `Initializing BaseProtocolSDK with numPeersToUse: ${this.numPeersToUse}, maintainPeersInterval: ${maintainPeersInterval}ms`
     );
     void this.startMaintainPeersInterval(maintainPeersInterval);
   }
 
   public get connectedPeers(): Peer[] {
-    return this.peerManager.getPeers();
+    return this.peerManager.getPeers().slice(0, this.numPeersToUse);
   }
 
   /**

diff --git a/packages/sdk/src/protocols/filter/constants.ts b/packages/sdk/src/protocols/filter/constants.ts
@@ -1,5 +1,8 @@
 export const DEFAULT_KEEP_ALIVE = 60_000;
+export const DEFAULT_LIGHT_PUSH_FILTER_CHECK = false;
+export const DEFAULT_LIGHT_PUSH_FILTER_CHECK_INTERVAL = 10_000;
 
 export const DEFAULT_SUBSCRIBE_OPTIONS = {
-  keepAlive: DEFAULT_KEEP_ALIVE
+  keepAlive: DEFAULT_KEEP_ALIVE,
+  enableLightPushFilterCheck: DEFAULT_LIGHT_PUSH_FILTER_CHECK
 };
diff --git a/packages/sdk/src/protocols/filter/index.ts b/packages/sdk/src/protocols/filter/index.ts
@@ -6,6 +6,7 @@ import {
   type IDecodedMessage,
   type IDecoder,
   type IFilter,
+  type ILightPush,
   type Libp2p,
   NetworkConfig,
   type ProtocolCreateOptions,
@@ -38,7 +39,8 @@ class Filter extends BaseProtocolSDK implements IFilter {
 
   public constructor(
     connectionManager: ConnectionManager,
-    libp2p: Libp2p,
+    private libp2p: Libp2p,
+    private lightPush?: ILightPush,
     options?: ProtocolCreateOptions
   ) {
     super(
@@ -195,7 +197,9 @@ class Filter extends BaseProtocolSDK implements IFilter {
           this.protocol,
           this.connectionManager,
           () => this.connectedPeers,
-          this.renewPeer.bind(this)
+          this.renewPeer.bind(this),
+          this.libp2p,
+          this.lightPush
         )
       );
 
@@ -300,7 +304,9 @@ class Filter extends BaseProtocolSDK implements IFilter {
 
 export function wakuFilter(
   connectionManager: ConnectionManager,
+  lightPush?: ILightPush,
   init?: ProtocolCreateOptions
 ): (libp2p: Libp2p) => IFilter {
-  return (libp2p: Libp2p) => new Filter(connectionManager, libp2p, init);
+  return (libp2p: Libp2p) =>
+    new Filter(connectionManager, libp2p, lightPush, init);
 }