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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
// lowlevel header binary accessors, use module qualified and fundamentally allow to do invalid construction
#![allow(dead_code)]

use std::mem::size_of;

// ************************************************************************
// Offset and Basic Types
// ************************************************************************

pub(super) type Version = u8;
pub(super) type ContentSize = u32;
pub(super) type DateEpoch = u32;
pub(super) type DateSlotid = u32;
pub(super) type Height = u32;
pub(super) type ContentHash = [u8; 32];
pub(super) type ParentHash = [u8; 32];

pub(super) type BftLeaderId = [u8; 32];
pub(super) type BftSignature = [u8; 64];

pub(super) type GpNodeId = [u8; 32];
pub(super) type GpVrfProof = [u8; 96];
pub(super) type GpKesSignature = [u8; 484];

// common parts
const HEADER_OFFSET_VERSION: usize = 0;
const HEADER_OFFSET_CONTENT_SIZE: usize = HEADER_OFFSET_VERSION + size_of::<Version>();
const HEADER_OFFSET_DATE_EPOCH: usize = HEADER_OFFSET_CONTENT_SIZE + size_of::<ContentSize>();
const HEADER_OFFSET_DATE_SLOTID: usize = HEADER_OFFSET_DATE_EPOCH + size_of::<DateEpoch>();
const HEADER_OFFSET_HEIGHT: usize = HEADER_OFFSET_DATE_SLOTID + size_of::<DateSlotid>();
const HEADER_OFFSET_CONTENT_HASH: usize = HEADER_OFFSET_HEIGHT + size_of::<Height>();
const HEADER_OFFSET_PARENT_HASH: usize = HEADER_OFFSET_CONTENT_HASH + size_of::<ContentHash>();

pub const HEADER_COMMON_SIZE: usize = HEADER_OFFSET_PARENT_HASH + size_of::<ParentHash>();

// BFT
const HEADER_OFFSET_BFT_LEADER_ID: usize = HEADER_COMMON_SIZE;
const HEADER_OFFSET_BFT_SIGNATURE: usize = HEADER_OFFSET_BFT_LEADER_ID + size_of::<BftLeaderId>();

pub const HEADER_BFT_SIZE: usize = HEADER_OFFSET_BFT_SIGNATURE + size_of::<BftSignature>();

pub const HEADER_BFT_AUTHED_SIZE: usize = HEADER_OFFSET_BFT_SIGNATURE;

// GenesisPraos
const HEADER_OFFSET_GP_ID: usize = HEADER_COMMON_SIZE;
const HEADER_OFFSET_GP_VRF_PROOF: usize = HEADER_OFFSET_GP_ID + size_of::<GpNodeId>();
const HEADER_OFFSET_GP_KES_SIG: usize = HEADER_OFFSET_GP_VRF_PROOF + size_of::<GpVrfProof>();

pub const HEADER_GP_SIZE: usize = HEADER_OFFSET_GP_KES_SIG + size_of::<GpKesSignature>();

pub const HEADER_GP_AUTHED_SIZE: usize = HEADER_OFFSET_GP_KES_SIG;

pub const HEADER_MIN_KNOWN_SIZE: usize = HEADER_COMMON_SIZE;
pub const HEADER_MAX_KNOWN_SIZE: usize = HEADER_GP_SIZE;

// ************************************************************************
// Header union construction & accessors
// ************************************************************************

pub(super) type HeaderUnsigned = [u8; HEADER_COMMON_SIZE];
pub(super) type HeaderBft = [u8; HEADER_BFT_SIZE];
pub(super) type HeaderGp = [u8; HEADER_GP_SIZE];

pub(super) union Header {
    unsigned: HeaderUnsigned,
    bft: HeaderBft,
    gp: HeaderGp,
}

impl Clone for Header {
    fn clone(&self) -> Self {
        let mut gp = [0u8; HEADER_GP_SIZE];
        gp[..].copy_from_slice(unsafe { &self.gp[..] });
        Header { gp }
    }
}

impl PartialEq for Header {
    fn eq(&self, other: &Self) -> bool {
        unsafe { self.gp[..] == other.gp[..] }
    }
}
impl Eq for Header {}

pub(super) const VERSION_UNSIGNED: Version = 0;
pub(super) const VERSION_BFT: Version = 1;
pub(super) const VERSION_GP: Version = 2;

pub struct HeaderSlice<'a>(&'a [u8]);

impl Header {
    pub fn version(&self) -> Version {
        let mut buf = [0u8; size_of::<Version>()];
        let s = unsafe { &self.unsigned[HEADER_OFFSET_VERSION..HEADER_OFFSET_CONTENT_SIZE] };
        buf.copy_from_slice(s);
        Version::from_be_bytes(buf)
    }

    pub fn as_slice(&self) -> HeaderSlice<'_> {
        match self.version() {
            VERSION_UNSIGNED => unsafe { HeaderSlice(&self.unsigned[..]) },
            VERSION_BFT => unsafe { HeaderSlice(&self.bft[..]) },
            VERSION_GP => unsafe { HeaderSlice(&self.gp[..]) },
            _ => panic!("Header: cstruct: as slice with undefined version"),
        }
    }

    pub(self) fn as_slice_mut(&mut self) -> &mut [u8] {
        match self.version() {
            VERSION_UNSIGNED => unsafe { &mut self.unsigned[..] },
            VERSION_BFT => unsafe { &mut self.bft[..] },
            VERSION_GP => unsafe { &mut self.gp[..] },
            _ => panic!("Header: cstruct: as slice mut with undefined version"),
        }
    }

    pub fn new(version: Version) -> Header {
        let gp = [0u8; HEADER_GP_SIZE];
        let mut hdr = Header { gp };
        hdr.set_version(version);
        hdr
    }

    pub fn set_version(&mut self, s: Version) {
        let sbuf = s.to_be_bytes();
        unsafe {
            self.unsigned[HEADER_OFFSET_VERSION..HEADER_OFFSET_CONTENT_SIZE]
                .copy_from_slice(&sbuf[..])
        }
    }

    pub fn set_content_size(&mut self, s: ContentSize) {
        let sbuf = s.to_be_bytes();
        unsafe {
            self.unsigned[HEADER_OFFSET_CONTENT_SIZE..HEADER_OFFSET_DATE_EPOCH]
                .copy_from_slice(&sbuf[..])
        }
    }

    pub fn set_date_epoch(&mut self, s: DateEpoch) {
        let sbuf = s.to_be_bytes();
        unsafe {
            self.unsigned[HEADER_OFFSET_DATE_EPOCH..HEADER_OFFSET_DATE_SLOTID]
                .copy_from_slice(&sbuf[..])
        }
    }

    pub fn set_date_slotid(&mut self, s: DateSlotid) {
        let sbuf = s.to_be_bytes();
        unsafe {
            self.unsigned[HEADER_OFFSET_DATE_SLOTID..HEADER_OFFSET_HEIGHT]
                .copy_from_slice(&sbuf[..])
        }
    }

    pub fn set_height(&mut self, s: Height) {
        let sbuf = s.to_be_bytes();
        unsafe {
            self.unsigned[HEADER_OFFSET_HEIGHT..HEADER_OFFSET_CONTENT_HASH]
                .copy_from_slice(&sbuf[..])
        }
    }

    pub fn set_content_hash(&mut self, s: &ContentHash) {
        unsafe {
            self.unsigned[HEADER_OFFSET_CONTENT_HASH..HEADER_OFFSET_PARENT_HASH]
                .copy_from_slice(&s[..])
        }
    }

    pub fn set_parent_hash(&mut self, s: &ParentHash) {
        unsafe {
            self.unsigned[HEADER_OFFSET_PARENT_HASH..HEADER_COMMON_SIZE].copy_from_slice(&s[..])
        }
    }

    #[allow(dead_code)]
    pub fn set_bft_leader_id(&mut self, s: &BftLeaderId) {
        assert_eq!(self.version(), VERSION_BFT);
        unsafe {
            self.bft[HEADER_OFFSET_BFT_LEADER_ID..HEADER_OFFSET_BFT_SIGNATURE]
                .copy_from_slice(&s[..])
        }
    }

    pub fn set_bft_leader_id_slice(&mut self, s: &[u8]) {
        assert_eq!(self.version(), VERSION_BFT);
        assert_eq!(s.len(), size_of::<BftLeaderId>());
        unsafe {
            self.bft[HEADER_OFFSET_BFT_LEADER_ID..HEADER_OFFSET_BFT_SIGNATURE].copy_from_slice(s)
        }
    }

    #[allow(dead_code)]
    pub fn set_bft_signature(&mut self, s: &BftSignature) {
        assert_eq!(self.version(), VERSION_BFT);
        unsafe { self.bft[HEADER_OFFSET_BFT_SIGNATURE..HEADER_BFT_SIZE].copy_from_slice(&s[..]) }
    }

    pub fn set_bft_signature_slice(&mut self, s: &[u8]) {
        assert_eq!(self.version(), VERSION_BFT);
        assert_eq!(s.len(), size_of::<BftSignature>());
        unsafe { self.bft[HEADER_OFFSET_BFT_SIGNATURE..HEADER_BFT_SIZE].copy_from_slice(s) }
    }

    pub fn set_gp_node_id(&mut self, s: &GpNodeId) {
        assert_eq!(self.version(), VERSION_GP);
        unsafe { self.gp[HEADER_OFFSET_GP_ID..HEADER_OFFSET_GP_VRF_PROOF].copy_from_slice(&s[..]) }
    }

    #[allow(dead_code)]
    pub fn set_gp_node_id_slice(&mut self, s: &[u8]) {
        assert_eq!(self.version(), VERSION_GP);
        assert_eq!(s.len(), size_of::<GpNodeId>());
        unsafe { self.gp[HEADER_OFFSET_GP_ID..HEADER_OFFSET_GP_VRF_PROOF].copy_from_slice(s) }
    }

    pub fn set_gp_vrf_proof(&mut self, s: &GpVrfProof) {
        assert_eq!(self.version(), VERSION_GP);
        unsafe {
            self.gp[HEADER_OFFSET_GP_VRF_PROOF..HEADER_OFFSET_GP_KES_SIG].copy_from_slice(&s[..])
        }
    }

    #[allow(dead_code)]
    pub fn set_gp_vrf_proof_slice(&mut self, s: &[u8]) {
        assert_eq!(self.version(), VERSION_GP);
        assert_eq!(s.len(), size_of::<GpVrfProof>());
        unsafe { self.gp[HEADER_OFFSET_GP_VRF_PROOF..HEADER_OFFSET_GP_KES_SIG].copy_from_slice(s) }
    }

    #[allow(dead_code)]
    pub fn set_gp_kes_signature(&mut self, s: &GpKesSignature) {
        assert_eq!(self.version(), VERSION_GP);
        unsafe { self.gp[HEADER_OFFSET_GP_KES_SIG..HEADER_GP_SIZE].copy_from_slice(&s[..]) }
    }

    pub fn set_gp_kes_signature_slice(&mut self, s: &[u8]) {
        assert_eq!(self.version(), VERSION_GP);
        assert_eq!(s.len(), size_of::<GpKesSignature>());
        unsafe { self.gp[HEADER_OFFSET_GP_KES_SIG..HEADER_GP_SIZE].copy_from_slice(s) }
    }
}

#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
pub enum HeaderError {
    #[error("invalid payload size for block header")]
    InvalidSize,
    #[error("unknown version of the block header payload")]
    UnknownVersion,
    #[error("block header payload size {got} does not match the expected {expected} bytes")]
    SizeMismatch { expected: usize, got: usize },
}

impl<'a> HeaderSlice<'a> {
    pub fn from_slice(slice: &'a [u8]) -> Result<Self, HeaderError> {
        let len = slice.len();
        if len < HEADER_MIN_KNOWN_SIZE {
            return Err(HeaderError::InvalidSize);
        }
        if len > HEADER_MAX_KNOWN_SIZE {
            return Err(HeaderError::InvalidSize);
        }

        let hdr = HeaderSlice(slice);
        match hdr.version() {
            VERSION_UNSIGNED => {
                if len != HEADER_COMMON_SIZE {
                    return Err(HeaderError::SizeMismatch {
                        expected: HEADER_COMMON_SIZE,
                        got: len,
                    });
                }
                Ok(hdr)
            }
            VERSION_BFT => {
                if len != HEADER_BFT_SIZE {
                    return Err(HeaderError::SizeMismatch {
                        expected: HEADER_BFT_SIZE,
                        got: len,
                    });
                }
                Ok(hdr)
            }
            VERSION_GP => {
                if len != HEADER_GP_SIZE {
                    return Err(HeaderError::SizeMismatch {
                        expected: HEADER_GP_SIZE,
                        got: len,
                    });
                }
                Ok(hdr)
            }
            _ => Err(HeaderError::UnknownVersion),
        }
    }

    pub fn as_slice(&self) -> &'a [u8] {
        self.0
    }

    pub(super) fn to_owned(&self) -> Header {
        let mut new = Header::new(self.version());
        new.as_slice_mut().copy_from_slice(self.0);
        new
    }

    pub fn version(&self) -> Version {
        let mut buf = [0u8; size_of::<Version>()];
        buf.copy_from_slice(&self.0[HEADER_OFFSET_VERSION..HEADER_OFFSET_CONTENT_SIZE]);
        Version::from_be_bytes(buf)
    }

    pub fn content_size(&self) -> ContentSize {
        let mut buf = [0u8; size_of::<ContentSize>()];
        buf.copy_from_slice(&self.0[HEADER_OFFSET_CONTENT_SIZE..HEADER_OFFSET_DATE_EPOCH]);
        ContentSize::from_be_bytes(buf)
    }

    pub fn date_epoch(&self) -> DateEpoch {
        let mut buf = [0u8; size_of::<DateEpoch>()];
        buf.copy_from_slice(&self.0[HEADER_OFFSET_DATE_EPOCH..HEADER_OFFSET_DATE_SLOTID]);
        DateEpoch::from_be_bytes(buf)
    }

    pub fn date_slotid(&self) -> DateSlotid {
        let mut buf = [0u8; size_of::<DateSlotid>()];
        buf.copy_from_slice(&self.0[HEADER_OFFSET_DATE_SLOTID..HEADER_OFFSET_HEIGHT]);
        DateSlotid::from_be_bytes(buf)
    }

    pub fn height(&self) -> Height {
        let mut buf = [0u8; size_of::<Height>()];
        buf.copy_from_slice(&self.0[HEADER_OFFSET_HEIGHT..HEADER_OFFSET_CONTENT_HASH]);
        Height::from_be_bytes(buf)
    }

    pub fn content_hash_ref(&self) -> &[u8] {
        &self.0[HEADER_OFFSET_CONTENT_HASH..HEADER_OFFSET_PARENT_HASH]
    }

    pub fn content_hash(&self) -> ContentHash {
        let mut buf = [0u8; size_of::<ContentHash>()];
        buf.copy_from_slice(self.content_hash_ref());
        buf
    }

    pub fn parent_hash_ref(&self) -> &[u8] {
        &self.0[HEADER_OFFSET_PARENT_HASH..HEADER_COMMON_SIZE]
    }

    pub fn parent_hash(&self) -> ParentHash {
        let mut buf = [0u8; size_of::<ParentHash>()];
        buf.copy_from_slice(self.parent_hash_ref());
        buf
    }

    pub fn bft_leader_id_ref(&self) -> &[u8] {
        assert_eq!(self.version(), VERSION_BFT);
        &self.0[HEADER_OFFSET_BFT_LEADER_ID..HEADER_OFFSET_BFT_SIGNATURE]
    }

    pub fn bft_leader_id(&self) -> BftLeaderId {
        let mut buf = [0u8; size_of::<BftLeaderId>()];
        buf.copy_from_slice(self.bft_leader_id_ref());
        buf
    }

    pub fn bft_signature_ref(&self) -> &[u8] {
        assert_eq!(self.version(), VERSION_BFT);
        &self.0[HEADER_OFFSET_BFT_SIGNATURE..HEADER_BFT_SIZE]
    }

    pub fn bft_signature(&self) -> BftSignature {
        let mut buf = [0u8; size_of::<BftSignature>()];
        buf.copy_from_slice(self.bft_signature_ref());
        buf
    }

    pub fn gp_node_id_ref(&self) -> &[u8] {
        assert_eq!(self.version(), VERSION_GP);
        &self.0[HEADER_OFFSET_GP_ID..HEADER_OFFSET_GP_VRF_PROOF]
    }

    pub fn gp_node_id(&self) -> GpNodeId {
        let mut buf = [0u8; size_of::<GpNodeId>()];
        buf.copy_from_slice(self.gp_node_id_ref());
        buf
    }

    pub fn gp_vrf_proof_ref(&self) -> &[u8] {
        assert_eq!(self.version(), VERSION_GP);
        &self.0[HEADER_OFFSET_GP_VRF_PROOF..HEADER_OFFSET_GP_KES_SIG]
    }

    pub fn gp_vrf_proof(&self) -> GpVrfProof {
        let mut buf = [0u8; size_of::<GpVrfProof>()];
        buf.copy_from_slice(self.gp_vrf_proof_ref());
        buf
    }

    pub fn gp_kes_signature_ref(&self) -> &[u8] {
        assert_eq!(self.version(), VERSION_GP);
        &self.0[HEADER_OFFSET_GP_KES_SIG..HEADER_GP_SIZE]
    }

    pub fn gp_kes_signature(&self) -> GpKesSignature {
        let mut buf = [0u8; size_of::<GpKesSignature>()];
        buf.copy_from_slice(self.gp_kes_signature_ref());
        buf
    }

    pub fn slice_bft_auth(self) -> &'a [u8] {
        assert_eq!(self.version(), VERSION_BFT);
        &self.0[0..HEADER_BFT_AUTHED_SIZE]
    }

    pub fn slice_gp_auth(self) -> &'a [u8] {
        assert_eq!(self.version(), VERSION_GP);
        &self.0[0..HEADER_GP_AUTHED_SIZE]
    }
}

#[cfg(test)]
mod tests {

    use crate::header::cstruct::*;

    #[test]
    pub fn header_bft_version_set() {
        let mut header = Header::new(VERSION_BFT);
        let bft_leader_id = [0; 32];
        header.set_bft_leader_id(&bft_leader_id);
        let bft_leader_id_sig = [0; 64];
        header.set_bft_signature(&bft_leader_id_sig);
    }

    #[test]
    pub fn header_gp_version_set() {
        let mut header = Header::new(VERSION_GP);
        let gp_node_id = [0; 32];
        header.set_gp_node_id_slice(&gp_node_id);
        let gp_vrf_proof_slice = [0; 96];
        header.set_gp_vrf_proof_slice(&gp_vrf_proof_slice);
        let gp_kes_signature = [0; 484];
        header.set_gp_kes_signature(&gp_kes_signature);
    }

    #[test]
    pub fn header_slice_from_slice_below_min_known_size() {
        assert_eq!(
            HeaderSlice::from_slice(&[0; HEADER_MIN_KNOWN_SIZE - 1])
                .err()
                .unwrap(),
            HeaderError::InvalidSize
        );
    }

    #[test]
    pub fn header_slice_from_slice_after_max_known_size() {
        assert_eq!(
            HeaderSlice::from_slice(&[0; HEADER_MAX_KNOWN_SIZE + 1])
                .err()
                .unwrap(),
            HeaderError::InvalidSize
        );
    }
}