@waku/core 0.0.8 → 0.0.9

package/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [@waku/core@0.0.9] - 2023-01-18
+
+### Changed
+
+- Removed `/vac/waku/relay/2.0.0-beta2` from `WakuRelay` protocols.
+- Moved `@chai` and `@fast-check` to `dependencies` list.
+- Remove peer exchange from protocols to expect in `waitForRemotePeer` by default.
+
+### Fixed
+
+- Documentation links.
+
 ## [@waku/core@0.0.8] - 2022-12-19
 
 ### Fixed
@@ -634,7 +646,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [ReactJS Chat App example](./examples/web-chat).
 - [Typedoc Documentation](https://js-waku.wakuconnect.dev/).
 
-[unreleased]: https://github.com/status-im/js-waku/compare/@waku/core@0.0.8...HEAD
+[unreleased]: https://github.com/status-im/js-waku/compare/@waku/core@0.0.9...HEAD
+[@waku/core@0.0.9]: https://github.com/waku-org/js-waku/compare/@waku/core@0.0.8...@waku/core@0.0.9
 [@waku/core@0.0.8]: https://github.com/waku-org/js-waku/compare/@waku/core@0.0.7...@waku/core@0.0.8
 [@waku/core@0.0.7]: https://github.com/waku-org/js-waku/compare/@waku/core@0.0.6...@waku/core@0.0.7
 [@waku/core@0.0.6]: https://github.com/waku-org/js-waku/compare/@waku/core@0.0.5...@waku/core@0.0.6

package/bundle/index.js

@@ -1,7 +1,7 @@
-import { c as commonjsGlobal, a as aspromise, b as base64$5, e as eventemitter, f as float, i as inquire_1, u as utf8$6, p as pool_1, g as getAugmentedNamespace, d as debug, F as FilterRPC$1, P as PushRPC$1, h as PushResponse, H as HistoryRPC$1, j as PagingInfo, k as HistoryResponse, l as getDefaultExportFromCjs } from './peer_exchange-df95c3a7.js';
-import { createEncoder } from './lib/message/version_0.js';
-export { DecodedMessage, createDecoder, createEncoder } from './lib/message/version_0.js';
-import { TopicOnlyDecoder } from './lib/message/topic_only_message.js';
+import { c as commonjsGlobal, a as aspromise, b as base64$5, e as eventemitter, f as float, i as inquire_1, u as utf8$6, p as pool_1, g as getAugmentedNamespace, d as debug, F as FilterRPC$1, P as PushRPC$1, h as PushResponse, H as HistoryRPC$1, j as PagingInfo, k as HistoryResponse, l as getDefaultExportFromCjs } from './peer_exchange-53df2b11.js';
+import { c as createEncoder, v as version_0 } from './version_0-b1fc527d.js';
+export { D as DecodedMessage, a as createDecoder, c as createEncoder } from './version_0-b1fc527d.js';
+import { t as topic_only_message, T as TopicOnlyDecoder } from './topic_only_message-ece0fef9.js';
 
 /**
  * DefaultPubSubTopic is the default gossipsub topic to use for Waku.
@@ -24116,12 +24116,12 @@ function decodeWaku2(byte) {
 
 const log$8 = debug("waku:enr");
 class ENR extends Map {
-    constructor(kvs = {}, seq = BigInt(1), signature = null) {
+    constructor(kvs = {}, seq = BigInt(1), signature) {
         super(Object.entries(kvs));
         this.seq = seq;
         this.signature = signature;
     }
-    static async create(kvs = {}, seq = BigInt(1), signature = null) {
+    static async create(kvs = {}, seq = BigInt(1), signature) {
         const enr = new ENR(kvs, seq, signature);
         try {
             const publicKey = enr.publicKey;
@@ -24198,7 +24198,7 @@ class ENR extends Map {
         return ENR.decode(fromString$1(encoded.slice(4), "base64url"));
     }
     set(k, v) {
-        this.signature = null;
+        this.signature = undefined;
         this.seq++;
         return super.set(k, v);
     }
@@ -25957,6 +25957,83 @@ function pipe(first, ...rest) {
 const PeerExchangeCodec = "/vac/waku/peer-exchange/2.0.0-alpha1";
 debug("waku:peer-exchange");
 
+var __classPrivateFieldGet = (undefined && undefined.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _EventEmitter_listeners;
+/**
+ * Adds types to the EventTarget class. Hopefully this won't be necessary forever.
+ *
+ * https://github.com/microsoft/TypeScript/issues/28357
+ * https://github.com/microsoft/TypeScript/issues/43477
+ * https://github.com/microsoft/TypeScript/issues/299
+ * etc
+ */
+class EventEmitter extends EventTarget {
+    constructor() {
+        super(...arguments);
+        _EventEmitter_listeners.set(this, new Map());
+    }
+    listenerCount(type) {
+        const listeners = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(type);
+        if (listeners == null) {
+            return 0;
+        }
+        return listeners.length;
+    }
+    addEventListener(type, listener, options) {
+        super.addEventListener(type, listener, options);
+        let list = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(type);
+        if (list == null) {
+            list = [];
+            __classPrivateFieldGet(this, _EventEmitter_listeners, "f").set(type, list);
+        }
+        list.push({
+            callback: listener,
+            once: (options !== true && options !== false && options?.once) ?? false
+        });
+    }
+    removeEventListener(type, listener, options) {
+        super.removeEventListener(type.toString(), listener ?? null, options);
+        let list = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(type);
+        if (list == null) {
+            return;
+        }
+        list = list.filter(({ callback }) => callback !== listener);
+        __classPrivateFieldGet(this, _EventEmitter_listeners, "f").set(type, list);
+    }
+    dispatchEvent(event) {
+        const result = super.dispatchEvent(event);
+        let list = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(event.type);
+        if (list == null) {
+            return result;
+        }
+        list = list.filter(({ once }) => !once);
+        __classPrivateFieldGet(this, _EventEmitter_listeners, "f").set(event.type, list);
+        return result;
+    }
+}
+_EventEmitter_listeners = new WeakMap();
+/**
+ * CustomEvent is a standard event but it's not supported by node.
+ *
+ * Remove this when https://github.com/nodejs/node/issues/40678 is closed.
+ *
+ * Ref: https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
+ */
+class CustomEventPolyfill extends Event {
+    constructor(message, data) {
+        super(message, data);
+        // @ts-expect-error could be undefined
+        this.detail = data?.detail;
+    }
+}
+const CustomEvent = globalThis.CustomEvent ?? CustomEventPolyfill;
+
+debug("waku:peer-exchange-discovery");
+
 function groupByContentTopic(values) {
     const groupedDecoders = new Map();
     values.forEach((value) => {
@@ -26681,7 +26758,7 @@ function wakuFilter(init = {}) {
     return (components) => new Filter(components, init);
 }
 
-var index$3 = /*#__PURE__*/Object.freeze({
+var index$4 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     FilterCodec: FilterCodec,
     wakuFilter: wakuFilter
@@ -26794,7 +26871,7 @@ function wakuLightPush(init = {}) {
     return (components) => new LightPush(components, init);
 }
 
-var index$2 = /*#__PURE__*/Object.freeze({
+var index$3 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     LightPushCodec: LightPushCodec,
     get PushResponse () { return PushResponse; },
@@ -26804,10 +26881,7 @@ var index$2 = /*#__PURE__*/Object.freeze({
 /**
  * RelayCodec is the libp2p identifier for the waku relay protocol
  */
-const RelayCodecs = [
-    "/vac/waku/relay/2.0.0-beta2",
-    "/vac/waku/relay/2.0.0",
-];
+const RelayCodecs = ["/vac/waku/relay/2.0.0"];
 const RelayPingContentTopic = "/relay-ping/1/ping/null";
 
 function number(n) {
@@ -27400,7 +27474,7 @@ function wakuStore(init = {}) {
     return (components) => new Store(components, init);
 }
 
-var index$1 = /*#__PURE__*/Object.freeze({
+var index$2 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     StoreCodec: StoreCodec,
     DefaultPageSize: DefaultPageSize,
@@ -27591,6 +27665,12 @@ var waku = /*#__PURE__*/Object.freeze({
     WakuNode: WakuNode
 });
 
+var index$1 = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    version_0: version_0,
+    topic_only_message: topic_only_message
+});
+
 const codes = {
     ERR_SIGNATURE_NOT_VALID: 'ERR_SIGNATURE_NOT_VALID'
 };
@@ -29697,81 +29777,6 @@ function createTopology(init) {
     return new TopologyImpl(init);
 }
 
-var __classPrivateFieldGet = (undefined && undefined.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _EventEmitter_listeners;
-/**
- * Adds types to the EventTarget class. Hopefully this won't be necessary forever.
- *
- * https://github.com/microsoft/TypeScript/issues/28357
- * https://github.com/microsoft/TypeScript/issues/43477
- * https://github.com/microsoft/TypeScript/issues/299
- * etc
- */
-class EventEmitter extends EventTarget {
-    constructor() {
-        super(...arguments);
-        _EventEmitter_listeners.set(this, new Map());
-    }
-    listenerCount(type) {
-        const listeners = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(type);
-        if (listeners == null) {
-            return 0;
-        }
-        return listeners.length;
-    }
-    addEventListener(type, listener, options) {
-        super.addEventListener(type, listener, options);
-        let list = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(type);
-        if (list == null) {
-            list = [];
-            __classPrivateFieldGet(this, _EventEmitter_listeners, "f").set(type, list);
-        }
-        list.push({
-            callback: listener,
-            once: (options !== true && options !== false && options?.once) ?? false
-        });
-    }
-    removeEventListener(type, listener, options) {
-        super.removeEventListener(type.toString(), listener ?? null, options);
-        let list = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(type);
-        if (list == null) {
-            return;
-        }
-        list = list.filter(({ callback }) => callback !== listener);
-        __classPrivateFieldGet(this, _EventEmitter_listeners, "f").set(type, list);
-    }
-    dispatchEvent(event) {
-        const result = super.dispatchEvent(event);
-        let list = __classPrivateFieldGet(this, _EventEmitter_listeners, "f").get(event.type);
-        if (list == null) {
-            return result;
-        }
-        list = list.filter(({ once }) => !once);
-        __classPrivateFieldGet(this, _EventEmitter_listeners, "f").set(event.type, list);
-        return result;
-    }
-}
-_EventEmitter_listeners = new WeakMap();
-/**
- * CustomEvent is a standard event but it's not supported by node.
- *
- * Remove this when https://github.com/nodejs/node/issues/40678 is closed.
- *
- * Ref: https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
- */
-class CustomEventPolyfill extends Event {
-    constructor(message, data) {
-        super(message, data);
-        // @ts-expect-error could be undefined
-        this.detail = data?.detail;
-    }
-}
-const CustomEvent = globalThis.CustomEvent ?? CustomEventPolyfill;
-
 class MessageCache {
     /**
      * Holds history of messages in timebounded history arrays
@@ -39313,8 +39318,8 @@ const log = debug("waku:wait-for-remote-peer");
 /**
  * Wait for a remote peer to be ready given the passed protocols.
  * Must be used after attempting to connect to nodes, using
- * {@link index.waku.WakuNode.dial} or a bootstrap method with
- * {@link lib/create_waku.createLightNode}.
+ * {@link @waku/core.WakuNode.dial} or a bootstrap method with
+ * {@link @waku/create.createLightNode}.
  *
  * If the passed protocols is a GossipSub protocol, then it resolves only once
  * a peer is in a mesh, to help ensure that other peers will send and receive
@@ -39418,10 +39423,7 @@ function getEnabledProtocols(waku) {
     if (waku.lightPush) {
         protocols.push(Protocols.LightPush);
     }
-    if (waku.peerExchange) {
-        protocols.push(Protocols.PeerExchange);
-    }
     return protocols;
 }
 
-export { DefaultPubSubTopic, DefaultUserAgent, LightPushCodec, PageDirection, StoreCodec, WakuNode, createCursor, waitForRemotePeer, waku, wakuFilter, wakuLightPush, wakuRelay, wakuStore, index$3 as waku_filter, index$2 as waku_light_push, index as waku_relay, index$1 as waku_store };
+export { DefaultPubSubTopic, DefaultUserAgent, LightPushCodec, PageDirection, StoreCodec, WakuNode, createCursor, index$1 as message, waitForRemotePeer, waku, wakuFilter, wakuLightPush, wakuRelay, wakuStore, index$4 as waku_filter, index$3 as waku_light_push, index as waku_relay, index$2 as waku_store };

package/bundle/lib/message/topic_only_message.js

@@ -1,33 +1,2 @@
-import { d as debug, T as TopicOnlyMessage$1 } from '../../peer_exchange-df95c3a7.js';
-
-const log = debug("waku:message:topic-only");
-class TopicOnlyMessage {
-    constructor(proto) {
-        this.proto = proto;
-    }
-    get contentTopic() {
-        return this.proto.contentTopic ?? "";
-    }
-}
-class TopicOnlyDecoder {
-    constructor() {
-        this.contentTopic = "";
-    }
-    fromWireToProtoObj(bytes) {
-        const protoMessage = TopicOnlyMessage$1.decode(bytes);
-        log("Message decoded", protoMessage);
-        return Promise.resolve({
-            contentTopic: protoMessage.contentTopic,
-            payload: undefined,
-            rateLimitProof: undefined,
-            timestamp: undefined,
-            version: undefined,
-            ephemeral: undefined,
-        });
-    }
-    async fromProtoObj(proto) {
-        return new TopicOnlyMessage(proto);
-    }
-}
-
-export { TopicOnlyDecoder, TopicOnlyMessage };
+import '../../peer_exchange-53df2b11.js';
+export { T as TopicOnlyDecoder, a as TopicOnlyMessage } from '../../topic_only_message-ece0fef9.js';

package/bundle/lib/message/version_0.js

@@ -1,133 +1,2 @@
-import { d as debug, W as WakuMessage } from '../../peer_exchange-df95c3a7.js';
-export { m as proto } from '../../peer_exchange-df95c3a7.js';
-
-const log = debug("waku:message:version-0");
-const OneMillion = BigInt(1000000);
-const Version = 0;
-class DecodedMessage {
-    constructor(proto) {
-        this.proto = proto;
-    }
-    get _rawPayload() {
-        if (this.proto.payload) {
-            return new Uint8Array(this.proto.payload);
-        }
-        return;
-    }
-    get ephemeral() {
-        return Boolean(this.proto.ephemeral);
-    }
-    get payload() {
-        return this._rawPayload;
-    }
-    get contentTopic() {
-        return this.proto.contentTopic;
-    }
-    get _rawTimestamp() {
-        return this.proto.timestamp;
-    }
-    get timestamp() {
-        // In the case we receive a value that is bigger than JS's max number,
-        // we catch the error and return undefined.
-        try {
-            if (this.proto.timestamp) {
-                // nanoseconds 10^-9 to milliseconds 10^-3
-                const timestamp = this.proto.timestamp / OneMillion;
-                return new Date(Number(timestamp));
-            }
-            if (this.proto.timestampDeprecated) {
-                return new Date(this.proto.timestampDeprecated * 1000);
-            }
-        }
-        catch (e) {
-            return;
-        }
-        return;
-    }
-    get version() {
-        // https://github.com/status-im/js-waku/issues/921
-        return this.proto.version ?? 0;
-    }
-    get rateLimitProof() {
-        return this.proto.rateLimitProof;
-    }
-}
-class Encoder {
-    constructor(contentTopic, ephemeral = false) {
-        this.contentTopic = contentTopic;
-        this.ephemeral = ephemeral;
-    }
-    async toWire(message$1) {
-        return WakuMessage.encode(await this.toProtoObj(message$1));
-    }
-    async toProtoObj(message) {
-        const timestamp = message.timestamp ?? new Date();
-        return {
-            payload: message.payload,
-            version: Version,
-            contentTopic: this.contentTopic,
-            timestamp: BigInt(timestamp.valueOf()) * OneMillion,
-            rateLimitProof: message.rateLimitProof,
-            ephemeral: this.ephemeral,
-        };
-    }
-}
-/**
- * Creates an encoder that encode messages without Waku level encryption or signature.
- *
- * An encoder is used to encode messages in the [`14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
- * format to be sent over the Waku network. The resulting encoder can then be
- * pass to { @link @waku/interfaces.LightPush.push } or
- * { @link @waku/interfaces.Relay.send } to automatically encode outgoing
- * messages.
- *
- * @param contentTopic The content topic to set on outgoing messages.
- * @param ephemeral An optional flag to mark message as ephemeral, ie, not to be stored by Waku Store nodes.
- */
-function createEncoder(contentTopic, ephemeral = false) {
-    return new Encoder(contentTopic, ephemeral);
-}
-class Decoder {
-    constructor(contentTopic) {
-        this.contentTopic = contentTopic;
-    }
-    fromWireToProtoObj(bytes) {
-        const protoMessage = WakuMessage.decode(bytes);
-        log("Message decoded", protoMessage);
-        return Promise.resolve({
-            payload: protoMessage.payload ?? undefined,
-            contentTopic: protoMessage.contentTopic ?? undefined,
-            version: protoMessage.version ?? undefined,
-            timestamp: protoMessage.timestamp ?? undefined,
-            rateLimitProof: protoMessage.rateLimitProof ?? undefined,
-            ephemeral: protoMessage.ephemeral ?? false,
-        });
-    }
-    async fromProtoObj(proto) {
-        // https://github.com/status-im/js-waku/issues/921
-        if (proto.version === undefined) {
-            proto.version = 0;
-        }
-        if (proto.version !== Version) {
-            log("Failed to decode due to incorrect version, expected:", Version, ", actual:", proto.version);
-            return Promise.resolve(undefined);
-        }
-        return new DecodedMessage(proto);
-    }
-}
-/**
- * Creates an decoder that decode messages without Waku level encryption.
- *
- * A decoder is used to decode messages from the [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
- * format when received from the Waku network. The resulting decoder can then be
- * pass to { @link @waku/interfaces.Filter.subscribe } or
- * { @link @waku/interfaces.Relay.subscribe } to automatically decode incoming
- * messages.
- *
- * @param contentTopic The resulting decoder will only decode messages with this content topic.
- */
-function createDecoder(contentTopic) {
-    return new Decoder(contentTopic);
-}
-
-export { DecodedMessage, Decoder, Encoder, Version, createDecoder, createEncoder };
+export { m as proto } from '../../peer_exchange-53df2b11.js';
+export { D as DecodedMessage, b as Decoder, E as Encoder, V as Version, a as createDecoder, c as createEncoder } from '../../version_0-b1fc527d.js';