@waku/core 0.0.31-ce62600.0 → 0.0.31

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-C6HnrRx8.js → base_protocol-C47QkJ2o.js}

@@ -1,4 +1,4 @@
-import { h as bytesToUtf8, T as Tags, L as Logger, i as ensureShardingConfigured } from './index-DnW8ifxc.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
@@ -118,24 +118,6 @@ async function getConnectedPeersForProtocolAndShard(connections, peerStore, prot
     const peersWithNulls = await Promise.all(peerPromises);
     return peersWithNulls.filter((peer) => peer !== null);
 }
-function selectConnection(connections) {
-    if (!connections.length)
-        return;
-    if (connections.length === 1)
-        return connections[0];
-    let latestConnection;
-    connections.forEach((connection) => {
-        if (connection.status === "open") {
-            if (!latestConnection) {
-                latestConnection = connection;
-            }
-            else if (connection.timeline.open > latestConnection.timeline.open) {
-                latestConnection = connection;
-            }
-        }
-    });
-    return latestConnection;
-}
 
 /**
  * Retrieves a list of peers based on the specified criteria:
@@ -174,6 +156,25 @@ function filterPeersByDiscovery(peers, numPeers, maxBootstrapPeers) {
     return selectedPeers;
 }
 
+function selectConnection(connections) {
+    if (!connections.length)
+        return;
+    if (connections.length === 1)
+        return connections[0];
+    let latestConnection;
+    connections.forEach((connection) => {
+        if (connection.status === "open") {
+            if (!latestConnection) {
+                latestConnection = connection;
+            }
+            else if (connection.timeline.open > latestConnection.timeline.open) {
+                latestConnection = connection;
+            }
+        }
+    });
+    return latestConnection;
+}
+
 const CONNECTION_TIMEOUT = 5_000;
 const RETRY_BACKOFF_BASE = 1_000;
 const MAX_RETRIES = 3;
@@ -271,16 +272,14 @@ class BaseProtocol {
     components;
     log;
     pubsubTopics;
-    options;
     addLibp2pEventListener;
     removeLibp2pEventListener;
     streamManager;
-    constructor(multicodec, components, log, pubsubTopics, options) {
+    constructor(multicodec, components, log, pubsubTopics) {
         this.multicodec = multicodec;
         this.components = components;
         this.log = log;
         this.pubsubTopics = pubsubTopics;
-        this.options = options;
         this.addLibp2pEventListener = components.events.addEventListener.bind(components.events);
         this.removeLibp2pEventListener = components.events.removeEventListener.bind(components.events);
         this.streamManager = new StreamManager(multicodec, components.connectionManager.getConnections.bind(components.connectionManager), this.addLibp2pEventListener);
@@ -318,9 +317,7 @@ class BaseProtocol {
         numPeers: 0
     }) {
         // Retrieve all connected peers that support the protocol & shard (if configured)
-        const connectedPeersForProtocolAndShard = await getConnectedPeersForProtocolAndShard(this.components.connectionManager.getConnections(), this.peerStore, [this.multicodec], this.options?.shardInfo
-            ? ensureShardingConfigured(this.options.shardInfo).shardInfo
-            : undefined);
+        const connectedPeersForProtocolAndShard = await getConnectedPeersForProtocolAndShard(this.components.connectionManager.getConnections(), this.peerStore, [this.multicodec], pubsubTopicsToShardInfo(this.pubsubTopics));
         // Filter the peers based on discovery & number of peers requested
         const filteredPeers = filterPeersByDiscovery(connectedPeersForProtocolAndShard, numPeers, maxBootstrapPeers);
         // Sort the peers by latency

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

@@ -1037,6 +1037,11 @@ var ProtocolError;
      * Ensure that the pubsub topic used for decoder creation is the same as the one used for protocol.
      */
     ProtocolError["TOPIC_DECODER_MISMATCH"] = "Topic decoder mismatch";
+    /**
+     * The topics passed in the decoders do not match each other, or don't exist at all.
+     * Ensure that all the pubsub topics used in the decoders are valid and match each other.
+     */
+    ProtocolError["INVALID_DECODER_TOPICS"] = "Invalid decoder topics";
     /**
      * Failure to find a peer with suitable protocols. This may due to a connection issue.
      * Mitigation can be: retrying after a given time period, display connectivity issue
@@ -1053,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`
@@ -1065,14 +1070,28 @@ 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 PageDirection;
-(function (PageDirection) {
-    PageDirection["BACKWARD"] = "backward";
-    PageDirection["FORWARD"] = "forward";
-})(PageDirection || (PageDirection = {}));
-
 var Tags;
 (function (Tags) {
     Tags["BOOTSTRAP"] = "bootstrap";
@@ -1091,14 +1110,18 @@ var EConnectionStateEvents;
     EConnectionStateEvents["CONNECTION_STATUS"] = "waku:connection";
 })(EConnectionStateEvents || (EConnectionStateEvents = {}));
 
-/**
- * DefaultPubsubTopic is the default gossipsub topic to use for Waku.
- */
 /**
  * The default cluster ID for The Waku Network
  */
 const DEFAULT_CLUSTER_ID = 1;
 
+var HealthStatus;
+(function (HealthStatus) {
+    HealthStatus["Unhealthy"] = "Unhealthy";
+    HealthStatus["MinimallyHealthy"] = "MinimallyHealthy";
+    HealthStatus["SufficientlyHealthy"] = "SufficientlyHealthy";
+})(HealthStatus || (HealthStatus = {}));
+
 /**
  * Turns a `Uint8Array` into a string.
  *
@@ -1127,7 +1150,7 @@ const utf8ToBytes = (s) => fromString(s, "utf8");
  * Concatenate using Uint8Arrays as `Buffer` has a different behavior with `DataView`
  */
 function concat(byteArrays, totalLength) {
-    const len = totalLength ?? byteArrays.reduce((acc, curr) => acc + curr.length, 0);
+    const len = byteArrays.reduce((acc, curr) => acc + curr.length, 0);
     const res = new Uint8Array(len);
     let offset = 0;
     for (const bytes of byteArrays) {
@@ -1179,6 +1202,27 @@ const pubsubTopicToSingleShardInfo = (pubsubTopics) => {
         shard
     };
 };
+const pubsubTopicsToShardInfo = (pubsubTopics) => {
+    const shardInfoSet = new Set();
+    const clusterIds = new Set();
+    for (const topic of pubsubTopics) {
+        const { clusterId, shard } = pubsubTopicToSingleShardInfo(topic);
+        shardInfoSet.add(`${clusterId}:${shard}`);
+        clusterIds.add(clusterId);
+    }
+    if (shardInfoSet.size === 0) {
+        throw new Error("No valid pubsub topics provided");
+    }
+    if (clusterIds.size > 1) {
+        throw new Error("Pubsub topics from multiple cluster IDs are not supported");
+    }
+    const clusterId = clusterIds.values().next().value;
+    const shards = Array.from(shardInfoSet).map((info) => parseInt(info.split(":")[1]));
+    return {
+        clusterId,
+        shards
+    };
+};
 /**
  * Given a string, will throw an error if it is not formatted as a valid content topic for autosharding based on https://rfc.vac.dev/spec/51/
  * @param contentTopic String to validate
@@ -1246,7 +1290,9 @@ function contentTopicToPubsubTopic(contentTopic, clusterId = DEFAULT_CLUSTER_ID,
 /**
  * Used when creating encoders/decoders to determine which pubsub topic to use
  */
-function determinePubsubTopic(contentTopic, pubsubTopicShardInfo) {
+function determinePubsubTopic(contentTopic, 
+// TODO: make it accept ShardInfo https://github.com/waku-org/js-waku/issues/2086
+pubsubTopicShardInfo) {
     if (typeof pubsubTopicShardInfo == "string") {
         return pubsubTopicShardInfo;
     }
@@ -1254,49 +1300,6 @@ function determinePubsubTopic(contentTopic, pubsubTopicShardInfo) {
         ? singleShardInfoToPubsubTopic(pubsubTopicShardInfo)
         : contentTopicToPubsubTopic(contentTopic, pubsubTopicShardInfo?.clusterId ?? DEFAULT_CLUSTER_ID);
 }
-/**
- * Validates sharding configuration and sets defaults where possible.
- * @returns Validated sharding parameters, with any missing values set to defaults
- */
-const ensureShardingConfigured = (shardInfo) => {
-    const clusterId = shardInfo.clusterId ?? DEFAULT_CLUSTER_ID;
-    const shards = "shards" in shardInfo ? shardInfo.shards : [];
-    const contentTopics = "contentTopics" in shardInfo ? shardInfo.contentTopics : [];
-    const [application, version] = "application" in shardInfo && "version" in shardInfo
-        ? [shardInfo.application, shardInfo.version]
-        : [undefined, undefined];
-    const isShardsConfigured = shards && shards.length > 0;
-    const isContentTopicsConfigured = contentTopics && contentTopics.length > 0;
-    const isApplicationVersionConfigured = application && version;
-    if (isShardsConfigured) {
-        return {
-            shardingParams: { clusterId, shards },
-            shardInfo: { clusterId, shards },
-            pubsubTopics: shardInfoToPubsubTopics({ clusterId, shards })
-        };
-    }
-    if (isContentTopicsConfigured) {
-        const pubsubTopics = Array.from(new Set(contentTopics.map((topic) => contentTopicToPubsubTopic(topic, clusterId))));
-        const shards = Array.from(new Set(contentTopics.map((topic) => contentTopicToShardIndex(topic))));
-        return {
-            shardingParams: { clusterId, contentTopics },
-            shardInfo: { clusterId, shards },
-            pubsubTopics
-        };
-    }
-    if (isApplicationVersionConfigured) {
-        const pubsubTopic = contentTopicToPubsubTopic(`/${application}/${version}/default/default`, clusterId);
-        return {
-            shardingParams: { clusterId, application, version },
-            shardInfo: {
-                clusterId,
-                shards: [pubsubTopicToSingleShardInfo(pubsubTopic).shard]
-            },
-            pubsubTopics: [pubsubTopic]
-        };
-    }
-    throw new Error("Missing minimum required configuration options for static sharding or autosharding.");
-};
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -1877,6 +1880,8 @@ var common = setup;
 			return false;
 		}
 
+		let m;
+
 		// Is webkit? http://stackoverflow.com/a/16459606/376773
 		// document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
 		return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
@@ -1884,7 +1889,7 @@ var common = setup;
 			(typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
 			// Is firefox >= v31?
 			// https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
-			(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/) && parseInt(RegExp.$1, 10) >= 31) ||
+			(typeof navigator !== 'undefined' && navigator.userAgent && (m = navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/)) && parseInt(m[1], 10) >= 31) ||
 			// Double check webkit in userAgent just in case we are in a worker
 			(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
 	}
@@ -2052,4 +2057,4 @@ class Logger {
     }
 }
 
-export { EConnectionStateEvents as E, Logger as L, ProtocolError as P, Tags as T, allocUnsafe as a, alloc as b, Protocols as c, EPeersByDiscoveryEvents as d, determinePubsubTopic as e, fromString as f, getDefaultExportFromCjs as g, bytesToUtf8 as h, ensureShardingConfigured as i, 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 };