@waku/core 0.0.23 → 0.0.25-a42b7be.0

package/CHANGELOG.md

@@ -5,6 +5,40 @@ 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.24](https://github.com/waku-org/js-waku/compare/core-v0.0.23...core-v0.0.24) (2023-10-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* **store:** use `pubSubTopic` from `DecodedMessage` for `createCursor` ([#1640](https://github.com/waku-org/js-waku/issues/1640))
+* **static-sharding:** allow multiple pubSubTopics ([#1586](https://github.com/waku-org/js-waku/issues/1586))
+* return `REMOTE_PEER_REJECTED` if remote peer rejected the message
+
+### Features
+
+* Add Firefox and Webkit to karma  ([#1598](https://github.com/waku-org/js-waku/issues/1598)) ([d9e4bcb](https://github.com/waku-org/js-waku/commit/d9e4bcbe3f7bcc092f20621bd362d76426701dab))
+* Enable pinging connected peers by default ([#1647](https://github.com/waku-org/js-waku/issues/1647)) ([1d60c4b](https://github.com/waku-org/js-waku/commit/1d60c4ba44f7fd511371e926247d9151590edec5))
+* Return `REMOTE_PEER_REJECTED` if remote peer rejected the message ([053b654](https://github.com/waku-org/js-waku/commit/053b6545ad0c2450af5687495eb7b6049c0f21ad))
+* **static-sharding:** Allow multiple pubSubTopics ([#1586](https://github.com/waku-org/js-waku/issues/1586)) ([a3c45b6](https://github.com/waku-org/js-waku/commit/a3c45b6e1a9beae488cae3c71c48949fa47bcaf6))
+* **static-sharding:** Filter peer connections per shards ([#1626](https://github.com/waku-org/js-waku/issues/1626)) ([124a29e](https://github.com/waku-org/js-waku/commit/124a29ebba59c05fbbf199d969e6ba3f9e57d45b))
+
+
+### Bug Fixes
+
+* Catch stream creation promise rejection for `lightPush.send` ([b696a89](https://github.com/waku-org/js-waku/commit/b696a8957211bf20577f419a207a23ceca03d23f))
+* Catch top level exception when preemptively creating streams ([fb37c89](https://github.com/waku-org/js-waku/commit/fb37c89e40a9d7c98bef17a085876478486fca8b))
+* **store:** Use `pubSubTopic` from `DecodedMessage` for `createCursor` ([#1640](https://github.com/waku-org/js-waku/issues/1640)) ([b10c46b](https://github.com/waku-org/js-waku/commit/b10c46b910511418a048d7092dfd8b500a71a931))
+* Throw error when no response ([#1567](https://github.com/waku-org/js-waku/issues/1567)) ([d049ebb](https://github.com/waku-org/js-waku/commit/d049ebbc3417e5c20eccba3aa1b9fc5382e8d7fc))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @waku/enr bumped from ^0.0.17 to ^0.0.18
+    * @waku/interfaces bumped from 0.0.18 to 0.0.19
+    * @waku/utils bumped from 0.0.11 to 0.0.12
+
 ## [0.0.23](https://github.com/waku-org/js-waku/compare/core-v0.0.22...core-v0.0.23) (2023-09-11)
 
 

package/bundle/{base_protocol-84d9b670.js → base_protocol-4bcf7514.js}

@@ -1,4 +1,4 @@
-import { d as debug } from './browser-bde977a3.js';
+import { L as Logger } from './index-27b91e3b.js';
 
 // base-x encoding / decoding
 // Copyright (c) 2018 base-x contributors
@@ -126,6 +126,25 @@ var src = base;
 
 var _brrp__multiformats_scope_baseX = src;
 
+/**
+ * @param {Uint8Array} aa
+ * @param {Uint8Array} bb
+ */
+const equals = (aa, bb) => {
+  if (aa === bb) return true
+  if (aa.byteLength !== bb.byteLength) {
+    return false
+  }
+
+  for (let ii = 0; ii < aa.byteLength; ii++) {
+    if (aa[ii] !== bb[ii]) {
+      return false
+    }
+  }
+
+  return true
+};
+
 /**
  * @param {ArrayBufferView|ArrayBuffer|Uint8Array} o
  * @returns {Uint8Array}
@@ -493,83 +512,22 @@ const rfc4648 = ({ name, prefix, bitsPerChar, alphabet }) => {
   })
 };
 
-// @ts-check
-
-
-const identity = from({
-  prefix: '\x00',
-  name: 'identity',
-  encode: (buf) => toString$1(buf),
-  decode: (str) => fromString$1(str)
-});
-
-var identityBase = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  identity: identity
-});
-
-// @ts-check
-
-
-const base2 = rfc4648({
-  prefix: '0',
-  name: 'base2',
-  alphabet: '01',
-  bitsPerChar: 1
-});
-
-var base2$1 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  base2: base2
-});
-
-// @ts-check
-
-
-const base8 = rfc4648({
-  prefix: '7',
-  name: 'base8',
-  alphabet: '01234567',
-  bitsPerChar: 3
-});
-
-var base8$1 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  base8: base8
-});
-
-const base10 = baseX({
-  prefix: '9',
-  name: 'base10',
-  alphabet: '0123456789'
-});
-
-var base10$1 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  base10: base10
-});
-
-// @ts-check
-
-
-const base16 = rfc4648({
-  prefix: 'f',
-  name: 'base16',
-  alphabet: '0123456789abcdef',
-  bitsPerChar: 4
+const base58btc = baseX({
+  name: 'base58btc',
+  prefix: 'z',
+  alphabet: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
 });
 
-const base16upper = rfc4648({
-  prefix: 'F',
-  name: 'base16upper',
-  alphabet: '0123456789ABCDEF',
-  bitsPerChar: 4
+const base58flickr = baseX({
+  name: 'base58flickr',
+  prefix: 'Z',
+  alphabet: '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ'
 });
 
-var base16$1 = /*#__PURE__*/Object.freeze({
+var base58 = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  base16: base16,
-  base16upper: base16upper
+  base58btc: base58btc,
+  base58flickr: base58flickr
 });
 
 const base32 = rfc4648({
@@ -648,6 +606,98 @@ var base32$1 = /*#__PURE__*/Object.freeze({
   base32z: base32z
 });
 
+const base10 = baseX({
+  prefix: '9',
+  name: 'base10',
+  alphabet: '0123456789'
+});
+
+var base10$1 = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  base10: base10
+});
+
+// @ts-check
+
+
+const base16 = rfc4648({
+  prefix: 'f',
+  name: 'base16',
+  alphabet: '0123456789abcdef',
+  bitsPerChar: 4
+});
+
+const base16upper = rfc4648({
+  prefix: 'F',
+  name: 'base16upper',
+  alphabet: '0123456789ABCDEF',
+  bitsPerChar: 4
+});
+
+var base16$1 = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  base16: base16,
+  base16upper: base16upper
+});
+
+// @ts-check
+
+
+const base2 = rfc4648({
+  prefix: '0',
+  name: 'base2',
+  alphabet: '01',
+  bitsPerChar: 1
+});
+
+var base2$1 = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  base2: base2
+});
+
+const alphabet = Array.from('🚀🪐☄🛰🌌🌑🌒🌓🌔🌕🌖🌗🌘🌍🌏🌎🐉☀💻🖥💾💿😂❤😍🤣😊🙏💕😭😘👍😅👏😁🔥🥰💔💖💙😢🤔😆🙄💪😉☺👌🤗💜😔😎😇🌹🤦🎉💞✌✨🤷😱😌🌸🙌😋💗💚😏💛🙂💓🤩😄😀🖤😃💯🙈👇🎶😒🤭❣😜💋👀😪😑💥🙋😞😩😡🤪👊🥳😥🤤👉💃😳✋😚😝😴🌟😬🙃🍀🌷😻😓⭐✅🥺🌈😈🤘💦✔😣🏃💐☹🎊💘😠☝😕🌺🎂🌻😐🖕💝🙊😹🗣💫💀👑🎵🤞😛🔴😤🌼😫⚽🤙☕🏆🤫👈😮🙆🍻🍃🐶💁😲🌿🧡🎁⚡🌞🎈❌✊👋😰🤨😶🤝🚶💰🍓💢🤟🙁🚨💨🤬✈🎀🍺🤓😙💟🌱😖👶🥴▶➡❓💎💸⬇😨🌚🦋😷🕺⚠🙅😟😵👎🤲🤠🤧📌🔵💅🧐🐾🍒😗🤑🌊🤯🐷☎💧😯💆👆🎤🙇🍑❄🌴💣🐸💌📍🥀🤢👅💡💩👐📸👻🤐🤮🎼🥵🚩🍎🍊👼💍📣🥂');
+const alphabetBytesToChars = /** @type {string[]} */ (alphabet.reduce((p, c, i) => { p[i] = c; return p }, /** @type {string[]} */([])));
+const alphabetCharsToBytes = /** @type {number[]} */ (alphabet.reduce((p, c, i) => { p[/** @type {number} */ (c.codePointAt(0))] = i; return p }, /** @type {number[]} */([])));
+
+/**
+ * @param {Uint8Array} data
+ * @returns {string}
+ */
+function encode (data) {
+  return data.reduce((p, c) => {
+    p += alphabetBytesToChars[c];
+    return p
+  }, '')
+}
+
+/**
+ * @param {string} str
+ * @returns {Uint8Array}
+ */
+function decode (str) {
+  const byts = [];
+  for (const char of str) {
+    const byt = alphabetCharsToBytes[/** @type {number} */ (char.codePointAt(0))];
+    if (byt === undefined) {
+      throw new Error(`Non-base256emoji character: ${char}`)
+    }
+    byts.push(byt);
+  }
+  return new Uint8Array(byts)
+}
+
+const base256emoji = from({
+  prefix: '🚀',
+  name: 'base256emoji',
+  encode,
+  decode
+});
+
+var base256emoji$1 = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  base256emoji: base256emoji
+});
+
 const base36 = baseX({
   prefix: 'k',
   name: 'base36',
@@ -666,24 +716,6 @@ var base36$1 = /*#__PURE__*/Object.freeze({
   base36upper: base36upper
 });
 
-const base58btc = baseX({
-  name: 'base58btc',
-  prefix: 'z',
-  alphabet: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
-});
-
-const base58flickr = baseX({
-  name: 'base58flickr',
-  prefix: 'Z',
-  alphabet: '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ'
-});
-
-var base58 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  base58btc: base58btc,
-  base58flickr: base58flickr
-});
-
 // @ts-check
 
 
@@ -723,47 +755,34 @@ var base64$1 = /*#__PURE__*/Object.freeze({
   base64urlpad: base64urlpad
 });
 
-const alphabet = Array.from('🚀🪐☄🛰🌌🌑🌒🌓🌔🌕🌖🌗🌘🌍🌏🌎🐉☀💻🖥💾💿😂❤😍🤣😊🙏💕😭😘👍😅👏😁🔥🥰💔💖💙😢🤔😆🙄💪😉☺👌🤗💜😔😎😇🌹🤦🎉💞✌✨🤷😱😌🌸🙌😋💗💚😏💛🙂💓🤩😄😀🖤😃💯🙈👇🎶😒🤭❣😜💋👀😪😑💥🙋😞😩😡🤪👊🥳😥🤤👉💃😳✋😚😝😴🌟😬🙃🍀🌷😻😓⭐✅🥺🌈😈🤘💦✔😣🏃💐☹🎊💘😠☝😕🌺🎂🌻😐🖕💝🙊😹🗣💫💀👑🎵🤞😛🔴😤🌼😫⚽🤙☕🏆🤫👈😮🙆🍻🍃🐶💁😲🌿🧡🎁⚡🌞🎈❌✊👋😰🤨😶🤝🚶💰🍓💢🤟🙁🚨💨🤬✈🎀🍺🤓😙💟🌱😖👶🥴▶➡❓💎💸⬇😨🌚🦋😷🕺⚠🙅😟😵👎🤲🤠🤧📌🔵💅🧐🐾🍒😗🤑🌊🤯🐷☎💧😯💆👆🎤🙇🍑❄🌴💣🐸💌📍🥀🤢👅💡💩👐📸👻🤐🤮🎼🥵🚩🍎🍊👼💍📣🥂');
-const alphabetBytesToChars = /** @type {string[]} */ (alphabet.reduce((p, c, i) => { p[i] = c; return p }, /** @type {string[]} */([])));
-const alphabetCharsToBytes = /** @type {number[]} */ (alphabet.reduce((p, c, i) => { p[/** @type {number} */ (c.codePointAt(0))] = i; return p }, /** @type {number[]} */([])));
+// @ts-check
 
-/**
- * @param {Uint8Array} data
- * @returns {string}
- */
-function encode (data) {
-  return data.reduce((p, c) => {
-    p += alphabetBytesToChars[c];
-    return p
-  }, '')
-}
 
-/**
- * @param {string} str
- * @returns {Uint8Array}
- */
-function decode (str) {
-  const byts = [];
-  for (const char of str) {
-    const byt = alphabetCharsToBytes[/** @type {number} */ (char.codePointAt(0))];
-    if (byt === undefined) {
-      throw new Error(`Non-base256emoji character: ${char}`)
-    }
-    byts.push(byt);
-  }
-  return new Uint8Array(byts)
-}
+const base8 = rfc4648({
+  prefix: '7',
+  name: 'base8',
+  alphabet: '01234567',
+  bitsPerChar: 3
+});
 
-const base256emoji = from({
-  prefix: '🚀',
-  name: 'base256emoji',
-  encode,
-  decode
+var base8$1 = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  base8: base8
 });
 
-var base256emoji$1 = /*#__PURE__*/Object.freeze({
+// @ts-check
+
+
+const identity = from({
+  prefix: '\x00',
+  name: 'identity',
+  encode: (buf) => toString$1(buf),
+  decode: (str) => fromString$1(str)
+});
+
+var identityBase = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  base256emoji: base256emoji
+  identity: identity
 });
 
 // @ts-check
@@ -906,11 +925,51 @@ var Protocols;
 })(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";
-    SendError["NO_RPC_RESPONSE"] = "No RPC response";
+    /**
+     * 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;
@@ -954,7 +1013,6 @@ function concat(byteArrays, totalLength) {
     return res;
 }
 
-const log = debug("waku:libp2p-utils");
 /**
  * Returns a pseudo-random peer that supports the given protocol.
  * Useful for protocols such as store and light push
@@ -1034,7 +1092,6 @@ async function selectPeerForProtocol(peerStore, protocols, peerId) {
             // Do not break as we want to keep the last value
         }
     }
-    log(`Using codec ${protocol}`);
     if (!protocol) {
         throw new Error(`Peer does not register required protocols (${peer.id.toString()}): ${protocols}`);
     }
@@ -1099,7 +1156,7 @@ class StreamManager {
         this.multicodec = multicodec;
         this.getConnections = getConnections;
         this.addEventListener = addEventListener;
-        this.log = debug(`waku:stream-manager:${multicodec}`);
+        this.log = new Logger(`stream-manager:${multicodec}`);
         this.addEventListener("peer:update", this.handlePeerUpdateStreamPool.bind(this));
         this.getStream = this.getStream.bind(this);
         this.streamPool = new Map();
@@ -1114,7 +1171,7 @@ class StreamManager {
         this.streamPool.delete(peerIdStr);
         this.prepareNewStream(peer);
         const stream = await streamPromise;
-        if (stream.status === "closed") {
+        if (!stream || stream.status === "closed") {
             return this.newStream(peer); // fallback by creating a new stream on the spot
         }
         return stream;
@@ -1128,13 +1185,16 @@ class StreamManager {
         return connection.newStream(this.multicodec);
     }
     prepareNewStream(peer) {
-        const streamPromise = this.newStream(peer);
+        const streamPromise = this.newStream(peer).catch(() => {
+            // No error thrown as this call is not triggered by the user
+            this.log.error(`Failed to prepare a new stream for ${peer.id.toString()}`);
+        });
         this.streamPool.set(peer.id.toString(), streamPromise);
     }
     handlePeerUpdateStreamPool = (evt) => {
         const peer = evt.detail.peer;
         if (peer.protocols.includes(this.multicodec)) {
-            this.log(`Preemptively opening a stream to ${peer.id.toString()}`);
+            this.log.info(`Preemptively opening a stream to ${peer.id.toString()}`);
             this.prepareNewStream(peer);
         }
     };
@@ -1195,4 +1255,4 @@ class BaseProtocol {
     }
 }
 
-export { BaseProtocol as B, EPeersByDiscoveryEvents as E, Protocols as P, SendError as S, Tags as T, allocUnsafe as a, asUint8Array as b, alloc as c, concat as d, StreamManager as e, fromString as f, toString as t, utf8ToBytes as u };
+export { BaseProtocol as B, EPeersByDiscoveryEvents as E, Protocols as P, SendError as S, Tags as T, base58btc as a, base32 as b, coerce as c, allocUnsafe as d, equals as e, asUint8Array as f, bases as g, fromString as h, alloc as i, concat as j, StreamManager as k, toString as t, utf8ToBytes as u };

package/bundle/{browser-bde977a3.js → browser-90197c87.js}

@@ -4,6 +4,31 @@ function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
 }
 
+function getAugmentedNamespace(n) {
+  if (n.__esModule) return n;
+  var f = n.default;
+	if (typeof f == "function") {
+		var a = function a () {
+			if (this instanceof a) {
+        return Reflect.construct(f, arguments, this.constructor);
+			}
+			return f.apply(this, arguments);
+		};
+		a.prototype = f.prototype;
+  } else a = {};
+  Object.defineProperty(a, '__esModule', {value: true});
+	Object.keys(n).forEach(function (k) {
+		var d = Object.getOwnPropertyDescriptor(n, k);
+		Object.defineProperty(a, k, d.get ? d : {
+			enumerable: true,
+			get: function () {
+				return n[k];
+			}
+		});
+	});
+	return a;
+}
+
 var browser = {exports: {}};
 
 /**
@@ -726,4 +751,4 @@ var common = setup;
 var browserExports = browser.exports;
 var debug = /*@__PURE__*/getDefaultExportFromCjs(browserExports);
 
-export { commonjsGlobal as c, debug as d, getDefaultExportFromCjs as g };
+export { getDefaultExportFromCjs as a, commonjsGlobal as c, debug as d, getAugmentedNamespace as g };

package/bundle/index-27b91e3b.js

@@ -0,0 +1,31 @@
+import { d as debug } from './browser-90197c87.js';
+
+const APP_NAME = "waku";
+class Logger {
+    _info;
+    _warn;
+    _error;
+    static createDebugNamespace(level, prefix) {
+        return prefix ? `${APP_NAME}:${level}:${prefix}` : `${APP_NAME}:${level}`;
+    }
+    constructor(prefix) {
+        this._info = debug(Logger.createDebugNamespace("info", prefix));
+        this._warn = debug(Logger.createDebugNamespace("warn", prefix));
+        this._error = debug(Logger.createDebugNamespace("error", prefix));
+    }
+    get info() {
+        return this._info;
+    }
+    get warn() {
+        return this._warn;
+    }
+    get error() {
+        return this._error;
+    }
+    log(level, ...args) {
+        const logger = this[level];
+        logger(...args);
+    }
+}
+
+export { Logger as L };