Propagate new backend changes through poseidon377

.github/workflows/rust.yml

@@ -76,6 +76,23 @@ jobs:
            popd
          done
 
+  build_no_alloc:
+    name: build without alloc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - run: rustup target add thumbv8m.main-none-eabi
+      - uses: Swatinem/rust-cache@v1
+      - uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --package poseidon377 --target thumbv8m.main-none-eabi --no-default-features
+
   # clippy:
   #  name: Clippy
   #  runs-on: ubuntu-latest

Cargo.toml

@@ -2,10 +2,11 @@
 
 members = [
     "poseidon377",
-    "poseidon-paramgen",
+    # "poseidon-paramgen" # Temporarily excluded until refactored
     "poseidon-permutation",
-    "poseidon-consistency",
+    # "poseidon-consistency", # Temporarily excluded until paramgen is refactored
     "poseidon-parameters",
+    "poseidon-tests",
 ]
 
 [profile.release]

README.md

@@ -8,6 +8,7 @@ This repository contains:
 parameters
 * [`poseidon-permutation`](../main/poseidon-permutation): an independent implementation of the Poseidon permutation
 * [`poseidon-consistency`](../main/poseidon-consistency): property-based tests for consistency between Poseidon implementations
+* [`poseidon-tests`](../main/poseidon-tests): test vectors for `poseidon-parameters` and `poseidon377`
 
 ## Audits
 

poseidon-consistency/Cargo.toml

@@ -8,18 +8,18 @@ license = "MIT OR Apache-2.0"
 repository = "https://github.com/penumbra-zone/poseidon377"
 
 [dependencies]
-poseidon-parameters = { path = "../poseidon-parameters" }
-poseidon-paramgen = { path = "../poseidon-paramgen", default-features = false }
+poseidon-parameters = { path = "../poseidon-parameters", default-features = false  }
+#poseidon-paramgen = { path = "../poseidon-paramgen", default-features = false }
 poseidon-permutation = { path="../poseidon-permutation", default-features = false }
-decaf377 = { version = "0.4", default-features = false }
+decaf377 = { version="0.9", default-features = false }
 
 [dev-dependencies]
 criterion = { version = "0.4", features=["html_reports"] }
 ark-ff = "0.4"
 ark-ed-on-bls12-377 = "0.4"
 num-bigint = "0.4"
 proptest = "1"
-rand_core = { version = "0.6.3", features = ["getrandom"] }
+rand_core = { version = "0.6.3", default-features=false }
 rand_chacha = "0.3"
 once_cell = "1.8"
 

poseidon-parameters/CHANGELOG.md

@@ -8,4 +8,8 @@
 
 # 0.4.0
 
-* Add `v1` and `v2` APIs.
+* Add `v1` and `v2` APIs.
+
+# 1.0.0
+
+* Remove Arkworks requirement

poseidon-parameters/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "poseidon-parameters"
-version = "0.4.0"
+version = "1.0.0"
 edition = "2018"
 authors = []
 description = "A crate for Poseidon parameters"
@@ -9,17 +9,13 @@ keywords = ["no_std"]
 repository = "https://github.com/penumbra-zone/poseidon377"
 
 [dependencies]
-anyhow = { version = "1", default-features = false }
-ark-ff = { version = "^0.4.0", default-features = false }
-num-integer = { version = "0.1.45", default-features = false }
-
-[dev-dependencies]
-ark-ed-on-bls12-377 = "0.4"
-proptest = "1"
+decaf377 = { version="0.9", default-features = false }
 
 [features]
+default = ["std"]
+alloc = [
+    "decaf377/alloc"
+]
 std = [
-    "anyhow/std",
-    "ark-ff/std",
-    "num-integer/std",
+    "decaf377/std",
 ]

poseidon-parameters/src/arc_matrix.rs

@@ -1,36 +1,51 @@
-use anyhow::Result;
-use ark_ff::{vec::Vec, PrimeField};
-
-use crate::{matrix::Matrix, matrix_ops::MatrixOperations};
+use crate::{error::PoseidonParameterError, matrix::Matrix, matrix_ops::MatrixOperations};
+use decaf377::Fq;
 
 /// Represents an matrix of round constants.
 ///
 /// Arc stands for `AddRoundConstant` which is the
 /// step in the permutation where this matrix is used.
 #[derive(Clone, Debug, PartialEq, Eq)]
-pub struct ArcMatrix<F: PrimeField>(pub Matrix<F>);
+pub struct ArcMatrix<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize>(
+    pub Matrix<N_ROWS, N_COLS, N_ELEMENTS>,
+);
+
+impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize>
+    ArcMatrix<N_ROWS, N_COLS, N_ELEMENTS>
+{
+    pub fn transpose(&self) -> ArcMatrix<N_COLS, N_ROWS, N_ELEMENTS> {
+        ArcMatrix(self.0.transpose())
+    }
 
-impl<F: PrimeField> MatrixOperations<F> for ArcMatrix<F> {
-    fn new(n_rows: usize, n_cols: usize, elements: Vec<F>) -> Self {
-        Self(Matrix::new(n_rows, n_cols, elements))
+    pub fn inner_elements(&self) -> [Fq; N_ELEMENTS] {
+        self.0.elements
     }
 
-    fn elements(&self) -> &Vec<F> {
+    /// Create a new matrix from a slice of elements.
+    pub const fn new_from_known(elements: [Fq; N_ELEMENTS]) -> Self {
+        Self(Matrix::new_from_known(elements))
+    }
+}
+
+impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> MatrixOperations
+    for ArcMatrix<N_ROWS, N_COLS, N_ELEMENTS>
+{
+    fn new(elements: &[Fq]) -> Self {
+        Self(Matrix::new(elements))
+    }
+
+    fn elements(&self) -> &[Fq] {
         self.0.elements()
     }
 
-    fn get_element(&self, i: usize, j: usize) -> F {
+    fn get_element(&self, i: usize, j: usize) -> Fq {
         self.0.get_element(i, j)
     }
 
-    fn set_element(&mut self, i: usize, j: usize, val: F) {
+    fn set_element(&mut self, i: usize, j: usize, val: Fq) {
         self.0.set_element(i, j, val)
     }
 
-    fn rows(&self) -> Vec<&[F]> {
-        self.0.rows()
-    }
-
     fn n_rows(&self) -> usize {
         self.0.n_rows()
     }
@@ -39,34 +54,14 @@ impl<F: PrimeField> MatrixOperations<F> for ArcMatrix<F> {
         self.0.n_cols()
     }
 
-    fn transpose(&self) -> Self {
-        Self(self.0.transpose())
-    }
-
-    fn hadamard_product(&self, rhs: &Self) -> Result<Self>
+    fn hadamard_product(&self, rhs: &Self) -> Result<Self, PoseidonParameterError>
     where
         Self: Sized,
     {
         Ok(Self(self.0.hadamard_product(&rhs.0)?))
     }
 }
 
-impl<F: PrimeField> From<ArcMatrix<F>> for Vec<Vec<F>> {
-    fn from(arc: ArcMatrix<F>) -> Self {
-        let mut rows = Vec::<Vec<F>>::new();
-        let m = &arc.0;
-
-        for i in 0..arc.n_rows() {
-            let mut row = Vec::new();
-            for j in 0..arc.n_cols() {
-                row.push(m.get_element(i, j));
-            }
-            rows.push(row);
-        }
-        rows
-    }
-}
-
 /// Represents an optimized matrix of round constants.
 ///
 /// This modifies the partial rounds in the middle of the permutation,
@@ -76,30 +71,43 @@ impl<F: PrimeField> From<ArcMatrix<F>> for Vec<Vec<F>> {
 /// This method follows `calc_equivalent_constants` from Appendix B's
 /// `poseidonperm_x3_64_24_optimized.sage`.
 #[derive(Clone, Debug, PartialEq, Eq)]
-pub struct OptimizedArcMatrix<F: PrimeField>(pub ArcMatrix<F>);
+pub struct OptimizedArcMatrix<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize>(
+    pub ArcMatrix<N_ROWS, N_COLS, N_ELEMENTS>,
+);
+
+impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize>
+    OptimizedArcMatrix<N_ROWS, N_COLS, N_ELEMENTS>
+{
+    pub fn transpose(&self) -> OptimizedArcMatrix<N_COLS, N_ROWS, N_ELEMENTS> {
+        OptimizedArcMatrix(self.0.transpose())
+    }
+
+    /// Create a new matrix from a slice of elements.
+    pub const fn new_from_known(elements: [Fq; N_ELEMENTS]) -> Self {
+        Self(ArcMatrix::new_from_known(elements))
+    }
+}
 
-impl<F: PrimeField> MatrixOperations<F> for OptimizedArcMatrix<F> {
+impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> MatrixOperations
+    for OptimizedArcMatrix<N_ROWS, N_COLS, N_ELEMENTS>
+{
     /// Create a `OptimizedArcMatrix` from its elements.
-    fn new(n_rows: usize, n_cols: usize, elements: Vec<F>) -> Self {
-        Self(ArcMatrix::new(n_rows, n_cols, elements))
+    fn new(elements: &[Fq]) -> Self {
+        Self(ArcMatrix::new(elements))
     }
 
-    fn elements(&self) -> &Vec<F> {
+    fn elements(&self) -> &[Fq] {
         self.0.elements()
     }
 
-    fn get_element(&self, i: usize, j: usize) -> F {
+    fn get_element(&self, i: usize, j: usize) -> Fq {
         self.0.get_element(i, j)
     }
 
-    fn set_element(&mut self, i: usize, j: usize, val: F) {
+    fn set_element(&mut self, i: usize, j: usize, val: Fq) {
         self.0.set_element(i, j, val)
     }
 
-    fn rows(&self) -> Vec<&[F]> {
-        self.0.rows()
-    }
-
     fn n_rows(&self) -> usize {
         self.0.n_rows()
     }
@@ -108,11 +116,7 @@ impl<F: PrimeField> MatrixOperations<F> for OptimizedArcMatrix<F> {
         self.0.n_cols()
     }
 
-    fn transpose(&self) -> Self {
-        Self(self.0.transpose())
-    }
-
-    fn hadamard_product(&self, rhs: &Self) -> Result<Self>
+    fn hadamard_product(&self, rhs: &Self) -> Result<Self, PoseidonParameterError>
     where
         Self: Sized,
     {

poseidon-parameters/src/error.rs

@@ -0,0 +1,16 @@
+#[derive(Debug)]
+pub enum PoseidonParameterError {
+    InvalidMatrixDimensions,
+    NoMatrixInverse,
+}
+
+impl core::fmt::Display for PoseidonParameterError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        let msg = match self {
+            Self::InvalidMatrixDimensions => "Invalid matrix dimensions",
+            Self::NoMatrixInverse => "No matrix inverse",
+        };
+
+        msg.fmt(f)
+    }
+}

poseidon-parameters/src/lib.rs

@@ -7,14 +7,12 @@
 
 mod alpha;
 mod arc_matrix;
+mod error;
 mod matrix;
 mod matrix_ops;
 mod mds_matrix;
 mod round_numbers;
 
-#[cfg(test)]
-mod tests;
-
 /// Structures related to Poseidon version 1 parameters.
 pub mod v1;