docs: Add a protocol document for publishBlockStream
#267
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsync-swirlds
added
Block Node
jsync-swirlds
force-pushed
the
add-handshake-document
branch
from
d498805
to
a062c6f
Compare
jsync-swirlds
changed the title
publishBlockStream.publishBlockStream
jsync-swirlds
force-pushed
the
add-handshake-document
branch
from
8750516
to
015a11a
Compare
georgi-l95
reviewed
Oct 17, 2024
* Added a new document in `docs/Protocol` for `publishBlockStream`.
* Included a first pass protocol definition.
* Note this is in general informal language; not Estelle, SDL, LOTOS,
or other highly formal language.
Signed-off-by: Joseph Sinclair <[email protected]>
Signed-off-by: Alfredo Gutierrez <[email protected]> Signed-off-by: Joseph Sinclair <[email protected]>
jsync-swirlds
force-pushed
the
add-handshake-document
branch
3 times, most recently
from
dfc7cc7
to
5e58a32
Compare
* Changed definition list to work within github limitations. * Added an Abstract section to reduce confusion. * Added a readme file to describe items in the protocol folder * Added a reliability note to explain the cautious nature of the protocol. Signed-off-by: Joseph Sinclair <[email protected]>
jsync-swirlds
force-pushed
the
add-handshake-document
branch
from
5e58a32
to
9ffb8e2
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #267 +/- ##
=========================================
Coverage 99.78% 99.78%
Complexity 259 259
=========================================
Files 52 52
Lines 938 938
Branches 64 64
=========================================
Hits 936 936
Misses 2 2 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs/ProtocolforpublishBlockStream.or other highly formal language.
Fixes #120