1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
use crate::merkle_tree::traits::IsMerkleTreeBackend;

/// Poseidon implementation for curve BLS12381
use self::parameters::Parameters;

use lambdaworks_math::{
    elliptic_curve::short_weierstrass::curves::bls12_381::field_extension::BLS12381PrimeField,
    field::{element::FieldElement, traits::IsField},
};
use std::ops::{Add, Mul};

mod parameters;

pub struct Poseidon<F: IsField> {
    params: Parameters<F>,
}

impl Poseidon<BLS12381PrimeField> {
    pub fn new() -> Self {
        Self {
            params: Parameters::with_t2()
                .expect("Error loading parameters for Posedon BLS12381 hasher"),
        }
    }
}

impl Default for Poseidon<BLS12381PrimeField> {
    fn default() -> Self {
        Self::new()
    }
}

impl IsMerkleTreeBackend for Poseidon<BLS12381PrimeField> {
    type Node = FieldElement<BLS12381PrimeField>;
    type Data = Self::Node;

    fn hash_data(
        &self,
        input: &FieldElement<BLS12381PrimeField>,
    ) -> FieldElement<BLS12381PrimeField> {
        // return first element of the state (unwraps to be removed after trait changes to return Result<>)
        // This clone could be removed
        self.hash(&[input.clone()])
            .unwrap()
            .first()
            .unwrap()
            .clone()
    }

    fn hash_new_parent(
        &self,
        left: &FieldElement<BLS12381PrimeField>,
        right: &FieldElement<BLS12381PrimeField>,
    ) -> FieldElement<BLS12381PrimeField> {
        // return first element of the state (unwraps to be removed after trait changes to return Result<>)
        self.hash(&[left.clone(), right.clone()])
            .unwrap()
            .first()
            .unwrap()
            .clone()
    }
}

impl<F> Poseidon<F>
where
    F: IsField,
{
    pub fn new_with_params(params: Parameters<F>) -> Self {
        Poseidon { params }
    }

    pub fn ark(&self, state: &mut [FieldElement<F>], round_number: usize) {
        let state_size = state.len();
        for (i, state) in state.iter_mut().enumerate() {
            *state += self.params.round_constants[round_number * state_size + i].clone();
        }
    }

    pub fn sbox(&self, state: &mut [FieldElement<F>], round_number: usize) {
        let is_full_round = round_number < self.params.n_full_rounds / 2
            || round_number >= self.params.n_full_rounds / 2 + self.params.n_partial_rounds;

        if is_full_round {
            // full s-box
            for current_state in state.iter_mut() {
                *current_state = current_state.pow(self.params.alpha);
            }
        } else {
            // partial s-box
            let last_state_index = state.len() - 1;
            state[last_state_index] = state[last_state_index].pow(self.params.alpha);
        }
    }

    pub fn mix(&self, state: &mut [FieldElement<F>]) {
        let mut new_state: Vec<FieldElement<F>> = Vec::with_capacity(state.len());
        for i in 0..state.len() {
            new_state.push(FieldElement::zero());
            for (j, current_state) in state.iter().enumerate() {
                let mut mij = self.params.mds_matrix[i][j].clone();
                mij = mij.mul(current_state);
                new_state[i] = new_state[i].clone().add(&mij);
            }
        }
        state.clone_from_slice(&new_state[0..state.len()]);
    }

    fn permute(&self, state: &mut [FieldElement<F>]) {
        for i in 0..(self.params.n_full_rounds + self.params.n_partial_rounds) {
            self.ark(state, i);
            self.sbox(state, i);
            self.mix(state);
        }
    }

    fn ensure_permuted(&self, state: &mut [FieldElement<F>], offset: &mut usize) {
        // offset should be <= rate, so really testing for equality
        if *offset >= self.params.rate {
            self.permute(state);
            *offset = 0;
        }
    }

    pub fn hash(&self, inputs: &[FieldElement<F>]) -> Result<Vec<FieldElement<F>>, String>
    where
        F: IsField,
    {
        let t = self.params.rate + self.params.capacity;
        if inputs.is_empty() || inputs.len() >= self.params.n_partial_rounds - 1 {
            return Err("Wrong input length".to_string());
        }

        let mut state = vec![FieldElement::zero(); t];
        let mut offset: usize = 0;

        let n_remaining = inputs.len() % self.params.rate;
        if n_remaining != 0 {
            return Err(format!(
                "Input length {} must be a multiple of the hash rate {}",
                inputs.len(),
                self.params.rate
            ));
        }

        // absorb
        for input in inputs {
            self.ensure_permuted(&mut state, &mut offset);
            state[offset] += input.clone();
            offset += 1;
        }

        // squeeze
        let mut result = vec![FieldElement::zero(); self.params.rate];
        for result_element in result.iter_mut().take(self.params.rate) {
            self.ensure_permuted(&mut state, &mut offset);
            *result_element = state[offset].clone();
            offset += 1;
        }

        Ok(result)
    }
}

// Test values and parameters are taken from https://github.com/keep-starknet-strange/poseidon-rs/blob/f01ff35ab4dca63a9d6feb7ff3f46c9b04b28b04/src/permutation.rs#L136
// (values are parsed from decimals and have been converted to hex in our mod)
// The field that these tests use is defined below, and parameters are stored under /s128b
#[cfg(test)]
mod tests {
    use lambdaworks_math::{
        field::fields::montgomery_backed_prime_fields::{IsModulus, U384PrimeField},
        unsigned_integer::element::U384,
    };

    use super::*;

    #[derive(Clone, Debug)]
    pub struct TestFieldModulus;
    impl IsModulus<U384> for TestFieldModulus {
        const MODULUS: U384 = U384::from_hex_unchecked(
            "2000000000000080000000000000000000000000000000000000000000000001",
        );
    }

    pub type PoseidonTestField = U384PrimeField<TestFieldModulus>;
    type TestFieldElement = FieldElement<PoseidonTestField>;

    pub fn load_test_parameters() -> Result<Parameters<PoseidonTestField>, String> {
        let round_constants_csv = include_str!("s128b/round_constants.csv");
        let mds_constants_csv = include_str!("s128b/mds_matrix.csv");

        let round_constants = round_constants_csv
            .split(',')
            .map(|c| TestFieldElement::new(U384::from_hex_unchecked(c.trim())))
            .collect();

        let mut mds_matrix = vec![];

        for line in mds_constants_csv.lines() {
            let matrix_line = line
                .split(',')
                .map(|c| TestFieldElement::new(U384::from_hex_unchecked(c.trim())))
                .collect();

            mds_matrix.push(matrix_line);
        }

        Ok(Parameters {
            rate: 2,
            capacity: 1,
            alpha: 3,
            n_full_rounds: 8,
            n_partial_rounds: 83,
            round_constants,
            mds_matrix,
        })
    }

    #[test]
    fn test_poseidon_s128b_t() {
        let mut state = [
            TestFieldElement::new(U384::from_u64(7)),
            TestFieldElement::new(U384::from_u64(98)),
            TestFieldElement::new(U384::from_u64(0)),
        ];
        let poseidon = Poseidon::new_with_params(load_test_parameters().unwrap());

        poseidon.ark(&mut state, 0);
        let expected = [
            TestFieldElement::new(U384::from_hex_unchecked(
                "16861759ea5568dd39dd92f9562a30b9e58e2ad98109ae4780b7fd8eac77fe8a",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "13827681995D5ADFFFC8397A3D00425A3DA43F76ABF28A64E4AB1A22F275092B",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "BA3956D2FAD4469E7F760A2277DC7CB2CAC75DC279B2D687A0DBE17704A8310",
            )),
        ];
        assert_eq!(state, expected);
    }

    #[test]
    fn test_mix() {
        let mut state = [
            TestFieldElement::new(U384::from_hex_unchecked(
                "13f891b043b3b740cc3e1b3051127d335f08e488322f360a776b3810b7dc690a",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "1bd24b7cb99acf0dbea719ff4007bd60105bcefef21ec509d2f8d4f9bb6a3a1a",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "110853eb2ebee0d940454fe420229a2a0974e666d16c92bab9f36cbd1a0eded",
            )),
        ];

        let poseidon = Poseidon::new_with_params(load_test_parameters().unwrap());

        poseidon.mix(&mut state);

        let expected = [
            TestFieldElement::new(U384::from_hex_unchecked(
                "1d30b34b465f8cddc8dc468f137891659c7e32b510cf41cec3aac0b26741681d",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "c445fa4dd2af583994272bede589b06b98fe9cd6d868bf718f6748ba6165620",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "1ed95ae0ea03bb892691f5200fb5902957ac17b3466afa62be808682801f97f9",
            )),
        ];
        assert_eq!(state, expected);
    }

    #[test]
    fn test_hash() {
        let poseidon: Poseidon<BLS12381PrimeField> = Poseidon::new();

        let a = FieldElement::one();
        let b = FieldElement::zero();

        poseidon.hash_new_parent(&a, &b);
    }

    #[test]
    fn test_permutation() {
        let poseidon = Poseidon::new_with_params(load_test_parameters().unwrap());

        let mut state = [
            TestFieldElement::new(U384::from_u64(7)),
            TestFieldElement::new(U384::from_u64(98)),
            TestFieldElement::new(U384::from_u64(0)),
        ];

        poseidon.permute(&mut state);

        let expected = [
            TestFieldElement::new(U384::from_hex_unchecked(
                "18700783647721BB9AD092B176BBEB5348401C21132CCF83C30134DFAB5A2DEB",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "1CC8856652601B3C81139AD5EC13E4A3A8F4A5DB242555521A09E002E7A10B2B",
            )),
            TestFieldElement::new(U384::from_hex_unchecked(
                "3DCB1CEC811FC2D7401CA7B9B084D167F33B6983D4428C8E0534C9C3CECF46D",
            )),
        ];

        assert_eq!(state, expected);
    }
}