Learn - Consensus quality section - content
@AurelienFT is already working on this.
Since May 19, 2023.
- Dominant language
- JavaScript
- Stars
- 18
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
The context:
Current Massa docs section Architecture included the lengthy description of Endorsement mechanism, which don't fit the purpose of the Learn segment where will be located in the new Documentation we're making.
The objective of this task is to write the content of this new section 'Consensus quality initiatives'.It will provide the list of mechanisms Massa’s consensus has in place that make it optimal/better/more efficient.
The listed mechanisms in the Massa docs I found are:
- Endorsements (requires rewriting some sections, described below)
- Slashing (needs full write up)
- Node banning (needs full write up)
- add others if any.
The content structure can be found in this PR #34 - consensus-quality.mdx file.
Sub-tasks (per sub-section in docs):
1. 1-2 Intro paragraph:
To add:
- create an introduction of why such mechanisms exists in Massa blockchain, how they optimize PoS and why we opted for these specific solutions.
- mention if there are any future plans to add more mechanisms
2. Endorsements - improvements:
Currently under review in PR #34. I summarized some parts.
To do:
- improve 'Technical decisions' section.
Details:
a) suggestion is to rename the current section Choosing the value of E and include all technical aspects mentioned there: Finality fork attacks, Security level, but shorter. The purpose is to explain the mechanisms and convice readers our Consensus is better because of it.
b) suggestion: remove the simulation results section and display a sentence about the simulation results and a
reference to the technical paper
c) suggestion: remove 'Future features' subsection from this learning segment.
3. Slashing - full write up:
To add:
- This mechanism should be described in full in the same way and structure the Endorsement;
- Introduce the reasons for slashing in our PoS.
- How it works - functionality (can be broken into subsections like Endorsements are)
- Incentives and penalties sub-section - which describes how exactly we penalize stakers.
4. Node banning - full write up:
To add:
- This mechanism should be described in full in the same way and structure the Endorsement;
- Introduce the reasons for node banning in PoS, and situations when it occurs.
- How it works
- Incentives and penalties sub-section - which describes how exactly we ban nodes and what it means for the node runners.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.