Consensus/readme by gokutheengineer · Pull Request #777 · pokt-network/pocket

gokutheengineer · 2023-05-21T12:16:14Z

Description

Summary generated by Reviewpad on 08 Jun 23 08:33 UTC

This pull request adds a new module, Consensus Module, to the project, implementing the HotStuff consensus algorithm and adhering to the Pocket's Consensus Module Specification. The pull request also includes the organization of files, code documentation, and testing.

Issue

Fixes #335

Type of change

Please mark the relevant option(s):

List of changes

Add README.md to the consensus module

Testing

make develop_test; if any code changes were made
make test_e2e on k8s LocalNet; if any code changes were made
e2e-devnet-test passes tests on DevNet; if any code was changed
Docker Compose LocalNet; if any major functionality was changed or introduced
k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
I have tested my changes using the available tooling
I have updated the corresponding CHANGELOG

If Applicable Checklist

I have updated the corresponding README(s); local and/or global
I have added tests that prove my fix is effective or that my feature works
I have added, or updated, mermaid.js diagrams in the corresponding README(s)
I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

This reverts commit 8caf8ab.

Olshansk

@gokutheengineer Thank you so much for doing this!

I submitted a few NITS myself, and left a couple comments. Would really appreciate if you could take a look (shouldn't take too long) and then we can merge it in!

consensus/README.md

Olshansk · 2023-05-23T00:59:32Z

consensus/README.md

+
+### State Sync
+
+State synchronization is crucial to ensure all participating nodes maintain a consistent and up-to-date view of the network state. It is especially important in a dynamic and decentralized network where nodes can join, leave, or experience intermittent connectivity. For an in-depth understanding of the state sync process and its current status, please refer to our [State Sync Protocol Design Specification](https://github.com/pokt-network/pocket/blob/main/consensus/doc/PROTOCOL_STATE_SYNC.md).


NIT: Any chance you could follow the "best practices" I learnt about recently and see if we can reformat this (by moving this around) so it's easier to read: https://twitter.com/olshansky/status/1660499323317284864

If this is too hard, then no worries!

@gokutheengineer we synched offline, but let's just merge in what we have and iterate on a diagram in a future PR!

I did a quick fix that I think makes it better and easier to understand.

codecov · 2023-06-02T20:13:05Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (185e0fc) 31.38% compared to head (8701934) 31.38%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #777   +/-   ##
=======================================
  Coverage   31.38%   31.38%           
=======================================
  Files         107      107           
  Lines        9080     9080           
=======================================
  Hits         2850     2850           
  Misses       5889     5889           
  Partials      341      341

Impacted Files	Coverage Δ
consensus/module_consensus_state_sync.go	`0.00% <ø> (ø)`

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

…ider * pokt/main: Consensus/readme (#777) chore: add `--build-tags` flag to `go_lint` make target (#807) [Core] Deploying all-the-protocol-actors (#710) Add github wiki tag to devlog8 Add README for Devlog8 for iteration17 (#805)

## Description  ### Summary generated by Reviewpad on 08 Jun 23 08:33 UTC This pull request adds a new module, Consensus Module, to the project, implementing the HotStuff consensus algorithm and adhering to the Pocket's Consensus Module Specification. The pull request also includes the organization of files, code documentation, and testing.  ## Issue Fixes #335 ## Type of change Please mark the relevant option(s): - [ ] New feature, functionality or library - [ ] Bug fix - [ ] Code health or cleanup - [ ] Major breaking change - [X] Documentation - [ ] Other  ## List of changes - Add README.md to the consensus module ## Testing - [ ] `make develop_test`; if any code changes were made - [ ] `make test_e2e` on [k8s LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md); if any code changes were made - [ ] `e2e-devnet-test` passes tests on [DevNet](https://pocketnetwork.notion.site/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd); if any code was changed - [ ] [Docker Compose LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md); if any major functionality was changed or introduced - [ ] [k8s LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md); if any infrastructure or configuration changes were made ## Required Checklist - [X] I have performed a self-review of my own code - [X] I have commented my code, particularly in hard-to-understand areas - [X] I have added, or updated, [`godoc` format comments](https://go.dev/blog/godoc) on touched members (see: [tip.golang.org/doc/comment](https://tip.golang.org/doc/comment)) - [X] I have tested my changes using the available tooling - [X] I have updated the corresponding CHANGELOG ### If Applicable Checklist - [ ] I have updated the corresponding README(s); local and/or global - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added, or updated, [mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding README(s) - [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s) --------- Co-authored-by: Gokhan Sagirlar <gokhansagirlar@Gokhans-MacBook-Pro.local> Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com>

…ider * pokt/main: Consensus/readme (#777) chore: add `--build-tags` flag to `go_lint` make target (#807) [Core] Deploying all-the-protocol-actors (#710) Add github wiki tag to devlog8 Add README for Devlog8 for iteration17 (#805)

* pokt/main: Consensus/readme (#777) chore: add `--build-tags` flag to `go_lint` make target (#807) [Core] Deploying all-the-protocol-actors (#710) Add github wiki tag to devlog8 Add README for Devlog8 for iteration17 (#805)

* refactor/peerstore-provider: (22 commits) fix: bugs chore: update changelogs refactor: rename `T` & `K` type params to `M` &`C` chore: improve comment chore: add issue numbers to TECHDEBT comments chore: add TECHDEBT comments refactor: re-implement `GetUnstakedPeerstore` refactor: update peerstore provider method receivers refactor: `p2pPeerstoreProvider` to a single function' refactor: rename persistence.go back to provider.go refactor: consolidate p2pPeerstoreProvider into persistencePeerstorProvider chore: oneline function signature refactor: embed `p2pPStoreProviderFactory` refactor: persistence peerstor provider Consensus/readme (#777) chore: add `--build-tags` flag to `go_lint` make target (#807) [Core] Deploying all-the-protocol-actors (#710) fix: retrieve p2p mdoule from bus on each call chore: add godoc comments chore: remove unused `GetP2PConfig()` method ...

gokutheengineer and others added 10 commits May 8, 2023 07:03

add state sync flow diagram

82d2da6

update README

c0fc587

Merge branch 'main' into consensus/readme

6551583

add block generation process diagram

c83ddd0

add initial block validation

8272ebf

fix

129070b

add new descriptiosn

8caf8ab

Revert "add new descriptiosn"

686e067

This reverts commit 8caf8ab.

update

9fedcf6

update changelog, update module desc

f7d90b1

reviewpad bot added the medium Pull request is medium label May 21, 2023

gokutheengineer marked this pull request as ready for review May 21, 2023 12:17

gokutheengineer requested a review from Olshansk May 21, 2023 12:17

reviewpad bot added the waiting-for-review label May 21, 2023

Olshansk assigned gokutheengineer May 22, 2023

Olshansk added this to the M1: Pocket PoS (Proof of Stake) milestone May 22, 2023

Consensus README edits

0635baa

Olshansk requested changes May 23, 2023

View reviewed changes

Olshansk assigned Olshansk and unassigned gokutheengineer May 31, 2023

Merge with main

5b03eb4

gokutheengineer added 4 commits June 7, 2023 16:01

updates to README

5c927ef

update CHANGELOG date

ded04fb

Merge branch 'main' into consensus/readme

d3ccad8

fix typo

374c73d

Olshansk approved these changes Jun 7, 2023

View reviewed changes

gokutheengineer added 2 commits June 8, 2023 11:29

simplify state sync test diagram

37c524b

Merge branch 'main' into consensus/readme

8701934

gokutheengineer merged commit f72e1f0 into main Jun 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consensus/readme#777

Consensus/readme#777
gokutheengineer merged 18 commits intomainfrom
consensus/readme

gokutheengineer commented May 21, 2023 •

edited by reviewpad bot

Loading

Uh oh!

Olshansk left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk May 23, 2023

Uh oh!

Olshansk Jun 7, 2023

Uh oh!

gokutheengineer Jun 8, 2023

Uh oh!

codecov bot commented Jun 2, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		### State Sync

		State synchronization is crucial to ensure all participating nodes maintain a consistent and up-to-date view of the network state. It is especially important in a dynamic and decentralized network where nodes can join, leave, or experience intermittent connectivity. For an in-depth understanding of the state sync process and its current status, please refer to our [State Sync Protocol Design Specification](https://github.com/pokt-network/pocket/blob/main/consensus/doc/PROTOCOL_STATE_SYNC.md).

Conversation

gokutheengineer commented May 21, 2023 • edited by reviewpad bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary generated by Reviewpad on 08 Jun 23 08:33 UTC

Issue

Type of change

List of changes

Testing

Required Checklist

If Applicable Checklist

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk May 23, 2023

Choose a reason for hiding this comment

Uh oh!

Olshansk Jun 7, 2023

Choose a reason for hiding this comment

Uh oh!

gokutheengineer Jun 8, 2023

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gokutheengineer commented May 21, 2023 •

edited by reviewpad bot

Loading

codecov bot commented Jun 2, 2023 •

edited

Loading