js-waku-examples/examples/rln-js/README.md

# Using [RLN](https://rfc.vac.dev/spec/32/) in JavaScript

> Rate limiting nullifier (RLN) is a construct based on zero-knowledge proofs
> that provides an anonymous rate-limited signaling/messaging framework
> suitable for decentralized (and centralized) environments

**Demonstrates**:

- RLN:
  - Generate credentials
  - Insert membership to smart contract (Goerli testnet)
  - Retrieve smart contract state
  - Generate and send proofs
  - Verify incoming proofs
  - Keystore
- Next.js framework

# Getting Started

```shell
git clone https://github.com/waku-org/js-waku-examples
cd js-waku-examples/examples/rln-js
npm install
npm run dev
# open  http://127.0.0.1:3000 In your browser
```

**There are a known issue using this webapp with Firefox + MetaMask. Try Chrome or Brave if you encounter any issue**.

The `master` branch's HEAD is deployed at https://examples.waku.org/rln-js/.
doc: update readme 2022-10-28 03:17:15 +00:00			`# Using [RLN](https://rfc.vac.dev/spec/32/) in JavaScript`

			`> Rate limiting nullifier (RLN) is a construct based on zero-knowledge proofs`
			`> that provides an anonymous rate-limited signaling/messaging framework`
			`> suitable for decentralized (and centralized) environments`
feat(rln-js): new pure javascript example for RLN 2022-09-26 00:41:30 +00:00
			`Demonstrates:`

doc: update readme 2022-10-28 03:17:15 +00:00			`- RLN:`
			`- Generate credentials`
			`- Insert membership to smart contract (Goerli testnet)`
			`- Retrieve smart contract state`
			`- Generate and send proofs`
			`- Verify incoming proofs`
feat: re-work rln-js (#281) * use next.js tempalte * use next lint rules * alight UI * fix problem with margins * remove old page, rename to hooks * add constants * create RLN service, add utils * add RLN init * refactor a bit * add init for Keystore * add store functions * add styles * add contract hooks, add store fields, fix multiple downloads issue * add features * add keystore read logic * add import export * combine to useContract * add useWaku stub, add state to Waku block, styles * add creation of a node * add messages functionality * up readme * update CI * update readme * remove and rename, address comments * update readme * move const 2023-11-20 16:00:11 +00:00			`- Keystore`
			`- Next.js framework`
feat(rln-js): new pure javascript example for RLN 2022-09-26 00:41:30 +00:00
feat: re-work rln-js (#281) * use next.js tempalte * use next lint rules * alight UI * fix problem with margins * remove old page, rename to hooks * add constants * create RLN service, add utils * add RLN init * refactor a bit * add init for Keystore * add store functions * add styles * add contract hooks, add store fields, fix multiple downloads issue * add features * add keystore read logic * add import export * combine to useContract * add useWaku stub, add state to Waku block, styles * add creation of a node * add messages functionality * up readme * update CI * update readme * remove and rename, address comments * update readme * move const 2023-11-20 16:00:11 +00:00			`# Getting Started`
feat: instructions to get started with rln 2022-11-18 02:00:18 +00:00
			```shell
			`git clone https://github.com/waku-org/js-waku-examples`
chore: update paths in quick use instructions in README for some of the examples (#244) 2023-06-23 04:35:06 +00:00			`cd js-waku-examples/examples/rln-js`
feat: instructions to get started with rln 2022-11-18 02:00:18 +00:00			`npm install`
feat: re-work rln-js (#281) * use next.js tempalte * use next lint rules * alight UI * fix problem with margins * remove old page, rename to hooks * add constants * create RLN service, add utils * add RLN init * refactor a bit * add init for Keystore * add store functions * add styles * add contract hooks, add store fields, fix multiple downloads issue * add features * add keystore read logic * add import export * combine to useContract * add useWaku stub, add state to Waku block, styles * add creation of a node * add messages functionality * up readme * update CI * update readme * remove and rename, address comments * update readme * move const 2023-11-20 16:00:11 +00:00			`npm run dev`
			`# open http://127.0.0.1:3000 In your browser`
feat: instructions to get started with rln 2022-11-18 02:00:18 +00:00			```

			`There are a known issue using this webapp with Firefox + MetaMask. Try Chrome or Brave if you encounter any issue.`
feat(rln-js): new pure javascript example for RLN 2022-09-26 00:41:30 +00:00
feat: re-work rln-js (#281) * use next.js tempalte * use next lint rules * alight UI * fix problem with margins * remove old page, rename to hooks * add constants * create RLN service, add utils * add RLN init * refactor a bit * add init for Keystore * add store functions * add styles * add contract hooks, add store fields, fix multiple downloads issue * add features * add keystore read logic * add import export * combine to useContract * add useWaku stub, add state to Waku block, styles * add creation of a node * add messages functionality * up readme * update CI * update readme * remove and rename, address comments * update readme * move const 2023-11-20 16:00:11 +00:00			The `master` branch's HEAD is deployed at https://examples.waku.org/rln-js/.