Skip to content

Commit

Permalink
Update doc names and sharding readme section
Browse files Browse the repository at this point in the history
  • Loading branch information
protolambda committed Mar 26, 2021
1 parent 1acb1d6 commit 306fc95
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 12 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,27 @@ Core specifications for Eth2 clients be found in [specs](specs/). These are divi
* [Altair fork](specs/altair/fork.md)
* [Light client sync protocol](specs/altair/sync-protocol.md)

### Sharding

The sharding spec is still actively in R&D; see the most recent available pull request [here](https://github.com/ethereum/eth2.0-specs/pull/2146) and some technical details [here](https://hackmd.io/@HWeNw8hNRimMm2m2GH56Cw/B1YJPGkpD).

### Merge

The merge is still actively in R&D; see an [ethresear.ch](https://ethresear.ch) post describing the proposed basic mechanism [here](https://ethresear.ch/t/the-eth1-eth2-transition/6265) and the section of [ethereum.org](https://ethereum.org) describing the merge at a high level [here](https://ethereum.org/en/eth2/docking/).

### Sharding

Sharding follows the merge, and is divided into three parts:

* Sharding base functionality
* [Beacon Chain changes](specs/sharding/beacon-chain.md)
* [P2P Network changes](specs/sharding/p2p-interface.md)
* Proof of Custody
* [Custody Game](specs/custody/custody-game.md)
* [Validator custody work](specs/custody/validator.md)
* Data Availability Sampling
* Technical details [here](https://hackmd.io/@HWeNw8hNRimMm2m2GH56Cw/B1YJPGkpD).
* [Core types and functions](specs/das/das-core.md)
* [P2P Networking](specs/das/p2p-interface.md)
* [Fork Choice](specs/das/fork-choice.md)
* [Sampling process](specs/das/sampling.md)

### Accompanying documents can be found in [specs](specs) and include:

* [SimpleSerialize (SSZ) spec](ssz/simple-serialize.md)
Expand Down
2 changes: 1 addition & 1 deletion specs/das/das-internals.md → specs/das/das-core.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ethereum 2.0 Phase 1 -- Data Availability Sampling - Internals
# Ethereum 2.0 Data Availability Sampling Core

**Notice**: This document is a work-in-progress for researchers and implementers.

Expand Down
2 changes: 1 addition & 1 deletion specs/das/fork-choice.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ethereum 2.0 Phase 1 -- Beacon Chain Fork Choice
# Ethereum 2.0 Data Availability Sampling Fork Choice

**Notice**: This document is a work-in-progress for researchers and implementers.

Expand Down
10 changes: 5 additions & 5 deletions specs/das/das-p2p.md → specs/das/p2p-interface.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ethereum 2.0 Phase 1 -- Data Availability Sampling - Network specification
# Ethereum 2.0 Data Availability Sampling Network specification

**Notice**: This document is a work-in-progress for researchers and implementers.

Expand Down Expand Up @@ -32,7 +32,7 @@

## Introduction

For an introduction about DAS itself, see [the DAS participation spec](./das-participation.md#data-availability-sampling).
For an introduction about DAS itself, see [the DAS participation spec](sampling.md#data-availability-sampling).
This is not a pre-requisite for the network layer, but will give you valuable context.

For sampling, all nodes need to query for `k` random samples each slot.
Expand Down Expand Up @@ -132,11 +132,11 @@ These subscriptions rotate slowly, and with different offsets per node identity
# TODO hash function: (node, time)->subnets
```

Backbone subscription work is outlined in the [DAS participation spec](./das-participation.md#slow-rotation-backbone)
Backbone subscription work is outlined in the [DAS participation spec](sampling.md#slow-rotation-backbone)

#### Quick Rotation: Sampling

A node MUST maintain `k` random subscriptions to topics, and rotate these according to the [DAS participation spec](./das-participation.md#quick-rotation-sampling).
A node MUST maintain `k` random subscriptions to topics, and rotate these according to the [DAS participation spec](sampling.md#quick-rotation-sampling).
If the node does not already have connected peers on the topic it needs to sample, it can search its peerstore, and if necessary in the DHT, for peers in the topic backbone.

## DAS in the Gossip domain: Push
Expand All @@ -161,7 +161,7 @@ Take `blob = signed_blob.blob`:
2. Create samples with proofs: `samples = sample_data(blob.slot, blob.shard, extended_data)`
3. Fanout-publish the samples to the vertical subnets of its peers (not all vertical subnets may be reached).

The [DAS participation spec](./das-participation.md#horizontal-subnets) outlines when and where to participate in DAS on horizontal subnets.
The [DAS participation spec](sampling.md#horizontal-subnets) outlines when and where to participate in DAS on horizontal subnets.


#### Vertical subnets: `das_sample_{subnet_index}`
Expand Down
2 changes: 1 addition & 1 deletion specs/das/das-participation.md → specs/das/sampling.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ethereum 2.0 Phase 1 -- Data Availability Sampling - Participation
# Ethereum 2.0 Data Availability Sampling

**Notice**: This document is a work-in-progress for researchers and implementers.

Expand Down
File renamed without changes.

0 comments on commit 306fc95

Please sign in to comment.