libssz 0.2.1

Simple Serialize (SSZ) encoding/decoding for Ethereum consensus
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
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
use libssz::{ContainerDecoder, ContainerEncoder, DecodeError, SszDecode, SszEncode};

// ── bool ──

#[test]
fn bool_true_round_trip() {
    let encoded = true.to_ssz();
    assert_eq!(encoded, vec![1]);
    assert!(bool::from_ssz_bytes(&encoded).unwrap());
}

#[test]
fn bool_false_round_trip() {
    let encoded = false.to_ssz();
    assert_eq!(encoded, vec![0]);
    assert!(!bool::from_ssz_bytes(&encoded).unwrap());
}

#[test]
fn bool_invalid_byte() {
    assert_eq!(
        bool::from_ssz_bytes(&[2]),
        Err(DecodeError::InvalidBooleanByte(2))
    );
}

#[test]
fn bool_wrong_length() {
    assert_eq!(
        bool::from_ssz_bytes(&[0, 1]),
        Err(DecodeError::InvalidFixedLength {
            expected: 1,
            got: 2
        })
    );
}

// ── u8 ──

#[test]
fn u8_round_trip() {
    for val in [0u8, 1, 127, 255] {
        let encoded = val.to_ssz();
        assert_eq!(encoded, vec![val]);
        assert_eq!(u8::from_ssz_bytes(&encoded).unwrap(), val);
    }
}

// ── u16 ──

#[test]
fn u16_round_trip() {
    let val: u16 = 0x0102;
    let encoded = val.to_ssz();
    assert_eq!(encoded, vec![0x02, 0x01]); // little-endian
    assert_eq!(u16::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── u32 ──

#[test]
fn u32_round_trip() {
    let val: u32 = 0x01020304;
    let encoded = val.to_ssz();
    assert_eq!(encoded, vec![0x04, 0x03, 0x02, 0x01]);
    assert_eq!(u32::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── u64 ──

#[test]
fn u64_round_trip() {
    let val: u64 = 0x0102030405060708;
    let encoded = val.to_ssz();
    assert_eq!(
        encoded,
        vec![0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01]
    );
    assert_eq!(u64::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── u128 ──

#[test]
fn u128_round_trip() {
    let val: u128 = 1;
    let encoded = val.to_ssz();
    assert_eq!(encoded.len(), 16);
    assert_eq!(u128::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── u256 ([u8; 32]) ──

#[test]
fn u256_round_trip() {
    let mut val = [0u8; 32];
    val[0] = 1;
    val[31] = 0xFF;
    let encoded = val.to_ssz();
    assert_eq!(encoded.len(), 32);
    assert_eq!(<[u8; 32]>::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── Vec<u16> (fixed-element list) ──

#[test]
fn vec_u16_round_trip() {
    let val: Vec<u16> = vec![1, 2, 3];
    let encoded = val.to_ssz();
    // 3 × 2 bytes = 6 bytes, LE
    assert_eq!(encoded, vec![0x01, 0x00, 0x02, 0x00, 0x03, 0x00]);
    assert_eq!(Vec::<u16>::from_ssz_bytes(&encoded).unwrap(), val);
}

#[test]
fn vec_empty() {
    let val: Vec<u16> = vec![];
    let encoded = val.to_ssz();
    assert_eq!(encoded, vec![]);
    assert_eq!(Vec::<u16>::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── Vec<Vec<u8>> (variable-element list) ──

#[test]
fn vec_of_vecs_round_trip() {
    let val: Vec<Vec<u8>> = vec![vec![1, 2], vec![3], vec![4, 5, 6]];
    let encoded = val.to_ssz();

    // 3 offsets (4 bytes each) = 12 bytes fixed part
    // offset[0] = 12, offset[1] = 14, offset[2] = 15
    // data: [1,2], [3], [4,5,6]
    let expected = vec![
        12, 0, 0, 0, // offset to [1,2]
        14, 0, 0, 0, // offset to [3]
        15, 0, 0, 0, // offset to [4,5,6]
        1, 2, // data[0]
        3, // data[1]
        4, 5, 6, // data[2]
    ];
    assert_eq!(encoded, expected);
    assert_eq!(Vec::<Vec<u8>>::from_ssz_bytes(&encoded).unwrap(), val);
}

#[test]
fn vec_of_vecs_empty() {
    let val: Vec<Vec<u8>> = vec![];
    let encoded = val.to_ssz();
    assert!(encoded.is_empty());
    assert_eq!(Vec::<Vec<u8>>::from_ssz_bytes(&encoded).unwrap(), val);
}

// ── ContainerEncoder / ContainerDecoder ──

/// Simulates a container: { a: u32, b: Vec<u8>, c: u16 }
/// Fixed part: 4 (u32) + 4 (offset) + 2 (u16) = 10 bytes
#[test]
fn container_mixed_round_trip() {
    let a: u32 = 42;
    let b: Vec<u8> = vec![0xAA, 0xBB, 0xCC];
    let c: u16 = 1000;

    // Encode
    let mut buf = Vec::new();
    let fixed_part_len_enc = 4 + 4 + 2; // u32 + offset + u16
    let mut encoder = ContainerEncoder::new(&mut buf, fixed_part_len_enc);
    encoder.append_fixed(&a);
    encoder.append_variable(&b);
    encoder.append_fixed(&c);
    encoder.finalize();

    // Expected:
    // [42, 0, 0, 0]         a = 42 (u32 LE)
    // [10, 0, 0, 0]         offset to b's data (fixed part = 4+4+2 = 10)
    // [0xE8, 0x03]          c = 1000 (u16 LE)
    // [0xAA, 0xBB, 0xCC]    b's data
    let expected = vec![42, 0, 0, 0, 10, 0, 0, 0, 0xE8, 0x03, 0xAA, 0xBB, 0xCC];
    assert_eq!(buf, expected);

    // Decode
    let fixed_part_len = 4 + 4 + 2; // u32 + offset + u16
    let mut decoder = ContainerDecoder::new(&buf, fixed_part_len).unwrap();
    let dec_a: u32 = decoder.decode_fixed().unwrap();
    decoder.read_variable_offset().unwrap();
    let dec_c: u16 = decoder.decode_fixed().unwrap();
    let dec_b: Vec<u8> = decoder.decode_variable().unwrap();

    assert_eq!(dec_a, a);
    assert_eq!(dec_b, b);
    assert_eq!(dec_c, c);
}

/// All-fixed container: { x: u32, y: u64 }
#[test]
fn container_all_fixed_round_trip() {
    let x: u32 = 7;
    let y: u64 = 999;

    let mut buf = Vec::new();
    let mut encoder = ContainerEncoder::new(&mut buf, 4 + 8);
    encoder.append_fixed(&x);
    encoder.append_fixed(&y);
    encoder.finalize();

    assert_eq!(buf.len(), 4 + 8);

    let mut decoder = ContainerDecoder::new(&buf, 12).unwrap();
    let dec_x: u32 = decoder.decode_fixed().unwrap();
    let dec_y: u64 = decoder.decode_fixed().unwrap();
    decoder.finish_fixed().unwrap();

    assert_eq!(dec_x, x);
    assert_eq!(dec_y, y);
}

/// Container with extra bytes should fail.
#[test]
fn container_extra_bytes() {
    let mut buf = vec![0u8; 16]; // 12-byte container + 4 extra bytes
    buf[0] = 7; // x = 7

    let mut decoder = ContainerDecoder::new(&buf, 12).unwrap();
    let _x: u32 = decoder.decode_fixed().unwrap();
    let _y: u64 = decoder.decode_fixed().unwrap();
    assert!(decoder.finish_fixed().is_err());
}

// ── encoded_len ──

#[test]
fn encoded_len_matches_actual() {
    let val: Vec<Vec<u8>> = vec![vec![1, 2, 3], vec![], vec![4]];
    assert_eq!(val.encoded_len(), val.to_ssz().len());

    let fixed: Vec<u32> = vec![1, 2, 3, 4, 5];
    assert_eq!(fixed.encoded_len(), fixed.to_ssz().len());

    assert_eq!(true.encoded_len(), 1);
    assert_eq!(42u64.encoded_len(), 8);
}

// ── Error cases ──

#[test]
fn u32_wrong_length() {
    assert_eq!(
        u32::from_ssz_bytes(&[1, 2, 3]),
        Err(DecodeError::InvalidFixedLength {
            expected: 4,
            got: 3
        })
    );
}

#[test]
fn vec_u32_not_divisible() {
    // 5 bytes is not divisible by 4
    assert!(Vec::<u32>::from_ssz_bytes(&[1, 2, 3, 4, 5]).is_err());
}

// ── Byte array round trips (Ethereum-sized: pubkeys, signatures) ──

#[test]
fn byte_array_4_round_trip() {
    let val = [0x01, 0x02, 0x03, 0x04];
    let encoded = val.to_ssz();
    assert_eq!(<[u8; 4]>::from_ssz_bytes(&encoded).unwrap(), val);
}

#[test]
fn byte_array_20_round_trip() {
    // Ethereum address size
    let mut val = [0u8; 20];
    val[0] = 0xDE;
    val[19] = 0xAD;
    let encoded = val.to_ssz();
    assert_eq!(encoded.len(), 20);
    assert_eq!(<[u8; 20]>::from_ssz_bytes(&encoded).unwrap(), val);
}

#[test]
fn byte_array_48_round_trip() {
    // BLS public key size
    let mut val = [0u8; 48];
    val[0] = 0xAB;
    val[47] = 0xCD;
    let encoded = val.to_ssz();
    assert_eq!(encoded.len(), 48);
    assert_eq!(<[u8; 48]>::from_ssz_bytes(&encoded).unwrap(), val);
}

#[test]
fn byte_array_96_round_trip() {
    // BLS signature size
    let mut val = [0u8; 96];
    val[0] = 0x01;
    val[95] = 0xFF;
    let encoded = val.to_ssz();
    assert_eq!(encoded.len(), 96);
    assert_eq!(<[u8; 96]>::from_ssz_bytes(&encoded).unwrap(), val);
}

#[test]
fn byte_array_wrong_length() {
    let err = <[u8; 48]>::from_ssz_bytes(&[0u8; 32]).unwrap_err();
    assert_eq!(
        err,
        DecodeError::InvalidFixedLength {
            expected: 48,
            got: 32
        }
    );
}

// ── Variable-length decoding: malformed data from untrusted peers ──

#[test]
fn variable_list_truncated_offset_region() {
    // Only 2 bytes when we need at least 4 for the first offset
    let err = Vec::<Vec<u8>>::from_ssz_bytes(&[0x01, 0x02]).unwrap_err();
    assert_eq!(
        err,
        DecodeError::InvalidByteLength {
            expected: 4,
            got: 2
        }
    );
}

#[test]
fn variable_list_first_offset_not_aligned() {
    // First offset = 5 (not a multiple of 4) — invalid
    let bytes = 5u32.to_le_bytes();
    let err = Vec::<Vec<u8>>::from_ssz_bytes(&bytes).unwrap_err();
    assert_eq!(
        err,
        DecodeError::InvalidFirstOffset {
            expected: 0,
            got: 5
        }
    );
}

#[test]
fn variable_list_offset_out_of_bounds() {
    // Two items: first offset = 8 (correct), second offset = 255 (way past end)
    let mut bytes = Vec::new();
    bytes.extend_from_slice(&8u32.to_le_bytes()); // offset[0] = 8
    bytes.extend_from_slice(&255u32.to_le_bytes()); // offset[1] = 255 (out of bounds)
    bytes.extend_from_slice(&[0xAA]); // some data
    let err = Vec::<Vec<u8>>::from_ssz_bytes(&bytes).unwrap_err();
    assert_eq!(
        err,
        DecodeError::OffsetOutOfBounds {
            offset: 255,
            length: 9
        }
    );
}

#[test]
fn variable_list_offsets_not_monotonic() {
    // Two items: first offset = 8, second offset = 7 (decreasing — corrupt)
    let mut bytes = Vec::new();
    bytes.extend_from_slice(&8u32.to_le_bytes()); // offset[0] = 8
    bytes.extend_from_slice(&7u32.to_le_bytes()); // offset[1] = 7 (not monotonic)
    bytes.extend_from_slice(&[0xAA, 0xBB]); // data
    let err = Vec::<Vec<u8>>::from_ssz_bytes(&bytes).unwrap_err();
    assert_eq!(err, DecodeError::OffsetsAreNotMonotonicallyIncreasing);
}

#[test]
fn variable_list_single_empty_item() {
    // One variable-length item that is empty: offset[0] = 4, no data after offsets
    let bytes = 4u32.to_le_bytes();
    let decoded = Vec::<Vec<u8>>::from_ssz_bytes(&bytes).unwrap();
    assert_eq!(decoded, vec![Vec::<u8>::new()]);
}

// ── ContainerDecoder edge cases ──

#[test]
fn container_decoder_bytes_too_short() {
    // Fixed part expects 12 bytes, only give 8
    let bytes = [0u8; 8];
    match ContainerDecoder::new(&bytes, 12) {
        Err(DecodeError::InvalidByteLength {
            expected: 12,
            got: 8,
        }) => {}
        Err(e) => panic!("unexpected error: {e:?}"),
        Ok(_) => panic!("expected error"),
    }
}

#[test]
fn container_decoder_fixed_field_overflow() {
    // Container with just a u64 field, but only 4 bytes available
    let bytes = [0u8; 4];
    let mut decoder = ContainerDecoder::new(&bytes, 4).unwrap();
    let err = decoder.decode_fixed::<u64>().unwrap_err();
    assert_eq!(
        err,
        DecodeError::InvalidByteLength {
            expected: 8, // cursor(0) + size(8) = 8, but only 4 bytes
            got: 4
        }
    );
}

#[test]
fn container_decoder_variable_offset_out_of_bounds() {
    // Simulate a container { x: Vec<u8> } where the offset points past the buffer
    let mut bytes = Vec::new();
    bytes.extend_from_slice(&255u32.to_le_bytes()); // offset = 255, way past end
    let mut decoder = ContainerDecoder::new(&bytes, 4).unwrap();
    let err = decoder.read_variable_offset().unwrap_err();
    // First offset (255) != fixed_part_len (4), caught before the out-of-bounds check
    assert_eq!(
        err,
        DecodeError::InvalidFirstOffset {
            expected: 4,
            got: 255
        }
    );
}

#[test]
fn container_decoder_variable_offsets_not_monotonic() {
    // Container { a: Vec<u8>, b: Vec<u8> } with offsets [8, 4] — decreasing
    let mut bytes = Vec::new();
    bytes.extend_from_slice(&8u32.to_le_bytes()); // offset a = 8 = fixed_part_len, ok
    bytes.extend_from_slice(&4u32.to_le_bytes()); // offset b = 4 (not monotonic)
    let mut decoder = ContainerDecoder::new(&bytes, 8).unwrap();
    decoder.read_variable_offset().unwrap(); // offset a = 8 = fixed_part_len, ok
    let err = decoder.read_variable_offset().unwrap_err();
    assert_eq!(err, DecodeError::OffsetsAreNotMonotonicallyIncreasing);
}

#[test]
fn container_decoder_decode_variable_without_offsets() {
    // Try to decode a variable field without having read any offsets
    let bytes = [0u8; 8];
    let mut decoder = ContainerDecoder::new(&bytes, 8).unwrap();
    let err = decoder.decode_variable::<Vec<u8>>().unwrap_err();
    assert_eq!(
        err,
        DecodeError::InvalidByteLength {
            expected: 1,
            got: 0
        }
    );
}

// ── Error Display ──

#[test]
fn decode_error_display_formats_correctly() {
    use std::fmt::Write;

    // Verify Display impl works (used in error reporting)
    let err = DecodeError::InvalidFixedLength {
        expected: 4,
        got: 2,
    };
    let mut s = String::new();
    write!(s, "{err}").unwrap();
    assert!(s.contains("InvalidFixedLength"));
    assert!(s.contains("4"));
    assert!(s.contains("2"));

    // Verify Error trait impl
    let err_ref: &dyn std::error::Error = &err;
    assert!(err_ref.to_string().contains("InvalidFixedLength"));
}

// ── Generic byte array encode/decode (non-standard sizes) ──

#[test]
fn encode_byte_array_7() {
    let arr = [0xab_u8; 7];
    assert_eq!(arr.to_ssz(), arr.to_vec());
    assert_eq!(<[u8; 7] as SszEncode>::fixed_size(), 7);
    assert!(<[u8; 7] as SszEncode>::is_fixed_size());
}

#[test]
fn encode_byte_array_52() {
    let arr = [0xcd_u8; 52];
    assert_eq!(arr.to_ssz(), arr.to_vec());
    assert_eq!(<[u8; 52] as SszEncode>::fixed_size(), 52);
}

#[test]
fn encode_byte_array_100() {
    let arr = [0xff_u8; 100];
    assert_eq!(arr.to_ssz(), arr.to_vec());
    assert_eq!(<[u8; 100] as SszEncode>::fixed_size(), 100);
}

#[test]
fn decode_byte_array_7() {
    let bytes = [0xab_u8; 7];
    let decoded = <[u8; 7]>::from_ssz_bytes(&bytes).unwrap();
    assert_eq!(decoded, bytes);
}

#[test]
fn decode_byte_array_52() {
    let bytes = [0xcd_u8; 52];
    let decoded = <[u8; 52]>::from_ssz_bytes(&bytes).unwrap();
    assert_eq!(decoded, bytes);
}

#[test]
fn decode_byte_array_wrong_length() {
    let bytes = [0u8; 31];
    let err = <[u8; 52]>::from_ssz_bytes(&bytes).unwrap_err();
    assert_eq!(
        err,
        DecodeError::InvalidFixedLength {
            expected: 52,
            got: 31
        }
    );
}

#[test]
fn roundtrip_byte_array_33() {
    let arr = [0x42_u8; 33];
    let encoded = arr.to_ssz();
    let decoded = <[u8; 33]>::from_ssz_bytes(&encoded).unwrap();
    assert_eq!(arr, decoded);
}

// ── ContainerEncoder default ──

#[test]
fn container_encoder_new() {
    let mut buf1 = Vec::new();
    let mut buf2 = Vec::new();
    let mut enc1 = ContainerEncoder::new(&mut buf1, 4);
    enc1.append_fixed(&42u32);
    enc1.finalize();
    let mut enc2 = ContainerEncoder::new(&mut buf2, 4);
    enc2.append_fixed(&42u32);
    enc2.finalize();
    assert_eq!(buf1, buf2);
}