fe52322088
## Issue Addressed NA ## Proposed Changes Implements the "union" type from the SSZ spec for `ssz`, `ssz_derive`, `tree_hash` and `tree_hash_derive` so it may be derived for `enums`: https://github.com/ethereum/consensus-specs/blob/v1.1.0-beta.3/ssz/simple-serialize.md#union The union type is required for the merge, since the `Transaction` type is defined as a single-variant union `Union[OpaqueTransaction]`. ### Crate Updates This PR will (hopefully) cause CI to publish new versions for the following crates: - `eth2_ssz_derive`: `0.2.1` -> `0.3.0` - `eth2_ssz`: `0.3.0` -> `0.4.0` - `eth2_ssz_types`: `0.2.0` -> `0.2.1` - `tree_hash`: `0.3.0` -> `0.4.0` - `tree_hash_derive`: `0.3.0` -> `0.4.0` These these crates depend on each other, I've had to add a workspace-level `[patch]` for these crates. A follow-up PR will need to remove this patch, ones the new versions are published. ### Union Behaviors We already had SSZ `Encode` and `TreeHash` derive for enums, however it just did a "transparent" pass-through of the inner value. Since the "union" decoding from the spec is in conflict with the transparent method, I've required that all `enum` have exactly one of the following enum-level attributes: #### SSZ - `#[ssz(enum_behaviour = "union")]` - matches the spec used for the merge - `#[ssz(enum_behaviour = "transparent")]` - maintains existing functionality - not supported for `Decode` (never was) #### TreeHash - `#[tree_hash(enum_behaviour = "union")]` - matches the spec used for the merge - `#[tree_hash(enum_behaviour = "transparent")]` - maintains existing functionality This means that we can maintain the existing transparent behaviour, but all existing users will get a compile-time error until they explicitly opt-in to being transparent. ### Legacy Option Encoding Before this PR, we already had a union-esque encoding for `Option<T>`. However, this was with the *old* SSZ spec where the union selector was 4 bytes. During merge specification, the spec was changed to use 1 byte for the selector. Whilst the 4-byte `Option` encoding was never used in the spec, we used it in our database. Writing a migrate script for all occurrences of `Option` in the database would be painful, especially since it's used in the `CommitteeCache`. To avoid the migrate script, I added a serde-esque `#[ssz(with = "module")]` field-level attribute to `ssz_derive` so that we can opt into the 4-byte encoding on a field-by-field basis. The `ssz::legacy::four_byte_impl!` macro allows a one-liner to define the module required for the `#[ssz(with = "module")]` for some `Option<T> where T: Encode + Decode`. Notably, **I have removed `Encode` and `Decode` impls for `Option`**. I've done this to force a break on downstream users. Like I mentioned, `Option` isn't used in the spec so I don't think it'll be *that* annoying. I think it's nicer than quietly having two different union implementations or quietly breaking the existing `Option` impl. ### Crate Publish Ordering I've modified the order in which CI publishes crates to ensure that we don't publish a crate without ensuring we already published a crate that it depends upon. ## TODO - [ ] Queue a follow-up `[patch]`-removing PR.
72 lines
2.1 KiB
Rust
72 lines
2.1 KiB
Rust
//! Provides encoding (serialization) and decoding (deserialization) in the SimpleSerialize (SSZ)
|
|
//! format designed for use in Ethereum 2.0.
|
|
//!
|
|
//! Adheres to the Ethereum 2.0 [SSZ
|
|
//! specification](https://github.com/ethereum/eth2.0-specs/blob/v0.12.1/ssz/simple-serialize.md)
|
|
//! at v0.12.1.
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! ```rust
|
|
//! use ssz_derive::{Encode, Decode};
|
|
//! use ssz::{Decode, Encode};
|
|
//!
|
|
//! #[derive(PartialEq, Debug, Encode, Decode)]
|
|
//! struct Foo {
|
|
//! a: u64,
|
|
//! b: Vec<u16>,
|
|
//! }
|
|
//!
|
|
//! fn ssz_encode_decode_example() {
|
|
//! let foo = Foo {
|
|
//! a: 42,
|
|
//! b: vec![1, 3, 3, 7]
|
|
//! };
|
|
//!
|
|
//! let ssz_bytes: Vec<u8> = foo.as_ssz_bytes();
|
|
//!
|
|
//! let decoded_foo = Foo::from_ssz_bytes(&ssz_bytes).unwrap();
|
|
//!
|
|
//! assert_eq!(foo, decoded_foo);
|
|
//! }
|
|
//!
|
|
//! ```
|
|
//!
|
|
//! See `examples/` for manual implementations of the `Encode` and `Decode` traits.
|
|
|
|
mod decode;
|
|
mod encode;
|
|
pub mod legacy;
|
|
mod union_selector;
|
|
|
|
pub use decode::{
|
|
impls::decode_list_of_variable_length_items, read_offset, split_union_bytes, Decode,
|
|
DecodeError, SszDecoder, SszDecoderBuilder,
|
|
};
|
|
pub use encode::{encode_length, Encode, SszEncoder};
|
|
pub use union_selector::UnionSelector;
|
|
|
|
/// The number of bytes used to represent an offset.
|
|
pub const BYTES_PER_LENGTH_OFFSET: usize = 4;
|
|
/// The maximum value that can be represented using `BYTES_PER_LENGTH_OFFSET`.
|
|
#[cfg(target_pointer_width = "32")]
|
|
pub const MAX_LENGTH_VALUE: usize = (std::u32::MAX >> (8 * (4 - BYTES_PER_LENGTH_OFFSET))) as usize;
|
|
#[cfg(target_pointer_width = "64")]
|
|
pub const MAX_LENGTH_VALUE: usize = (std::u64::MAX >> (8 * (8 - BYTES_PER_LENGTH_OFFSET))) as usize;
|
|
|
|
/// The number of bytes used to indicate the variant of a union.
|
|
pub const BYTES_PER_UNION_SELECTOR: usize = 1;
|
|
/// The highest possible union selector value (higher values are reserved for backwards compatible
|
|
/// extensions).
|
|
pub const MAX_UNION_SELECTOR: u8 = 127;
|
|
|
|
/// Convenience function to SSZ encode an object supporting ssz::Encode.
|
|
///
|
|
/// Equivalent to `val.as_ssz_bytes()`.
|
|
pub fn ssz_encode<T>(val: &T) -> Vec<u8>
|
|
where
|
|
T: Encode,
|
|
{
|
|
val.as_ssz_bytes()
|
|
}
|