waku-org / nwaku

Waku node and protocol.
Other
203 stars 54 forks source link

feat: Improve RLN developer experience #2762

Open AlejandroCabeza opened 5 months ago

AlejandroCabeza commented 5 months ago

Problem

Since I began trying to add tests to the RLN part of nwaku I've been having a lot of issues trying to understand the code flow, which ate a lot of time.

Suggested solution

Document via tests, code examples and plain old documentation, the basic/advanced flows of RLN:

Also, some concepts, such as pk and sk, are not directly mapped from RFC into the code. Adding comments telling what those variables correspond to in the RFC would help finding them.

I haven't taken of all the little issues I've had during testing. Should I be listing them somewhere? E.g.: In this document

rymnc commented 5 months ago

agree, the devex with rln can be better. with the rlnv2 fork we will be cutting a lot of code out of scope, and reducing the surface area for testing. I'll set up a milestone for rln documentation