@waku/core 0.0.26-7eb3375.0 → 0.0.26

package/CHANGELOG.md

@@ -5,6 +5,36 @@ 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.26](https://github.com/waku-org/js-waku/compare/core-v0.0.25...core-v0.0.26) (2024-01-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* add support for sharded pubsub topics & remove support for named pubsub topics ([#1697](https://github.com/waku-org/js-waku/issues/1697))
+* change all instances of `PubSubTopic` to `PubsubTopic` ([#1703](https://github.com/waku-org/js-waku/issues/1703))
+
+### Features
+
+* Add support for autosharded pubsub topics ([2bc3735](https://github.com/waku-org/js-waku/commit/2bc3735e4dcf85f06b3dee542024d7f20a40fac2))
+* Add support for sharded pubsub topics & remove support for named pubsub topics ([#1697](https://github.com/waku-org/js-waku/issues/1697)) ([4cf2ffe](https://github.com/waku-org/js-waku/commit/4cf2ffefa75e0571805036b71644d2cdd4fe3192))
+* Metadata protocol ([#1732](https://github.com/waku-org/js-waku/issues/1732)) ([9ac2a3f](https://github.com/waku-org/js-waku/commit/9ac2a3f36352523b79fcd8f8a94bd6e0e109fc30))
+* Track node connection state ([#1719](https://github.com/waku-org/js-waku/issues/1719)) ([1d0e2ac](https://github.com/waku-org/js-waku/commit/1d0e2ace7fa5b44ab192505c7ebce01a7ce343e0))
+
+
+### Miscellaneous Chores
+
+* Change all instances of `PubSubTopic` to `PubsubTopic` ([#1703](https://github.com/waku-org/js-waku/issues/1703)) ([3166a51](https://github.com/waku-org/js-waku/commit/3166a5135e77583da4fa722ee2aa47c785854a38))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @waku/enr bumped from ^0.0.19 to ^0.0.20
+    * @waku/interfaces bumped from 0.0.20 to 0.0.21
+    * @waku/proto bumped from 0.0.5 to 0.0.6
+    * @waku/utils bumped from 0.0.13 to 0.0.14
+
 ## [0.0.25](https://github.com/waku-org/js-waku/compare/core-v0.0.24...core-v0.0.25) (2023-11-01)
 
 

package/bundle/{base_protocol-46017f51.js → base_protocol-pDODy0G6.js}

@@ -1,227 +1,5 @@
-import { i as identityBase, h as base2, j as base8, k as base10, l as base16, m as base32, n as base36, o as base58, p as base64, q as base256emoji } from './browser-9a6558bb.js';
-import { L as Logger } from './index-7581d519.js';
-
-// @ts-check
-
-
-const bases = { ...identityBase, ...base2, ...base8, ...base10, ...base16, ...base32, ...base36, ...base58, ...base64, ...base256emoji };
-
-/**
- * To guarantee Uint8Array semantics, convert nodejs Buffers
- * into vanilla Uint8Arrays
- */
-function asUint8Array(buf) {
-    if (globalThis.Buffer != null) {
-        return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
-    }
-    return buf;
-}
-
-/**
- * Returns a `Uint8Array` of the requested size. Referenced memory will
- * be initialized to 0.
- */
-function alloc(size = 0) {
-    if (globalThis.Buffer?.alloc != null) {
-        return asUint8Array(globalThis.Buffer.alloc(size));
-    }
-    return new Uint8Array(size);
-}
-/**
- * Where possible returns a Uint8Array of the requested size that references
- * uninitialized memory. Only use if you are certain you will immediately
- * overwrite every value in the returned `Uint8Array`.
- */
-function allocUnsafe(size = 0) {
-    if (globalThis.Buffer?.allocUnsafe != null) {
-        return asUint8Array(globalThis.Buffer.allocUnsafe(size));
-    }
-    return new Uint8Array(size);
-}
-
-function createCodec(name, prefix, encode, decode) {
-    return {
-        name,
-        prefix,
-        encoder: {
-            name,
-            prefix,
-            encode
-        },
-        decoder: {
-            decode
-        }
-    };
-}
-const string = createCodec('utf8', 'u', (buf) => {
-    const decoder = new TextDecoder('utf8');
-    return 'u' + decoder.decode(buf);
-}, (str) => {
-    const encoder = new TextEncoder();
-    return encoder.encode(str.substring(1));
-});
-const ascii = createCodec('ascii', 'a', (buf) => {
-    let string = 'a';
-    for (let i = 0; i < buf.length; i++) {
-        string += String.fromCharCode(buf[i]);
-    }
-    return string;
-}, (str) => {
-    str = str.substring(1);
-    const buf = allocUnsafe(str.length);
-    for (let i = 0; i < str.length; i++) {
-        buf[i] = str.charCodeAt(i);
-    }
-    return buf;
-});
-const BASES = {
-    utf8: string,
-    'utf-8': string,
-    hex: bases.base16,
-    latin1: ascii,
-    ascii,
-    binary: ascii,
-    ...bases
-};
-
-/**
- * Turns a `Uint8Array` into a string.
- *
- * Supports `utf8`, `utf-8` and any encoding supported by the multibase module.
- *
- * Also `ascii` which is similar to node's 'binary' encoding.
- */
-function toString(array, encoding = 'utf8') {
-    const base = BASES[encoding];
-    if (base == null) {
-        throw new Error(`Unsupported encoding "${encoding}"`);
-    }
-    if ((encoding === 'utf8' || encoding === 'utf-8') && globalThis.Buffer != null && globalThis.Buffer.from != null) {
-        return globalThis.Buffer.from(array.buffer, array.byteOffset, array.byteLength).toString('utf8');
-    }
-    // strip multibase prefix
-    return base.encoder.encode(array).substring(1);
-}
-
-/**
- * Create a `Uint8Array` from the passed string
- *
- * Supports `utf8`, `utf-8`, `hex`, and any encoding supported by the multiformats module.
- *
- * Also `ascii` which is similar to node's 'binary' encoding.
- */
-function fromString(string, encoding = 'utf8') {
-    const base = BASES[encoding];
-    if (base == null) {
-        throw new Error(`Unsupported encoding "${encoding}"`);
-    }
-    if ((encoding === 'utf8' || encoding === 'utf-8') && globalThis.Buffer != null && globalThis.Buffer.from != null) {
-        return asUint8Array(globalThis.Buffer.from(string, 'utf-8'));
-    }
-    // add multibase prefix
-    return base.decoder.decode(`${base.prefix}${string}`); // eslint-disable-line @typescript-eslint/restrict-template-expressions
-}
-
-var Protocols;
-(function (Protocols) {
-    Protocols["Relay"] = "relay";
-    Protocols["Store"] = "store";
-    Protocols["LightPush"] = "lightpush";
-    Protocols["Filter"] = "filter";
-})(Protocols || (Protocols = {}));
-var SendError;
-(function (SendError) {
-    /** Could not determine the origin of the fault. Best to check connectivity and try again */
-    SendError["GENERIC_FAIL"] = "Generic error";
-    /**
-     * Failure to protobuf encode the message. This is not recoverable and needs
-     * further investigation.
-     */
-    SendError["ENCODE_FAILED"] = "Failed to encode";
-    /**
-     * Failure to protobuf decode the message. May be due to a remote peer issue,
-     * ensuring that messages are sent via several peer enable mitigation of this error.
-     */
-    SendError["DECODE_FAILED"] = "Failed to decode";
-    /**
-     * The message payload is empty, making the message invalid. Ensure that a non-empty
-     * payload is set on the outgoing message.
-     */
-    SendError["EMPTY_PAYLOAD"] = "Payload is empty";
-    /**
-     * The message size is above the maximum message size allowed on the Waku Network.
-     * Compressing the message or using an alternative strategy for large messages is recommended.
-     */
-    SendError["SIZE_TOO_BIG"] = "Size is too big";
-    /**
-     * The PubsubTopic passed to the send function is not configured on the Waku node.
-     * Please ensure that the PubsubTopic is used when initializing the Waku node.
-     */
-    SendError["TOPIC_NOT_CONFIGURED"] = "Topic not configured";
-    /**
-     * 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
-     * to user or listening for `peer:connected:bootstrap` or `peer:connected:peer-exchange`
-     * on the connection manager before retrying.
-     */
-    SendError["NO_PEER_AVAILABLE"] = "No peer available";
-    /**
-     * The remote peer did not behave as expected. Mitigation for `NO_PEER_AVAILABLE`
-     * or `DECODE_FAILED` can be used.
-     */
-    SendError["REMOTE_PEER_FAULT"] = "Remote peer fault";
-    /**
-     * The remote peer rejected the message. Information provided by the remote peer
-     * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
-     * or `DECODE_FAILED` can be used.
-     */
-    SendError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
-})(SendError || (SendError = {}));
-
-var PageDirection;
-(function (PageDirection) {
-    PageDirection["BACKWARD"] = "backward";
-    PageDirection["FORWARD"] = "forward";
-})(PageDirection || (PageDirection = {}));
-
-var Tags;
-(function (Tags) {
-    Tags["BOOTSTRAP"] = "bootstrap";
-    Tags["PEER_EXCHANGE"] = "peer-exchange";
-})(Tags || (Tags = {}));
-var EPeersByDiscoveryEvents;
-(function (EPeersByDiscoveryEvents) {
-    EPeersByDiscoveryEvents["PEER_DISCOVERY_BOOTSTRAP"] = "peer:discovery:bootstrap";
-    EPeersByDiscoveryEvents["PEER_DISCOVERY_PEER_EXCHANGE"] = "peer:discovery:peer-exchange";
-    EPeersByDiscoveryEvents["PEER_CONNECT_BOOTSTRAP"] = "peer:connected:bootstrap";
-    EPeersByDiscoveryEvents["PEER_CONNECT_PEER_EXCHANGE"] = "peer:connected:peer-exchange";
-})(EPeersByDiscoveryEvents || (EPeersByDiscoveryEvents = {}));
-var EConnectionStateEvents;
-(function (EConnectionStateEvents) {
-    EConnectionStateEvents["CONNECTION_STATUS"] = "waku:connection";
-})(EConnectionStateEvents || (EConnectionStateEvents = {}));
-
-/**
- * Decode byte array to utf-8 string.
- */
-const bytesToUtf8 = (b) => toString(b, "utf8");
-/**
- * Encode utf-8 string to byte array.
- */
-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 res = new Uint8Array(len);
-    let offset = 0;
-    for (const bytes of byteArrays) {
-        res.set(bytes, offset);
-        offset += bytes.length;
-    }
-    return res;
-}
+import { T as Tags } from './browser-mTOOnVZp.js';
+import { k as bytesToUtf8, L as Logger, s as shardInfoToPubsubTopics, D as DefaultPubsubTopic } from './index-cmONXM-V.js';
 
 /**
  * Returns a pseudo-random peer that supports the given protocol.
@@ -272,6 +50,16 @@ async function getPeersForProtocol(peerStore, protocols) {
     });
     return peers;
 }
+async function getConnectedPeersForProtocol(connections, peerStore, protocols) {
+    const openConnections = connections.filter((connection) => connection.status === "open");
+    const peerPromises = openConnections.map(async (connection) => {
+        const peer = await peerStore.get(connection.remotePeer);
+        const supportsProtocol = peer.protocols.some((protocol) => protocols.includes(protocol));
+        return supportsProtocol ? peer : null;
+    });
+    const peersWithNulls = await Promise.all(peerPromises);
+    return peersWithNulls.filter((peer) => peer !== null);
+}
 /**
  * Returns a peer that supports the given protocol.
  * If peerId is provided, the peer with that id is returned.
@@ -446,7 +234,7 @@ class BaseProtocol {
         return peer;
     }
     /**
-     * Retrieves a list of peers based on the specified criteria.
+     * Retrieves a list of connected peers based on the specified criteria.
      *
      * @param numPeers - The total number of peers to retrieve. If 0, all peers are returned.
      * @param maxBootstrapPeers - The maximum number of bootstrap peers to retrieve.
@@ -456,13 +244,17 @@ class BaseProtocol {
         maxBootstrapPeers: 1,
         numPeers: 0
     }) {
-        // Retrieve all peers that support the protocol
-        const allPeersForProtocol = await getPeersForProtocol(this.peerStore, [
-            this.multicodec
-        ]);
+        // Retrieve all connected peers that support the protocol
+        const allPeersForProtocol = await getConnectedPeersForProtocol(this.components.connectionManager.getConnections(), this.peerStore, [this.multicodec]);
         // Filter the peers based on the specified criteria
         return filterPeers(allPeersForProtocol, numPeers, maxBootstrapPeers);
     }
+    initializePubsubTopic(options) {
+        return (options?.pubsubTopics ??
+            (options?.shardInfo
+                ? shardInfoToPubsubTopics(options.shardInfo)
+                : [DefaultPubsubTopic]));
+    }
 }
 
-export { BaseProtocol as B, EConnectionStateEvents as E, Protocols as P, SendError as S, Tags as T, allocUnsafe as a, asUint8Array as b, bases as c, EPeersByDiscoveryEvents as d, alloc as e, fromString as f, concat as g, StreamManager as h, toString as t, utf8ToBytes as u };
+export { BaseProtocol as B, StreamManager as S };

package/bundle/{browser-9a6558bb.js → browser-mTOOnVZp.js}

@@ -793,6 +793,85 @@ var identityBase = /*#__PURE__*/Object.freeze({
 new TextEncoder();
 new TextDecoder();
 
+var Protocols;
+(function (Protocols) {
+    Protocols["Relay"] = "relay";
+    Protocols["Store"] = "store";
+    Protocols["LightPush"] = "lightpush";
+    Protocols["Filter"] = "filter";
+})(Protocols || (Protocols = {}));
+var SendError;
+(function (SendError) {
+    /** Could not determine the origin of the fault. Best to check connectivity and try again */
+    SendError["GENERIC_FAIL"] = "Generic error";
+    /**
+     * Failure to protobuf encode the message. This is not recoverable and needs
+     * further investigation.
+     */
+    SendError["ENCODE_FAILED"] = "Failed to encode";
+    /**
+     * Failure to protobuf decode the message. May be due to a remote peer issue,
+     * ensuring that messages are sent via several peer enable mitigation of this error.
+     */
+    SendError["DECODE_FAILED"] = "Failed to decode";
+    /**
+     * The message payload is empty, making the message invalid. Ensure that a non-empty
+     * payload is set on the outgoing message.
+     */
+    SendError["EMPTY_PAYLOAD"] = "Payload is empty";
+    /**
+     * The message size is above the maximum message size allowed on the Waku Network.
+     * Compressing the message or using an alternative strategy for large messages is recommended.
+     */
+    SendError["SIZE_TOO_BIG"] = "Size is too big";
+    /**
+     * The PubsubTopic passed to the send function is not configured on the Waku node.
+     * Please ensure that the PubsubTopic is used when initializing the Waku node.
+     */
+    SendError["TOPIC_NOT_CONFIGURED"] = "Topic not configured";
+    /**
+     * 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
+     * to user or listening for `peer:connected:bootstrap` or `peer:connected:peer-exchange`
+     * on the connection manager before retrying.
+     */
+    SendError["NO_PEER_AVAILABLE"] = "No peer available";
+    /**
+     * The remote peer did not behave as expected. Mitigation for `NO_PEER_AVAILABLE`
+     * or `DECODE_FAILED` can be used.
+     */
+    SendError["REMOTE_PEER_FAULT"] = "Remote peer fault";
+    /**
+     * The remote peer rejected the message. Information provided by the remote peer
+     * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
+     * or `DECODE_FAILED` can be used.
+     */
+    SendError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
+})(SendError || (SendError = {}));
+
+var PageDirection;
+(function (PageDirection) {
+    PageDirection["BACKWARD"] = "backward";
+    PageDirection["FORWARD"] = "forward";
+})(PageDirection || (PageDirection = {}));
+
+var Tags;
+(function (Tags) {
+    Tags["BOOTSTRAP"] = "bootstrap";
+    Tags["PEER_EXCHANGE"] = "peer-exchange";
+})(Tags || (Tags = {}));
+var EPeersByDiscoveryEvents;
+(function (EPeersByDiscoveryEvents) {
+    EPeersByDiscoveryEvents["PEER_DISCOVERY_BOOTSTRAP"] = "peer:discovery:bootstrap";
+    EPeersByDiscoveryEvents["PEER_DISCOVERY_PEER_EXCHANGE"] = "peer:discovery:peer-exchange";
+    EPeersByDiscoveryEvents["PEER_CONNECT_BOOTSTRAP"] = "peer:connected:bootstrap";
+    EPeersByDiscoveryEvents["PEER_CONNECT_PEER_EXCHANGE"] = "peer:connected:peer-exchange";
+})(EPeersByDiscoveryEvents || (EPeersByDiscoveryEvents = {}));
+var EConnectionStateEvents;
+(function (EConnectionStateEvents) {
+    EConnectionStateEvents["CONNECTION_STATUS"] = "waku:connection";
+})(EConnectionStateEvents || (EConnectionStateEvents = {}));
+
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 function getDefaultExportFromCjs (x) {
@@ -1546,4 +1625,4 @@ var common = setup;
 var browserExports = browser.exports;
 var debug = /*@__PURE__*/getDefaultExportFromCjs(browserExports);
 
-export { base58btc as a, base32 as b, coerce as c, commonjsGlobal as d, equals as e, getDefaultExportFromCjs as f, getAugmentedNamespace as g, base2$1 as h, identityBase as i, base8$1 as j, base10$1 as k, base16$1 as l, base32$1 as m, base36$1 as n, base58 as o, base64$1 as p, base256emoji$1 as q, debug as r };
+export { EConnectionStateEvents as E, Protocols as P, SendError as S, Tags as T, base58btc as a, base32 as b, coerce as c, commonjsGlobal as d, equals as e, EPeersByDiscoveryEvents as f, getAugmentedNamespace as g, getDefaultExportFromCjs as h, identityBase as i, base2$1 as j, base8$1 as k, base10$1 as l, base16$1 as m, base32$1 as n, base36$1 as o, base58 as p, base64$1 as q, base256emoji$1 as r, debug as s };