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.

Sign up for GitHub

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

Jump to bottom

docs: Design document for Block Verification Process #384

Merged
merged 16 commits into from
Jan 9, 2025
Merged

docs: Design document for Block Verification Process #384

merged 16 commits into from
Jan 9, 2025

Conversation

AlfredoG87
Copy link
Contributor

@AlfredoG87 AlfredoG87 commented Dec 5, 2024 •
edited
Loading

Description:
Design document for Block Verification Process

Related issue(s):

Fixes #383

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@AlfredoG87 AlfredoG87 changed the title Design document for Block Verification Process docs: Design document for Block Verification Process Dec 6, 2024
@AlfredoG87 AlfredoG87 self-assigned this Dec 6, 2024
@AlfredoG87 AlfredoG87 added Design Issue/PR for feature design documents Block Node Issues/PR related to the Block Node. labels Dec 6, 2024
@AlfredoG87 AlfredoG87 added this to the 0.3.0 milestone Dec 6, 2024
@AlfredoG87 AlfredoG87 marked this pull request as ready for review December 6, 2024 16:14
@AlfredoG87 AlfredoG87 requested a review from a team as a code owner December 6, 2024 16:14
jsync-swirlds
jsync-swirlds reviewed Dec 6, 2024
View reviewed changes
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
jsync-swirlds
jsync-swirlds reviewed Dec 9, 2024
View reviewed changes
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
@AlfredoG87 AlfredoG87 added the Documentation Issues/PR related to documentation label Dec 11, 2024
ata-nas
ata-nas reviewed Dec 11, 2024
View reviewed changes
Copy link
Contributor

@ata-nas ata-nas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few suggestions.

server/docs/design/block-verification.md Show resolved Hide resolved
server/docs/design/block-verification.md Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Show resolved Hide resolved
server/docs/design/block-verification.md Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
@AlfredoG87
Design document for Block Verification Process
61c1073 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Changes that came up during first discussion with Matt P
2e78261 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
further simplification and cleaning of diagram
4738587 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
further simplification and cleaning of diagram
8626fc7 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
further simplification and cleaning of diagram
d9787e2 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Added notes for simpler approach on first iteration of implementation.
4cf32fd 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Suggestions by Joseph Design review.
0a5f61f 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
removed some more unneeded blank lines
1dd01f7 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
removed the notes to deffer the async as items come
d50533b 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Some more improvements out of the design PR Review
83e5362 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Added configuration section
479bcd8 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Improved Configuration section
35b2df8 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
Improved design wording
788be85 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
adjusted the line wrap at 80 for easier raw visualization
b1eb251 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
mattp-swirldslabs
mattp-swirldslabs previously approved these changes Dec 13, 2024
View reviewed changes
server/docs/design/block-verification.md Show resolved Hide resolved
@AlfredoG87
Feedback fixes
70a5458 
Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
@AlfredoG87
removed interfaces to simplify the design doc and give some breathing…
85aa769 
… room to the actual implementation

Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
mattp-swirldslabs
mattp-swirldslabs approved these changes Jan 9, 2025
View reviewed changes
Copy link
Contributor

@mattp-swirldslabs mattp-swirldslabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@AlfredoG87 AlfredoG87 merged commit 15519f5 into main Jan 9, 2025
13 checks passed
@AlfredoG87 AlfredoG87 deleted the verification-design branch January 9, 2025 22:07
@codecov Codecov
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.78%. Comparing base (b0270c1) to head (85aa769).
Report is 33 commits behind head on main.

Additional details and impacted files 
@@             Coverage Diff              @@
##               main     #384      +/-   ##
============================================
- Coverage     96.96%   96.78%   -0.19%     
- Complexity      395      409      +14     
============================================
  Files            79       82       +3     
  Lines          1417     1460      +43     
  Branches         93       90       -3     
============================================
+ Hits           1374     1413      +39     
- Misses           32       34       +2     
- Partials         11       13       +2

see 82 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsync-swirlds jsync-swirlds jsync-swirlds left review comments

@ata-nas ata-nas ata-nas left review comments

@mattp-swirldslabs mattp-swirldslabs mattp-swirldslabs approved these changes

@jasperpotts jasperpotts Awaiting requested review from jasperpotts

@georgi-l95 georgi-l95 Awaiting requested review from georgi-l95

Assignees

@AlfredoG87 AlfredoG87

Labels
Block Node Issues/PR related to the Block Node. Design Issue/PR for feature design documents Documentation Issues/PR related to documentation
Projects
None yet
Milestone
0.3.0
Development

Successfully merging this pull request may close these issues.

Design Doc for Verification Implementation
4 participants
@AlfredoG87 @ata-nas @mattp-swirldslabs @jsync-swirlds