fix readme #41
Draft
fix readme #41
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
|
Adding lists of TODOS for today:
|
Eikix
commented
Jul 12, 2024
|
|
||
| As a design choice This Node results in some loss of generality, but seems like a reasonable given that libp2p is becoming a de-facto standard, and we see little value in re-implementing (and re-inventing) lower level network communication protocols. | ||
|
|
||
| Specifically, we identify nodes and address them using [Peer IDs](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md), with key pairs derived using [Ed25519](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#ed25519) scheme. |
There was a problem hiding this comment.
Is this still true?
Commit is old
Eikix
commented
Jul 12, 2024
|
|
||
| ### Identifying Nodes | ||
|
|
||
| An [`Identify` message](https://github.com/libp2p/specs/blob/master/identify/README.md) should include the following fields |
There was a problem hiding this comment.
Is this still true?
Commit is old
Eikix
commented
Jul 12, 2024
|
|
||
| ### Message Encoding | ||
|
|
||
| Use protobuf (`proto3`) for message encoding/decoding between peers. |
Eikix
commented
Jul 12, 2024
| Use protobuf (`proto3`) for message encoding/decoding between peers. | ||
| Specific message schemas to be defined for each protocol. | ||
|
|
||
| Messages that tie into other messages in one flow, i.e. messages expecting a response and providing a response MUST include a `request_id` (a positive integer) that allows nodes to correlate messages in the same flow. |
Eikix
commented
Jul 12, 2024
|
|
||
| Nodes SHOULD use semantic version matching when matching protocols, as described [here](https://docs.libp2p.io/concepts/protocols/#protocol-negotiation). | ||
|
|
||
| `agentVersion` is defined in the form of _agent-name/version_; e.g. `papyrus/0.1.0`. |
Eikix
commented
Jul 12, 2024
|
|
||
| An [`Identify` message](https://github.com/libp2p/specs/blob/master/identify/README.md) should include the following fields | ||
|
|
||
| `protocolVersion` := `/starknet/` + version |
Eikix
force-pushed
the
docs/update_readme
branch
from
58ca808
to
53e85f1
Compare
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.
Fixing readme by: