* High level docs - start.
* Clean up README
* Start adding details to high level docs
* More docs on the header sync pallet
* Testing scenarios document.
* Add some scenarios.
* Add multi-sig scenario.
* Start writing about message dispatch pallet
* Move content from old README into PoA specific doc
* Apply suggestions from code review
Co-authored-by: Andreas Doerr <adoerr@users.noreply.github.com>
* GRANDPA for consistency.
* Describe scenario steps.
* WiP
* Add notes about block production and forks
* Update.
* Add sequence diagram for Millau to Rialto transfer
* Clean up header sync pallet overview
* Remove leftover example code
* Clean up testing scenarios and amend sequence diagram.
* Linking docs.
* Add some more docs.
* Do a bit of cleanup on the high-level docs
* Clean up the testing scenario
* Fix typos in flow charts
* Fix small typo
* Fix indentation of Rust block
* Another attempt at rendering block correctly
* TIL about lazy list numbering in Markdown
* Add list numbers across sections
* Start counting from correct number
* Update README to use correct path to local scripts
* Wrap ASCII art in code block
Co-authored-by: Tomasz Drwięga <tomasz@parity.io>
Co-authored-by: Tomasz Drwięga <tomusdrw@users.noreply.github.com>
Co-authored-by: Andreas Doerr <adoerr@users.noreply.github.com>
* Support multiple "best headers" from different forks
* Update the name of a test
* Add note about multiple scheduled changes
* Disallow multiple scheduled authority set changes
* Return multiple best headers from Runtime APIs
* Remove invalid test write-up
* Add some sketch-ups of test scenarios
* Clean up test scenarios
* Add module for testing forks
* Write headers to storage
* Add way to check expected outcome for header imports
* Add support for importing finality proofs
* Support importing headers which schedule changes
* Write out test scenario using new framework
* Map authority set changes across forks
Gets all the tests in the `forks` module passing
* Remove basic tests
These were used when working on the initial test helper
* Prevent multiple pending set changes on the same fork
* Remove old test which allowed imports past unfinalized header
* Ignore failing test (for now)
* Rewrite `if` comparison using `match` and `cmp`
Fixes Clippy warning: `comparison_chain`
* Add helper for writing test headers with default characteristics
* Fix test that checked authority set updates
* Make note about importing headers on different unfinalized fork
* Perform some cleanup on the fork module
* Fix Clippy complaints
* Provide list of unfinalized headers to Runtime APIs
* Add proofs to expect() calls
* Make tests the focus of the forks module
* Allow specific errors to be checked in fork tests
* Remove unused method
* Replace unreachable() statement with expect()
* Rename storage `unfinalized_headers() `to make its purpose more clear
* Update Runtime API name in relayer to match pallet
* Commit `unfinalized_headers` changes I forgot to add
* Rename ChainTipHeight to BestHeight
* Make schedule_next_set_change require a mutable reference
* Remove check for key when enacting authority set
We only expect to take the happy-path in the pallet anyways, so this check
to save ourselves the time spent decoding the entry isn't really used.
* Clear justification set when writing headers to storage
* Clarify why we only allow one set change per fork
* Change best_headers() to return HeaderIDs
Prevents us from returning full headers (which are more expensive to
get from storage) since we only care about header IDs (number, hash)
anyways.
* Fix Clippy complaint
* Make note about equivocations
* Use HeaderIds when returning incomplete headers
This change stops returning full headers which are more expensive
to get from storage than header Ids (number, hash) are. Clients likely
don't need the full header anyways which is why this change is fine.
* Introduce HeaderId type to reduce type complexity
* Add signal hash to storage during genesis config
* Return error instead of expect()-ing
* Fix Clippy lint about `ok_or` fn call
* Rename `forks` module to indicate that it's for testing
* Use `const` for `expect()` proofs
* Remove check that key exists before `kill`-ing value
Co-authored-by: Svyatoslav Nikolsky <svyatonik@gmail.com>
**Update:** Pushed additional changes based on the review comments.
**This pull request fixes various spelling mistakes in this
repository.**
Most of the changes are contained in the first **3** commits:
- `Fix spelling mistakes in comments and docs`
- `Fix spelling mistakes in test names`
- `Fix spelling mistakes in error messages, panic messages, logs and
tracing`
Other source code spelling mistakes are separated into individual
commits for easier reviewing:
- `Fix the spelling of 'authority'`
- `Fix the spelling of 'REASONABLE_HEADERS_IN_JUSTIFICATION_ANCESTRY'`
- `Fix the spelling of 'prev_enqueud_messages'`
- `Fix the spelling of 'endpoint'`
- `Fix the spelling of 'children'`
- `Fix the spelling of 'PenpalSiblingSovereignAccount'`
- `Fix the spelling of 'PenpalSudoAccount'`
- `Fix the spelling of 'insufficient'`
- `Fix the spelling of 'PalletXcmExtrinsicsBenchmark'`
- `Fix the spelling of 'subtracted'`
- `Fix the spelling of 'CandidatePendingAvailability'`
- `Fix the spelling of 'exclusive'`
- `Fix the spelling of 'until'`
- `Fix the spelling of 'discriminator'`
- `Fix the spelling of 'nonexistent'`
- `Fix the spelling of 'subsystem'`
- `Fix the spelling of 'indices'`
- `Fix the spelling of 'committed'`
- `Fix the spelling of 'topology'`
- `Fix the spelling of 'response'`
- `Fix the spelling of 'beneficiary'`
- `Fix the spelling of 'formatted'`
- `Fix the spelling of 'UNKNOWN_PROOF_REQUEST'`
- `Fix the spelling of 'succeeded'`
- `Fix the spelling of 'reopened'`
- `Fix the spelling of 'proposer'`
- `Fix the spelling of 'InstantiationNonce'`
- `Fix the spelling of 'depositor'`
- `Fix the spelling of 'expiration'`
- `Fix the spelling of 'phantom'`
- `Fix the spelling of 'AggregatedKeyValue'`
- `Fix the spelling of 'randomness'`
- `Fix the spelling of 'defendant'`
- `Fix the spelling of 'AquaticMammal'`
- `Fix the spelling of 'transactions'`
- `Fix the spelling of 'PassingTracingSubscriber'`
- `Fix the spelling of 'TxSignaturePayload'`
- `Fix the spelling of 'versioning'`
- `Fix the spelling of 'descendant'`
- `Fix the spelling of 'overridden'`
- `Fix the spelling of 'network'`
Let me know if this structure is adequate.
**Note:** The usage of the words `Merkle`, `Merkelize`, `Merklization`,
`Merkelization`, `Merkleization`, is somewhat inconsistent but I left it
as it is.
~~**Note:** In some places the term `Receival` is used to refer to
message reception, IMO `Reception` is the correct word here, but I left
it as it is.~~
~~**Note:** In some places the term `Overlayed` is used instead of the
more acceptable version `Overlaid` but I also left it as it is.~~
~~**Note:** In some places the term `Applyable` is used instead of the
correct version `Applicable` but I also left it as it is.~~
**Note:** Some usage of British vs American english e.g. `judgement` vs
`judgment`, `initialise` vs `initialize`, `optimise` vs `optimize` etc.
are both present in different places, but I suppose that's
understandable given the number of contributors.
~~**Note:** There is a spelling mistake in `.github/CODEOWNERS` but it
triggers errors in CI when I make changes to it, so I left it as it
is.~~
Hernando Castano