PoC: onchain rln tree + root #31

rymnc · 2023-11-29T06:48:11Z

Description

This PR includes 2 important changes -

Integrate BinaryIMT (edit LazyIMT) into the Rln contract to allow for trustless root computation for lighter verifiers, reference: Onchain RLN + L2 waku-org/research#56
Moves the codebase over the the vacp2p/foundry-template, since verification of these contracts is failing due to an etherscan bug between etherscan <> hardhat-deploy. Saw this as an opportunity to port the repo.

Apologies for the large PR, but please note that most of the changes are restricted to Rln.sol, and a new function computeRoot. The tests remain the same, with some additional testing for compatibility with zerokit.

alrevuelta

Thanks! Left some comments.

contracts/PoseidonHasher.sol

test/Rln.t.sol

contracts/RlnBase.sol

github-actions · 2023-11-30T17:31:32Z

LCOV of commit `ea4a157` during CI #49

Summary coverage rate:
  lines......: 30.4% (41 of 135 lines)
  functions..: 52.0% (13 of 25 functions)
  branches...: 52.5% (21 of 40 branches)

Files changed coverage rate:
                              |Lines       |Functions  |Branches    
  Filename                    |Rate     Num|Rate    Num|Rate     Num
  ==================================================================
  contracts/PoseidonHasher.sol| 100%      1| 100%     1|    -      0
  contracts/RlnBase.sol       | 100%     37| 100%     8| 100%     18

rymnc · 2023-11-30T18:09:22Z

@alrevuelta as requested,

{
  "RLN": {
    "polygonZkevmTestnet": "https://testnet-zkevm.polygonscan.com/address/0xC568eF58009b8e5B8824d9fbB271141782545538#",
    "sepolia": "https://sepolia.etherscan.io/address/0xbE24C8d709754523D882D4b67C59e983107cf1E8"
  }
}

github-actions · 2023-12-01T07:15:20Z

LCOV of commit `caa3d3b` during CI #51

Summary coverage rate:
  lines......: 29.9% (40 of 134 lines)
  functions..: 50.0% (12 of 24 functions)
  branches...: 52.5% (21 of 40 branches)

Files changed coverage rate:
                           |Lines       |Functions  |Branches    
  Filename                 |Rate     Num|Rate    Num|Rate     Num
  ===============================================================
  contracts/RlnBase.sol    | 100%     37| 100%     8| 100%     18
  test/RLNApp.t.sol        | 100%      2| 100%     2|75.0%      4

github-actions · 2023-12-01T09:59:12Z

LCOV of commit `a3193ce` during CI #52

Summary coverage rate:
  lines......: 33.8% (48 of 142 lines)
  functions..: 52.0% (13 of 25 functions)
  branches...: 52.3% (23 of 44 branches)

Files changed coverage rate:
                           |Lines       |Functions  |Branches    
  Filename                 |Rate     Num|Rate    Num|Rate     Num
  ===============================================================
  contracts/RlnBase.sol    | 100%     45| 100%     9|90.9%     22
  test/RLNApp.t.sol        | 100%      2| 100%     2|75.0%      4

alrevuelta · 2023-12-01T11:27:51Z

test/Rln.t.sol

+
+    function test__root() public {
+        uint256[] memory idCommitments = new uint256[](10);
+        idCommitments[0] = 19143711682366759980911001457853255795836264632723844153354310748778748156460;


no action point here. leaving this for reference, in case we want to generate other testvectors. isn't golang beautiful?

package main import ( "math/big" log "github.com/sirupsen/logrus" "github.com/waku-org/go-zerokit-rln/rln" ) func main() { rlnInstance, err := rln.NewRLN() if err != nil { log.Fatal(err) } leafsTestVector := []*big.Int{ ParseBigInt("19143711682366759980911001457853255795836264632723844153354310748778748156460"), ParseBigInt("16984765328852711772291441487727981184905800779020079168989152080434188364678"), ParseBigInt("10972315136095845343447418815139813428649316683283020632475608655814722712541"), ParseBigInt("2709631781045191277266130708832884002577134582503944059038971337978087532997"), ParseBigInt("8255654132980945447086418574686169461187805238257784695584517016324877809505"), ParseBigInt("20291701150251695209910387548168084091751201746043024067531503187703236470983"), ParseBigInt("11817872986033932471261438074921403500882957864164537515599299873089437746577"), ParseBigInt("18475838919635792169148272767721284591038756730004222133003018558598315558783"), ParseBigInt("10612118277928165031660389522171737855229037400929675201853245490188277695983"), ParseBigInt("17318633845296358766427229711888486415250435256643711009388405482885762601797"), } for _, leaf := range leafsTestVector { rlnInstance.InsertMember(rln.BigIntToBytes32(leaf)) } root, err := rlnInstance.GetMerkleRoot() if err != nil { log.Fatal(err) } log.Info("Merkle root:", rln.Bytes32ToBigInt(root)) // 5210724218081541877101688952118136930297124697603087561558225712176057209122 } func ParseBigInt(s string) *big.Int { x, ok := new(big.Int).SetString(s, 10) if !ok { log.Fatal("could not parse") } return x }

0x-r4bbit

Massive work!
This is still in draft, but I left some comments anyways

0x-r4bbit · 2023-12-05T10:54:54Z

.gas-snapshot

@@ -0,0 +1 @@
+FooTest:test_Example() (gas: 8662)


Probably want to have this regenerated based on the tests of this repository.
Just need to run forge snapshot

addressed in f22afdf

0x-r4bbit · 2023-12-05T10:55:26Z

.github/scripts/rename.sh

+
+# Rename instances of "vacp2p/foundry-template" to the new repo name in README.md for badges only
+sedi "/gha/ s|vacp2p/foundry-template|"${GITHUB_REPOSITORY}"|;" "README.md"
+sedi "/gha-badge/ s|vacp2p/foundry-template|"${GITHUB_REPOSITORY}"|;" "README.md"


This entire file is not needed and is only triggered when forking/creating a repo from our template repo.
So you can remove this.

Addressed in 9f3b5df

0x-r4bbit · 2023-12-05T10:57:34Z

.github/workflows/create.yml

+      - name: "Add commit summary"
+        run: |
+          echo "## Commit result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY


This file is also only needed for forking/creating from the GH template.
No need to keep this here.

Addressed in 9f3b5df

0x-r4bbit · 2023-12-05T10:58:34Z

LICENSE.md

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Not sure if this needs to be changed. Probably fine to just keep it

Addressed in 9f3b5df, we have the licenses as LICENSE-MIT and LICENSE-APACHE

0x-r4bbit · 2023-12-05T10:59:12Z

README.md

+[foundry]: https://getfoundry.sh/
+[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
+[license]: https://opensource.org/licenses/MIT
+[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg


We also have a badge for coverage. If you want to have this added, let me know

not at the moment!

0x-r4bbit · 2023-12-05T11:02:30Z

foundry.toml

+  bytecode_hash = "none"
+  cbor_metadata = false
+  evm_version = "shanghai"


Unless you're sure that these contracts aren't going to be deployed on chains that don't support for example PUSH0, I'd use "paris" for now.

For more info, see https://www.evmdiff.com/diff?base=1&target=10

Addressed in 700d99b

0x-r4bbit · 2023-12-05T11:03:17Z

package.json

+  "version": "1.0.0",
+  "author": {
+    "name": "0x-r4bbit",
+    "url": "https://github.com/vacp2p"


This part probably needs change (name, description, author)

Addressed in a647a84

0x-r4bbit · 2023-12-05T11:05:44Z

script/DeploymentConfig.s.sol

+
+    function getOrCreatePolygonZkevmConfig() public view returns (NetworkConfig memory) {
+        return NetworkConfig({ deployer: deployer });
+    }


Unless there's a plan to actually provide different configurations pre network, we can probably remove these and simplify the constructor. But I'm also fine if we keep it for explicitness

Leaving it in for explicitness if we want to change it!

0x-r4bbit · 2023-12-05T11:07:55Z

script/deploy.sh

+  fi
+
+
+  forge script script/Deploy.s.sol:Deploy --chain $chain_name --rpc-url $rpc_url --private-key "$PRIVATE_KEY" --broadcast -v


FYI: Since we're using Deploy.s.sol here, which is BaseScript, we can probably better use the MNEMONIC environment variable over --private-key.

Otherwise, I believe there's also an interactive mode in forge script using -i which lets you enter the private key. Not sure if this is any better though.

err, i dont use a mnemonic to deploy, and if anyone needs to, they can always go back to deriving a private key for it, not the other way around. seems fine to me for now

alrevuelta

No more input on my side by now. This was enough for a Proof of Concept (see waku-org/research#72) and until we decide if we want to integrate it or not in The Waku Network, we can consider it done.

If at some point we decide to move forward, we will have to do proper/deep reviews.

By now I would leave the PR open for reference, with no intention to merge by now.

Thanks!

alrevuelta · 2024-05-31T08:13:43Z

Can we close this since the LazyIMT was integrated successfully here?
https://github.com/waku-org/waku-rlnv2-contract

rymnc added 3 commits November 29, 2023 12:16

feat: works for 1

8d1480d

feat: integrated binaryIMT

8d771fd

feat: fix deployments

9c9943d

alrevuelta reviewed Nov 30, 2023

View reviewed changes

contracts/PoseidonHasher.sol Outdated Show resolved Hide resolved

test/Rln.t.sol Outdated Show resolved Hide resolved

contracts/RlnBase.sol Outdated Show resolved Hide resolved

contracts/RlnBase.sol Outdated Show resolved Hide resolved

contracts/RlnBase.sol Show resolved Hide resolved

rymnc added 5 commits November 30, 2023 22:52

chore: polygon zkevm testnet deployment

8106f45

fix: address comments

54053b1

fix: redeploy to polygon zkevm testnet

fc406ec

fix: redeploy to sepolia

a403bee

fix: test

ea4a157

rymnc added 2 commits December 1, 2023 12:41

chore: remove PoseidonHasher contract, incl Q in RLN

7cca053

fix: tests

caa3d3b

rymnc added 2 commits December 1, 2023 15:26

chore: added pagination for commitments

9d32b44

chore: add and redeploy

a3193ce

alrevuelta reviewed Dec 1, 2023

View reviewed changes

rymnc added 4 commits December 4, 2023 15:14

chore: move to vacp2p/foundry-template

0d03e85

chore: add deployments

6a894cd

fix: sol versions, solhintignore

bfc3747

chore: add deployments to .prettierignore

647cec6

rymnc force-pushed the compute-root-view-fn branch from bfd57d6 to cc72612 Compare December 5, 2023 09:02

fix: ci, add pnpm to github action

46a7dc5

rymnc force-pushed the compute-root-view-fn branch from cc72612 to 46a7dc5 Compare December 5, 2023 09:03

rymnc added 2 commits December 5, 2023 14:37

incl: certora spec

443cbfc

chore: disable pnpm verify

855b409

rymnc marked this pull request as ready for review December 5, 2023 09:59

rymnc requested a review from alrevuelta December 5, 2023 09:59

rymnc self-assigned this Dec 5, 2023

0x-r4bbit reviewed Dec 5, 2023

View reviewed changes

alrevuelta changed the title ~~computeRoot view function~~ PoC: onchain rln tree + root Dec 5, 2023

alrevuelta mentioned this pull request Dec 5, 2023

PoC Onchain Trees waku-org/waku-rlnv1-contract#10

Closed

rymnc added 4 commits December 6, 2023 16:46

chore: add gas snapshot

f22afdf

chore: remove template files

9f3b5df

chore: back to paris

700d99b

chore: update package.json

a647a84

alrevuelta mentioned this pull request Dec 6, 2023

Onchain RLN tree+root: Proof Of Concept waku-org/research#72

Open

alrevuelta reviewed Dec 6, 2023

View reviewed changes

rymnc mentioned this pull request Jan 11, 2024

chore: move repo to foundry template #33

Closed

feat: integrate LazyIMT with getting the merkle proof from the chain

71f310a

alrevuelta mentioned this pull request Apr 17, 2024

Custom witness with onchain Merkle proof alrevuelta/go-waku-light#2

Merged

chore: cardona deployment

98df444

rymnc closed this May 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PoC: onchain rln tree + root #31

PoC: onchain rln tree + root #31

rymnc commented Nov 29, 2023 •

edited by alrevuelta

alrevuelta left a comment

github-actions bot commented Nov 30, 2023

rymnc commented Nov 30, 2023 •

edited

github-actions bot commented Dec 1, 2023

github-actions bot commented Dec 1, 2023

alrevuelta Dec 1, 2023

0x-r4bbit left a comment

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

0x-r4bbit Dec 5, 2023

rymnc Dec 6, 2023

alrevuelta left a comment

alrevuelta commented May 31, 2024

		fi


		forge script script/Deploy.s.sol:Deploy --chain $chain_name --rpc-url $rpc_url --private-key "$PRIVATE_KEY" --broadcast -v

PoC: onchain rln tree + root #31

PoC: onchain rln tree + root #31

Conversation

rymnc commented Nov 29, 2023 • edited by alrevuelta

Description

alrevuelta left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 30, 2023

LCOV of commit ea4a157 during CI #49

rymnc commented Nov 30, 2023 • edited

github-actions bot commented Dec 1, 2023

LCOV of commit caa3d3b during CI #51

github-actions bot commented Dec 1, 2023

LCOV of commit a3193ce during CI #52

Choose a reason for hiding this comment

0x-r4bbit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alrevuelta left a comment

Choose a reason for hiding this comment

alrevuelta commented May 31, 2024

rymnc commented Nov 29, 2023 •

edited by alrevuelta

LCOV of commit `ea4a157` during CI #49

rymnc commented Nov 30, 2023 •

edited

LCOV of commit `caa3d3b` during CI #51

LCOV of commit `a3193ce` during CI #52