@waku/core 0.0.31-f387f59.0 → 0.0.32-3687d81.0

package/CHANGELOG.md

@@ -5,6 +5,35 @@ All notable changes to this project will be documented in this file.
 The file is maintained by [Release Please](https://github.com/googleapis/release-please) based on [Conventional Commits](https://www.conventionalcommits.org) specification,
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.31](https://github.com/waku-org/js-waku/compare/core-v0.0.30...core-v0.0.31) (2024-08-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* **lightpush:** return new error messages ([#2115](https://github.com/waku-org/js-waku/issues/2115))
+* deprecate named pubsub topics and use static/auto sharding  ([#2097](https://github.com/waku-org/js-waku/issues/2097))
+* store v3 ([#2036](https://github.com/waku-org/js-waku/issues/2036))
+
+### Features
+
+* Deprecate named pubsub topics and use static/auto sharding  ([#2097](https://github.com/waku-org/js-waku/issues/2097)) ([5ce36c8](https://github.com/waku-org/js-waku/commit/5ce36c8f187f218df8af66e0643ab277e909b227))
+* Fix peer renewal, change Filter keep alive ([#2065](https://github.com/waku-org/js-waku/issues/2065)) ([00635b7](https://github.com/waku-org/js-waku/commit/00635b7afe60c2ed739f2ccd1f07b2a6cc04f797))
+* **lightpush:** Return new error messages ([#2115](https://github.com/waku-org/js-waku/issues/2115)) ([a022433](https://github.com/waku-org/js-waku/commit/a022433851e6e187679b8c40bb465b431854809b))
+* Node and protocols health ([#2080](https://github.com/waku-org/js-waku/issues/2080)) ([d464af3](https://github.com/waku-org/js-waku/commit/d464af3645d769034d6c6293607de5b00e904ae4))
+* Offline state recovery for Filter subscription ([#2049](https://github.com/waku-org/js-waku/issues/2049)) ([eadb85a](https://github.com/waku-org/js-waku/commit/eadb85ab8367c0e0d8fa9f9fd012eebc71200b6c))
+* Store v3 ([#2036](https://github.com/waku-org/js-waku/issues/2036)) ([86f730f](https://github.com/waku-org/js-waku/commit/86f730f9587e3688b79c8e846e5c005bb4d5fae4))
+* Validate messages for individual filter nodes & perform renewals ([#2057](https://github.com/waku-org/js-waku/issues/2057)) ([9b0f1e8](https://github.com/waku-org/js-waku/commit/9b0f1e855aa3a1f7b9aec3a4c726568d37595c28))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @waku/enr bumped from ^0.0.24 to ^0.0.25
+    * @waku/interfaces bumped from 0.0.25 to 0.0.26
+    * @waku/proto bumped from 0.0.7 to 0.0.8
+    * @waku/utils bumped from 0.0.18 to 0.0.19
+
 ## [0.0.30](https://github.com/waku-org/js-waku/compare/core-v0.0.29...core-v0.0.30) (2024-07-10)
 
 

package/bundle/{base_protocol-Dge5_tvU.js → base_protocol-C47QkJ2o.js}

@@ -1,4 +1,4 @@
-import { h as bytesToUtf8, T as Tags, L as Logger, e as pubsubTopicsToShardInfo } from './index-Gts2Ddu_.js';
+import { h as bytesToUtf8, T as Tags, L as Logger, e as pubsubTopicsToShardInfo } from './index-tdQNdKHx.js';
 
 const decodeRelayShard = (bytes) => {
     // explicitly converting to Uint8Array to avoid Buffer

package/bundle/{index-Gts2Ddu_.js → index-tdQNdKHx.js}

@@ -1058,7 +1058,7 @@ var ProtocolError;
      * The remote peer did not behave as expected. Mitigation for `NO_PEER_AVAILABLE`
      * or `DECODE_FAILED` can be used.
      */
-    ProtocolError["REMOTE_PEER_FAULT"] = "Remote peer fault";
+    ProtocolError["NO_RESPONSE"] = "No response received";
     /**
      * The remote peer rejected the message. Information provided by the remote peer
      * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
@@ -1070,6 +1070,26 @@ var ProtocolError;
      * Mitigation can be: retrying after a given time period
      */
     ProtocolError["REQUEST_TIMEOUT"] = "Request timeout";
+    /**
+     * Missing credentials info message.
+     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L186
+     */
+    ProtocolError["RLN_IDENTITY_MISSING"] = "Identity credentials are not set";
+    /**
+     * Membership index missing info message.
+     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L188
+     */
+    ProtocolError["RLN_MEMBERSHIP_INDEX"] = "Membership index is not set";
+    /**
+     * Message limit is missing.
+     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L190
+     */
+    ProtocolError["RLN_LIMIT_MISSING"] = "User message limit is not set";
+    /**
+     * General proof generation error message.
+     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L201C19-L201C42
+     */
+    ProtocolError["RLN_PROOF_GENERATION"] = "Proof generation failed";
 })(ProtocolError || (ProtocolError = {}));
 
 var Tags;
@@ -2037,4 +2057,4 @@ class Logger {
     }
 }
 
-export { EConnectionStateEvents as E, HealthStatus as H, Logger as L, ProtocolError as P, Tags as T, allocUnsafe as a, alloc as b, Protocols as c, EPeersByDiscoveryEvents as d, pubsubTopicsToShardInfo as e, fromString as f, determinePubsubTopic as g, bytesToUtf8 as h, pubsubTopicToSingleShardInfo as p, shardInfoToPubsubTopics as s, utf8ToBytes as u };
+export { EPeersByDiscoveryEvents as E, HealthStatus as H, Logger as L, ProtocolError as P, Tags as T, allocUnsafe as a, alloc as b, Protocols as c, EConnectionStateEvents as d, pubsubTopicsToShardInfo as e, fromString as f, determinePubsubTopic as g, bytesToUtf8 as h, pubsubTopicToSingleShardInfo as p, shardInfoToPubsubTopics as s, utf8ToBytes as u };

package/bundle/index.js

@@ -1,8 +1,8 @@
-import { v as version_0, e as encodingLength, a as encode$1, d as decode$1, M as MessagePush, F as FilterSubscribeRequest, b as FilterSubscribeResponse$1, P as PushRpc$1, c as PushResponse, S as StoreQueryRequest$1, f as StoreQueryResponse$1, g as createEncoder, W as WakuMetadataRequest, h as WakuMetadataResponse } from './version_0-CNRKFufI.js';
-export { i as createDecoder } from './version_0-CNRKFufI.js';
-import { a as allocUnsafe, b as alloc, L as Logger, P as ProtocolError, c as Protocols, u as utf8ToBytes, p as pubsubTopicToSingleShardInfo, E as EConnectionStateEvents, T as Tags, d as EPeersByDiscoveryEvents, s as shardInfoToPubsubTopics, H as HealthStatus, e as pubsubTopicsToShardInfo } from './index-Gts2Ddu_.js';
-import { B as BaseProtocol, d as decodeRelayShard, e as encodeRelayShard } from './base_protocol-Dge5_tvU.js';
-export { S as StreamManager } from './base_protocol-Dge5_tvU.js';
+import { v as version_0, e as encodingLength, a as encode$1, d as decode$1, M as MessagePush, F as FilterSubscribeRequest, b as FilterSubscribeResponse$1, P as PushRpc$1, c as PushResponse, S as StoreQueryRequest$1, f as StoreQueryResponse$1, g as createEncoder, W as WakuMetadataRequest, h as WakuMetadataResponse } from './version_0-BrbNEwD-.js';
+export { i as createDecoder } from './version_0-BrbNEwD-.js';
+import { a as allocUnsafe, b as alloc, L as Logger, P as ProtocolError, c as Protocols, u as utf8ToBytes, p as pubsubTopicToSingleShardInfo, T as Tags, E as EPeersByDiscoveryEvents, s as shardInfoToPubsubTopics, d as EConnectionStateEvents, H as HealthStatus, e as pubsubTopicsToShardInfo } from './index-tdQNdKHx.js';
+import { B as BaseProtocol, d as decodeRelayShard, e as encodeRelayShard } from './base_protocol-C47QkJ2o.js';
+export { S as StreamManager } from './base_protocol-C47QkJ2o.js';
 
 const MB = 1024 ** 2;
 const SIZE_CAP_IN_MB = 1;
@@ -1618,7 +1618,7 @@ class FilterCore extends BaseProtocol {
             return {
                 success: null,
                 failure: {
-                    error: ProtocolError.REMOTE_PEER_FAULT,
+                    error: ProtocolError.NO_STREAM_AVAILABLE,
                     peerId: peer.id
                 }
             };
@@ -1649,7 +1649,7 @@ class FilterCore extends BaseProtocol {
         if (!res || !res.length) {
             return {
                 failure: {
-                    error: ProtocolError.REMOTE_PEER_FAULT,
+                    error: ProtocolError.NO_RESPONSE,
                     peerId: peer.id
                 },
                 success: null
@@ -1681,7 +1681,7 @@ class FilterCore extends BaseProtocol {
             return {
                 success: null,
                 failure: {
-                    error: ProtocolError.REMOTE_PEER_FAULT,
+                    error: ProtocolError.NO_STREAM_AVAILABLE,
                     peerId: peer.id
                 }
             };
@@ -1705,7 +1705,7 @@ class FilterCore extends BaseProtocol {
             return {
                 success: null,
                 failure: {
-                    error: ProtocolError.REMOTE_PEER_FAULT,
+                    error: ProtocolError.NO_RESPONSE,
                     peerId: peer.id
                 }
             };
@@ -1793,6 +1793,31 @@ class PushRpc {
     }
 }
 
+// should match nwaku
+// https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/rln_relay.nim#L309
+// https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/tests/waku_rln_relay/rln/waku_rln_relay_utils.nim#L20
+const RLN_GENERATION_PREFIX_ERROR = "could not generate rln-v2 proof";
+const isRLNResponseError = (info) => {
+    if (!info) {
+        return false;
+    }
+    return info.includes(RLN_GENERATION_PREFIX_ERROR);
+};
+const matchRLNErrorMessage = (info) => {
+    const rlnErrorMap = {
+        [ProtocolError.RLN_IDENTITY_MISSING]: ProtocolError.RLN_IDENTITY_MISSING,
+        [ProtocolError.RLN_MEMBERSHIP_INDEX]: ProtocolError.RLN_MEMBERSHIP_INDEX,
+        [ProtocolError.RLN_LIMIT_MISSING]: ProtocolError.RLN_LIMIT_MISSING
+    };
+    const infoLowerCase = info.toLowerCase();
+    for (const errorKey in rlnErrorMap) {
+        if (infoLowerCase.includes(errorKey.toLowerCase())) {
+            return rlnErrorMap[errorKey];
+        }
+    }
+    return ProtocolError.RLN_PROOF_GENERATION;
+};
+
 const log$5 = new Logger("light-push");
 const LightPushCodec = "/vac/waku/lightpush/2.0.0-beta1";
 /**
@@ -1895,7 +1920,18 @@ class LightPushCore extends BaseProtocol {
             return {
                 success: null,
                 failure: {
-                    error: ProtocolError.REMOTE_PEER_FAULT,
+                    error: ProtocolError.NO_RESPONSE,
+                    peerId: peer.id
+                }
+            };
+        }
+        if (isRLNResponseError(response.info)) {
+            const rlnErrorCase = matchRLNErrorMessage(response.info);
+            log$5.error("Remote peer rejected the message: ", rlnErrorCase);
+            return {
+                success: null,
+                failure: {
+                    error: rlnErrorCase,
                     peerId: peer.id
                 }
             };
@@ -2650,25 +2686,12 @@ class ConnectionManager extends TypedEventEmitter {
     dialErrorsForPeer = new Map();
     currentActiveParallelDialCount = 0;
     pendingPeerDialQueue = [];
-    online = false;
+    isP2PNetworkConnected = false;
     isConnected() {
-        return this.online;
-    }
-    toggleOnline() {
-        if (!this.online) {
-            this.online = true;
-            this.dispatchEvent(new CustomEvent(EConnectionStateEvents.CONNECTION_STATUS, {
-                detail: this.online
-            }));
-        }
-    }
-    toggleOffline() {
-        if (this.online && this.libp2p.getConnections().length == 0) {
-            this.online = false;
-            this.dispatchEvent(new CustomEvent(EConnectionStateEvents.CONNECTION_STATUS, {
-                detail: this.online
-            }));
+        if (globalThis?.navigator && !globalThis?.navigator?.onLine) {
+            return false;
         }
+        return this.isP2PNetworkConnected;
     }
     static create(peerId, libp2p, keepAliveOptions, pubsubTopics, relay, options) {
         let instance = ConnectionManager.instances.get(peerId);
@@ -2683,6 +2706,7 @@ class ConnectionManager extends TypedEventEmitter {
         this.libp2p.removeEventListener("peer:connect", this.onEventHandlers["peer:connect"]);
         this.libp2p.removeEventListener("peer:disconnect", this.onEventHandlers["peer:disconnect"]);
         this.libp2p.removeEventListener("peer:discovery", this.onEventHandlers["peer:discovery"]);
+        this.stopNetworkStatusListener();
     }
     async dropConnection(peerId) {
         try {
@@ -2759,7 +2783,7 @@ class ConnectionManager extends TypedEventEmitter {
             libp2p,
             options: keepAliveOptions
         });
-        this.run()
+        this.startEventListeners()
             .then(() => log$1.info(`Connection Manager is now running`))
             .catch((error) => log$1.error(`Unexpected error while running service`, error));
         // libp2p emits `peer:discovery` events during its initialization
@@ -2782,11 +2806,11 @@ class ConnectionManager extends TypedEventEmitter {
             log$1.error(`Unexpected error while dialing peer store peers`, error);
         }
     }
-    async run() {
-        // start event listeners
+    async startEventListeners() {
         this.startPeerDiscoveryListener();
         this.startPeerConnectionListener();
         this.startPeerDisconnectionListener();
+        this.startNetworkStatusListener();
     }
     async dialPeer(peerId) {
         this.currentActiveParallelDialCount += 1;
@@ -2934,14 +2958,17 @@ class ConnectionManager extends TypedEventEmitter {
                         detail: peerId
                     }));
                 }
-                this.toggleOnline();
+                this.setP2PNetworkConnected();
             })();
         },
         "peer:disconnect": (evt) => {
             void (async () => {
                 this.keepAliveManager.stop(evt.detail);
-                this.toggleOffline();
+                this.setP2PNetworkDisconnected();
             })();
+        },
+        "browser:network": () => {
+            this.dispatchWakuConnectionEvent();
         }
     };
     /**
@@ -3032,6 +3059,42 @@ class ConnectionManager extends TypedEventEmitter {
             return undefined;
         return decodeRelayShard(shardInfoBytes);
     }
+    startNetworkStatusListener() {
+        try {
+            globalThis.addEventListener("online", this.onEventHandlers["browser:network"]);
+            globalThis.addEventListener("offline", this.onEventHandlers["browser:network"]);
+        }
+        catch (err) {
+            log$1.error(`Failed to start network listener: ${err}`);
+        }
+    }
+    stopNetworkStatusListener() {
+        try {
+            globalThis.removeEventListener("online", this.onEventHandlers["browser:network"]);
+            globalThis.removeEventListener("offline", this.onEventHandlers["browser:network"]);
+        }
+        catch (err) {
+            log$1.error(`Failed to stop network listener: ${err}`);
+        }
+    }
+    setP2PNetworkConnected() {
+        if (!this.isP2PNetworkConnected) {
+            this.isP2PNetworkConnected = true;
+            this.dispatchWakuConnectionEvent();
+        }
+    }
+    setP2PNetworkDisconnected() {
+        if (this.isP2PNetworkConnected &&
+            this.libp2p.getConnections().length === 0) {
+            this.isP2PNetworkConnected = false;
+            this.dispatchWakuConnectionEvent();
+        }
+    }
+    dispatchWakuConnectionEvent() {
+        this.dispatchEvent(new CustomEvent(EConnectionStateEvents.CONNECTION_STATUS, {
+            detail: this.isConnected()
+        }));
+    }
 }
 
 class HealthManager {

package/bundle/lib/base_protocol.js

@@ -1,2 +1,2 @@
-import '../index-Gts2Ddu_.js';
-export { B as BaseProtocol } from '../base_protocol-Dge5_tvU.js';
+import '../index-tdQNdKHx.js';
+export { B as BaseProtocol } from '../base_protocol-C47QkJ2o.js';

package/bundle/lib/message/version_0.js

@@ -1,2 +1,2 @@
-export { D as DecodedMessage, j as Decoder, E as Encoder, V as Version, i as createDecoder, g as createEncoder, m as proto } from '../../version_0-CNRKFufI.js';
-import '../../index-Gts2Ddu_.js';
+export { D as DecodedMessage, j as Decoder, E as Encoder, V as Version, i as createDecoder, g as createEncoder, m as proto } from '../../version_0-BrbNEwD-.js';
+import '../../index-tdQNdKHx.js';

package/bundle/{version_0-CNRKFufI.js → version_0-BrbNEwD-.js}

@@ -1,4 +1,4 @@
-import { a as allocUnsafe, f as fromString, b as alloc$1, L as Logger, g as determinePubsubTopic } from './index-Gts2Ddu_.js';
+import { a as allocUnsafe, f as fromString, b as alloc$1, L as Logger, g as determinePubsubTopic } from './index-tdQNdKHx.js';
 
 /* eslint-disable no-fallthrough */
 const N1 = Math.pow(2, 7);