Skip to content

Commit 2f0e5a6

Browse files
authored
add notices to the implementer's guide docs that changed for elastic scaling (#4983)
The update is tracked by: #3699 However, this is not worth doing at this point since it will change in the future for phase 2 of the implementation. Still, it's useful to let people know that the information is not the most up to date.
1 parent 01e0fc2 commit 2f0e5a6

File tree

6 files changed

+24
-0
lines changed

6 files changed

+24
-0
lines changed

polkadot/roadmap/implementers-guide/src/node/backing/candidate-backing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Candidate Backing
22

3+
> NOTE: This module has suffered changes for the elastic scaling implementation. As a result, parts of this document may
4+
be out of date and will be updated at a later time. Issue tracking the update:
5+
https://github.com/paritytech/polkadot-sdk/issues/3699
6+
37
The Candidate Backing subsystem ensures every parablock considered for relay block inclusion has been seconded by at
48
least one validator, and approved by a quorum. Parablocks for which not enough validators will assert correctness are
59
discarded. If the block later proves invalid, the initial backers are slashable; this gives Polkadot a rational threat

polkadot/roadmap/implementers-guide/src/node/backing/prospective-parachains.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Prospective Parachains
22

3+
> NOTE: This module has suffered changes for the elastic scaling implementation. As a result, parts of this document may
4+
be out of date and will be updated at a later time. Issue tracking the update:
5+
https://github.com/paritytech/polkadot-sdk/issues/3699
6+
37
## Overview
48

59
**Purpose:** Tracks and handles prospective parachain fragments and informs

polkadot/roadmap/implementers-guide/src/node/collators/collator-protocol.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Collator Protocol
22

3+
> NOTE: This module has suffered changes for the elastic scaling implementation. As a result, parts of this document may
4+
be out of date and will be updated at a later time. Issue tracking the update:
5+
https://github.com/paritytech/polkadot-sdk/issues/3699
6+
37
The Collator Protocol implements the network protocol by which collators and validators communicate. It is used by
48
collators to distribute collations to validators and used by validators to accept collations by collators.
59

polkadot/roadmap/implementers-guide/src/node/utility/provisioner.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Provisioner
22

3+
> NOTE: This module has suffered changes for the elastic scaling implementation. As a result, parts of this document may
4+
be out of date and will be updated at a later time. Issue tracking the update:
5+
https://github.com/paritytech/polkadot-sdk/issues/3699
6+
37
Relay chain block authorship authority is governed by BABE and is beyond the scope of the Overseer and the rest of the
48
subsystems. That said, ultimately the block author needs to select a set of backable parachain candidates and other
59
consensus data, and assemble a block from them. This subsystem is responsible for providing the necessary data to all

polkadot/roadmap/implementers-guide/src/runtime/inclusion.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Inclusion Pallet
22

3+
> NOTE: This module has suffered changes for the elastic scaling implementation. As a result, parts of this document may
4+
be out of date and will be updated at a later time. Issue tracking the update:
5+
https://github.com/paritytech/polkadot-sdk/issues/3699
6+
37
The inclusion module is responsible for inclusion and availability of scheduled parachains. It also manages the UMP
48
dispatch queue of each parachain.
59

polkadot/roadmap/implementers-guide/src/runtime/parainherent.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# `ParaInherent`
22

3+
> NOTE: This module has suffered changes for the elastic scaling implementation. As a result, parts of this document may
4+
be out of date and will be updated at a later time. Issue tracking the update:
5+
https://github.com/paritytech/polkadot-sdk/issues/3699
6+
37
This module is responsible for providing all data given to the runtime by the block author to the various parachains
48
modules. The entry-point is mandatory, in that it must be invoked exactly once within every block, and it is also
59
"inherent", in that it is provided with no origin by the block author. The data within it carries its own

0 commit comments

Comments
 (0)