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

pub use alloy_primitives::Address as AlloyAddress;

/// A wrapper over [alloy_primitives::Address] that allows us to add custom
/// methods and trait implementations.
#[derive(
    Debug,
    Clone,
    Copy,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    serde::Serialize,
    serde::Deserialize,
    derive_more::From,
    derive_more::Into,
    derive_more::FromStr,
    derive_more::AsRef,
    derive_more::AsMut,
    derive_more::Display,
    derive_more::LowerHex,
    derive_more::UpperHex,
)]
#[cfg_attr(feature = "testutils", derive(arbitrary::Arbitrary))]
#[from(AlloyAddress, [u8; 20])]
#[into(AlloyAddress, [u8; 20])]
#[as_ref(AlloyAddress, [u8; 20], [u8])]
#[repr(transparent)]
#[serde(rename = "agglayer_primitives::Address")]
pub struct Address(AlloyAddress);

impl Address {
    pub const ZERO: Self = Self::from_alloy(AlloyAddress::ZERO);

    #[inline]
    pub const fn new(bytes: [u8; 20]) -> Self {
        Self::from_alloy(AlloyAddress::new(bytes))
    }

    #[inline]
    pub const fn from_alloy(address: AlloyAddress) -> Self {
        Self(address)
    }

    #[inline]
    pub const fn as_alloy(&self) -> &AlloyAddress {
        &self.0
    }

    #[inline]
    pub const fn into_alloy(self) -> AlloyAddress {
        self.0
    }

    #[inline]
    pub const fn into_array(self) -> [u8; 20] {
        self.into_alloy().into_array()
    }

    #[inline]
    pub const fn as_slice(&self) -> &[u8] {
        self.as_alloy().0.as_slice()
    }
}

impl TryFrom<&[u8]> for Address {
    type Error = std::array::TryFromSliceError;

    #[inline]
    fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
        AlloyAddress::try_from(value).map(Self)
    }
}

#[macro_export]
macro_rules! address {
    ($($addr:literal)*) => {
        $crate::Address::from_alloy($crate::alloy_primitives::address!($($addr)*))
    };
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn address_macro() {
        let address = address!("00112233445566778899aabbccddeeff00112233");
        let alloy_address = alloy_primitives::address!("00112233445566778899aabbccddeeff00112233");
        assert_eq!(address, Address::from_alloy(alloy_address));
    }
}