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: Design document for Block Verification Process #384

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

AlfredoG87
Copy link
Contributor

@AlfredoG87 AlfredoG87 commented Dec 5, 2024

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
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
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
server/docs/design/block-verification.md Outdated Show resolved Hide resolved
- **blocks_system_error**: Counter of the number of blocks with system errors
- **block_verification_time**: Histogram of the time taken to verify a block, gives the node operator an idea of the time taken to verify a block.
-
## Exceptions
Copy link
Member

Choose a reason for hiding this comment

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

I think we're mingling high-level and detail design a bit too much, then.

A response code is what I would call these (as they are not exception classes) and avoid mingling concepts.
At this high level, it is irrelevant how that response code is generated (whether exception, or inspection, or any other mechanism); only that the response is returned to the "caller" (however that is defined).

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
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 Show resolved Hide resolved
server/docs/design/block-verification.md Show resolved Hide resolved
- **blocks_system_error**: Counter of the number of blocks with system errors
- **block_verification_time**: Histogram of the time taken to verify a block, gives the node operator an idea of the time taken to verify a block.
-
## Exceptions
Copy link
Contributor

Choose a reason for hiding this comment

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

server/docs/design/block-verification.md Outdated Show resolved Hide resolved
Signed-off-by: Alfredo Gutierrez <[email protected]>
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.96%. Comparing base (b0270c1) to head (b1eb251).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #384   +/-   ##
=========================================
  Coverage     96.96%   96.96%           
  Complexity      395      395           
=========================================
  Files            79       79           
  Lines          1417     1417           
  Branches         93       93           
=========================================
  Hits           1374     1374           
  Misses           32       32           
  Partials         11       11           


## Entities

- #### VerificationHandler
Copy link
Contributor

Choose a reason for hiding this comment

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

Wrong heading level for verification handler

Suggested change
- #### VerificationHandler
- ### VerificationHandler

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

Design Doc for Verification Implementation
4 participants