Skip to content

Commit af1f7b6

Browse files
committed
Restructure README
1 parent 4ce9185 commit af1f7b6

File tree

4 files changed

+20
-14
lines changed

4 files changed

+20
-14
lines changed

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,6 @@ This specification presents a way to implement Distributed Validator Client soft
6464
- Under the assumption of a synchronous network, the Validator is never slashed unless more than 1/3rd of the Co-Validators are Byzantine.
6565
- **Liveness**: The protocol will eventually produce a new attestation/block under partially synchronous network unless more than 1/3rd of the Co-Validators are Byzantine.
6666

67-
## Spec
67+
## Specification
6868

69-
The specifications are organized as follows:
70-
- The [distributed validator specification](src/dvspec/spec.py) defines the behavior of a Co-Validator regarding attestation & block production processes.
71-
- The [Ethereum node interface](src/dvspec/eth_node_interface.py) describes the interface to communicate with the associated Beacon Node & Validator Client.
72-
- The [consensus specification](src/dvspec/consensus.py) describes the basic structure for the consensus protocol used between Co-Validators.
73-
- The [networking specification](src/dvspec/networking.py) defines the required networking logic between Distributed Validator Clients.
74-
75-
### Attestation Production Process
76-
77-
![UML for Attestation Production Process](figures/dv-attestation-production-process.png)
78-
79-
### Block Production Process
80-
81-
![UML for Block Production Process](figures/dv-block-production-process.png)
69+
Technical details about the specification are described in [`src/dvspec/`](src/dvspec/).

src/dvspec/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Ethereum Distributed Validator Specification
2+
3+
## Spec
4+
5+
The specifications are organized as follows:
6+
- [`spec.py` - distributed validator specification](spec.py) defines the behavior of a Co-Validator regarding attestation & block production processes.
7+
- [`eth_node_interface.py` - Ethereum node interface](eth_node_interface.py) describes the interface to communicate with the associated Beacon Node & Validator Client.
8+
- [`consensus.py` - consensus specification](consensus.py) describes the basic structure for the consensus protocol used between Co-Validators.
9+
- [`networking.py` - networking specification](networking.py) defines the required networking logic between Distributed Validator Clients.
10+
- [`utils/` - utilities](utils/) contain type definitions and misc. helper functions for the specification.
11+
12+
### Attestation Production Process
13+
14+
![UML for Attestation Production Process](figures/dv-attestation-production-process.png)
15+
16+
### Block Production Process
17+
18+
![UML for Block Production Process](figures/dv-block-production-process.png)

0 commit comments

Comments
 (0)