From ea834b12de1664be6a2133102f41b26107568d40 Mon Sep 17 00:00:00 2001 From: Andronik Ordian Date: Fri, 31 Jul 2020 16:28:45 +0200 Subject: [PATCH] Guide: add a diagram for Inclusion Pipeline & Approval Subsystem (#1457) * guide: optimize diagrams for readability * guide: inclusion subsystem diagram * guide: rename Approval Subsystem for clarity * guide: correct the approval subsystem * guide: clarify that validator are selected from the same set * guide: simplify secondary checkers labels --- .../src/parachains-overview.md | 143 ++++++++++++++++-- 1 file changed, 128 insertions(+), 15 deletions(-) diff --git a/polkadot/roadmap/implementers-guide/src/parachains-overview.md b/polkadot/roadmap/implementers-guide/src/parachains-overview.md index 8eff666225..23a8e83cf2 100644 --- a/polkadot/roadmap/implementers-guide/src/parachains-overview.md +++ b/polkadot/roadmap/implementers-guide/src/parachains-overview.md @@ -56,19 +56,109 @@ Reiterating the lifecycle of a candidate: 1. Included: Backed and considered available. 1. Accepted: Backed, available, and undisputed -> TODO Diagram: Inclusion Pipeline & Approval Subsystems interaction +```dot process Inclusion Pipeline +digraph { + subgraph cluster_vg { + label=< + Parachain Validators +
+ (subset of all) + > + labeljust=l + style=filled + color=lightgrey + node [style=filled color=white] + + v1 [label="Validator 1"] + v2 [label="Validator 2"] + v3 [label="Validator 3"] + + b [label="(3) Backable", shape=box] + + v1 -> v2 [label="(2) Seconded"] + v1 -> v3 [label="(2) Seconded"] + + v2 -> b [style=dashed arrowhead=none] + v3 -> b [style=dashed arrowhead=none] + v1 -> b [style=dashed arrowhead=none] + } + + v4 [label=< + Validator 4 (relay chain) +
+ + (selected by BABE) + + >] + + col [label="Collator"] + pa [label="(5) Relay Block (Pending Availability)", shape=box] + pb [label="Parablock", shape=box] + rc [label="Relay Chain Validators"] + + subgraph cluster_approval { + label=< + Secondary Checkers +
+ (subset of all) + > + labeljust=l + style=filled + color=lightgrey + node [style=filled color=white] + + a5 [label="Validator 5"] + a6 [label="Validator 6"] + a7 [label="Validator 7"] + } + + b -> v4 [label="(4) Backed"] + col -> v1 [label="(1) Candidate"] + v4 -> pa + pa -> pb [label="(6) a few blocks later..." arrowhead=none] + pb -> a5 + pb -> a6 + pb -> a7 + + a5 -> rc [label="(7) Approved"] + a6 -> rc [label="(7) Approved"] + a7 -> rc [label="(7) Approved"] +} +``` + +The diagram above shows the happy path of a block from (1) Candidate to the (7) Approved state. It is also important to take note of the fact that the relay-chain is extended by BABE, which is a forkful algorithm. That means that different block authors can be chosen at the same time, and may not be building on the same block parent. Furthermore, the set of validators is not fixed, nor is the set of parachains. And even with the same set of validators and parachains, the validators' assignments to parachains is flexible. This means that the architecture proposed in the next chapters must deal with the variability and multiplicity of the network state. ```dot process digraph { - rca [label = "Relay Block A" shape=rectangle] - rcb [label = "Relay Block B" shape=rectangle] - rcc [label = "Relay Block C" shape=rectangle] + rca [label="Relay Block A" shape=box] + rcb [label="Relay Block B" shape=box] + rcc [label="Relay Block C" shape=box] - vg1 [label =<Validator Group 1

(Validator 4)
(Validator 1) (Validator 2)
(Validator 5)>] - vg2 [label =<Validator Group 2

(Validator 7)
(Validator 3) (Validator 6)>] + vg1 [label=< + Validator Group 1 +
+
+ + (Validator 4) +
+ (Validator 1) (Validator 2) +
+ (Validator 5) + + >] + vg2 [label=< + Validator Group 2 +
+
+ + (Validator 7) +
+ (Validator 3) (Validator 6) + + >] rcb -> rca rcc -> rcb @@ -82,23 +172,46 @@ In this example, group 1 has received block C while the others have not due to n ```dot process digraph { - rca [label = "Relay Block A" shape=rectangle] - rcb [label = "Relay Block B" shape=rectangle] - rcc [label = "Relay Block C" shape=rectangle] - rcc_prime [label = "Relay Block C'" shape=rectangle] + rca [label="Relay Block A" shape=box] + rcb [label="Relay Block B" shape=box] + rcc [label="Relay Block C" shape=box] + rcc_prime [label="Relay Block C'" shape=box] - vg1 [label =<Validator Group 1

(Validator 4) (Validator 1)>] - vg2 [label =<Validator Group 2

(Validator 7) (Validator 6)>] - vg3 [label =<Validator Group 3

(Validator 2) (Validator 3)
(Validator 5)>] + vg1 [label=< + Validator Group 1 +
+
+ + (Validator 4) (Validator 1) + + >] + vg2 [label=< + Validator Group 2 +
+
+ + (Validator 7) (Validator 6) + + >] + vg3 [label=< + Validator Group 3 +
+
+ + (Validator 2) (Validator 3) +
+ (Validator 5) + + >] rcb -> rca rcc -> rcb rcc_prime -> rcb - vg1 -> rcc [style=dashed arrowhead=none] + vg1 -> rcc [style=dashed arrowhead=none] vg2 -> rcc_prime [style=dashed arrowhead=none] vg3 -> rcc_prime [style=dashed arrowhead=none] - vg3 -> rcc [style=dashed arrowhead=none] + vg3 -> rcc [style=dashed arrowhead=none] } ```