[Epic: Dogfooding] Deliver RLN v2 + RLN in resource-restricted to The Waku Network

[alrevuelta]

Summary

Based on the work done on previous milestones that included both research and development:

• RLN v2 [Deliverable] RLN v2 #163
• RLN in resource-restricted clients [Deliverable] RLN in resource-restricted clients #159

This new milestone tracks the shipping of the above developed features i) RLNv2 and ii) RLN in resource-restricted clients into The Waku Network. See waku-org/research#96 and waku-org/nwaku#2345.

Note that both features are tracked together since they imply breaking changes in the smart contract.

• RLN v2 introduces userMessageLimit in membership registration.
• RLN in resource-restricted clients introduces a new function merkleProofElements.

Both changes will be introduced together to merge two backward incompatible changes into a single one, which has fewer effects on The Waku Network users.

Epics

• research:
  •  Come up with final gas estimation after the optimizations (RLN v2 + RLN in resource-restricted). Here: [Epic: Dogfooding] Deliver RLN v2 + RLN in resource-restricted to The Waku Network #168 (comment)
  • Implement changes in zerokit RLNv2 (>0.4.0) to support RLNv2 proof generation with custom witness: feat: expose custom witness ffi vacp2p/zerokit#255
  • Integrate RLNv2 into go-zerokit. Go allows to iterate faster and to develop testing tooling: Update to RLN v2 go-zerokit-rln#21
  • Integrate custom witness for RLNv2 in go-zerokit: Custom witness proof with RLN v2 go-zerokit-rln#22
  • Deliver end-to-end PoC working in The Waku Network showcasing the new features. Based on https://github.com/alrevuelta/go-waku-light/ but currently doesn't support RLN v2.
    • PR: Integrate RLN v2 and new contract alrevuelta/go-waku-light#5
• js-waku:
  • Deprioritized by now in favor of feat: RLN-proofs as a lightpush service nwaku#2593
• nwaku:
  • Update contract interface: chore(rlnv2): contract interface changes nwaku#2770
  • Make RLNv2 the default waku RLN, removing feature flag and RLN v1: feat(rlnv2): clean fork of rlnv2 nwaku#2828
  • New smart contract with both RLNv2 and RLN in resource-restricted clients changes: https://github.com/waku-org/waku-rlnv2-contract
  • bug: fix(rln-relay): clear nullifier log only if length is over max epoch gap nwaku#2836
  • bug: fix(rln): nullifierlog vulnerability nwaku#2855
  • chore: chore(rln-relay): add chain-id flag to wakunode and restrict usage if mismatches rpc provider nwaku#2858
  • Decide epoch size (rln-relay-epoch-sec) and user message limit (rln-relay-user-message-limit) for TWN and set them in nwaku chore: add TWN parameters for RLNv2 nwaku#2843
  • Deploy and consider using a L2 testnet. Deployed in PolygonzkEVM testnet: https://cardona-zkevm.polygonscan.com/address/0x4976df0f61135ef3e5720d92eade2e5f47a68ef9
  • Due to some instability with PolygonzkEVM we decided to stick to Sepolia by now. Contract: https://sepolia.etherscan.io/address/0xCB33Aa5B38d79E3D9Fa8B10afF38AA201399a7e3
  • Release v0.30.0 including RLNv2 + onchain trees. https://github.com/waku-org/nwaku/releases/tag/v0.30.0
  • Release v0.30.1 containing some fixes: https://github.com/waku-org/nwaku/releases/tag/v0.30.1
  • Deploy release to fleets, see multiaddress: https://github.com/waku-org/nwaku/pull/2872/files
  • nwaku-compose changes to allow joining TWN with said configuration: Update to v0.30.1 (RLN v2) nwaku-compose#103
  • Deploy new instance of waku simulator to the host: Update wakusim.env for TWN config waku-simulator#84
• go-waku:
• QA:
  • Develop tooling in waku-simulator to allow rlnv2 testing: Upgrade to RLNv2 waku-simulator#45.
  • Documentation to use waku-simulator for testing: https://waku-org.github.io/waku-simulator/
  • Prepare testing plan for release v0.30.0 to test RLNv2 + onchain merkle trees: https://www.notion.so/Waku-RLNv2-End-to-End-Testing-with-Waku-simulator-6f50a5613eb44ae38e2dbbcfa72b7417
  • Execute all tests on nwaku release candidate.
• Docs:
  • Update TWN spec: Add RLNv2 to TheWakuNetwork vacp2p/rfc-index#82
• Eco-Dev:
  • Blog post announcing the new feature: Post RLN-V2 + Stateless Light Clients blog.waku.org#60

[rymnc]

cc: @kaiserd, added vac acz milestone in logos-co/roadmap@986ebd5

[alrevuelta]

Implement changes in zerokit RLNv2 (>0.4.0)

Required changes in zerokit done and merged: vacp2p/zerokit#255

[alrevuelta]

Integrate RLNv2 into go-zerokit

done and merged: waku-org/go-zerokit-rln#21
The main reason for integrating zerokit in go (go-zerokit) is that go allows to iterate faster and develop tooling for testing than in nim.

[alrevuelta]

Integrate custom witness for RLNv2 in go-zerokit

Done in waku-org/go-zerokit-rln#22

[alrevuelta]

Deliver end-to-end PoC working in The Waku Network showcasing the new features.

Done here: alrevuelta/go-waku-light#5

[alrevuelta]

New smart contract with both RLNv2 and RLN in resource-restricted clients changes:

Done by @rymnc here: https://github.com/waku-org/waku-rlnv2-contract

[alrevuelta]

Develop tooling in waku-simulator to allow rlnv2 testing

Done by @stubbsta here: waku-org/waku-simulator#45

[alrevuelta]

Make RLNv2 the default waku RLN, removing feature flag and RLN v1

Done in here by @rymnc waku-org/nwaku#2828

[alrevuelta]

Prepare testing plan for release v0.30.0 to test RLNv2 + onchain merkle trees:

Done by @stubbsta in https://www.notion.so/Waku-RLNv2-End-to-End-Testing-with-Waku-simulator-6f50a5613eb44ae38e2dbbcfa72b7417

[alrevuelta]

Documentation to use waku-simulator for testing

Done: https://waku-org.github.io/waku-simulator/

[alrevuelta]

Deploy and consider using a L2 testnet.

Deployed in PolygonzkEVM testnet: https://cardona-zkevm.polygonscan.com/address/0x4976df0f61135ef3e5720d92eade2e5f47a68ef9 by @rymnc

[alrevuelta]

Decide epoch size (rln-relay-epoch-sec) and user message limit (rln-relay-user-message-limit) for TWN

Done, parameters set for The Waku Network: waku-org/nwaku#2843

[alrevuelta]

bug fixed

waku-org/nwaku#2855

[alrevuelta]

Come up with final gas estimation after the optimizations (RLN v2 + RLN in resource-restricted)

Here we show the results of forge test --gas-report -vv of the register function. It shows the gas consumption of the call for different tree sizes.

With 100k memberships

With 10k memberships

In both cases:

• mean gas: 127k
• median gas: 83k
• some other higher value hits very rarely but stays withing some reasonable limits.

[alrevuelta]

Release v0.30.0 including RLNv2 + onchain trees

Done here https://github.com/waku-org/nwaku/releases/tag/v0.30.0 by @Ivansete-status. Thanks for the help with the release.

[alrevuelta]

nwaku-compose changes to allow joining TWN with said configuration:

Done. Now anyone can join the new version of TheWakuNetwork including rlnv2 and onchain merkle trees
waku-org/nwaku-compose#103 Thanks @Ivansete-status for the support.

[alrevuelta]

Deploy release to fleets

Release 0.30.1 deployed by @Ivansete-status to TWN. See https://github.com/waku-org/nwaku/pull/2872/files for the multiaddresses of the bootstrap nodes.

[alrevuelta]

Due to some instability with PolygonzkEVM we decided to stick to Sepolia by now.
Release v0.30.1 containing some fixes:

• Fixes in v0.30.1: https://github.com/waku-org/nwaku/releases/tag/v0.30.1
• Contract in sepolia: https://sepolia.etherscan.io/address/0xCB33Aa5B38d79E3D9Fa8B10afF38AA201399a7e3

[alrevuelta]

Deploy new instance of waku simulator to the host

Feature deployed to waku-simulator by @stubbsta waku-org/waku-simulator#84. RLNv2 + onchain trees is live in the private testnet of waku-simulator:

• https://explorer.waku.org/dashboard
• https://simulator.waku.org/

[alrevuelta]

The Waku Network spec updated with RLNv2 and new parameters

vacp2p/rfc-index#82

[alrevuelta]

Blog post announcing the new feature

waku-org/blog.waku.org#60
Live at: https://blog.waku.org/rln-v2-stateless-light-clients

[alrevuelta]

RLN-V2+ stateless light clients features are live in The Waku Network. I consider this epic closed. Thanks to anyone involved in making this happen!