RLN Relay

[fryorcraken]

Meta issue: vacp2p/research#129

Breakdown

We want (1) , (2) and (3) for DevCon. Order on the other user stories in loose.

1. As a user, I want to join the group

• Generate RLN credentials
  • Integrate zerokit in js-waku-rln
• Call the contract to join the group
  • Using web wallet

2. As a user, I want to send a message that includes a proof

Would probably use Light Push (but does not really matter)

• Retrieve state of group (must be latest to be secured)
  • Call contract (every time?)
  • Listen to contract events
• Generate the proof using zerokit
• Attach the proof to Waku Message
  • Need to design API/interface so messages are attached every time relay.send or lightpush.push is used.

3. As a end user, I want to use RLN in the web

• Create rln-web-chat (clone web-chat)

4. As a rln-web-chat user, I want to my RLN credentials to be securely saved in the browser storage

• This is a nice feature for web-chat users
• Also an example for developers
• See how eth-pm saves encryption key

5. As a rln-web-chat user, I want to be able to export and import my RLN credentials

Save as a file?
Maybe need to agree on format to be imported on chat2?

6. As a user, I want my node to check proofs on messages

The message could be received via store, filter or relay.

Note: This could be pass as a generalized "validation callback" method to filter and store. Maybe some helper to avoid too much code.

7. As a user, I want Waku Relay to check proofs on messages and drop them if invalid

Useful once Relay scalability #905 is ready.
Preferably use pubsub validator.

8. As a user, I want to be able to slash spammers

Review if slashing makes sense in the browser once #905 is progressed.

Other requirements

• create js-rln repo under waku-org
• Use Apache 2.0 - MIT Licence
• Use similar tech stake than js-waku:
  • language: TypeScript
  • ESM Only package
  • package manager: npm or pnpm
  • Docs: Typedoc
  • TypeScript to JavaScript: tsc or parcel or vite
  • Bundling (to enable direct usage in <script> tag): rollup or vite
  • Format: prettier + eslint
  • Testing:
    • mocha/chai is used for js-waku, ok to consider more modern alternative, consider aegir
    • Browser run: karma, ok to consider better alternative or aegir (js-waku uses webpack for karma, best to try rollup or whichever bundler is used for prod code).
    • NodeJS: 16 or 18 (js-waku uses 16, tests can't run with 18 due to ESM loader changes, fine to use 18 and backport config fix to js-waku)
  • Dependencies: aim to use similar deps to js-waku for similar purposes (ie, noble, etc). Avoid polyfills.

[fryorcraken]

Transferred to waku-org/js-rln#1