docs(node-network): add crate README#4070
Open
shaaibu7 wants to merge 2 commits intoProvableHQ:stagingfrom
Open
docs(node-network): add crate README#4070shaaibu7 wants to merge 2 commits intoProvableHQ:stagingfrom
shaaibu7 wants to merge 2 commits intoProvableHQ:stagingfrom
Conversation
vicsn
reviewed
Jan 14, 2026
| # snarkos-node-network | ||
|
|
||
| [](https://crates.io/crates/snarkos-node-network) | ||
| [](https://aleo.org) |
Collaborator
There was a problem hiding this comment.
Can you add License like every crate has?
Author
There was a problem hiding this comment.
@vicsn I have added a license and updated the readme.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
This PR adds a README.md to the
snarkos-node-networkcrate to document its purpose and responsibilities.The goal is to make the networking layer easier to understand for contributors by clearly describing peer management, connection lifecycle handling, bootstrap peer discovery, and address resolution.
Test Plan
This change is documentation-only.
Documentation
This PR introduces crate-level documentation for
snarkos-node-network.No additional external documentation updates are required at this time.
Backwards compatibility
This PR does not affect runtime behavior or consensus logic.
No backwards compatibility concerns and no
ConsensusVersionchanges are required.Fixes #4023
@raychu86