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

use chain_core::{
    packer::Codec,
    property::{Deserialize, ReadError, Serialize, WriteError},
};
use thiserror::Error;
use typed_bytes::ByteBuilder;

pub const TOKEN_NAME_MAX_SIZE: usize = 32;

/// A sequence of bytes serving as a token name. Tokens that share the same name but have different
/// voting policies hashes are different tokens. A name can be empty. The maximum length of a token
/// name is 32 bytes.
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(
    any(test, feature = "property-test-api"),
    derive(test_strategy::Arbitrary)
)]
pub struct TokenName(Vec<u8>);

#[derive(Debug, Error)]
#[error("Token name can be no more that {} bytes long; got {} bytes", TOKEN_NAME_MAX_SIZE, .actual)]
pub struct TokenNameTooLong {
    actual: usize,
}

impl AsRef<[u8]> for TokenName {
    fn as_ref(&self) -> &[u8] {
        self.0.as_ref()
    }
}

impl TokenName {
    pub fn bytes(&self) -> Vec<u8> {
        let bb: ByteBuilder<Self> = ByteBuilder::new();
        bb.u8(self.0.len() as u8)
            .bytes(self.0.as_ref())
            .finalize_as_vec()
    }
}

impl TryFrom<Vec<u8>> for TokenName {
    type Error = TokenNameTooLong;

    fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
        if value.len() > TOKEN_NAME_MAX_SIZE {
            return Err(TokenNameTooLong {
                actual: value.len(),
            });
        }
        Ok(Self(value))
    }
}

impl Serialize for TokenName {
    fn serialized_size(&self) -> usize {
        Codec::u8_size() + self.0.len()
    }

    fn serialize<W: std::io::Write>(&self, codec: &mut Codec<W>) -> Result<(), WriteError> {
        codec.put_u8(self.0.len() as u8)?;
        codec.put_bytes(self.0.as_slice())
    }
}

impl Deserialize for TokenName {
    fn deserialize<R: std::io::Read>(codec: &mut Codec<R>) -> Result<Self, ReadError> {
        let name_length = codec.get_u8()? as usize;
        if name_length > TOKEN_NAME_MAX_SIZE {
            return Err(ReadError::SizeTooBig(TOKEN_NAME_MAX_SIZE, name_length));
        }
        let bytes = codec.get_bytes(name_length)?;
        Ok(Self(bytes))
    }
}

#[cfg(any(test, feature = "property-test-api"))]
mod tests {
    use super::*;
    #[cfg(test)]
    use crate::testing::serialization::serialization_bijection;
    #[cfg(test)]
    use quickcheck::TestResult;
    use quickcheck::{Arbitrary, Gen};

    impl Arbitrary for TokenName {
        fn arbitrary<G: Gen>(g: &mut G) -> Self {
            let len = usize::arbitrary(g) % (TOKEN_NAME_MAX_SIZE + 1);
            let mut bytes = Vec::with_capacity(len);
            for _ in 0..len {
                bytes.push(Arbitrary::arbitrary(g));
            }
            Self(bytes)
        }
    }

    #[quickcheck_macros::quickcheck]
    fn token_name_serialization_bijection(token_name: TokenName) -> TestResult {
        serialization_bijection(token_name)
    }
}