vacp2p
/
zerokit
mirror of https://github.com/vacp2p/zerokit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: docs cleanup (#196)

This commit is contained in:
Aaryamann Challani 2023-08-01 22:33:08 +05:30 committed by GitHub
parent d1414a44c5
commit ecb4d9307f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
rln/src/hashers.rs
View File

@ -1,13 +1,12 @@
// This crate instantiate the Poseidon hash algorithm /// This crate instantiates the Poseidon hash algorithm.
use crate::{circuit::Fr, utils::bytes_le_to_fr}; use crate::{circuit::Fr, utils::bytes_le_to_fr};
use once_cell::sync::Lazy; use once_cell::sync::Lazy;
use tiny_keccak::{Hasher, Keccak}; use tiny_keccak::{Hasher, Keccak};
use utils::poseidon::Poseidon; use utils::poseidon::Poseidon;
// These indexed constants hardcodes the supported round parameters tuples (t, RF, RN, SKIP_MATRICES) for the Bn254 scalar field /// These indexed constants hardcode the supported round parameters tuples (t, RF, RN, SKIP_MATRICES) for the Bn254 scalar field.
// SKIP_MATRICES is the index of the randomly generated secure MDS matrix. See security note in the zerokit_utils::poseidon::poseidon_constants crate on this. /// SKIP_MATRICES is the index of the randomly generated secure MDS matrix.
// TODO: generate these parameters /// TODO: generate these parameters
pub const ROUND_PARAMS: [(usize, usize, usize, usize); 8] = [ pub const ROUND_PARAMS: [(usize, usize, usize, usize); 8] = [
(2, 8, 56, 0), (2, 8, 56, 0),
(3, 8, 57, 0), (3, 8, 57, 0),
@ -19,7 +18,7 @@ pub const ROUND_PARAMS: [(usize, usize, usize, usize); 8] = [
(9, 8, 63, 0), (9, 8, 63, 0),
]; ];
// Poseidon Hash wrapper over above implementation. Adapted from semaphore-rs poseidon hash wrapper. /// Poseidon Hash wrapper over above implementation.
static POSEIDON: Lazy<Poseidon<Fr>> = Lazy::new(|| Poseidon::<Fr>::from(&ROUND_PARAMS)); static POSEIDON: Lazy<Poseidon<Fr>> = Lazy::new(|| Poseidon::<Fr>::from(&ROUND_PARAMS));
pub fn poseidon_hash(input: &[Fr]) -> Fr { pub fn poseidon_hash(input: &[Fr]) -> Fr {
@ -28,11 +27,11 @@ pub fn poseidon_hash(input: &[Fr]) -> Fr {
.expect("hash with fixed input size can't fail") .expect("hash with fixed input size can't fail")
} }
// The zerokit RLN Merkle tree Hasher /// The zerokit RLN Merkle tree Hasher.
#[derive(Clone, Copy, PartialEq, Eq)] #[derive(Clone, Copy, PartialEq, Eq)]
pub struct PoseidonHash; pub struct PoseidonHash;
// The default Hasher trait used by Merkle tree implementation in utils /// The default Hasher trait used by Merkle tree implementation in utils.
impl utils::merkle_tree::Hasher for PoseidonHash { impl utils::merkle_tree::Hasher for PoseidonHash {
type Fr = Fr; type Fr = Fr;
@ -45,10 +44,9 @@ impl utils::merkle_tree::Hasher for PoseidonHash {
} }
} }
// Hashes arbitrary signal to the underlying prime field /// Hashes arbitrary signal to the underlying prime field.
pub fn hash_to_field(signal: &[u8]) -> Fr { pub fn hash_to_field(signal: &[u8]) -> Fr {
// We hash the input signal using Keccak256 // We hash the input signal using Keccak256
// (note that a bigger curve order might require a bigger hash blocksize)
let mut hash = [0; 32]; let mut hash = [0; 32];
let mut hasher = Keccak::v256(); let mut hasher = Keccak::v256();
hasher.update(signal); hasher.update(signal);