zec
/
halo2
mirror of https://github.com/zcash/halo2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

poseidon: Rename `SpongeState` to `SpongeRate`

This commit is contained in:
Jack Grigg 2021-11-24 16:48:04 +00:00
parent e4f338e758
commit b827298d42
3 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/circuit/gadget/poseidon.rs
View File

@ -13,7 +13,7 @@ use halo2::{
mod pow5; mod pow5;
pub use pow5::{Pow5Chip, Pow5Config, StateWord}; pub use pow5::{Pow5Chip, Pow5Config, StateWord};
use crate::primitives::poseidon::{ConstantLength, Domain, Spec, Sponge, SpongeState, State}; use crate::primitives::poseidon::{ConstantLength, Domain, Spec, Sponge, SpongeRate, State};
/// The set of circuit instructions required to use the Poseidon permutation. /// The set of circuit instructions required to use the Poseidon permutation.
pub trait PoseidonInstructions<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize>: pub trait PoseidonInstructions<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize>:
@ -53,11 +53,11 @@ pub trait PoseidonDuplexInstructions<
layouter: &mut impl Layouter<F>, layouter: &mut impl Layouter<F>,
domain: &impl Domain<F, T, RATE>, domain: &impl Domain<F, T, RATE>,
initial_state: &State<Self::Word, T>, initial_state: &State<Self::Word, T>,
input: &SpongeState<Self::Word, RATE>, input: &SpongeRate<Self::Word, RATE>,
) -> Result<State<Self::Word, T>, Error>; ) -> Result<State<Self::Word, T>, Error>;
/// Extracts sponge output from the given state. /// Extracts sponge output from the given state.
fn get_output(state: &State<Self::Word, T>) -> SpongeState<Self::Word, RATE>; fn get_output(state: &State<Self::Word, T>) -> SpongeRate<Self::Word, RATE>;
} }
/// A word over which the Poseidon permutation operates. /// A word over which the Poseidon permutation operates.
@ -103,8 +103,8 @@ fn poseidon_duplex<
mut layouter: impl Layouter<F>, mut layouter: impl Layouter<F>,
domain: &D, domain: &D,
state: &mut State<PoseidonChip::Word, T>, state: &mut State<PoseidonChip::Word, T>,
input: &SpongeState<PoseidonChip::Word, RATE>, input: &SpongeRate<PoseidonChip::Word, RATE>,
) -> Result<SpongeState<PoseidonChip::Word, RATE>, Error> { ) -> Result<SpongeRate<PoseidonChip::Word, RATE>, Error> {
*state = chip.pad_and_add(&mut layouter, domain, state, input)?; *state = chip.pad_and_add(&mut layouter, domain, state, input)?;
*state = chip.permute(&mut layouter, state)?; *state = chip.permute(&mut layouter, state)?;
Ok(PoseidonChip::get_output(state)) Ok(PoseidonChip::get_output(state))

6
src/circuit/gadget/poseidon/pow5.rs
View File

@ -10,7 +10,7 @@ use halo2::{
use super::{PoseidonDuplexInstructions, PoseidonInstructions}; use super::{PoseidonDuplexInstructions, PoseidonInstructions};
use crate::circuit::gadget::utilities::Var; use crate::circuit::gadget::utilities::Var;
use crate::primitives::poseidon::{Domain, Mds, Spec, SpongeState, State}; use crate::primitives::poseidon::{Domain, Mds, Spec, SpongeRate, State};
/// Configuration for a [`Pow5Chip`]. /// Configuration for a [`Pow5Chip`].
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
@ -310,7 +310,7 @@ impl<F: FieldExt, S: Spec<F, WIDTH, RATE>, const WIDTH: usize, const RATE: usize
layouter: &mut impl Layouter<F>, layouter: &mut impl Layouter<F>,
domain: &impl Domain<F, WIDTH, RATE>, domain: &impl Domain<F, WIDTH, RATE>,
initial_state: &State<Self::Word, WIDTH>, initial_state: &State<Self::Word, WIDTH>,
input: &SpongeState<Self::Word, RATE>, input: &SpongeRate<Self::Word, RATE>,
) -> Result<State<Self::Word, WIDTH>, Error> { ) -> Result<State<Self::Word, WIDTH>, Error> {
let config = self.config(); let config = self.config();
layouter.assign_region( layouter.assign_region(
@ -386,7 +386,7 @@ impl<F: FieldExt, S: Spec<F, WIDTH, RATE>, const WIDTH: usize, const RATE: usize
) )
} }
fn get_output(state: &State<Self::Word, WIDTH>) -> SpongeState<Self::Word, RATE> { fn get_output(state: &State<Self::Word, WIDTH>) -> SpongeRate<Self::Word, RATE> {
state[..RATE] state[..RATE]
.iter() .iter()
.map(|word| Some(word.clone())) .map(|word| Some(word.clone()))

24
src/primitives/poseidon.rs
View File

@ -25,7 +25,7 @@ use grain::SboxType;
pub(crate) type State<F, const T: usize> = [F; T]; pub(crate) type State<F, const T: usize> = [F; T];
/// The type used to hold duplex sponge state. /// The type used to hold duplex sponge state.
pub(crate) type SpongeState<F, const RATE: usize> = [Option<F>; RATE]; pub(crate) type SpongeRate<F, const RATE: usize> = [Option<F>; RATE];
/// The type used to hold the MDS matrix and its inverse. /// The type used to hold the MDS matrix and its inverse.
pub(crate) type Mds<F, const T: usize> = [[F; T]; T]; pub(crate) type Mds<F, const T: usize> = [[F; T]; T];
@ -126,11 +126,11 @@ pub(crate) fn permute<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RA
fn poseidon_duplex<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize>( fn poseidon_duplex<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize>(
state: &mut State<F, T>, state: &mut State<F, T>,
input: &SpongeState<F, RATE>, input: &SpongeRate<F, RATE>,
pad_and_add: &dyn Fn(&mut State<F, T>, &SpongeState<F, RATE>), pad_and_add: &dyn Fn(&mut State<F, T>, &SpongeRate<F, RATE>),
mds_matrix: &Mds<F, T>, mds_matrix: &Mds<F, T>,
round_constants: &[[F; T]], round_constants: &[[F; T]],
) -> SpongeState<F, RATE> { ) -> SpongeRate<F, RATE> {
pad_and_add(state, input); pad_and_add(state, input);
permute::<F, S, T, RATE>(state, mds_matrix, round_constants); permute::<F, S, T, RATE>(state, mds_matrix, round_constants);
@ -144,8 +144,8 @@ fn poseidon_duplex<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE:
#[derive(Debug)] #[derive(Debug)]
pub(crate) enum Sponge<F, const RATE: usize> { pub(crate) enum Sponge<F, const RATE: usize> {
Absorbing(SpongeState<F, RATE>), Absorbing(SpongeRate<F, RATE>),
Squeezing(SpongeState<F, RATE>), Squeezing(SpongeRate<F, RATE>),
} }
impl<F: fmt::Debug, const RATE: usize> Sponge<F, RATE> { impl<F: fmt::Debug, const RATE: usize> Sponge<F, RATE> {
@ -164,7 +164,7 @@ impl<F: fmt::Debug, const RATE: usize> Sponge<F, RATE> {
pub(crate) struct Duplex<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize> { pub(crate) struct Duplex<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize> {
sponge: Sponge<F, RATE>, sponge: Sponge<F, RATE>,
state: State<F, T>, state: State<F, T>,
pad_and_add: Box<dyn Fn(&mut State<F, T>, &SpongeState<F, RATE>)>, pad_and_add: Box<dyn Fn(&mut State<F, T>, &SpongeRate<F, RATE>)>,
mds_matrix: Mds<F, T>, mds_matrix: Mds<F, T>,
round_constants: Vec<[F; T]>, round_constants: Vec<[F; T]>,
_marker: PhantomData<S>, _marker: PhantomData<S>,
@ -174,7 +174,7 @@ impl<F: FieldExt, S: Spec<F, T, RATE>, const T: usize, const RATE: usize> Duplex
/// Constructs a new duplex sponge for the given Poseidon specification. /// Constructs a new duplex sponge for the given Poseidon specification.
pub(crate) fn new( pub(crate) fn new(
initial_capacity_element: F, initial_capacity_element: F,
pad_and_add: Box<dyn Fn(&mut State<F, T>, &SpongeState<F, RATE>)>, pad_and_add: Box<dyn Fn(&mut State<F, T>, &SpongeRate<F, RATE>)>,
) -> Self { ) -> Self {
let (round_constants, mds_matrix, _) = S::constants(); let (round_constants, mds_matrix, _) = S::constants();
@ -254,11 +254,11 @@ pub trait Domain<F: FieldExt, const T: usize, const RATE: usize>: Copy + fmt::De
fn initial_capacity_element(&self) -> F; fn initial_capacity_element(&self) -> F;
/// The padding that will be added to each state word by [`Domain::pad_and_add`]. /// The padding that will be added to each state word by [`Domain::pad_and_add`].
fn padding(&self) -> SpongeState<F, RATE>; fn padding(&self) -> SpongeRate<F, RATE>;
/// Returns a function that will update the given state with the given input to a /// Returns a function that will update the given state with the given input to a
/// duplex permutation round, applying padding according to this domain specification. /// duplex permutation round, applying padding according to this domain specification.
fn pad_and_add(&self) -> Box<dyn Fn(&mut State<F, T>, &SpongeState<F, RATE>)>; fn pad_and_add(&self) -> Box<dyn Fn(&mut State<F, T>, &SpongeRate<F, RATE>)>;
} }
/// A Poseidon hash function used with constant input length. /// A Poseidon hash function used with constant input length.
@ -276,7 +276,7 @@ impl<F: FieldExt, const T: usize, const RATE: usize, const L: usize> Domain<F, T
F::from_u128((L as u128) << 64) F::from_u128((L as u128) << 64)
} }
fn padding(&self) -> SpongeState<F, RATE> { fn padding(&self) -> SpongeRate<F, RATE> {
// For constant-input-length hashing, padding consists of the field elements being // For constant-input-length hashing, padding consists of the field elements being
// zero. // zero.
let mut padding = [None; RATE]; let mut padding = [None; RATE];
@ -286,7 +286,7 @@ impl<F: FieldExt, const T: usize, const RATE: usize, const L: usize> Domain<F, T
padding padding
} }
fn pad_and_add(&self) -> Box<dyn Fn(&mut State<F, T>, &SpongeState<F, RATE>)> { fn pad_and_add(&self) -> Box<dyn Fn(&mut State<F, T>, &SpongeRate<F, RATE>)> {
Box::new(|state, input| { Box::new(|state, input| {
// `Iterator::zip` short-circuits when one iterator completes, so this will only // `Iterator::zip` short-circuits when one iterator completes, so this will only
// mutate the rate portion of the state. // mutate the rate portion of the state.