@waku/rln 0.0.1 → 0.0.2-c41b319.0

package/bundle/packages/core/dist/lib/filter/filter.js

@@ -0,0 +1,27 @@
+import '../../../../interfaces/dist/protocols.js';
+import '../../../../interfaces/dist/connection_manager.js';
+import '../../../../interfaces/dist/health_indicator.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base10.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base16.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base2.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/identity.js';
+import '../../../../../node_modules/multiformats/dist/src/codecs/json.js';
+import { Logger } from '../../../../utils/dist/logger/index.js';
+import '../../../../../node_modules/it-length-prefixed/dist/src/decode.js';
+import '../../../../proto/dist/generated/message.js';
+import '../../../../proto/dist/generated/filter.js';
+import '../../../../proto/dist/generated/topic_only_message.js';
+import '../../../../proto/dist/generated/filter_v2.js';
+import '../../../../proto/dist/generated/light_push.js';
+import '../../../../proto/dist/generated/store_v3.js';
+import '../../../../proto/dist/generated/peer_exchange.js';
+import '../../../../proto/dist/generated/metadata.js';
+import '../../../../proto/dist/generated/sds_message.js';
+
+new Logger("filter:v2");

package/bundle/packages/core/dist/lib/light_push/light_push.js

@@ -0,0 +1,27 @@
+import '../../../../interfaces/dist/protocols.js';
+import '../../../../interfaces/dist/connection_manager.js';
+import '../../../../interfaces/dist/health_indicator.js';
+import '../../../../proto/dist/generated/message.js';
+import '../../../../proto/dist/generated/filter.js';
+import '../../../../proto/dist/generated/topic_only_message.js';
+import '../../../../proto/dist/generated/filter_v2.js';
+export { PushResponse } from '../../../../proto/dist/generated/light_push.js';
+import '../../../../proto/dist/generated/store_v3.js';
+import '../../../../proto/dist/generated/peer_exchange.js';
+import '../../../../proto/dist/generated/metadata.js';
+import '../../../../proto/dist/generated/sds_message.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base10.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base16.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base2.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/identity.js';
+import '../../../../../node_modules/multiformats/dist/src/codecs/json.js';
+import { Logger } from '../../../../utils/dist/logger/index.js';
+import '../../../../../node_modules/it-length-prefixed/dist/src/decode.js';
+
+new Logger("light-push");

package/bundle/packages/core/dist/lib/message/version_0.js

@@ -0,0 +1,154 @@
+import { WakuMessage } from '../../../../proto/dist/generated/message.js';
+import '../../../../proto/dist/generated/filter.js';
+import '../../../../proto/dist/generated/topic_only_message.js';
+import '../../../../proto/dist/generated/filter_v2.js';
+import '../../../../proto/dist/generated/light_push.js';
+import '../../../../proto/dist/generated/store_v3.js';
+import '../../../../proto/dist/generated/peer_exchange.js';
+import '../../../../proto/dist/generated/metadata.js';
+import '../../../../proto/dist/generated/sds_message.js';
+import { determinePubsubTopic } from '../../../../utils/dist/common/sharding/index.js';
+import { Logger } from '../../../../utils/dist/logger/index.js';
+
+const log = new Logger("message:version-0");
+const OneMillion = BigInt(1_000_000);
+const Version = 0;
+class DecodedMessage {
+    pubsubTopic;
+    proto;
+    constructor(pubsubTopic, proto) {
+        this.pubsubTopic = pubsubTopic;
+        this.proto = proto;
+    }
+    get ephemeral() {
+        return Boolean(this.proto.ephemeral);
+    }
+    get payload() {
+        return this.proto.payload;
+    }
+    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));
+            }
+            return;
+        }
+        catch (e) {
+            return;
+        }
+    }
+    get meta() {
+        return this.proto.meta;
+    }
+    get version() {
+        // https://rfc.vac.dev/spec/14/
+        // > If omitted, the value SHOULD be interpreted as version 0.
+        return this.proto.version ?? 0;
+    }
+    get rateLimitProof() {
+        return this.proto.rateLimitProof;
+    }
+}
+class Encoder {
+    contentTopic;
+    ephemeral;
+    pubsubTopic;
+    metaSetter;
+    constructor(contentTopic, ephemeral = false, pubsubTopic, metaSetter) {
+        this.contentTopic = contentTopic;
+        this.ephemeral = ephemeral;
+        this.pubsubTopic = pubsubTopic;
+        this.metaSetter = metaSetter;
+        if (!contentTopic || contentTopic === "") {
+            throw new Error("Content topic must be specified");
+        }
+    }
+    async toWire(message) {
+        return WakuMessage.encode(await this.toProtoObj(message));
+    }
+    async toProtoObj(message) {
+        const timestamp = message.timestamp ?? new Date();
+        const protoMessage = {
+            payload: message.payload,
+            version: Version,
+            contentTopic: this.contentTopic,
+            timestamp: BigInt(timestamp.valueOf()) * OneMillion,
+            meta: undefined,
+            rateLimitProof: message.rateLimitProof,
+            ephemeral: this.ephemeral
+        };
+        if (this.metaSetter) {
+            const meta = this.metaSetter(protoMessage);
+            return { ...protoMessage, meta };
+        }
+        return protoMessage;
+    }
+}
+/**
+ * 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!ISender.send } to automatically encode outgoing
+ * messages.
+ */
+function createEncoder({ pubsubTopic, pubsubTopicShardInfo, contentTopic, ephemeral, metaSetter }) {
+    return new Encoder(contentTopic, ephemeral, determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo), metaSetter);
+}
+class Decoder {
+    pubsubTopic;
+    contentTopic;
+    constructor(pubsubTopic, contentTopic) {
+        this.pubsubTopic = pubsubTopic;
+        this.contentTopic = contentTopic;
+        if (!contentTopic || contentTopic === "") {
+            throw new Error("Content topic must be specified");
+        }
+    }
+    fromWireToProtoObj(bytes) {
+        const protoMessage = WakuMessage.decode(bytes);
+        return Promise.resolve({
+            payload: protoMessage.payload,
+            contentTopic: protoMessage.contentTopic,
+            version: protoMessage.version ?? undefined,
+            timestamp: protoMessage.timestamp ?? undefined,
+            meta: protoMessage.meta ?? undefined,
+            rateLimitProof: protoMessage.rateLimitProof ?? undefined,
+            ephemeral: protoMessage.ephemeral ?? false
+        });
+    }
+    async fromProtoObj(pubsubTopic, proto) {
+        // https://rfc.vac.dev/spec/14/
+        // > If omitted, the value SHOULD be interpreted as version 0.
+        if (proto.version ?? 0 !== Version) {
+            log.error("Failed to decode due to incorrect version, expected:", Version, ", actual:", proto.version);
+            return Promise.resolve(undefined);
+        }
+        return new DecodedMessage(pubsubTopic, proto);
+    }
+}
+/**
+ * Creates a 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!IReceiver.subscribe } to automatically decode incoming
+ * messages.
+ *
+ * @param contentTopic The resulting decoder will only decode messages with this content topic.
+ */
+function createDecoder(contentTopic, pubsubTopicShardInfo) {
+    return new Decoder(determinePubsubTopic(contentTopic, pubsubTopicShardInfo), contentTopic);
+}
+
+export { DecodedMessage, Decoder, Encoder, Version, createDecoder, createEncoder };

package/bundle/packages/core/dist/lib/metadata/metadata.js

@@ -0,0 +1,27 @@
+import '../../../../interfaces/dist/protocols.js';
+import '../../../../interfaces/dist/connection_manager.js';
+import '../../../../interfaces/dist/health_indicator.js';
+import '../../../../proto/dist/generated/message.js';
+import '../../../../proto/dist/generated/filter.js';
+import '../../../../proto/dist/generated/topic_only_message.js';
+import '../../../../proto/dist/generated/filter_v2.js';
+import '../../../../proto/dist/generated/light_push.js';
+import '../../../../proto/dist/generated/store_v3.js';
+import '../../../../proto/dist/generated/peer_exchange.js';
+import '../../../../proto/dist/generated/metadata.js';
+import '../../../../proto/dist/generated/sds_message.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base10.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base16.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base2.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/identity.js';
+import '../../../../../node_modules/multiformats/dist/src/codecs/json.js';
+import { Logger } from '../../../../utils/dist/logger/index.js';
+import '../../../../../node_modules/it-length-prefixed/dist/src/decode.js';
+
+new Logger("metadata");

package/bundle/packages/core/dist/lib/store/store.js

@@ -0,0 +1,27 @@
+import '../../../../interfaces/dist/protocols.js';
+import '../../../../interfaces/dist/connection_manager.js';
+import '../../../../interfaces/dist/health_indicator.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base10.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base16.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base2.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../../../node_modules/multiformats/dist/src/bases/identity.js';
+import '../../../../../node_modules/multiformats/dist/src/codecs/json.js';
+import { Logger } from '../../../../utils/dist/logger/index.js';
+import '../../../../../node_modules/it-length-prefixed/dist/src/decode.js';
+import '../../../../proto/dist/generated/message.js';
+import '../../../../proto/dist/generated/filter.js';
+import '../../../../proto/dist/generated/topic_only_message.js';
+import '../../../../proto/dist/generated/filter_v2.js';
+import '../../../../proto/dist/generated/light_push.js';
+import '../../../../proto/dist/generated/store_v3.js';
+import '../../../../proto/dist/generated/peer_exchange.js';
+import '../../../../proto/dist/generated/metadata.js';
+import '../../../../proto/dist/generated/sds_message.js';
+
+new Logger("store");

package/bundle/packages/interfaces/dist/connection_manager.js

@@ -0,0 +1,19 @@
+var Tags;
+(function (Tags) {
+    Tags["BOOTSTRAP"] = "bootstrap";
+    Tags["PEER_EXCHANGE"] = "peer-exchange";
+    Tags["LOCAL"] = "local-peer-cache";
+})(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 = {}));
+
+export { EConnectionStateEvents, EPeersByDiscoveryEvents, Tags };

package/bundle/packages/interfaces/dist/constants.js

@@ -0,0 +1,6 @@
+/**
+ * The default cluster ID for The Waku Network
+ */
+const DEFAULT_CLUSTER_ID = 1;
+
+export { DEFAULT_CLUSTER_ID };

package/bundle/packages/interfaces/dist/health_indicator.js

@@ -0,0 +1,12 @@
+var HealthStatusChangeEvents;
+(function (HealthStatusChangeEvents) {
+    HealthStatusChangeEvents["StatusChange"] = "health:change";
+})(HealthStatusChangeEvents || (HealthStatusChangeEvents = {}));
+var HealthStatus;
+(function (HealthStatus) {
+    HealthStatus["Unhealthy"] = "Unhealthy";
+    HealthStatus["MinimallyHealthy"] = "MinimallyHealthy";
+    HealthStatus["SufficientlyHealthy"] = "SufficientlyHealthy";
+})(HealthStatus || (HealthStatus = {}));
+
+export { HealthStatus, HealthStatusChangeEvents };

package/bundle/packages/interfaces/dist/protocols.js

@@ -0,0 +1,97 @@
+var Protocols;
+(function (Protocols) {
+    Protocols["Relay"] = "relay";
+    Protocols["Store"] = "store";
+    Protocols["LightPush"] = "lightpush";
+    Protocols["Filter"] = "filter";
+})(Protocols || (Protocols = {}));
+var ProtocolError;
+(function (ProtocolError) {
+    /** Could not determine the origin of the fault. Best to check connectivity and try again */
+    ProtocolError["GENERIC_FAIL"] = "Generic error";
+    /**
+     * Failure to protobuf encode the message. This is not recoverable and needs
+     * further investigation.
+     */
+    ProtocolError["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.
+     */
+    ProtocolError["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.
+     */
+    ProtocolError["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.
+     */
+    ProtocolError["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.
+     */
+    ProtocolError["TOPIC_NOT_CONFIGURED"] = "Topic not configured";
+    /**
+     * The pubsub topic configured on the decoder does not match the pubsub topic setup on the protocol.
+     * 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
+     * to user or listening for `peer:connected:bootstrap` or `peer:connected:peer-exchange`
+     * on the connection manager before retrying.
+     */
+    ProtocolError["NO_PEER_AVAILABLE"] = "No peer available";
+    /**
+     * Failure to find a stream to the peer. This may be because the connection with the peer is not still alive.
+     * Mitigation can be: retrying after a given time period, or mitigation for `NO_PEER_AVAILABLE` can be used.
+     */
+    ProtocolError["NO_STREAM_AVAILABLE"] = "No stream available";
+    /**
+     * The remote peer did not behave as expected. Mitigation for `NO_PEER_AVAILABLE`
+     * or `DECODE_FAILED` can be used.
+     */
+    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`
+     * or `DECODE_FAILED` can be used.
+     */
+    ProtocolError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
+    /**
+     * The protocol request timed out without a response. This may be due to a connection issue.
+     * 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 = {}));
+
+export { ProtocolError, Protocols };