#length #fixed-length #required #bit-fields #ssz #serialization #bit-vector

eth2_ssz_types

Provides types with unique properties required for SSZ serialization and Merklization

3 unstable releases

0.2.1 Nov 23, 2021
0.2.0 Aug 24, 2021
0.1.0 Jul 29, 2021

#1742 in Rust patterns

Download history 72/week @ 2023-12-18 62/week @ 2023-12-25 124/week @ 2024-01-01 113/week @ 2024-01-08 110/week @ 2024-01-15 227/week @ 2024-01-22 176/week @ 2024-01-29 111/week @ 2024-02-05 117/week @ 2024-02-12 278/week @ 2024-02-19 215/week @ 2024-02-26 27/week @ 2024-03-04 76/week @ 2024-03-11 13/week @ 2024-03-18 26/week @ 2024-03-25 109/week @ 2024-04-01

227 downloads per month
Used in 2 crates

Apache-2.0

85KB
2K SLoC

Provides types with unique properties required for SSZ serialization and Merklization:

  • FixedVector: A heap-allocated list with a size that is fixed at compile time.
  • VariableList: A heap-allocated list that cannot grow past a type-level maximum length.
  • BitList: A heap-allocated bitfield that with a type-level maximum length.
  • BitVector: A heap-allocated bitfield that with a type-level fixed_ length.

These structs are required as SSZ serialization and Merklization rely upon type-level lengths for padding and verification.

Adheres to the Ethereum 2.0 SSZ specification at v0.12.1.

Example

use ssz_types::*;

pub struct Example {
    bit_vector: BitVector<typenum::U8>,
    bit_list: BitList<typenum::U8>,
    variable_list: VariableList<u64, typenum::U8>,
    fixed_vector: FixedVector<u64, typenum::U8>,
}

let mut example = Example {
    bit_vector: Bitfield::new(),
    bit_list: Bitfield::with_capacity(4).unwrap(),
    variable_list: <_>::from(vec![0, 1]),
    fixed_vector: <_>::from(vec![2, 3]),
};

assert_eq!(example.bit_vector.len(), 8);
assert_eq!(example.bit_list.len(), 4);
assert_eq!(&example.variable_list[..], &[0, 1]);
assert_eq!(&example.fixed_vector[..], &[2, 3, 0, 0, 0, 0, 0, 0]);

Dependencies

~6.5–9MB
~263K SLoC