light-hasher 6.0.0

Trait for generic usage of hash functions on Solana
Documentation 
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

//! # light-hasher
//!
//! Trait for generic hash function usage on Solana.
//!
//! | Type | Description |
//! |------|-------------|
//! | [`Hasher`] | Trait with `hash`, `hashv`, and `zero_bytes` |
//! | [`Poseidon`] | Poseidon hash over BN254 |
//! | [`Keccak`] | Keccak-256 hash |
//! | [`Sha256`] | SHA-256 hash |
//! | [`DataHasher`] | Trait to hash structured data |
//! | [`HasherError`] | Error type for hash operations |
//! | [`hash_chain`] | Sequential hash chaining |
//! | [`hash_to_field_size`] | Truncate hash output to BN254 field size |
//! | [`zero_bytes`] | Precomputed zero-leaf hashes per hasher |

#![allow(unexpected_cfgs)]
#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(all(feature = "alloc", not(feature = "std")))]
extern crate alloc;

#[cfg(feature = "alloc")]
#[cfg(not(feature = "std"))]
pub use alloc::{string::String, vec, vec::Vec};
#[cfg(feature = "std")]
pub use std::{string::String, vec, vec::Vec};

pub mod bigint;
mod data_hasher;
pub mod errors;
pub mod hash_chain;
pub mod hash_to_field_size;
pub mod keccak;
pub mod poseidon;
pub mod sha256;
pub mod syscalls;
pub mod to_byte_array;
pub mod zero_bytes;
pub mod zero_indexed_leaf;

pub use data_hasher::DataHasher;
pub use keccak::Keccak;
pub use poseidon::Poseidon;
pub use sha256::Sha256;

pub use crate::errors::HasherError;
use crate::zero_bytes::ZeroBytes;

pub const HASH_BYTES: usize = 32;

pub type Hash = [u8; HASH_BYTES];

pub trait Hasher {
    const ID: u8;
    fn hash(val: &[u8]) -> Result<Hash, HasherError>;
    fn hashv(vals: &[&[u8]]) -> Result<Hash, HasherError>;
    fn zero_bytes() -> ZeroBytes;
    fn zero_indexed_leaf() -> [u8; 32];
}