light-poseidon

light-poseidon is a Poseidon hash implementation in Rust created for Light Protocol.

Parameters

The library provides pre-generated parameters over the BN254 curve, however it can work with any parameters provided as long as developers take care of generating the round constants.

Parameters provided by the library are:

• x^5 S-boxes
• width - 2 ≤ t ≤ 13
• inputs - 1 ≤ n ≤ 12
• 8 full rounds and partial rounds depending on t: [56, 57, 56, 60, 60, 63, 64, 63, 60, 66, 60, 65]

The parameters can be generated with:

cargo xtask generate-poseidon-parameters

Output type

Poseidon type implements two traits which serve the purpose of returning the calculated hash in different representations:

• PoseidonBytesHasher with the hash_bytes_be and hash_bytes_le methods which returns a byte array.
• PoseidonHasher with the hash method which returns ark_ff::PrimeField. Might be useful if you want to immediately process the result with an another library which works with ark_ff::PrimeField types.

Examples

Example with two simple big-endian byte inputs (converted to field elements) and BN254-based parameters provided by the library, with PoseidonBytesHasher trait and a byte array result:

use light_poseidon::{Poseidon,PoseidonBytesHasher, parameters::bn254_x5};use ark_bn254::Fr;use ark_ff::{BigInteger,PrimeField};letmut poseidon = Poseidon::<Fr>::new_circom(2).unwrap();let hash = poseidon.hash_bytes_be(&[&[1u8;32],&[2u8;32]]).unwrap();println!("{:?}", hash);// Should print:// [// 13, 84, 225, 147, 143, 138, 140, 28, 125, 235, 94, 3, 85, 242, 99, 25, 32, 123, 132,// 254, 156, 162, 206, 27, 38, 231, 53, 200, 41, 130, 25, 144// ]

With PoseidonHasher trait and ark_ff::PrimeField result:

use light_poseidon::{Poseidon,PoseidonHasher, parameters::bn254_x5};use ark_bn254::Fr;use ark_ff::{BigInteger,PrimeField};letmut poseidon = Poseidon::<Fr>::new_circom(2).unwrap();let input1 = Fr::from_be_bytes_mod_order(&[1u8;32]);let input2 = Fr::from_be_bytes_mod_order(&[2u8;32]);let hash = poseidon.hash(&[input1, input2]).unwrap();// Do something with `hash`.

Implementation

The implementation is compatible with the original SageMath implementation, but it was also inspired by the following ones:

• circomlibjs
• zero-knowledge-gadgets

Performance

This repository contains a benchmark measuring the performance of this Poseidon implementation for given 1 - 12 random 32 bytes inputs.

To run them, simply use:

cargo bench

This is the result from a host with the following hardware:

• AMD Ryzen™ 9 7945HX with Radeon™ Graphics × 32

poseidon_bn254_x5_1 time: [12.710 µs 12.735 µs 12.754 µs]
poseidon_bn254_x5_2 time: [18.948 µs 18.963 µs 18.990 µs]
poseidon_bn254_x5_3 time: [26.607 µs 26.611 µs 26.615 µs]
poseidon_bn254_x5_4 time: [38.507 µs 38.513 µs 38.519 µs]
poseidon_bn254_x5_5 time: [51.024 µs 51.031 µs 51.039 µs]
poseidon_bn254_x5_6 time: [68.368 µs 68.375 µs 68.385 µs]
poseidon_bn254_x5_7 time: [86.819 µs 86.886 µs 86.968 µs]
poseidon_bn254_x5_8 time: [105.38 µs 105.49 µs 105.61 µs]
poseidon_bn254_x5_9 time: [121.99 µs 122.00 µs 122.01 µs]
poseidon_bn254_x5_10 time: [157.00 µs 157.02 µs 157.05 µs]
poseidon_bn254_x5_11 time: [170.01 µs 170.04 µs 170.07 µs]
poseidon_bn254_x5_12 time: [210.78 µs 210.81 µs 210.84 µs]

Security

This library has been audited by Veridise. You can read the audit report here.