update ping protocol to use MetaData

This commit is contained in:
Danny Ryan 2020-03-25 11:57:37 -06:00
parent f227e026fa
commit d5a9af6469
No known key found for this signature in database
GPG Key ID: 2765A792E42CE07A
2 changed files with 36 additions and 22 deletions

View File

@ -28,6 +28,7 @@ It consists of four main sections:
- [Multiplexing](#multiplexing) - [Multiplexing](#multiplexing)
- [Eth2 network interaction domains](#eth2-network-interaction-domains) - [Eth2 network interaction domains](#eth2-network-interaction-domains)
- [Configuration](#configuration) - [Configuration](#configuration)
- [MetaData](#metadata)
- [The gossip domain: gossipsub](#the-gossip-domain-gossipsub) - [The gossip domain: gossipsub](#the-gossip-domain-gossipsub)
- [Topics and messages](#topics-and-messages) - [Topics and messages](#topics-and-messages)
- [Global topics](#global-topics) - [Global topics](#global-topics)
@ -49,6 +50,8 @@ It consists of four main sections:
- [Goodbye](#goodbye) - [Goodbye](#goodbye)
- [BeaconBlocksByRange](#beaconblocksbyrange) - [BeaconBlocksByRange](#beaconblocksbyrange)
- [BeaconBlocksByRoot](#beaconblocksbyroot) - [BeaconBlocksByRoot](#beaconblocksbyroot)
- [Ping](#ping)
- [GetMetaData](#getmetadata)
- [The discovery domain: discv5](#the-discovery-domain-discv5) - [The discovery domain: discv5](#the-discovery-domain-discv5)
- [Integration into libp2p stacks](#integration-into-libp2p-stacks) - [Integration into libp2p stacks](#integration-into-libp2p-stacks)
- [ENR structure](#enr-structure) - [ENR structure](#enr-structure)
@ -195,6 +198,22 @@ This section outlines constants that are used in this spec.
| `ATTESTATION_PROPAGATION_SLOT_RANGE` | `32` | The maximum number of slots during which an attestation can be propagated. | | `ATTESTATION_PROPAGATION_SLOT_RANGE` | `32` | The maximum number of slots during which an attestation can be propagated. |
| `MAXIMUM_GOSSIP_CLOCK_DISPARITY` | `500ms` | The maximum milliseconds of clock disparity assumed between honest nodes. | | `MAXIMUM_GOSSIP_CLOCK_DISPARITY` | `500ms` | The maximum milliseconds of clock disparity assumed between honest nodes. |
## MetaData
Clients MUST locally store the following `MetaData`:
```
(
seq_number: uint64
attnets: Bitvector[ATTESTATION_SUBNET_COUNT]
)
```
Where
- `seq_number` is a `uint64` starting at `0` used to version the node's metadata. If any other field in the local `MetaData` changes, the node MUST increment `seq_number` by 1.
- `attnets` is a `Bitvector` representing the node's persistent attestation subnet subscriptions.
## The gossip domain: gossipsub ## The gossip domain: gossipsub
Clients MUST support the [gossipsub](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) libp2p protocol. Clients MUST support the [gossipsub](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) libp2p protocol.
@ -621,44 +640,35 @@ Response Content:
) )
``` ```
Sent intermittently, the PING protocol checks liveness of connected peers. Sent intermittently, the `Ping` protocol checks liveness of connected peers.
Peers send and respond with their local ENR sequence number. Peers send and respond with their local metadata sequence number (`MetaData.seq_number`).
A client may then determine if their local record of a peer's ENR is up to date If the peer does not respond to the `Ping` request, the client MAY disconnect from the peer.
and may request an updated version via the ENR RPC method if not.
A client can then determine if their local record of a peer's MetaData is up to date
and MAY request an updated version via the `MetaData` RPC method if not.
The request MUST be encoded as an SSZ-field. The request MUST be encoded as an SSZ-field.
The response MUST consist of a single `response_chunk`. The response MUST consist of a single `response_chunk`.
#### Enr #### GetMetaData
**Protocol ID:** `/eth2/beacon_chain/req/enr/1/` **Protocol ID:** `/eth2/beacon_chain/req/metadata/1/`
No Request Content. No Request Content.
Response Content: Response Content:
``` ```
( (
enr: Bytes, MetaData
subnet_expiries: []Slot
) )
``` ```
Requests the ENR of a peer. The request opens and negotiates the stream without Requests the MetaData of a peer. The request opens and negotiates the stream without
sending any request content. Once established the receiving peer responds with sending any request content. Once established the receiving peer responds with
it's local up-to-date ENR along with a list of `Slot` corresponding to it's local most up-to-date MetaData.
the expiry of all long-lived subnets specified by the `attnets` field in the
sent ENR.
The `subnet_expiries` list MUST have a length corresponding to the number of
true values in the `attnets` bitfield. The order of the slots in `subnet_expiries`
MUST correspond to the order of long-lived subnets specified in the `attnets`
bitfield.
The `enr` field represents the rlp-encoded bytes of the local ENR.
The response MUST be encoded as an SSZ-container. The response MUST be encoded as an SSZ-container.
@ -693,12 +703,16 @@ Specifications of these parameters can be found in the [ENR Specification](http:
#### Attestation subnet bitfield #### Attestation subnet bitfield
The ENR MAY contain an entry (`attnets`) signifying the attestation subnet bitfield with the following form to more easily discover peers participating in particular attestation gossip subnets. The ENR `attnets` entry signifies the attestation subnet bitfield with the following form to more easily discover peers participating in particular attestation gossip subnets.
| Key | Value | | Key | Value |
|:-------------|:-------------------------------------------------| |:-------------|:-------------------------------------------------|
| `attnets` | SSZ `Bitvector[ATTESTATION_SUBNET_COUNT]` | | `attnets` | SSZ `Bitvector[ATTESTATION_SUBNET_COUNT]` |
If a node's `MetaData.attnets` has any non-zero bit, the ENR MUST include the `attnets` entry with the same value as `MetaData.attnets`.
If a node's `MetaData.attnets` is composed of all zeros, the ENR MAY optionally include the `attnets` entry or leave it out entirely.
#### Interop #### Interop
In the interoperability testnet, all peers will support all capabilities defined in this document (gossip, full Req/Resp suite, discovery protocol), therefore the ENR record does not need to carry Eth2 capability information, as it would be superfluous. In the interoperability testnet, all peers will support all capabilities defined in this document (gossip, full Req/Resp suite, discovery protocol), therefore the ENR record does not need to carry Eth2 capability information, as it would be superfluous.

View File

@ -202,7 +202,7 @@ Specifically a validator should:
* Call `get_committee_assignment(state, next_epoch, validator_index)` when checking for next epoch assignments. * Call `get_committee_assignment(state, next_epoch, validator_index)` when checking for next epoch assignments.
* Join the pubsub topic -- `committee_index{committee_index % ATTESTATION_SUBNET_COUNT}_beacon_attestation`. * Join the pubsub topic -- `committee_index{committee_index % ATTESTATION_SUBNET_COUNT}_beacon_attestation`.
* For any current peer subscribed to the topic, the validator simply sends a `subscribe` message for the new topic. * For any current peer subscribed to the topic, the validator simply sends a `subscribe` message for the new topic.
* If an _insufficient_ number of current peers are subscribed to the topic, the validator must discover new peers on this topic. Via the discovery protocol, find peers with an ENR containing the `attnets` entry such that `ENR["attnets"][committee_index % ATTESTATION_SUBNET_COUNT] == True`. * If an _insufficient_ number of current peers are subscribed to the topic, the validator must discover new peers on this topic. Via the discovery protocol, find peers with an ENR containing the `attnets` entry such that `ENR["attnets"][committee_index % ATTESTATION_SUBNET_COUNT] == True`. Then validate that the peers are still persisted on the desired topic by sending a `GetMetaData` and checking the resulting `attnets` field.
## Beacon chain responsibilities ## Beacon chain responsibilities