clvmr 0.19.0

Implementation of `clvm` for Chia Network's cryptocurrency
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

use crate::error::{EvalErr, Result};
use std::io;

/// all atoms serialize their contents verbatim. All expect those one-byte atoms
/// from 0x00-0x7f also have a prefix encoding their length. This function
/// writes the correct prefix for an atom of size `size` whose first byte is `atom_0`.
/// If the atom is of size 0, use any placeholder first byte, as it's ignored anyway.
fn write_atom_encoding_prefix_with_size<W: io::Write>(
    f: &mut W,
    atom_0: u8,
    size: u64,
) -> Result<()> {
    if size == 0 {
        f.write_all(&[0x80])
            .map_err(|_| EvalErr::SerializationError)
    } else if size == 1 && atom_0 < 0x80 {
        Ok(())
    } else if size < 0x40 {
        f.write_all(&[0x80 | (size as u8)])
            .map_err(|_| EvalErr::SerializationError)
    } else if size < 0x2000 {
        f.write_all(&[0xc0 | (size >> 8) as u8, size as u8])
            .map_err(|_| EvalErr::SerializationError)
    } else if size < 0x10_0000 {
        f.write_all(&[
            (0xe0 | (size >> 16)) as u8,
            ((size >> 8) & 0xff) as u8,
            ((size) & 0xff) as u8,
        ])
        .map_err(|_| EvalErr::SerializationError)
    } else if size < 0x800_0000 {
        f.write_all(&[
            (0xf0 | (size >> 24)) as u8,
            ((size >> 16) & 0xff) as u8,
            ((size >> 8) & 0xff) as u8,
            ((size) & 0xff) as u8,
        ])
        .map_err(|_| EvalErr::SerializationError)
    } else if size < 0x4_0000_0000 {
        f.write_all(&[
            (0xf8 | (size >> 32)) as u8,
            ((size >> 24) & 0xff) as u8,
            ((size >> 16) & 0xff) as u8,
            ((size >> 8) & 0xff) as u8,
            ((size) & 0xff) as u8,
        ])
        .map_err(|_| EvalErr::SerializationError)
    } else {
        Err(EvalErr::SerializationError)?
    }
}

/// serialize an atom
pub fn write_atom<W: io::Write>(f: &mut W, atom: &[u8]) -> Result<()> {
    let u8_0 = if !atom.is_empty() { atom[0] } else { 0 };
    write_atom_encoding_prefix_with_size(f, u8_0, atom.len() as u64)?;
    f.write_all(atom).map_err(|_| EvalErr::OutOfMemory)
}

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

    #[test]
    fn test_write_atom_encoding_prefix_with_size() {
        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0, 0).is_ok());
        assert_eq!(buf, vec![0x80]);

        for v in 0..0x7f {
            let mut buf = Vec::<u8>::new();
            assert!(write_atom_encoding_prefix_with_size(&mut buf, v, 1).is_ok());
            assert_eq!(buf.len(), 0);
        }

        for v in 0x80..0xff {
            let mut buf = Vec::<u8>::new();
            assert!(write_atom_encoding_prefix_with_size(&mut buf, v, 1).is_ok());
            assert_eq!(buf, vec![0x81]);
        }

        for size in 0x1_u8..0x3f_u8 {
            let mut buf = Vec::<u8>::new();
            assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, size as u64).is_ok());
            assert_eq!(buf, vec![0x80 + size]);
        }

        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0b111111).is_ok());
        assert_eq!(buf, vec![0b10111111]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0b1000000).is_ok());
        assert_eq!(buf, vec![0b11000000, 0b1000000]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0xfffff).is_ok());
        assert_eq!(buf, vec![0b11101111, 0xff, 0xff]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0xffffff).is_ok());
        assert_eq!(buf, vec![0b11110000, 0xff, 0xff, 0xff]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0xffffffff).is_ok());
        assert_eq!(buf, vec![0b11111000, 0xff, 0xff, 0xff, 0xff]);

        // this is the largest possible atom size
        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0x3ffffffff).is_ok());
        assert_eq!(buf, vec![0b11111011, 0xff, 0xff, 0xff, 0xff]);

        // this is too large
        let mut buf = Vec::<u8>::new();
        assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, 0x400000000).is_err());

        for (size, expected_prefix) in [
            (0x1, vec![0x81]),
            (0x2, vec![0x82]),
            (0x3f, vec![0xbf]),
            (0x40, vec![0xc0, 0x40]),
            (0x1fff, vec![0xdf, 0xff]),
            (0x2000, vec![0xe0, 0x20, 0x00]),
            (0xf_ffff, vec![0xef, 0xff, 0xff]),
            (0x10_0000, vec![0xf0, 0x10, 0x00, 0x00]),
            (0x7ff_ffff, vec![0xf7, 0xff, 0xff, 0xff]),
            (0x800_0000, vec![0xf8, 0x08, 0x00, 0x00, 0x00]),
            (0x3_ffff_ffff, vec![0xfb, 0xff, 0xff, 0xff, 0xff]),
        ] {
            let mut buf = Vec::<u8>::new();
            assert!(write_atom_encoding_prefix_with_size(&mut buf, 0xaa, size).is_ok());
            assert_eq!(buf, expected_prefix);
        }
    }

    #[test]
    fn test_write_atom() {
        let mut buf = Vec::<u8>::new();
        assert!(write_atom(&mut buf, &[]).is_ok());
        assert_eq!(buf, vec![0b10000000]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom(&mut buf, &[0x00]).is_ok());
        assert_eq!(buf, vec![0b00000000]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom(&mut buf, &[0x7f]).is_ok());
        assert_eq!(buf, vec![0x7f]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom(&mut buf, &[0x80]).is_ok());
        assert_eq!(buf, vec![0x81, 0x80]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom(&mut buf, &[0xff]).is_ok());
        assert_eq!(buf, vec![0x81, 0xff]);

        let mut buf = Vec::<u8>::new();
        assert!(write_atom(&mut buf, &[0xaa, 0xbb]).is_ok());
        assert_eq!(buf, vec![0x82, 0xaa, 0xbb]);

        for (size, mut expected_prefix) in [
            (0x1, vec![0x81]),
            (0x2, vec![0x82]),
            (0x3f, vec![0xbf]),
            (0x40, vec![0xc0, 0x40]),
            (0x1fff, vec![0xdf, 0xff]),
            (0x2000, vec![0xe0, 0x20, 0x00]),
            (0xf_ffff, vec![0xef, 0xff, 0xff]),
            (0x10_0000, vec![0xf0, 0x10, 0x00, 0x00]),
            (0x7ff_ffff, vec![0xf7, 0xff, 0xff, 0xff]),
            (0x800_0000, vec![0xf8, 0x08, 0x00, 0x00, 0x00]),
            // the next one represents 17 GB of memory, which it then has to serialize
            // so let's not do it until some time in the future when all machines have
            // 64 GB of memory
            // (0x3_ffff_ffff, vec![0xfb, 0xff, 0xff, 0xff, 0xff]),
        ] {
            let mut buf = Vec::<u8>::new();
            let atom = vec![0xaa; size];
            assert!(write_atom(&mut buf, &atom).is_ok());
            expected_prefix.extend(atom);
            assert_eq!(buf, expected_prefix);
        }
    }
}