zerokit/rln/tests/protocol.rs

#[cfg(test)]
mod test {
    use rln::circuit::{
        circom_from_folder, vk_from_folder, zkey_from_folder, Fr, TEST_RESOURCES_FOLDER,
        TEST_TREE_HEIGHT,
    };
    use rln::poseidon_hash::poseidon_hash;
    use rln::poseidon_tree::PoseidonTree;
    use rln::protocol::*;
    use rln::utils::str_to_fr;

    // Input generated with https://github.com/oskarth/zk-kit/commit/b6a872f7160c7c14e10a0ea40acab99cbb23c9a8
    const WITNESS_JSON_15: &str = r#"
            {
              "identity_secret": "12825549237505733615964533204745049909430608936689388901883576945030025938736",
              "path_elements": [
                "18622655742232062119094611065896226799484910997537830749762961454045300666333",
                "20590447254980891299813706518821659736846425329007960381537122689749540452732",
                "7423237065226347324353380772367382631490014989348495481811164164159255474657",
                "11286972368698509976183087595462810875513684078608517520839298933882497716792",
                "3607627140608796879659380071776844901612302623152076817094415224584923813162",
                "19712377064642672829441595136074946683621277828620209496774504837737984048981",
                "20775607673010627194014556968476266066927294572720319469184847051418138353016",
                "3396914609616007258851405644437304192397291162432396347162513310381425243293",
                "21551820661461729022865262380882070649935529853313286572328683688269863701601",
                "6573136701248752079028194407151022595060682063033565181951145966236778420039",
                "12413880268183407374852357075976609371175688755676981206018884971008854919922",
                "14271763308400718165336499097156975241954733520325982997864342600795471836726",
                "20066985985293572387227381049700832219069292839614107140851619262827735677018",
                "9394776414966240069580838672673694685292165040808226440647796406499139370960",
                "11331146992410411304059858900317123658895005918277453009197229807340014528524"
              ],
              "identity_path_index": [
                1,
                1,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
              ],
              "x": "8143228284048792769012135629627737459844825626241842423967352803501040982",
              "epoch": "0x0000005b612540fc986b42322f8cb91c2273afad58ed006fdba0c97b4b16b12f",
              "rln_identifier": "11412926387081627876309792396682864042420635853496105400039841573530884328439"
            }
        "#;

    // Input generated with protocol::random_rln_witness
    const WITNESS_JSON_19: &str = r#"
            {
              "identity_secret": "922538810348594125658702672067738675294669207539999802857585668079702330450",
              "path_elements": [
                  "16059714054680148404543504061485737353203416489071538960876865983954285286166",
                  "3041470753871943901334053763207316028823782848445723460227667780327106380356",
                  "2557297527793326315072058421057853700096944625924483912548759909801348042183",
                  "6677578602456189582427063963562590713054668181987223110955234085327917303436",
                  "2250827150965576973906150764756422151438812678308727218463995574869267980301",
                  "1895457427602709606993445561553433669787657053834360973759981803464906070980",
                  "11033689991077061346803816826729204895841441316315304395980565540264104346466",
                  "18588752216879570844240300406954267039026327526134910835334500497981810174976",
                  "19346480964028499661277403659363466542857230928032088490855656809181891953123",
                  "21460193770370072688835316363068413651465631481105148051902686770759127189327",
                  "20906347653364838502964722817589315918082261023317339146393355650507243340078",
                  "13466599592974387800162739317046838825289754472645703919149409009404541432954",
                  "9617165663598957201253074168824246164494443748556931540348223968573884172285",
                  "6936463137584425684797785981770877165377386163416057257854261010817156666898",
                  "369902028235468424790098825415813437044876310542601948037281422841675126849",
                  "13510969869821080499683463562609720931680005714401083864659516045615497273644",
                  "2567921390740781421487331055530491683313154421589525170472201828596388395736",
                  "14360870889466292805403568662660511177232987619663547772298178013674025998478",
                  "4735344599616284973799984501493858013178071155960162022656706545116168334293"
              ],
              "identity_path_index": [
                  1,
                  0,
                  1,
                  0,
                  1,
                  1,
                  0,
                  0,
                  1,
                  1,
                  1,
                  0,
                  0,
                  0,
                  1,
                  0,
                  1,
                  1,
                  0
              ],
              "x": "6427050788896290028100534859169645070970780055911091444144195464808120686416",
              "epoch": "0x2bd155d9f85c741044da6909d144f9cc5ce8e0d545a9ed4921b156e8b8569bab",
              "rln_identifier": "2193983000213424579594329476781986065965849144986973472766961413131458022566"
            }
        "#;

    const WITNESS_JSON_20: &str = r#"
            {
              "identity_secret": "13732353453861280511150022598793312186188599006979552959297495195757997428306",
              "path_elements": [
                  "20463525608687844300981085488128968694844212760055234622292326942405619575964",
                  "8040856403709217901175408904825741112286158901303127670929462145501210871313",
                  "3776499751255585163563840252112871568402966629435152937692711318702338789837",
                  "19415813252626942110541463414404411443562242499365750694284604341271149125679",
                  "19414720788761208006634240390286942738242262010168559813148115573784354129237",
                  "17680594732844291740094158892269696200077963275550625226493856898849422516043",
                  "16009199741350632715210088346611798597033333293348807000623441780059543674510",
                  "18743496911007535170857676824393811326863602477260615792503039058813338644738",
                  "1029572792321380246989475723806770724699749375691788486434716005338938722216",
                  "21713138150151063186050010182615713685603650963220209951496401043119768920892",
                  "6713732504049401389983008178456811894856018247924860823028704114266363984580",
                  "2746686888799473963221285145390361693256731812094259845879519459924507786594",
                  "18620748467731297359505500266677881218553438497271819903304075323783392031715",
                  "2446201221122671119406471414204229600430018713181038717206670749886932158104",
                  "12037171942017611311954851302868199608036334625783560875426350283156617524597",
                  "21798743392351780927808323348278035105395367759688979232116905142049921734349",
                  "17450230289417496971557215666910229260621413088991137405744457922069827319039",
                  "20936854099128086256353520300046664152516566958630447858438908748907198510485",
                  "13513344965831154386658059617477268600255664386844920822248038939666265737046",
                  "15546319496880899251450021422131511560001766832580480193115646510655765306630"

              ],
              "identity_path_index": [
                  0,
                  1,
                  0,
                  0,
                  1,
                  1,
                  0,
                  0,
                  1,
                  1,
                  0,
                  0,
                  0,
                  1,
                  0,
                  1,
                  1,
                  0,
                  0,
                  0
              ],
              "x": "18073935665561339809445069958310044423750771681863480888589546877024349720547",
              "epoch": "0x147e4c23a43a1ddca78d94bcd28147f62ca74b3dc7e56bb0a314a954b9f0e567",
              "rln_identifier": "2193983000213424579594329476781986065965849144986973472766961413131458022566"
            }
        "#;

    #[test]
    // We test Merkle tree generation, proofs and verification
    fn test_merkle_proof() {
        let tree_height = TEST_TREE_HEIGHT;
        let leaf_index = 3;

        // generate identity
        let identity_secret_hash = hash_to_field(b"test-merkle-proof");
        let id_commitment = poseidon_hash(&vec![identity_secret_hash]);

        // generate merkle tree
        let default_leaf = Fr::from(0);
        let mut tree = PoseidonTree::new(tree_height, default_leaf);
        tree.set(leaf_index, id_commitment.into()).unwrap();

        // We check correct computation of the root
        let root = tree.root();

        if TEST_TREE_HEIGHT == 15 {
            assert_eq!(
                root,
                str_to_fr(
                    "0x1984f2e01184aef5cb974640898a5f5c25556554e2b06d99d4841badb8b198cd",
                    16
                )
            );
        } else if TEST_TREE_HEIGHT == 19 {
            assert_eq!(
                root,
                str_to_fr(
                    "0x219ceb53f2b1b7a6cf74e80d50d44d68ecb4a53c6cc65b25593c8d56343fb1fe",
                    16
                )
            );
        } else if TEST_TREE_HEIGHT == 20 {
            assert_eq!(
                root,
                str_to_fr(
                    "0x21947ffd0bce0c385f876e7c97d6a42eec5b1fe935aab2f01c1f8a8cbcc356d2",
                    16
                )
            );
        }

        let merkle_proof = tree.proof(leaf_index).expect("proof should exist");
        let path_elements = merkle_proof.get_path_elements();
        let identity_path_index = merkle_proof.get_path_index();

        // We check correct computation of the path and indexes
        // These values refers to TEST_TREE_HEIGHT == 16
        let mut expected_path_elements = vec![
            str_to_fr(
                "0x0000000000000000000000000000000000000000000000000000000000000000",
                16,
            ),
            str_to_fr(
                "0x2098f5fb9e239eab3ceac3f27b81e481dc3124d55ffed523a839ee8446b64864",
                16,
            ),
            str_to_fr(
                "0x1069673dcdb12263df301a6ff584a7ec261a44cb9dc68df067a4774460b1f1e1",
                16,
            ),
            str_to_fr(
                "0x18f43331537ee2af2e3d758d50f72106467c6eea50371dd528d57eb2b856d238",
                16,
            ),
            str_to_fr(
                "0x07f9d837cb17b0d36320ffe93ba52345f1b728571a568265caac97559dbc952a",
                16,
            ),
            str_to_fr(
                "0x2b94cf5e8746b3f5c9631f4c5df32907a699c58c94b2ad4d7b5cec1639183f55",
                16,
            ),
            str_to_fr(
                "0x2dee93c5a666459646ea7d22cca9e1bcfed71e6951b953611d11dda32ea09d78",
                16,
            ),
            str_to_fr(
                "0x078295e5a22b84e982cf601eb639597b8b0515a88cb5ac7fa8a4aabe3c87349d",
                16,
            ),
            str_to_fr(
                "0x2fa5e5f18f6027a6501bec864564472a616b2e274a41211a444cbe3a99f3cc61",
                16,
            ),
            str_to_fr(
                "0x0e884376d0d8fd21ecb780389e941f66e45e7acce3e228ab3e2156a614fcd747",
                16,
            ),
            str_to_fr(
                "0x1b7201da72494f1e28717ad1a52eb469f95892f957713533de6175e5da190af2",
                16,
            ),
            str_to_fr(
                "0x1f8d8822725e36385200c0b201249819a6e6e1e4650808b5bebc6bface7d7636",
                16,
            ),
            str_to_fr(
                "0x2c5d82f66c914bafb9701589ba8cfcfb6162b0a12acf88a8d0879a0471b5f85a",
                16,
            ),
            str_to_fr(
                "0x14c54148a0940bb820957f5adf3fa1134ef5c4aaa113f4646458f270e0bfbfd0",
                16,
            ),
            str_to_fr(
                "0x190d33b12f986f961e10c0ee44d8b9af11be25588cad89d416118e4bf4ebe80c",
                16,
            ),
        ];

        let mut expected_identity_path_index: Vec<u8> =
            vec![1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];

        // We add the remaining elements for the case TEST_TREE_HEIGHT = 20
        if TEST_TREE_HEIGHT == 19 || TEST_TREE_HEIGHT == 20 {
            expected_path_elements.append(&mut vec![
                str_to_fr(
                    "0x22f98aa9ce704152ac17354914ad73ed1167ae6596af510aa5b3649325e06c92",
                    16,
                ),
                str_to_fr(
                    "0x2a7c7c9b6ce5880b9f6f228d72bf6a575a526f29c66ecceef8b753d38bba7323",
                    16,
                ),
                str_to_fr(
                    "0x2e8186e558698ec1c67af9c14d463ffc470043c9c2988b954d75dd643f36b992",
                    16,
                ),
                str_to_fr(
                    "0x0f57c5571e9a4eab49e2c8cf050dae948aef6ead647392273546249d1c1ff10f",
                    16,
                ),
            ]);
            expected_identity_path_index.append(&mut vec![0, 0, 0, 0]);
        }

        if TEST_TREE_HEIGHT == 20 {
            expected_path_elements.append(&mut vec![str_to_fr(
                "0x1830ee67b5fb554ad5f63d4388800e1cfe78e310697d46e43c9ce36134f72cca",
                16,
            )]);
            expected_identity_path_index.append(&mut vec![0]);
        }

        assert_eq!(path_elements, expected_path_elements);
        assert_eq!(identity_path_index, expected_identity_path_index);

        // We check correct verification of the proof
        assert!(tree.verify(&id_commitment, &merkle_proof).unwrap());
    }

    #[test]
    // We test a RLN proof generation and verification
    fn test_witness_from_json() {
        // We generate all relevant keys
        let proving_key = zkey_from_folder(TEST_RESOURCES_FOLDER).unwrap();
        let verification_key = vk_from_folder(TEST_RESOURCES_FOLDER).unwrap();
        let builder = circom_from_folder(TEST_RESOURCES_FOLDER);

        // We compute witness from the json input example
        let mut witness_json: &str = "";

        if TEST_TREE_HEIGHT == 15 {
            witness_json = WITNESS_JSON_15;
        } else if TEST_TREE_HEIGHT == 19 {
            witness_json = WITNESS_JSON_19;
        } else if TEST_TREE_HEIGHT == 20 {
            witness_json = WITNESS_JSON_20;
        }

        let rln_witness = rln_witness_from_json(witness_json);

        // Let's generate a zkSNARK proof
        let proof = generate_proof(builder, &proving_key, &rln_witness).unwrap();

        let proof_values = proof_values_from_witness(&rln_witness);

        // Let's verify the proof
        let verified = verify_proof(&verification_key, &proof, &proof_values);

        assert!(verified.unwrap());
    }

    #[test]
    // We test a RLN proof generation and verification
    fn test_end_to_end() {
        let tree_height = TEST_TREE_HEIGHT;
        let leaf_index = 3;

        // Generate identity pair
        let (identity_secret_hash, id_commitment) = keygen();

        //// generate merkle tree
        let default_leaf = Fr::from(0);
        let mut tree = PoseidonTree::new(tree_height, default_leaf);
        tree.set(leaf_index, id_commitment.into()).unwrap();

        let merkle_proof = tree.proof(leaf_index).expect("proof should exist");

        let signal = b"hey hey";
        let x = hash_to_field(signal);

        // We set the remaining values to random ones
        let epoch = hash_to_field(b"test-epoch");
        //let rln_identifier = hash_to_field(b"test-rln-identifier");

        let rln_witness: RLNWitnessInput = rln_witness_from_values(
            identity_secret_hash,
            &merkle_proof,
            x,
            epoch, /*, rln_identifier*/
        );

        // We generate all relevant keys
        let proving_key = zkey_from_folder(TEST_RESOURCES_FOLDER).unwrap();
        let verification_key = vk_from_folder(TEST_RESOURCES_FOLDER).unwrap();
        let builder = circom_from_folder(TEST_RESOURCES_FOLDER);

        // Let's generate a zkSNARK proof
        let proof = generate_proof(builder, &proving_key, &rln_witness).unwrap();

        let proof_values = proof_values_from_witness(&rln_witness);

        // Let's verify the proof
        let success = verify_proof(&verification_key, &proof, &proof_values).unwrap();

        assert!(success);
    }

    #[test]
    fn test_witness_serialization() {
        // We test witness serialization
        let mut witness_json: &str = "";

        if TEST_TREE_HEIGHT == 15 {
            witness_json = WITNESS_JSON_15;
        } else if TEST_TREE_HEIGHT == 19 {
            witness_json = WITNESS_JSON_19;
        } else if TEST_TREE_HEIGHT == 20 {
            witness_json = WITNESS_JSON_20;
        }

        let rln_witness = rln_witness_from_json(witness_json);

        let ser = serialize_witness(&rln_witness);
        let (deser, _) = deserialize_witness(&ser);
        assert_eq!(rln_witness, deser);

        // We test Proof values serialization
        let proof_values = proof_values_from_witness(&rln_witness);
        let ser = serialize_proof_values(&proof_values);
        let (deser, _) = deserialize_proof_values(&ser);
        assert_eq!(proof_values, deser);
    }

    #[test]
    // Tests seeded keygen
    // Note that hardcoded values are only valid for Bn254
    fn test_seeded_keygen() {
        // Generate identity pair using a seed phrase
        let seed_phrase: &str = "A seed phrase example";
        let (identity_secret_hash, id_commitment) = seeded_keygen(seed_phrase.as_bytes());

        // We check against expected values
        let expected_identity_secret_hash_seed_phrase = str_to_fr(
            "0x20df38f3f00496f19fe7c6535492543b21798ed7cb91aebe4af8012db884eda3",
            16,
        );
        let expected_id_commitment_seed_phrase = str_to_fr(
            "0x1223a78a5d66043a7f9863e14507dc80720a5602b2a894923e5b5147d5a9c325",
            16,
        );

        assert_eq!(
            identity_secret_hash,
            expected_identity_secret_hash_seed_phrase
        );
        assert_eq!(id_commitment, expected_id_commitment_seed_phrase);

        // Generate identity pair using an byte array
        let seed_bytes: &[u8] = &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
        let (identity_secret_hash, id_commitment) = seeded_keygen(seed_bytes);

        // We check against expected values
        let expected_identity_secret_hash_seed_bytes = str_to_fr(
            "0x766ce6c7e7a01bdf5b3f257616f603918c30946fa23480f2859c597817e6716",
            16,
        );
        let expected_id_commitment_seed_bytes = str_to_fr(
            "0xbf16d2b5c0d6f9d9d561e05bfca16a81b4b873bb063508fae360d8c74cef51f",
            16,
        );

        assert_eq!(
            identity_secret_hash,
            expected_identity_secret_hash_seed_bytes
        );
        assert_eq!(id_commitment, expected_id_commitment_seed_bytes);

        // We check again if the identity pair generated with the same seed phrase corresponds to the previously generated one
        let (identity_secret_hash, id_commitment) = seeded_keygen(seed_phrase.as_bytes());

        assert_eq!(
            identity_secret_hash,
            expected_identity_secret_hash_seed_phrase
        );
        assert_eq!(id_commitment, expected_id_commitment_seed_phrase);
    }
}