feat: poseidon hash

lib/crypto/src/poseidon2/instance/babybear.rs

@@ -1,20 +1,18 @@
-#![allow(missing_docs)]
 use crate::{
     field::instance::FpBabyBear, fp_from_hex, poseidon2::params::PoseidonParams,
 };
 
-type Scalar = FpBabyBear;
-
+/// Poseidon sponge hash parameters for [`FpBabyBear`] field instance.
 pub struct BabyBear24Params;
 
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for BabyBear24Params {
+impl PoseidonParams<FpBabyBear> for BabyBear24Params {
     const T: usize = 24;
     const D: u8 = 7;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 21;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpBabyBear] = &[
         fp_from_hex!("409133f0"),
         fp_from_hex!("1667a8a1"),
         fp_from_hex!("06a6c7b6"),
@@ -40,7 +38,7 @@ impl PoseidonParams<Scalar> for BabyBear24Params {
         fp_from_hex!("00d0ca4c"),
         fp_from_hex!("36c0e388"),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpBabyBear]] = &[
         &[
             fp_from_hex!("0fa20c37"),
             fp_from_hex!("0795bb97"),

lib/crypto/src/poseidon2/instance/bls12.rs

@@ -1,24 +1,22 @@
-#![allow(missing_docs)]
 use crate::{
     field::instance::FpBLS12, fp_from_hex, poseidon2::params::PoseidonParams,
 };
 
-type Scalar = FpBLS12;
-
+/// Poseidon sponge hash parameters for [`FpBLS12`] field instance.
 pub struct BLS2Params;
 
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for BLS2Params {
+impl PoseidonParams<FpBLS12> for BLS2Params {
     const T: usize = 2;
     const D: u8 = 5;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 56;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpBLS12] = &[
         fp_from_hex!("0000000000000000000000000000000000000000000000000000000000000001"),
         fp_from_hex!("0000000000000000000000000000000000000000000000000000000000000002"),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpBLS12]] = &[
         &[
             fp_from_hex!("6267f5556c88257324c1c8b00d5871b2eba13cc39d72aa10dde6b69bc44c41c7"),
             fp_from_hex!("30347723511438a085118166c68bf0c4f4ab5c10a2c55adb5cf87cc9e030f60f"),
@@ -278,20 +276,20 @@
     ];
 }
 
 pub struct BLS3Params;
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for BLS3Params {
+impl PoseidonParams<FpBLS12> for BLS3Params {
     const T: usize = 3;
     const D: u8 = 5;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 56;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpBLS12] = &[
         fp_from_hex!("0000000000000000000000000000000000000000000000000000000000000001"),
         fp_from_hex!("0000000000000000000000000000000000000000000000000000000000000001"),
         fp_from_hex!("0000000000000000000000000000000000000000000000000000000000000002"),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpBLS12]] = &[
         &[
             fp_from_hex!("6f007a551156b3a449e44936b7c093644a0ed33f33eaccc628e942e836c1a875"),
             fp_from_hex!("360d7470611e473d353f628f76d110f34e71162f31003b7057538c2596426303"),
@@ -615,21 +613,21 @@
     ];
 }
 
 pub struct BLS4Params;
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for BLS4Params {
+impl PoseidonParams<FpBLS12> for BLS4Params {
     const T: usize = 4;
     const D: u8 = 5;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 56;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpBLS12] = &[
         fp_from_hex!("07564ad691bf01c8601d68757a561d224f00f313ada673ab83e6255fb4fd5b3d"),
         fp_from_hex!("6184e3be38549f7c0850cd069b32f6decbfde312dd4b8c18349b1b3776a6eaa4"),
         fp_from_hex!("419289088178ad742be6f78425c0156b6546a18fd338f0169937dea46cfb64d2"),
         fp_from_hex!("3244cdec173b71a4659e2529b499362dac10cb2fd17562860c8bb9d0fd45b787"),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpBLS12]] = &[
         &[
             fp_from_hex!("1a3bdcbfc11dabfb6ed0dd5f5a9b38191488bce9eecd811c10f9378b32db8c61"),
             fp_from_hex!("52b733e857912fdd2248dc9638dd79b1ce18b285b27792238b44c2b23c0f5d5f"),

lib/crypto/src/poseidon2/instance/bn256.rs

@@ -1,20 +1,18 @@
-#![allow(missing_docs)]
 use crate::{
     field::instance::FpBN256, fp_from_hex, poseidon2::params::PoseidonParams,
 };
 
-type Scalar = FpBN256;
-
+/// Poseidon sponge hash parameters for [`FpBN256`] field instance.
 pub struct BN256Params;
 
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for BN256Params {
+impl PoseidonParams<FpBN256> for BN256Params {
     const T: usize = 3;
     const D: u8 = 5;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 56;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpBN256] = &[
         fp_from_hex!(
             "0000000000000000000000000000000000000000000000000000000000000001"
         ),
@@ -25,7 +23,7 @@ impl PoseidonParams<Scalar> for BN256Params {
             "0000000000000000000000000000000000000000000000000000000000000002"
         ),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpBN256]] = &[
         &[
             fp_from_hex!("1d066a255517b7fd8bddd3a93f7804ef7f8fcde48bb4c37a59a09a1a97052816"),
             fp_from_hex!("29daefb55f6f2dc6ac3f089cebcc6120b7c6fef31367b68eb7238547d32c1610"),

lib/crypto/src/poseidon2/instance/goldilocks.rs

@@ -1,21 +1,19 @@
-#![allow(missing_docs)]
 use crate::{
     field::instance::FpGoldiLocks, fp_from_hex,
     poseidon2::params::PoseidonParams,
 };
 
-type Scalar = FpGoldiLocks;
-
+/// Poseidon sponge hash parameters for [`FpGoldiLocks`] field instance.
 pub struct Goldilocks12Params;
 
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for Goldilocks12Params {
+impl PoseidonParams<FpGoldiLocks> for Goldilocks12Params {
     const T: usize = 12;
     const D: u8 = 7;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 22;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpGoldiLocks] = &[
         fp_from_hex!("c3b6c08e23ba9300"),
         fp_from_hex!("d84b5de94a324fb6"),
         fp_from_hex!("0d0c371c5b35b84f"),
@@ -29,7 +27,7 @@ impl PoseidonParams<Scalar> for Goldilocks12Params {
         fp_from_hex!("0c6388b51545e883"),
         fp_from_hex!("d27dbb6944917b60"),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpGoldiLocks]] = &[
         &[
             fp_from_hex!("13dcf33aba214f46"),
             fp_from_hex!("30b3b654a1da6d83"),

lib/crypto/src/poseidon2/instance/pallas.rs

@@ -1,20 +1,18 @@
-#![allow(missing_docs)]
 use crate::{
     field::instance::FpPallas, fp_from_hex, poseidon2::params::PoseidonParams,
 };
 
-type Scalar = FpPallas;
-
+/// Poseidon sponge hash parameters for [`FpPallas`] field instance.
 pub struct PallasParams;
 
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for PallasParams {
+impl PoseidonParams<FpPallas> for PallasParams {
     const T: usize = 3;
     const D: u8 = 5;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 56;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpPallas] = &[
         fp_from_hex!(
             "0000000000000000000000000000000000000000000000000000000000000001"
         ),
@@ -25,7 +23,7 @@ impl PoseidonParams<Scalar> for PallasParams {
             "0000000000000000000000000000000000000000000000000000000000000002"
         ),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpPallas]] = &[
         &[
             fp_from_hex!("360d7470611e473d353f628f76d110f34e71162f31003b7057538c2596426303"),
             fp_from_hex!("2bab94d7ae222d135dc3c6c5febfaa314908ac2f12ebe06fbdb74213bf63188b"),

lib/crypto/src/poseidon2/instance/vesta.rs

@@ -1,20 +1,18 @@
-#![allow(missing_docs)]
 use crate::{
     field::instance::FpVesta, fp_from_hex, poseidon2::params::PoseidonParams,
 };
 
-type Scalar = FpVesta;
-
+/// Poseidon sponge hash parameters for [`FpVesta`] field instance.
 pub struct VestaParams;
 
 #[rustfmt::skip]
-impl PoseidonParams<Scalar> for VestaParams {
+impl PoseidonParams<FpVesta> for VestaParams {
     const T: usize = 3;
     const D: u8 = 5;
     const CAPACITY: usize = 1;
     const ROUNDS_F: usize = 8;
     const ROUNDS_P: usize = 56;
-    const MAT_INTERNAL_DIAG_M_1: &'static [Scalar] = &[
+    const MAT_INTERNAL_DIAG_M_1: &'static [FpVesta] = &[
         fp_from_hex!(
             "0000000000000000000000000000000000000000000000000000000000000001"
         ),
@@ -25,7 +23,7 @@ impl PoseidonParams<Scalar> for VestaParams {
             "0000000000000000000000000000000000000000000000000000000000000002"
         ),
     ];
-    const ROUND_CONSTANTS: &'static [&'static [Scalar]] = &[
+    const ROUND_CONSTANTS: &'static [&'static [FpVesta]] = &[
         &[
             fp_from_hex!("360d7470611e473d353f628f76d110f34e71162f31003b7057538c2596426303"),
             fp_from_hex!("2bab94d7ae222d135dc3c6c5febfaa314908ac2f12ebe06fbdb74213bf63188b"),