feat: include request response protocol description #19
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
just-mitch
reviewed
Sep 4, 2024
| /aztec/req/{subprotocol}/{version} | ||
| ``` | ||
|
|
||
| Where subprotocol details the type of request being made, and version details the version of the protocol being used, the exact form of version is yet to be determined. It may represent a semantic version (such as a hardfork), or it may represent a specific protocol implementation version (semver identifier). |
There was a problem hiding this comment.
semver identifier makes more sense to me here.
just-mitch
reviewed
Sep 4, 2024
| It should fail if, the message received is not of the expected size. | ||
| The message cannot be deserialized into the expected type. | ||
|
|
||
| The responder will read from the stream until: |
There was a problem hiding this comment.
Should be "will write to the stream"?
just-mitch
reviewed
Sep 4, 2024
| ``` | ||
|
|
||
| #### Making a request | ||
| When opening a stream with a peer, a specific protocolID (a.k.a. SubProtocol) will be used to determine what data the peer requires. For example, a SubProtocol with id `/aztec/req/tx/0.1.0` represents a stream that will be used to request a transaction payload from a peer. |
There was a problem hiding this comment.
Just curious, how does req/resp pick a peer to query?
There was a problem hiding this comment.
Right now it round robins through it's peer list, but I beleive spyros is working on a peer ranking system, so it should choose the first peer based on its ranking
|
Close in favor of https://github.com/AztecProtocol/engineering-designs/pull/27/files |
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.
No description provided.