Add networking specs
This commit is contained in:
Matthew Slipper
parent
9ee7ed061e
commit
e4a1ef16e6
|
|
@ -0,0 +1,41 @@
|
|||
ETH 2.0 Networking Spec - Messaging
|
||||
===
|
||||
|
||||
# Abstract
|
||||
|
||||
This specification describes how individual Ethereum 2.0 messages are represented on the wire.
|
||||
|
||||
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL”, NOT", “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
|
||||
|
||||
# Motivation
|
||||
|
||||
This specification seeks to define a messaging protocol that is flexible enough to be changed easily as the ETH 2.0 specification evolves.
|
||||
|
||||
# Specification
|
||||
|
||||
## Message Structure
|
||||
|
||||
An ETH 2.0 message consists of a single byte representing the message version followed by the encoded, potentially compressed body. We separate the message's version from the version included in the `libp2p` protocol path in order to allow encoding and compression schemes to be updated independently of the `libp2p` protocols themselves.
|
||||
|
||||
It is unlikely that more than 255 message versions will need to be supported, so a single byte should suffice.
|
||||
|
||||
Visually, a message looks like this:
|
||||
|
||||
```
|
||||
+--------------------------+
|
||||
| version byte |
|
||||
+--------------------------+
|
||||
| |
|
||||
| body |
|
||||
| |
|
||||
+--------------------------+
|
||||
```
|
||||
|
||||
Clients MUST ignore messages with mal-formed bodies. The `version` byte MUST be one of the below values:
|
||||
|
||||
## Version Byte Values
|
||||
|
||||
### `0x01`
|
||||
|
||||
- **Encoding Scheme:** SSZ
|
||||
- **Compression Scheme:** Snappy
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
ETH 2.0 Networking Spec - Node Identification
|
||||
===
|
||||
|
||||
# Abstract
|
||||
|
||||
This specification describes how Ethereum 2.0 nodes identify and address each other on the network.
|
||||
|
||||
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL", NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
|
||||
|
||||
# Specification
|
||||
|
||||
Clients use Ethereum Node Records (as described in [EIP-778](http://eips.ethereum.org/EIPS/eip-778)) to discover one another. Each ENR includes, among other things, the following keys:
|
||||
|
||||
- The node's IP.
|
||||
- The node's TCP port.
|
||||
- The node's public key.
|
||||
|
||||
For clients to be addressable, their ENR responses MUST contain all of the above keys. Client MUST verify the signature of any received ENRs, and disconnect from peers whose ENR signatures are invalid. Each node's public key MUST be unique.
|
||||
|
||||
The keys above are enough to construct a [multiaddr](https://github.com/multiformats/multiaddr) for use with the rest of the `libp2p` stack.
|
||||
|
||||
It is RECOMMENDED that clients set their TCP port to the default of `9000`.
|
||||
|
||||
## Peer ID Generation
|
||||
|
||||
The `libp2p` networking stack identifies peers via a "peer ID." Simply put, a node's Peer ID is the SHA2-256 `multihash` of the node's public key. `go-libp2p-crypto` contains the canonical implementation of how to hash `secp256k1` keys for use as a peer ID.
|
||||
|
||||
# See Also
|
||||
|
||||
- [multiaddr](https://github.com/multiformats/multiaddr)
|
||||
- [multihash](https://multiformats.io/multihash/)
|
||||
- [go-libp2p-crypto](https://github.com/libp2p/go-libp2p-crypto)
|
||||
|
|
@ -0,0 +1,246 @@
|
|||
ETH 2.0 Networking Spec - RPC Interface
|
||||
===
|
||||
|
||||
# Abstract
|
||||
|
||||
The Ethereum 2.0 networking stack uses two modes of communication: a broadcast protocol that gossips information to interested parties via GossipSub, and an RPC protocol that retrieves information from specific clients. This specification defines the RPC protocol.
|
||||
|
||||
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL", NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
|
||||
|
||||
# Dependencies
|
||||
|
||||
This specification assumes familiarity with the [Messaging](./messaging.md), [Node Identification](./node-identification), and [Beacon Chain](../core/0_beacon-chain.md) specifications.
|
||||
|
||||
# Specification
|
||||
|
||||
## Message Schemas
|
||||
|
||||
Message body schemas are notated like this:
|
||||
|
||||
```
|
||||
(
|
||||
field_name_1: type
|
||||
field_name_2: type
|
||||
)
|
||||
```
|
||||
|
||||
SSZ serialization is field-order dependent. Therefore, fields MUST be encoded and decoded according to the order described in this document. The encoded values of each field are concatenated to form the final encoded message body. Embedded structs are serialized as Containers unless otherwise noted.
|
||||
|
||||
All referenced data structures can be found in the [0-beacon-chain](https://github.com/ethereum/eth2.0-specs/blob/dev/specs/core/0_beacon-chain.md#data-structures) specification.
|
||||
|
||||
## `libp2p` Protocol Names
|
||||
|
||||
A "Protocol Name" in `libp2p` parlance refers to a human-readable identifier `libp2p` uses in order to identify sub-protocols and stream messages of different types over the same connection. A client's supported protocol paths are negotiated by the `libp2p` stack at connection time; as such they are not part of individual message bodies.
|
||||
|
||||
## RPC-Over-`libp2p`
|
||||
|
||||
To facilitate RPC-over-`libp2p`, a single protocol path is used: `/eth/serenity/rpc/1.0.0`. Remote method calls are wrapped in a "request" structure:
|
||||
|
||||
```
|
||||
(
|
||||
id: uint64
|
||||
method_id: uint16
|
||||
body: Request
|
||||
)
|
||||
```
|
||||
|
||||
and their corresponding responses are wrapped in a "response" structure:
|
||||
|
||||
```
|
||||
(
|
||||
id: uint64
|
||||
result: Response
|
||||
)
|
||||
```
|
||||
|
||||
If an error occurs, a variant of the response structure is returned:
|
||||
|
||||
```
|
||||
(
|
||||
id: uint64
|
||||
error: (
|
||||
code: uint16
|
||||
data: bytes
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
The details of the RPC-Over-`libp2p` protocol are similar to [JSON-RPC 2.0](https://www.jsonrpc.org/specification). Specifically:
|
||||
|
||||
1. The `id` member is REQUIRED.
|
||||
2. The `id` member in the response MUST be the same as the value of the `id` in the request.
|
||||
3. The `method_id` member is REQUIRED.
|
||||
4. The `result` member is required on success, and MUST NOT exist if there was an error.
|
||||
5. The `error` member is REQUIRED on errors, and MUST NOT exist if there wasn't an error.
|
||||
|
||||
Structuring RPC requests in this manner allows multiple calls and responses to be multiplexed over the same stream without switching.
|
||||
|
||||
The "method ID" fields in the below messages refer to the `method` field in the request structure above.
|
||||
|
||||
The first 1,000 values in `error.code` are reserved for system use. The following error codes are predefined:
|
||||
|
||||
1. `0`: Parse error.
|
||||
2. `10`: Invalid request.
|
||||
3. `20`: Method not found.
|
||||
4. `30`: Server error.
|
||||
|
||||
## Messages
|
||||
|
||||
### Hello
|
||||
|
||||
**Method ID:** `0`
|
||||
|
||||
**Body**:
|
||||
|
||||
```
|
||||
(
|
||||
network_id: uint8
|
||||
latest_finalized_root: bytes32
|
||||
latest_finalized_epoch: uint64
|
||||
best_root: bytes32
|
||||
best_slot: uint64
|
||||
)
|
||||
```
|
||||
|
||||
Clients exchange `hello` messages upon connection, forming a two-phase handshake. The first message the initiating client sends MUST be the `hello` message. In response, the receiving client MUST respond with its own `hello` message.
|
||||
|
||||
Clients SHOULD immediately disconnect from one another following the handshake above under the following conditions:
|
||||
|
||||
1. If `network_id` belongs to a different chain, since the client definitionally cannot sync with this client.
|
||||
2. If the `latest_finalized_root` shared by the peer is not in the client's chain at the expected epoch. For example, if Peer 1 in the diagram below has `(root, epoch)` of `(A, 5)` and Peer 2 has `(B, 3)`, Peer 1 would disconnect because it knows that `B` is not the root in their chain at epoch 3:
|
||||
|
||||
```
|
||||
Root A
|
||||
|
||||
+---+
|
||||
|xxx| +----+ Epoch 5
|
||||
+-+-+
|
||||
^
|
||||
|
|
||||
+-+-+
|
||||
| | +----+ Epoch 4
|
||||
+-+-+
|
||||
Root B ^
|
||||
|
|
||||
+---+ +-+-+
|
||||
|xxx+<---+--->+ | +----+ Epoch 3
|
||||
+---+ | +---+
|
||||
|
|
||||
+-+-+
|
||||
| | +-----------+ Epoch 2
|
||||
+-+-+
|
||||
^
|
||||
|
|
||||
+-+-+
|
||||
| | +-----------+ Epoch 1
|
||||
+---+
|
||||
```
|
||||
|
||||
Once the handshake completes, the client with the higher `latest_finalized_epoch` or `best_slot` (if the clients have equal `latest_finalized_epoch`s) SHOULD send beacon block roots to its counterparty via `beacon_block_roots` (i.e., RPC method `10`).
|
||||
|
||||
### Goodbye
|
||||
|
||||
**Method ID:** `1`
|
||||
|
||||
**Body:**
|
||||
|
||||
```
|
||||
(
|
||||
reason: uint64
|
||||
)
|
||||
```
|
||||
|
||||
Client MAY send `goodbye` messages upon disconnection. The reason field MUST be one of the following values:
|
||||
|
||||
- `1`: Client shut down.
|
||||
- `2`: Irrelevant network.
|
||||
- `3`: Irrelevant shard.
|
||||
|
||||
### Provide Beacon Block Roots
|
||||
|
||||
**Method ID:** `10`
|
||||
|
||||
**Body:**
|
||||
|
||||
```
|
||||
# BlockRootSlot
|
||||
(
|
||||
block_root: HashTreeRoot
|
||||
slot: uint64
|
||||
)
|
||||
|
||||
(
|
||||
roots: []BlockRootSlot
|
||||
)
|
||||
```
|
||||
|
||||
Send a list of block roots and slots to the peer.
|
||||
|
||||
### Beacon Block Headers
|
||||
|
||||
**Method ID:** `11`
|
||||
|
||||
**Request Body**
|
||||
|
||||
```
|
||||
(
|
||||
start_root: HashTreeRoot
|
||||
start_slot: uint64
|
||||
max_headers: uint64
|
||||
skip_slots: uint64
|
||||
)
|
||||
```
|
||||
|
||||
**Response Body:**
|
||||
|
||||
```
|
||||
(
|
||||
headers: []BlockHeader
|
||||
)
|
||||
```
|
||||
|
||||
Requests beacon block headers from the peer starting from `(start_root, start_slot)`. The response MUST contain no more than `max_headers` headers. `skip_slots` defines the maximum number of slots to skip between blocks. For example, requesting blocks starting at slots `2` a `skip_slots` value of `2` would return the blocks at `[2, 4, 6, 8, 10]`. In cases where a slot is undefined for a given slot number, the closest previous block MUST be returned. For example, if slot `4` were undefined in the previous example, the returned array would contain `[2, 3, 6, 8, 10]`. If slot three were further undefined, the array would contain `[2, 6, 8, 10]` - i.e., duplicate blocks MUST be collapsed.
|
||||
|
||||
The function of the `skip_slots` parameter helps facilitate light client sync - for example, in [#459](https://github.com/ethereum/eth2.0-specs/issues/459) - and allows clients to balance the peers from whom they request headers. Client could, for instance, request every 10th block from a set of peers where each per has a different starting block in order to populate block data.
|
||||
|
||||
### Beacon Block Bodies
|
||||
|
||||
**Method ID:** `12`
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```
|
||||
(
|
||||
block_roots: []HashTreeRoot
|
||||
)
|
||||
```
|
||||
|
||||
**Response Body:**
|
||||
|
||||
```
|
||||
(
|
||||
block_bodies: []BeaconBlockBody
|
||||
)
|
||||
```
|
||||
|
||||
Requests the `block_bodies` associated with the provided `block_roots` from the peer. Responses MUST return `block_roots` in the order provided in the request. If the receiver does not have a particular `block_root`, it must return a zero-value `block_body` (i.e., a `block_body` container with all zero fields).
|
||||
|
||||
### Beacon Chain State
|
||||
|
||||
**Note:** This section is preliminary, pending the definition of the data structures to be transferred over the wire during fast sync operations.
|
||||
|
||||
**Method ID:** `13`
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```
|
||||
(
|
||||
hashes: []HashTreeRoot
|
||||
)
|
||||
```
|
||||
|
||||
**Response Body:** TBD
|
||||
|
||||
Requests contain the hashes of Merkle tree nodes that when merkelized yield the block's `state_root`.
|
||||
|
||||
The response will contain the values that, when hashed, yield the hashes inside the request body.
|
||||
Loading…
Reference in New Issue