Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement PBFT consensus algorithm to replace PoW consensus algorithm #2872

Merged
merged 913 commits into from Mar 2, 2023

Conversation

limebell
Copy link
Member

@limebell limebell commented Feb 28, 2023

This patch implements PBFT (Practical Byzantine Fault Tolerance) consensus algorithm for libplanet, motivated by tendermint.

Each node can be promoted to validator by special system action SetValidator produced by admin key, which is hard-coded in policy. And selection of validator for each round is now round-robin, and its power does not affect preference to be chosen.

You can check all progress here.

greymistcube and others added 30 commits November 7, 2022 12:19
….0-to-pbft

🔀 Merge main 0.44.0 to pbft
…actor-null-start

Run `ConsensusReactor` if `consensusOption` is given
…mmit

Move `LastCommit` saving to `Commit`
…t-invalid-lastcommit-proposal

Added additional checks when proposing a block
🧹 Reuse private keys for validator set
chore: fix build failure in linux mono  [skip changelog]
@pull-request-quantifier-deprecated

This PR has 11604 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +8478 -3126
Percentile : 100%

Total files changed: 200

Change summary by file extension:
.yml : +1 -1
.md : +92 -0
.cs : +8380 -3123
.csproj : +4 -1
.xml : +1 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@codecov
Copy link

codecov bot commented Mar 2, 2023

Codecov Report

Merging #2872 (10c933e) into main (325cb55) will increase coverage by 0.56%.
The diff coverage is 91.71%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2872      +/-   ##
==========================================
+ Coverage   80.31%   80.88%   +0.56%     
==========================================
  Files         313      335      +22     
  Lines       10752    11751     +999     
==========================================
+ Hits         8636     9505     +869     
- Misses       2116     2246     +130     
Impacted Files Coverage Δ
...bplanet.Extensions.Cocona/Commands/BlockCommand.cs 0.00% <0.00%> (ø)
...bplanet.Extensions.Cocona/Commands/StatsCommand.cs 100.00% <ø> (ø)
Libplanet.Net/BlockCandidateTable.cs 100.00% <ø> (ø)
Libplanet.Net/BlockDemand.cs 100.00% <ø> (ø)
Libplanet.Net/Messages/ChainStatusMsg.cs 100.00% <ø> (ø)
Libplanet.Net/PeerChainState.cs 50.00% <0.00%> (ø)
Libplanet.Net/Transports/NetMQTransport.cs 85.81% <ø> (+0.33%) ⬆️
Libplanet.Node/NodeConfig.cs 0.00% <0.00%> (ø)
Libplanet.Node/NodeUtils.cs 90.62% <ø> (ø)
Libplanet.Node/SwarmConfig.cs 91.30% <ø> (ø)
... and 111 more

@limebell limebell merged commit ef8c2b4 into planetarium:main Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Extra Large pbft Related to PBFT consensus
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

6 participants