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.
71 lines
2.0 KiB
TOML
71 lines
2.0 KiB
TOML
[package]
|
|
name = "types"
|
|
version = "0.2.0"
|
|
authors = ["Paul Hauner <paul@paulhauner.com>", "Age Manning <Age@AgeManning.com>"]
|
|
edition = "2018"
|
|
|
|
[[bench]]
|
|
name = "benches"
|
|
harness = false
|
|
|
|
[dependencies]
|
|
bls = { path = "../../crypto/bls" }
|
|
compare_fields = { path = "../../common/compare_fields" }
|
|
compare_fields_derive = { path = "../../common/compare_fields_derive" }
|
|
eth2_interop_keypairs = { path = "../../common/eth2_interop_keypairs" }
|
|
ethereum-types = "0.11.0"
|
|
eth2_hashing = "0.2.0"
|
|
hex = "0.4.2"
|
|
int_to_bytes = { path = "../int_to_bytes" }
|
|
log = "0.4.11"
|
|
merkle_proof = { path = "../merkle_proof" }
|
|
rayon = "1.4.1"
|
|
rand = "0.7.3"
|
|
safe_arith = { path = "../safe_arith" }
|
|
serde = {version = "1.0.116" , features = ["rc"] }
|
|
serde_derive = "1.0.116"
|
|
slog = "2.5.2"
|
|
eth2_ssz = "0.4.0"
|
|
eth2_ssz_derive = "0.3.0"
|
|
eth2_ssz_types = "0.2.1"
|
|
swap_or_not_shuffle = { path = "../swap_or_not_shuffle" }
|
|
test_random_derive = { path = "../../common/test_random_derive" }
|
|
tree_hash = "0.4.0"
|
|
tree_hash_derive = "0.4.0"
|
|
rand_xorshift = "0.2.0"
|
|
cached_tree_hash = { path = "../cached_tree_hash" }
|
|
serde_yaml = "0.8.13"
|
|
tempfile = "3.1.0"
|
|
derivative = "2.1.1"
|
|
rusqlite = { version = "0.25.3", features = ["bundled"], optional = true }
|
|
arbitrary = { version = "0.4.6", features = ["derive"], optional = true }
|
|
eth2_serde_utils = "0.1.0"
|
|
regex = "1.3.9"
|
|
lazy_static = "1.4.0"
|
|
parking_lot = "0.11.1"
|
|
itertools = "0.10.0"
|
|
superstruct = "0.2.0"
|
|
|
|
[dev-dependencies]
|
|
serde_json = "1.0.58"
|
|
criterion = "0.3.3"
|
|
beacon_chain = { path = "../../beacon_node/beacon_chain" }
|
|
eth2_interop_keypairs = { path = "../../common/eth2_interop_keypairs" }
|
|
state_processing = { path = "../state_processing" }
|
|
|
|
[features]
|
|
default = ["sqlite", "legacy-arith"]
|
|
# Allow saturating arithmetic on slots and epochs. Enabled by default, but deprecated.
|
|
legacy-arith = []
|
|
sqlite = ["rusqlite"]
|
|
arbitrary-fuzz = [
|
|
"arbitrary",
|
|
"ethereum-types/arbitrary",
|
|
"bls/arbitrary",
|
|
"eth2_ssz/arbitrary",
|
|
"eth2_ssz_types/arbitrary",
|
|
"merkle_proof/arbitrary",
|
|
"swap_or_not_shuffle/arbitrary",
|
|
"tree_hash/arbitrary",
|
|
]
|