agglayer-primitives 0.18.0

agglayer-primitives contains various structs and traits that are the ground of agglayer protocol.
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
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

use alloy_primitives::B256;
use serde::{Deserialize, Serialize};

use crate::Digest;

/// Type alias for a 256-bit hash. When using this alias, ensure that the
/// array is in fact hashed.
pub type HashU32 = [u32; 8];

/// Verifying key hash.
#[derive(Clone, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
#[serde(from = "B256", into = "B256")]
pub struct VKeyHash(HashU32);

impl VKeyHash {
    /// Create a [`VKeyHash`] from a [`HashU32`].
    pub const fn from_hash_u32(hash: HashU32) -> Self {
        Self(hash)
    }

    /// Create a [`VKeyHash`] from a [`B256`]. Assumes the bytes are in
    /// big-endian order.
    pub const fn from_bytes(bytes: B256) -> Self {
        let bytes = bytes.0;
        let mut hash_u32: HashU32 = [0u32; 8];

        let mut w = 0_usize;
        while w < 8 {
            let b0 = bytes[4 * w];
            let b1 = bytes[4 * w + 1];
            let b2 = bytes[4 * w + 2];
            let b3 = bytes[4 * w + 3];
            hash_u32[w] = u32::from_be_bytes([b0, b1, b2, b3]);
            w += 1;
        }

        Self(hash_u32)
    }

    /// Convert a [`VKeyHash`] to a [`B256`]. The resulting bytes are in
    /// big-endian order.
    pub const fn to_bytes(&self) -> B256 {
        let mut bytes = [0_u8; 32];

        let mut w = 0_usize;
        while w < 8 {
            let [b0, b1, b2, b3] = self.0[w].to_be_bytes();
            bytes[4 * w] = b0;
            bytes[4 * w + 1] = b1;
            bytes[4 * w + 2] = b2;
            bytes[4 * w + 3] = b3;
            w += 1;
        }

        B256::new(bytes)
    }

    /// Convert a [`VKeyHash`] to a [`HashU32`].
    pub const fn to_hash_u32(&self) -> HashU32 {
        self.0
    }
}

impl From<Digest> for VKeyHash {
    fn from(digest: Digest) -> Self {
        Self::from_bytes(B256::from(digest))
    }
}

impl From<VKeyHash> for Digest {
    fn from(hash: VKeyHash) -> Self {
        Self::from(hash.to_bytes())
    }
}

impl From<B256> for VKeyHash {
    fn from(bytes: B256) -> Self {
        Self::from_bytes(bytes)
    }
}

impl From<VKeyHash> for B256 {
    fn from(hash: VKeyHash) -> Self {
        hash.to_bytes()
    }
}

impl std::str::FromStr for VKeyHash {
    type Err = <B256 as std::str::FromStr>::Err;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        s.parse().map(Self::from_bytes)
    }
}

impl std::fmt::Debug for VKeyHash {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.to_bytes().fmt(f)
    }
}

#[cfg(test)]
mod test {
    use alloy_primitives::b256;

    use super::*;

    #[test]
    fn constructors_consistently_be() {
        let from_hash_u32 = VKeyHash::from_hash_u32([
            0x00010203, 0x04050607, 0x08090a0b, 0x0c0d0e0f, 0x10111213, 0x14151617, 0x18191a1b,
            0x1c1d1e1f,
        ]);

        let from_hex = VKeyHash::from_bytes(b256!(
            "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"
        ));

        assert_eq!(from_hash_u32, from_hex);

        let roundtrip = VKeyHash::from_bytes(from_hash_u32.to_bytes());
        assert_eq!(from_hash_u32, roundtrip);
    }
}