diff --git a/specs/_features/das/p2p-interface.md b/specs/_features/das/p2p-interface.md index 6372c481e..2c165078d 100644 --- a/specs/_features/das/p2p-interface.md +++ b/specs/_features/das/p2p-interface.md @@ -28,8 +28,6 @@ - - ## Introduction For an introduction about DAS itself, see [the DAS participation spec](sampling.md#data-availability-sampling). diff --git a/specs/_features/eip7594/p2p-interface.md b/specs/_features/eip7594/p2p-interface.md index ad08cf69f..a2a452384 100644 --- a/specs/_features/eip7594/p2p-interface.md +++ b/specs/_features/eip7594/p2p-interface.md @@ -8,6 +8,7 @@ +- [Introduction](#introduction) - [Modifications in EIP-7594](#modifications-in-eip-7594) - [Preset](#preset) - [Configuration](#configuration) @@ -40,6 +41,12 @@ +## Introduction + +This document contains the consensus-layer networking specification for EIP7594. + +The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. + ## Modifications in EIP-7594 ### Preset diff --git a/specs/_features/eip7732/p2p-interface.md b/specs/_features/eip7732/p2p-interface.md index a1dd1a259..df02cc238 100644 --- a/specs/_features/eip7732/p2p-interface.md +++ b/specs/_features/eip7732/p2p-interface.md @@ -1,10 +1,9 @@ # EIP-7732 -- Networking -This document contains the consensus-layer networking specification for EIP7732. - +- [Introduction](#introduction) - [Modification in EIP-7732](#modification-in-eip-7732) - [Preset](#preset) - [Configuration](#configuration) @@ -28,6 +27,12 @@ This document contains the consensus-layer networking specification for EIP7732. +## Introduction + +This document contains the consensus-layer networking specification for EIP7732. + +The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. + ## Modification in EIP-7732 ### Preset diff --git a/specs/altair/p2p-interface.md b/specs/altair/p2p-interface.md index 5b0c938df..f70e4e9b1 100644 --- a/specs/altair/p2p-interface.md +++ b/specs/altair/p2p-interface.md @@ -1,18 +1,12 @@ # Altair -- Networking -This document contains the networking specification for Altair. -This document should be viewed as additive to the [document from Phase 0](../phase0/p2p-interface.md) and will be referred to as the "Phase 0 document" hereafter. -Readers should understand the Phase 0 document and use it as a basis to understand the changes outlined in this document. - -Altair adds new messages, topics and data to the Req-Resp, Gossip and Discovery domain. Some Phase 0 features will be deprecated, but not removed immediately. - - ## Table of contents +- [Introduction](#introduction) - [Modifications in Altair](#modifications-in-altair) - [MetaData](#metadata) - [The gossip domain: gossipsub](#the-gossip-domain-gossipsub) @@ -39,6 +33,14 @@ Altair adds new messages, topics and data to the Req-Resp, Gossip and Discovery +## Introduction + +This document contains the networking specification for Altair. +This document should be viewed as additive to the [document from Phase 0](../phase0/p2p-interface.md) and will be referred to as the "Phase 0 document" hereafter. +Readers should understand the Phase 0 document and use it as a basis to understand the changes outlined in this document. + +Altair adds new messages, topics and data to the Req-Resp, Gossip and Discovery domain. Some Phase 0 features will be deprecated, but not removed immediately. + ## Modifications in Altair ### MetaData diff --git a/specs/bellatrix/p2p-interface.md b/specs/bellatrix/p2p-interface.md index eb10eb7e1..1f4c81566 100644 --- a/specs/bellatrix/p2p-interface.md +++ b/specs/bellatrix/p2p-interface.md @@ -1,17 +1,12 @@ # Bellatrix -- Networking -This document contains the networking specification for the Bellatrix. - -The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. This document should be viewed as additive to the documents from [Phase 0](../phase0/p2p-interface.md) and from [Altair](../altair/p2p-interface.md) -and will be referred to as the "Phase 0 document" and "Altair document" respectively, hereafter. -Readers should understand the Phase 0 and Altair documents and use them as a basis to understand the changes outlined in this document. - ## Table of contents + - [Introduction](#introduction) - [Modifications in Bellatrix](#modifications-in-bellatrix) - [The gossip domain: gossipsub](#the-gossip-domain-gossipsub) - [Topics and messages](#topics-and-messages) @@ -32,6 +27,14 @@ Readers should understand the Phase 0 and Altair documents and use them as a bas +## Introduction + +This document contains the networking specification for Bellatrix. + +The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. This document should be viewed as additive to the documents from [Phase 0](../phase0/p2p-interface.md) and from [Altair](../altair/p2p-interface.md) +and will be referred to as the "Phase 0 document" and "Altair document" respectively, hereafter. +Readers should understand the Phase 0 and Altair documents and use them as a basis to understand the changes outlined in this document. + ## Modifications in Bellatrix ### The gossip domain: gossipsub diff --git a/specs/capella/p2p-interface.md b/specs/capella/p2p-interface.md index a71b6479f..25b2fb3b9 100644 --- a/specs/capella/p2p-interface.md +++ b/specs/capella/p2p-interface.md @@ -1,15 +1,12 @@ # Capella -- Networking -This document contains the networking specification for Capella. - -The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. - ### Table of contents +- [Introduction](#introduction) - [Modifications in Capella](#modifications-in-capella) - [The gossip domain: gossipsub](#the-gossip-domain-gossipsub) - [Topics and messages](#topics-and-messages) @@ -25,6 +22,11 @@ The specification of these changes continues in the same format as the network s +## Introduction + +This document contains the networking specification for Capella. + +The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. ## Modifications in Capella diff --git a/specs/deneb/p2p-interface.md b/specs/deneb/p2p-interface.md index aa63ebe87..e865ccd03 100644 --- a/specs/deneb/p2p-interface.md +++ b/specs/deneb/p2p-interface.md @@ -1,15 +1,12 @@ # Deneb -- Networking -This document contains the consensus-layer networking specification for Deneb. - -The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. - ## Table of contents +- [Introduction](#introduction) - [Modifications in Deneb](#modifications-in-deneb) - [Constant](#constant) - [Preset](#preset) @@ -42,6 +39,12 @@ The specification of these changes continues in the same format as the network s +## Introduction + +This document contains the consensus-layer networking specification for Deneb. + +The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. + ## Modifications in Deneb ### Constant diff --git a/specs/electra/p2p-interface.md b/specs/electra/p2p-interface.md index 0ea33df9f..84d67f6e0 100644 --- a/specs/electra/p2p-interface.md +++ b/specs/electra/p2p-interface.md @@ -1,15 +1,12 @@ # Electra -- Networking -This document contains the consensus-layer networking specification for Electra. - -The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. - ## Table of contents +- [Introduction](#introduction) - [Modifications in Electra](#modifications-in-electra) - [The gossip domain: gossipsub](#the-gossip-domain-gossipsub) - [Topics and messages](#topics-and-messages) @@ -21,6 +18,12 @@ The specification of these changes continues in the same format as the network s +## Introduction + +This document contains the consensus-layer networking specification for Electra. + +The specification of these changes continues in the same format as the network specifications of previous upgrades, and assumes them as pre-requisite. + ## Modifications in Electra ### The gossip domain: gossipsub diff --git a/specs/phase0/p2p-interface.md b/specs/phase0/p2p-interface.md index 6970a6d7d..396e4671b 100644 --- a/specs/phase0/p2p-interface.md +++ b/specs/phase0/p2p-interface.md @@ -1,19 +1,11 @@ # Phase 0 -- Networking -This document contains the networking specification for Phase 0. - -It consists of four main sections: - -1. A specification of the network fundamentals. -2. A specification of the three network interaction *domains* of the proof-of-stake consensus layer: (a) the gossip domain, (b) the discovery domain, and (c) the Req/Resp domain. -3. The rationale and further explanation for the design choices made in the previous two sections. -4. An analysis of the maturity/state of the libp2p features required by this spec across the languages in which clients are being developed. - ## Table of contents +- [Introduction](#introduction) - [Network fundamentals](#network-fundamentals) - [Transport](#transport) - [Encryption and identification](#encryption-and-identification) @@ -115,6 +107,17 @@ It consists of four main sections: +## Introduction + +This document contains the networking specification for Phase 0. + +It consists of four main sections: + +1. A specification of the network fundamentals. +2. A specification of the three network interaction *domains* of the proof-of-stake consensus layer: (a) the gossip domain, (b) the discovery domain, and (c) the Req/Resp domain. +3. The rationale and further explanation for the design choices made in the previous two sections. +4. An analysis of the maturity/state of the libp2p features required by this spec across the languages in which clients are being developed. + ## Network fundamentals This section outlines the specification for the networking stack in Ethereum consensus-layer clients.