@waku/rln 0.1.3-f6d5deb → 0.1.4-d27db21.0

package/README.md

@@ -1,201 +1,25 @@
-# `@waku/rln`
+# @waku/rln
 
-This browser library enables the usage of RLN with Waku, as specified in the [Waku v2 RLN Relay RFC](https://rfc.vac.dev/spec/17/).
+Rate Limiting Nullifier (RLN) implementation for Waku.
 
-## Purpose
+## Description
 
-### RLN Cryptography
+This package provides RLN functionality for the Waku protocol, enabling rate-limiting capabilities while preserving privacy.
 
-The RLN cryptographic function are provided by [zerokit](https://github.com/vacp2p/zerokit/).
-This is imported via the `@waku/zerokit-rln-wasm` dependencies which contains a WASM extract of zerokit's RLN functions.
+## Installation
 
-Note that RLN Credentials generated with `zerokit`, and hence `@waku/rln`, are compatible with semaphore credentials.
-
-Note that the WASM blob uses browser APIs, **NodeJS is not supported**.
-
-### Waku Interfaces
-
-This library implements the [`IEncoder`](https://github.com/waku-org/js-waku/blob/604ba1a889f1994bd27f5749107c3a5b2ef490d5/packages/interfaces/src/message.ts#L43)
-and [`IDecoder`](https://github.com/waku-org/js-waku/blob/604ba1a889f1994bd27f5749107c3a5b2ef490d5/packages/interfaces/src/message.ts#L58)
-interfaces of [js-waku](https://github.com/waku-org/js-waku).
-
-This enables a seamless usage with js-waku applications, as demonstrated in the [rln-js example](https://github.com/waku-org/js-waku-examples/tree/master/examples/rln-js).
-
-### Comparison to Existing Work
-
-[Rate-Limiting-Nullifier/rlnjs](https://github.com/Rate-Limiting-Nullifier/rlnjs)
-is an existing JavaScript / TypeScript library that already provides RLN cryptographic functionalities for the browser.
-
-The core difference is that `@waku/rln` uses [zerokit](https://github.com/vacp2p/zerokit/) for cryptography and provide opinionated interfaces to use RLN specifically in the context of Waku.
-
-## Install
-
-```
+```bash
 npm install @waku/rln
-
-# or with yarn
-
-yarn add @waku/rln
-```
-
-Or to use ESM import directly from a `<script>` tag:
-
-```html
-<script type="module">
-  import * as rln from "https://unpkg.com/@waku/rln@0.0.13/bundle/index.js";
-</script>
-```
-
-## Running example app
-
-```
-git clone https://github.com/waku-org/js-rln
-
-cd js-rln/
-
-npm install
-
-cd example/
-
-npm install  # or yarn
-
-npm start
 ```
 
-Browse http://localhost:8080 and open the dev tools console to see the proof being generated and its verification
-
 ## Usage
 
-### Initializing the Library
-
-```js
-import * as rln from "@waku/rln";
-
-const rlnInstance = await rln.createRLN();
-```
-
-### Starting RLN to listen to a contract
-
-```js
-import * as rln from "@waku/rln";
-
-const rlnInstance = await rln.createRLN();
-await rlnInstance.start(); // will use default Sepolia contract
-```
-
-#### Generating RLN Membership Credentials
-
-```js
-let credentials = rlnInstance.generateIdentityCredentials();
-```
-
-### Generating RLN Membership Keypair Using a Seed
-
-This can be used to generate credentials from a signature hash (e.g. signed by an Ethereum account).
-
-```js
-let credentials = rlnInstance.generateSeededIdentityCredentials(seed);
-```
-
-### Adding Membership Keys Into Merkle Tree
-
-```js
-rlnInstance.insertMember(credentials.IDCommitment);
-```
-
-### Registering Membership on a contract
-
-```js
-import * as rln from "@waku/rln";
-
-const rlnInstance = await rln.createRLN();
-await rlnInstance.start(); // will use default Sepolia contract
-
-const membershipInfo = await rlnInstance.contract.registerWithKey(credentials);
-```
-
-### Generating a Proof
-
-```js
-// prepare the message
-const uint8Msg = Uint8Array.from(
-  "Hello World".split("").map((x) => x.charCodeAt())
-);
-
-// setting up the epoch (With 0s for the test)
-const epoch = new Uint8Array(32);
-
-// generating a proof
-const proof = await rlnInstance.generateProof(
-  uint8Msg,
-  index,
-  epoch,
-  credentials.IDSecretHash
-);
-```
-
-### Verifying a Proof
-
-```js
-try {
-  // verify the proof
-  const verificationResult = rlnInstance.verifyProof(proof, uint8Msg);
-  console.log("Is proof verified?", verificationResult ? "yes" : "no");
-} catch (err) {
-  console.log("Invalid proof");
-}
-```
-
-### Updating Circuit, Verification Key and Zkey
-
-The RLN specs defines the defaults.
-These values are fixed and should not change.
-Currently, these [resources](https://github.com/vacp2p/zerokit/tree/master/rln/resources/tree_height_20) are being used.
-If they change, this file needs to be updated in `resources.ts` which
-contains these values encoded in base64 in this format:
+```typescript
+import { RLN } from '@waku/rln';
 
+// Usage examples coming soon
 ```
-const verification_key = "...";
-const circuit = "..."; // wasm file generated by circom
-const zkey = "...";
-export {verification_key, circuit, zkey};
-```
-
-A tool like GNU's `base64` could be used to encode this data.
-
-### Updating Zerokit
-
-1. Make sure you have NodeJS installed and a C compiler
-2. Install wasm-pack
-
-```
-curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
-```
-
-3. Compile RLN for wasm
-
-```
-git clone https://github.com/vacp2p/zerokit
-cd zerokit/rln-wasm
-wasm-pack build --release
-```
-
-4. Copy `pkg/rln*` into `src/zerokit`
-
-## Bugs, Questions & Features
-
-If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-rln/issues/new/).
-
-For more general discussion, help and latest news, join [Vac Discord](https://discord.gg/PQFdubGt6d) or [Telegram](https://t.me/vacp2p).
 
 ## License
 
-Licensed and distributed under either of
-
-- MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
-
-or
-
-- Apache License, Version 2.0, ([LICENSE-APACHE-v2](LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)
-
-at your option. These files may not be copied, modified, or distributed except according to those terms.
+MIT OR Apache-2.0 

package/bundle/_virtual/__node-resolve_empty.js

@@ -0,0 +1,6 @@
+import * as _nodeResolve_empty from './_node-resolve_empty.js';
+import { getAugmentedNamespace } from './_commonjsHelpers.js';
+
+var require$$0 = /*@__PURE__*/getAugmentedNamespace(_nodeResolve_empty);
+
+export { require$$0 as default };

package/bundle/_virtual/_assert.js

@@ -0,0 +1,3 @@
+var _assert = {};
+
+export { _assert as __exports };

package/bundle/_virtual/_commonjs-dynamic-modules.js

@@ -0,0 +1,5 @@
+function commonjsRequire(path) {
+	throw new Error('Could not dynamically require "' + path + '". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.');
+}
+
+export { commonjsRequire };

package/bundle/_virtual/_commonjsHelpers.js

@@ -0,0 +1,32 @@
+var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
+
+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;
+}
+
+export { commonjsGlobal, getAugmentedNamespace, getDefaultExportFromCjs };

package/bundle/_virtual/_node-resolve_empty.js

@@ -0,0 +1,3 @@
+var _nodeResolve_empty = {};
+
+export { _nodeResolve_empty as default };

package/bundle/_virtual/_sha2.js

@@ -0,0 +1,3 @@
+var _sha2 = {};
+
+export { _sha2 as __exports };

package/bundle/_virtual/_u64.js

@@ -0,0 +1,3 @@
+var _u64 = {};
+
+export { _u64 as __exports };

package/bundle/_virtual/aes.js

@@ -0,0 +1,3 @@
+var aes = {};
+
+export { aes as __exports };

package/bundle/_virtual/bn.js

@@ -0,0 +1,3 @@
+var bn = {exports: {}};
+
+export { bn as __module };

package/bundle/_virtual/browser.js

@@ -0,0 +1,3 @@
+var browser = {exports: {}};
+
+export { browser as __module };

package/bundle/_virtual/checksum.js

@@ -0,0 +1,3 @@
+var checksum = {};
+
+export { checksum as __exports };

package/bundle/_virtual/cipher.js

@@ -0,0 +1,3 @@
+var cipher = {};
+
+export { cipher as __exports };

package/bundle/_virtual/class.js

@@ -0,0 +1,3 @@
+var _class = {};
+
+export { _class as __exports };

package/bundle/_virtual/common.js

@@ -0,0 +1,3 @@
+var common = {};
+
+export { common as __exports };

package/bundle/_virtual/common2.js

@@ -0,0 +1,3 @@
+var common = {};
+
+export { common as __exports };

package/bundle/_virtual/cryptoBrowser.js

@@ -0,0 +1,3 @@
+var cryptoBrowser = {};
+
+export { cryptoBrowser as __exports };

package/bundle/_virtual/functional.js

@@ -0,0 +1,3 @@
+var functional = {};
+
+export { functional as __exports };

package/bundle/_virtual/hash.js

@@ -0,0 +1,3 @@
+var hash = {};
+
+export { hash as __exports };

package/bundle/_virtual/hmac.js

@@ -0,0 +1,3 @@
+var hmac = {};
+
+export { hmac as __exports };

package/bundle/_virtual/index.js

@@ -0,0 +1,3 @@
+var lib = {};
+
+export { lib as __exports };

package/bundle/_virtual/index2.js

@@ -0,0 +1,6 @@
+import { getAugmentedNamespace } from './_commonjsHelpers.js';
+import * as index from '../packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/index.js';
+
+var require$$0 = /*@__PURE__*/getAugmentedNamespace(index);
+
+export { require$$0 as default };

package/bundle/_virtual/inherits_browser.js

@@ -0,0 +1,3 @@
+var inherits_browser = {exports: {}};
+
+export { inherits_browser as __module };

package/bundle/_virtual/kdf.js

@@ -0,0 +1,3 @@
+var kdf = {};
+
+export { kdf as __exports };

package/bundle/_virtual/lodash.js

@@ -0,0 +1,3 @@
+var lodash = {exports: {}};
+
+export { lodash as __module };

package/bundle/_virtual/password.js

@@ -0,0 +1,3 @@
+var password = {};
+
+export { password as __exports };

package/bundle/_virtual/pbkdf2.js

@@ -0,0 +1,3 @@
+var pbkdf2 = {};
+
+export { pbkdf2 as __exports };

package/bundle/_virtual/pbkdf22.js

@@ -0,0 +1,3 @@
+var pbkdf2 = {};
+
+export { pbkdf2 as __exports };

package/bundle/_virtual/random.js

@@ -0,0 +1,3 @@
+var random = {};
+
+export { random as __exports };

package/bundle/_virtual/ripemd.js

@@ -0,0 +1,3 @@
+var ripemd = {};
+
+export { ripemd as __exports };

package/bundle/_virtual/schema-validation-generated.js

@@ -0,0 +1,3 @@
+var schemaValidationGenerated = {};
+
+export { schemaValidationGenerated as __exports };

package/bundle/_virtual/schema-validation.js

@@ -0,0 +1,3 @@
+var schemaValidation = {};
+
+export { schemaValidation as __exports };

package/bundle/_virtual/scrypt.js

@@ -0,0 +1,3 @@
+var scrypt = {};
+
+export { scrypt as __exports };

package/bundle/_virtual/scrypt2.js

@@ -0,0 +1,3 @@
+var scrypt = {};
+
+export { scrypt as __exports };

package/bundle/_virtual/sha.js

@@ -0,0 +1,3 @@
+var sha = {};
+
+export { sha as __exports };

package/bundle/_virtual/sha256.js

@@ -0,0 +1,3 @@
+var sha256 = {};
+
+export { sha256 as __exports };

package/bundle/_virtual/sha2562.js

@@ -0,0 +1,3 @@
+var sha256 = {};
+
+export { sha256 as __exports };

package/bundle/_virtual/sha3.js

@@ -0,0 +1,3 @@
+var sha3 = {exports: {}};
+
+export { sha3 as __module };

package/bundle/_virtual/sha512.js

@@ -0,0 +1,3 @@
+var sha512 = {};
+
+export { sha512 as __exports };

package/bundle/_virtual/types.js

@@ -0,0 +1,3 @@
+var types = {};
+
+export { types as __exports };

package/bundle/_virtual/utils.js

@@ -0,0 +1,3 @@
+var utils = {};
+
+export { utils as __exports };

package/bundle/_virtual/utils2.js

@@ -0,0 +1,3 @@
+var utils = {exports: {}};
+
+export { utils as __module };

package/bundle/_virtual/utils3.js

@@ -0,0 +1,3 @@
+var utils = {};
+
+export { utils as __exports };