-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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.
- Loading branch information
1 parent
335f5c6
commit 5e58a32
Showing
2 changed files
with
58 additions
and
18 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Protocol Documents | ||
|
||
This folder contains documents describing the expected protocol for various | ||
APIs provided by the block node and related systems. | ||
Each protocol document should describe a single API call and the expected | ||
behavior of both sides of that API call, including common error conditions. | ||
|
||
## Contents | ||
| Document | API call | Description | | ||
|:---|---:|:---| | ||
| publishBlockStream.md | `publishBlockStream` | The communication between a publisher and a block node when publishing a block stream from an authoritative source such as a consensus node.| |
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