* add availability bitfield types to primitives
* begin inclusion module
* use GitHub issue link for limitation
* fix some compiler errors
* integrate validators into initializer
* add generic signing context
* make signing-context more generic
* fix issues with inclusion module
* add TODO
* guide: add validators and session index to inclusion
* guide: add session index to change notification
* implement session change logic
* add BackedCandidate type
* guide: refine inclusion pipeline
* guide: rename group_on to group_validators
* guide: add check about collator for parathread
* guide: add last_code_upgrade to paras and use in inclusion
* implement Paras::last_code_upgrade
* implement most checks in process_candidates
* make candidate receipt structs more generic
* make BackedCandidate struct more generic
* use hash param, not block number
* check that candidate is in context of the parent block
* include inclusion module in initializer
* implement enact-candidate
* check that only occupied cores have bits set
* finish implementing bitfield processing
* restructure consistency checks on candidates
* make some more primitives generic
* signature checking logic for backed candidates
* finish implementing process_candidates
* implement collect_pending
* add some trait implementations to primitives
* implement InclusionInherent and squash warnings
* test bitfield signing checks
* rename parachain head to para_head
* fix note_new_head bug in paras
* test bitfield enactment in inclusion
* helpers for candidate checks
* add test for most candidate checks
* add test for backing setting storage
* test session change logic
* remove extraneous type parameter
* remove some allow(unused)s
* extract threshold computation to const fn
* remove some more allow(unused)s
* improve doc
* add debug assertion
* fix primitive test compilation
* tag unanimous variant as unused
* Router module initial commit
* Add the router.md itself
* Enqueue only on enact_candidate
* Initialization concerns
* Ignore the snippet
* Update roadmap/implementors-guide/src/runtime/router.md
Co-authored-by: Robert Habermeier <rphmeier@gmail.com>
* Dispatch messages on finalization
* More fixes from review
* Update roadmap/implementors-guide/src/SUMMARY.md
Co-authored-by: Robert Habermeier <rphmeier@gmail.com>
* Adds router to initializer order
* Adds messages.md
Co-authored-by: Robert Habermeier <rphmeier@gmail.com>
* introduce polkadot-node-primitives
* guide: change statement distribution message types
* guide: remove variant from `CandidateSelectionMessage`
* add a few more message types
* add TODOs
* Almost all messages
* NewBackedCandidate notification
* Formatting
* Use AttestedCandidate as BackedCandidate
* Update node/primitives/src/lib.rs
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* Fix the tests
* Bring in types from #1242
* Adds network bridge messages
* More message types from doc
* use fn pointer type
* Fixes from the review
* Add missing Runtime subsystem message
* rename to CandidateValidationMessage and fix tests
Co-authored-by: Fedor Sakharov <fedor.sakharov@gmail.com>
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* types chapter & candidate types
* Factor out some message types
* backing and availability types.
* spacing
* finish thought
* info on signed payloads
* update links
* explicit wrapper types
* add remaining message types
* add runtime API subsystem
* adjust language
* tweak candidate validation message
* find homes for some misfit types
* embed abridged within full candidate receipt
* Update roadmap/implementors-guide/src/SUMMARY.md
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* Update roadmap/implementors-guide/src/SUMMARY.md
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* adjust text on candidate selection message to match
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* update provisioner subsystem
Closes#1143
* update with answers to the questions posed by previous todos
* add misbehavior reports, disputes to provisioner messages
* expand on the protocol
* updates per code review
* scheduler module skeleton
* update scheduler skeleton to match latest version of guide
* better session change notification
* add mock randomness and fix test compilation
* shuffle validators into groups
* finish implementing session change logic for scheduler
* tweak core assignment type to track retries of parathread
* reframe queued parathread core as offset
* implement initialzation and finalization routines
* implement parathread claim queuing
* implement core_para
* implement the group_validators routine and fix errors
* add a reason for freeing cores
* implement `schedule` function
* add some docs to the scheduled function
* implement `occupied` helper
* implement availability predicate
* fix some warnings
* integrate scheduler into initializer
* integrate scheduler into mock module
* avoid conflict with Substrate's scheduler storage
* add parathreads index to paras module
* implement parathreads map in paras module
* add is_parathread to paras
* test adding parathread claim
* test that you cannot add claims when no parathread cores exist
* check session change parathread queue pruning
* test validator shuffling
* add allow_unused to scheduler items
* add test for scheduling
* add some more tests for scheduling logic
* test core rotation
* check parathread claim pruning after retries
* add bound notes
* Apply suggestions from code review
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
Co-authored-by: Bernhard Schuster <bernhard@ahoi.io>
* more suggestions from review
* test availability predicate, add box to please compiler
* add changes to guide
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
Co-authored-by: Bernhard Schuster <bernhard@ahoi.io>
* move old implementers' guide, add skeleton of new
* Split the old implementers' guide into the new one's sections
This is mostly a straightforward copying operation, moving the
appropriate sections from the old guide to the new. However, there
are certain differences between the old text and the new:
- removed horizontal rules between the sections
- promoted headers appropriately within each section
- deleted certain sections which were in the old guide's ToC but
which were not actually present in the old guide.
- added Peer Set Manager to the new ToC
* remove description headers
It is redundant and unnecessary. Descriptions fall directly under the
top-level header for any given section.
* add stub description of the backing module
* add stub description for the availability module
* add stub description for collators
* add stub description for validity
* add stub description for utility
* highlight TODO and REVIEW comments
* add guide readme describing how to use mdbook
* fix markdownlint lints
* re-title parachains overview
* internal linking for types
* module and subsystem internal links
* .gitignore should have a trailing newline
* node does not have modules, just subsystems
* define subsystems skeleton
* Create a blank section for each subsystem in the initial batch
* write out basics for most subsystems
* define network bridge subsystem
* integrate network bridge into network systems
* Apply suggestions from code review
some nits
Co-authored-by: Max Inden <mail@max-inden.de>
* clean up wording
Co-authored-by: Max Inden <mail@max-inden.de>
* define subsystems skeleton
* Create a blank section for each subsystem in the initial batch
* write out basics for most subsystems
* Update roadmap/implementors-guide/guide.md
clean up language
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* ToC indentation
* clean up wording
* renaming block authorship (provisioning) to Provisioner
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
* expand subsystems descriptions independent of subsystems overview
The subsystems overview in https://github.com/paritytech/polkadot/pull/1161
is a very useful reference for what subsystems need to talk to each other,
when, and why; it helps us design the actual messages.
However, administratively, it belongs in a different PR. This commit
brings in all the changes made there so far as a base for an independent
PR.
* Reorder subsystem descriptions, add some messages
Update ordering of subsystem descriptions to rough order of use,
mirroring the order in the overview document.
Added some message types. Added OverseerSignal variants to several
types, such that each subsystem only needs to listen for a single
type.
* add some more message types, Statement Distribution overview
* add more detail on Statement Distribution, Misbehavior Arbitration
* intentionally punt MA details for a future PR
* reduce duplication from overseer signal handling
* reword for clarity
* clarify: other modules and subsystems also get to talk to the network
* finish current work on candidate selection
* update candidate backing subsystem description according to current thought
* update mechanism for candidate backing to report collator misbehavior to candidate selection
* sketch out the peer receipt state machine
* Fix typo in roadmap/implementors-guide/guide.md
Co-authored-by: Robert Habermeier <rphmeier@gmail.com>
* Don't specify 'peer validators', as messages from non-validator peers are ignored regardless
* clarify instancing of peer receipt state machine
* add section on peer knowledge tracking
* fix typo in roadmap/implementors-guide/guide.md
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Robert Habermeier <rphmeier@gmail.com>
Co-authored-by: Max Inden <mail@max-inden.de>
* clarify exception to communication rule for responses
* add note about outside world
* write up my understanding of local and remote disputes
* clean up secondary checker language
* amend to match Jeff's notes
* migrate subsystem expansion PR from w3f/research
As the file at this new location included changes not present in
https://github.com/w3f/research/pull/87, this is effectively a
rebase, applied manually. I believe that I have successfully retained
all of, and only, the intended changes.
* add section on collators
* note why the overseer is the terminal message point for the validation subsystem
* add detail about how the validitiy system gets PoV blocks
* rename to Validity Subsystems Overview
* get rid of changes to the implementor's guide
I think it makes most sense to track and review the subsystems
overview in a different PR than the one which adds content to
the implementor's guide.
* punt misbehavior arbitration details to the future
* empty commit to rerun CI
* file structure and initializer skeleton
* ensure session changes happen before initialization
* add a couple tests for initializer flow
* integrate with session handling
* configuration update logic
* configuration methods
* move test mock to its own module
* integrate configuration into initializer
* add note about initialization order
* integrate configuration module into mock
* add some tests for config module
* paras module storage
* implement paras session change operation
* amend past code pruning to fully cover acceptance period
* update guide again
* do pruning of historical validation code
* add weight to initialization
* integrate into mock & leave notes for next session
* clean up un-ended sentence
* alter test to account for double index in past code meta
* port over code-at logic test
* clarify checking for conflicting code upgrades
* add genesis for paras, include in mock, ensure incoming paras are processed
* note on return value of `validation_code_at`
* implement paras routines from implementor's guide
* bring over some existing tests and begin porting
* port over code upgrade tests
* test parachain registration
* test code_at with intermediate block
* fix warnings
* clean up docs and extract to separate struct
* adjust implementor's guide to include replacementtimes
* kill stray println
* rename expected_at to applied_after
* rewrite ParaPastCodeMeta to avoid reversal
* clarify and test interface of validation_code_at
* make FutureCode optional
* rename do_old_code_pruning
* add comment on Option<()> to answer FAQ
* address some more grumbles
* remove redundant resize instruction from guide
* amend past code pruning to fully cover acceptance period
* update guide again
* note on return value of `validation_code_at`
* rename execution cores to availability cores
* clarify terminology
* add ReplacementTimes to the guide
* fully decouple inclusion and scheduler
* clarify parathread scheduling substantially
* clarify validator group selection
Robert Habermeier