[Epic: js-waku] Provision RLN for light push clients PoC

[fryorcraken]

Epic label: E:js-waku User Pays Own RLN Membership

Summary

Enable developers to build application where the users pays for their own credentials.

Acceptance Criteria

• A developer can build a web app for which a user generate credentials and push them to the RLN smart contract.
• The API needs to be simple enough so it is usable in a hackathon and can be documented.
• Import/export to keystore JSON file is supported

Tasks

• feat: better developer experience js-rln#76
• Setup tests with NodeJS js-rln#25

Notes

For the sake of developer experience, the API should be simple and easy to use (e.g. in less than 20 lines). This means that the library may need to be opinionated in the way contract events are handled, what web3 library is used (etherjs), etc.

Consideration needs to be made on how to handle that in the js-waku package ecosystem. For example. should this be part of the @waku/sdk (I would suggest yes).

Notes that waku-org/research#45 is not in the scope of the issue. The intent is to get RLN in the hands of developer, the second priority will be to fix the UX.

[weboko]

Execution plan

Step 1: improve bootstrapping and connection to ethereum

Metamask:

• abstraction to get provider with triggering dialog from Metamask
• ability to pass it from outside

RLN Instance:

• dedicated step for starting: bootstraps RLN Contract
• expose RLN contract from instance

Example showcasing it

PRs: waku-org/js-rln#92, waku-org/examples.waku.org#297

Step 2: improve cred management, verification

Keystore

• easy way to import or hardcode credentials
• easier way to register credential (use case: simple chat app, e.g light-js)
• example showcasing Keystore and cred registration

Verification:

• embed verification into DecodedMessage so that all messages received can be verified;

PR: waku-org/js-rln#93, waku-org/examples.waku.org#299

Step 3: include into @waku/sdk and improve RLN instance interface

RLN Instance:

• make it resembling Waku node: rln contract exposed;
• separation of member management and proof verification;

Files:

• do basic reorganization: e.g rln.ts is too chunky

[weboko]

Leftovers:

• merge examples - feat: add rln-js and rln-identity examples lab.waku.org#13
• better integration with @waku/sdk - will be covered here feat: better developer experience js-rln#76
• improve credentials handling - feat: improve credential management  js-rln#95

[fryorcraken]

This is descoped in favour of deliverable "Provision RLN for light push clients PoC" cc @weboko

[weboko]

Closing as the only leftover is waku-org/js-rln#76 and can be done separately when in priority again.