2019-03-04 05:39:37 +00:00
|
|
|
[package]
|
2020-06-19 04:13:23 +00:00
|
|
|
name = "eth2_libp2p"
|
2020-08-06 03:43:05 +00:00
|
|
|
version = "0.2.0"
|
2020-08-04 02:31:41 +00:00
|
|
|
authors = ["Sigma Prime <contact@sigmaprime.io>"]
|
2019-03-04 05:39:37 +00:00
|
|
|
edition = "2018"
|
|
|
|
|
|
|
|
|
|
[dependencies]
|
2021-09-16 04:45:05 +00:00
|
|
|
#discv5 = { version = "0.1.0-beta.10", features = ["libp2p"] }
|
|
|
|
|
discv5 = { git = "https://github.com/sigp/discv5", rev="10247bbd299227fef20233f2f5a8de9780de09ac", features = ["libp2p"] }
|
2021-02-10 23:29:49 +00:00
|
|
|
unsigned-varint = { version = "0.6.0", features = ["codec"] }
|
2020-05-18 11:24:23 +00:00
|
|
|
types = { path = "../../consensus/types" }
|
|
|
|
|
hashset_delay = { path = "../../common/hashset_delay" }
|
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_types = "0.2.1"
|
2020-10-05 08:22:19 +00:00
|
|
|
serde = { version = "1.0.116", features = ["derive"] }
|
|
|
|
|
serde_derive = "1.0.116"
|
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"
|
2019-10-30 01:22:18 +00:00
|
|
|
slog = { version = "2.5.2", features = ["max_level_trace"] }
|
2020-08-04 07:44:53 +00:00
|
|
|
lighthouse_version = { path = "../../common/lighthouse_version" }
|
2021-08-17 01:00:24 +00:00
|
|
|
tokio = { version = "1.10.0", features = ["time", "macros"] }
|
2020-11-28 05:30:57 +00:00
|
|
|
futures = "0.3.7"
|
2021-02-10 23:29:49 +00:00
|
|
|
futures-io = "0.3.7"
|
2020-10-05 08:22:19 +00:00
|
|
|
error-chain = "0.12.4"
|
|
|
|
|
dirs = "3.0.1"
|
2020-05-26 20:34:15 +00:00
|
|
|
fnv = "1.0.7"
|
2019-10-30 01:22:18 +00:00
|
|
|
lazy_static = "1.4.0"
|
2020-05-18 11:24:23 +00:00
|
|
|
lighthouse_metrics = { path = "../../common/lighthouse_metrics" }
|
2021-01-11 23:32:11 +00:00
|
|
|
smallvec = "1.6.1"
|
2021-02-10 23:29:49 +00:00
|
|
|
tokio-io-timeout = "1.1.1"
|
2020-10-05 08:22:19 +00:00
|
|
|
lru = "0.6.0"
|
2020-07-06 01:55:56 +00:00
|
|
|
parking_lot = "0.11.0"
|
|
|
|
|
sha2 = "0.9.1"
|
2020-10-05 08:22:19 +00:00
|
|
|
base64 = "0.13.0"
|
|
|
|
|
snap = "1.0.1"
|
2020-04-19 10:45:25 +00:00
|
|
|
void = "1.0.2"
|
2020-10-05 07:45:54 +00:00
|
|
|
hex = "0.4.2"
|
2021-02-10 23:29:49 +00:00
|
|
|
tokio-util = { version = "0.6.2", features = ["codec", "compat", "time"] }
|
2020-05-17 11:16:48 +00:00
|
|
|
tiny-keccak = "2.0.2"
|
2020-10-05 07:45:54 +00:00
|
|
|
task_executor = { path = "../../common/task_executor" }
|
2020-07-23 03:55:36 +00:00
|
|
|
rand = "0.7.3"
|
2020-09-29 00:02:44 +00:00
|
|
|
directory = { path = "../../common/directory" }
|
2020-09-10 04:43:22 +00:00
|
|
|
regex = "1.3.9"
|
2021-08-17 01:00:24 +00:00
|
|
|
strum = { version = "0.21.0", features = ["derive"] }
|
2021-08-04 01:44:57 +00:00
|
|
|
superstruct = "0.2.0"
|
2020-05-17 11:16:48 +00:00
|
|
|
|
2021-08-12 01:59:20 +00:00
|
|
|
# TODO: remove the rev-reference and go back to release versions once there is a release that
|
|
|
|
|
# includes the following PR:
|
|
|
|
|
#
|
|
|
|
|
# https://github.com/libp2p/rust-libp2p/pull/2175
|
2020-05-17 11:16:48 +00:00
|
|
|
[dependencies.libp2p]
|
2021-07-15 00:53:59 +00:00
|
|
|
#version = "0.39.1"
|
|
|
|
|
#default-features = false
|
2021-08-12 01:59:20 +00:00
|
|
|
git = "https://github.com/libp2p/rust-libp2p"
|
|
|
|
|
rev = "ce23cbe76a0382b6fcb0e49f1b2612df86f6465d"
|
2021-06-03 01:11:33 +00:00
|
|
|
features = ["websocket", "identify", "mplex", "yamux", "noise", "gossipsub", "dns-tokio", "tcp-tokio"]
|
2019-11-27 01:47:46 +00:00
|
|
|
|
|
|
|
|
[dev-dependencies]
|
2021-08-17 01:00:24 +00:00
|
|
|
tokio = { version = "1.10.0", features = ["full"] }
|
2020-10-05 08:22:19 +00:00
|
|
|
slog-term = "2.6.0"
|
2020-05-17 11:16:48 +00:00
|
|
|
slog-async = "2.5.0"
|
2021-01-06 06:36:11 +00:00
|
|
|
tempfile = "3.1.0"
|
2020-06-06 06:39:42 +00:00
|
|
|
exit-future = "0.2.0"
|
2020-06-18 07:42:42 +00:00
|
|
|
|
|
|
|
|
[features]
|
|
|
|
|
libp2p-websocket = []
|
