@waku/rln 0.0.2-c86e056.0 → 0.0.2-ebd7523.0

package/bundle/index.js

@@ -1,5 +1,5 @@
 export { RLNDecoder, RLNEncoder } from './packages/rln/dist/codec.js';
-export { RLN_V2_ABI } from './packages/rln/dist/contract/abi/rlnv2.js';
+export { RLN_ABI } from './packages/rln/dist/contract/abi.js';
 export { RLNContract } from './packages/rln/dist/contract/rln_contract.js';
 export { SEPOLIA_CONTRACT } from './packages/rln/dist/contract/constants.js';
 export { createRLN } from './packages/rln/dist/create.js';

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

@@ -7,43 +7,24 @@ var Protocols;
 })(Protocols || (Protocols = {}));
 var ProtocolError;
 (function (ProtocolError) {
-    /** Could not determine the origin of the fault. Best to check connectivity and try again */
+    //
+    // GENERAL ERRORS SECTION
+    //
+    /**
+     * 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.
+     * 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["ENCODE_FAILED"] = "Failed to encode";
+    ProtocolError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
     /**
      * 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
@@ -61,37 +42,51 @@ var ProtocolError;
      * or `DECODE_FAILED` can be used.
      */
     ProtocolError["NO_RESPONSE"] = "No response received";
+    //
+    // SEND ERRORS SECTION
+    //
     /**
-     * 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.
+     * Failure to protobuf encode the message. This is not recoverable and needs
+     * further investigation.
      */
-    ProtocolError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
+    ProtocolError["ENCODE_FAILED"] = "Failed to encode";
     /**
-     * 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
+     * The message payload is empty, making the message invalid. Ensure that a non-empty
+     * payload is set on the outgoing message.
      */
-    ProtocolError["REQUEST_TIMEOUT"] = "Request timeout";
+    ProtocolError["EMPTY_PAYLOAD"] = "Payload is empty";
     /**
-     * Missing credentials info message.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L186
+     * 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["RLN_IDENTITY_MISSING"] = "Identity credentials are not set";
+    ProtocolError["SIZE_TOO_BIG"] = "Size is too big";
     /**
-     * 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
+     * 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["RLN_MEMBERSHIP_INDEX"] = "Membership index is not set";
+    ProtocolError["TOPIC_NOT_CONFIGURED"] = "Topic not configured";
     /**
-     * Message limit is missing.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L190
+     * Fails when
      */
-    ProtocolError["RLN_LIMIT_MISSING"] = "User message limit is not set";
+    ProtocolError["STREAM_ABORTED"] = "Stream aborted";
     /**
      * 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";
+    //
+    // RECEIVE ERRORS SECTION
+    //
+    /**
+     * 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";
 })(ProtocolError || (ProtocolError = {}));
 
 export { ProtocolError, Protocols };