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

docs: update consensus readme #26

Merged
merged 1 commit into from
Jan 20, 2023

Conversation

bryanchriswhite
Copy link
Contributor

Changes

  • §3.1.1: embolden first occurance of the term QuorumCerfiticate and add abbreviated form (QC) in parenthesis to mitigate confusion around derivative terms (e.g. highQC)
  • §3.1.3: fix typo, the
  • §3.1.4: remove or, assuming it's a typo
  • §3.1.9: replace space with . for consistent usage of QuorumCertificate.Round/Step
  • §4.1: fix typo, unbond instead of unbound
  • §4.4: add the duration to the phrase ...is vulnerable to Leader DDOS for the duration between...
  • §6: close open quote around non-deterministic

- 3.1.1: embolden first occurance of the term `QuorumCerfiticate` and add abbreviated form (`QC`) in parenthesis to mitigate confusion around derivative terms (e.g. `highQC`)
- 3.1.3: fix typo, `the`
- 3.1.4: remove `or`, assuming it's a typo
- 3.1.9: replace space with `.` for consistent usage of `QuorumCertificate.Round/Step`
- 4.1: fix typo, `unbond` instead of `unbound`
- 4.4: add `the duration` to the phrase `...is vulnerable to Leader DDOS for the duration between...`
- 6: close open quote around `non-deterministic`
@bryanchriswhite
Copy link
Contributor Author

  1. I was also wondering if, in the HotPocket Leader Selection pseudo-code, SelectLeader should receive height, round, and lastNLeaders like IsLeaderCandidate does?

  2. I didn't see any source for those images, is there a source of truth for the images in this repo?

@bryanchriswhite bryanchriswhite self-assigned this Jan 19, 2023
@bryanchriswhite bryanchriswhite added the documentation Improvements or additions to documentation label Jan 19, 2023
@Olshansk
Copy link
Member

  1. I was also wondering if, in the HotPocket Leader Selection pseudo-code, SelectLeader should receive height, round, and lastNLeaders like IsLeaderCandidate does?

Yea, ideally it should to make things clearer. Feel free to update it in a followup PR after we merge this and #28 in.

  1. I didn't see any source for those images, is there a source of truth for the images in this repo?

Appreciate the request. Adding these in, as well as updating the algorithm, has been on my backlog for a while and this was a good catalyst/reminder to do so. Please see #28


@bryanchriswhite What we do on the team is "squash and merge" PRs where the body of the commit message is a copy-paste of the github PR.

Also, make sure to attach the iteration to the PR being merged so we can look back and see on everything we finished when reviewing the iteration!

Screenshot 2023-01-19 at 5 43 27 PM

@bryanchriswhite bryanchriswhite merged commit 9b257f2 into pokt-network:main Jan 20, 2023
@bryanchriswhite bryanchriswhite deleted the docs/consensus branch January 20, 2023 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants