2020-09-29 03:46:54 +00:00
|
|
|
[package]
|
|
|
|
|
name = "eth2"
|
|
|
|
|
version = "0.1.0"
|
|
|
|
|
authors = ["Paul Hauner <paul@paulhauner.com>"]
|
|
|
|
|
edition = "2018"
|
|
|
|
|
|
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
|
|
|
|
|
|
[dependencies]
|
2020-10-05 08:22:19 +00:00
|
|
|
serde = { version = "1.0.116", features = ["derive"] }
|
|
|
|
|
serde_json = "1.0.58"
|
2020-09-29 03:46:54 +00:00
|
|
|
types = { path = "../../consensus/types" }
|
|
|
|
|
hex = "0.4.2"
|
2021-02-10 23:29:49 +00:00
|
|
|
reqwest = { version = "0.11.0", features = ["json","stream"] }
|
2020-09-29 03:46:54 +00:00
|
|
|
eth2_libp2p = { path = "../../beacon_node/eth2_libp2p" }
|
|
|
|
|
proto_array = { path = "../../consensus/proto_array", optional = true }
|
2021-09-03 01:10:25 +00:00
|
|
|
eth2_serde_utils = "0.1.0"
|
2021-09-25 05:58:37 +00:00
|
|
|
zeroize = { version = "1.4.2", features = ["zeroize_derive"] }
|
2020-10-02 09:42:19 +00:00
|
|
|
eth2_keystore = { path = "../../crypto/eth2_keystore" }
|
2021-08-12 01:59:20 +00:00
|
|
|
libsecp256k1 = "0.6.0"
|
2020-12-14 02:28:19 +00:00
|
|
|
ring = "0.16.19"
|
2021-02-10 23:29:49 +00:00
|
|
|
bytes = "1.0.1"
|
2020-10-02 09:42:19 +00:00
|
|
|
account_utils = { path = "../../common/account_utils" }
|
2021-05-04 01:59:51 +00:00
|
|
|
sensitive_url = { path = "../../common/sensitive_url" }
|
Implement SSZ union type (#2579)
## 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.
2021-09-25 05:58:36 +00:00
|
|
|
eth2_ssz = "0.4.0"
|
|
|
|
|
eth2_ssz_derive = "0.3.0"
|
2020-12-04 00:18:58 +00:00
|
|
|
futures-util = "0.3.8"
|
|
|
|
|
futures = "0.3.8"
|
2021-09-22 00:37:28 +00:00
|
|
|
store = { path = "../../beacon_node/store", optional = true }
|
2020-09-29 03:46:54 +00:00
|
|
|
|
|
|
|
|
[target.'cfg(target_os = "linux")'.dependencies]
|
2020-10-05 08:22:19 +00:00
|
|
|
psutil = { version = "3.2.0", optional = true }
|
2020-09-29 03:46:54 +00:00
|
|
|
procinfo = { version = "0.4.2", optional = true }
|
|
|
|
|
|
|
|
|
|
[features]
|
|
|
|
|
default = ["lighthouse"]
|
2021-09-22 00:37:28 +00:00
|
|
|
lighthouse = ["proto_array", "psutil", "procinfo", "store"]
|
