Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: p2p package overview #6096

Merged
merged 6 commits into from
Aug 15, 2024
Merged

Conversation

algorandskiy
Copy link
Contributor

@algorandskiy algorandskiy commented Aug 7, 2024

Summary

  1. Update network/p2p/README.md
  2. Add network/README-P2P.md

While writing this doc found and fixed the following:

  • Make some methods package-private since there is no clients for them.
  • Handle peer.GetHTTPClient() returning nil since MakeHTTPClient for p2p net can err.
  • Enable capabilities only if node is configured to listen.

@algorandskiy algorandskiy self-assigned this Aug 7, 2024
@algorandskiy algorandskiy force-pushed the pavel/p2p-docs branch 2 times, most recently from f20f860 to bcd818f Compare August 7, 2024 20:49
Copy link

codecov bot commented Aug 7, 2024

Codecov Report

Attention: Patch coverage is 67.85714% with 9 lines in your changes missing coverage. Please review.

Project coverage is 55.93%. Comparing base (23a04c2) to head (c1fd68b).
Report is 1 commits behind head on master.

Files Patch % Lines
catchup/ledgerFetcher.go 50.00% 1 Missing and 1 partial ⚠️
catchup/universalFetcher.go 50.00% 1 Missing and 1 partial ⚠️
network/p2p/p2p.go 0.00% 2 Missing ⚠️
network/p2pPeer.go 75.00% 2 Missing ⚠️
network/p2pNetwork.go 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6096      +/-   ##
==========================================
- Coverage   56.25%   55.93%   -0.32%     
==========================================
  Files         490      490              
  Lines       69699    69706       +7     
==========================================
- Hits        39206    38993     -213     
- Misses      27825    28004     +179     
- Partials     2668     2709      +41     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@algorandskiy algorandskiy changed the title WIP: p2p documentation docs: p2p package overview Aug 8, 2024
@algorandskiy algorandskiy marked this pull request as ready for review August 8, 2024 20:54
Copy link
Contributor

@jasonpaulos jasonpaulos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good I have just a few minor comments

catchup/ledgerFetcher.go Outdated Show resolved Hide resolved
network/p2p/README.md Outdated Show resolved Hide resolved
network/README-P2P.md Outdated Show resolved Hide resolved
node/node.go Show resolved Hide resolved
Copy link
Contributor

@gmalouf gmalouf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put in some wording suggestions for the READMEs along with a question about the isGossipServer checks.

network/README-P2P.md Outdated Show resolved Hide resolved
network/README-P2P.md Outdated Show resolved Hide resolved
network/README-P2P.md Outdated Show resolved Hide resolved
network/README-P2P.md Show resolved Hide resolved
network/README-P2P.md Outdated Show resolved Hide resolved
network/p2p/README.md Outdated Show resolved Hide resolved
network/p2p/README.md Outdated Show resolved Hide resolved
network/p2p/README.md Outdated Show resolved Hide resolved
network/p2p/README.md Outdated Show resolved Hide resolved
network/p2p/README.md Outdated Show resolved Hide resolved
@algorandskiy
Copy link
Contributor Author

@jasonpaulos / @gmalouf thank you for corrections! All applied.

Copy link
Contributor

@gmalouf gmalouf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I like - I do wonder where we put the clear recommendation to bias towards using the appropriate hybrid profiles (and making sure they are aware of the appropriate settings) for users interesting in exercising the P2P network out of the gate.

@algorandskiy algorandskiy merged commit 7fc243c into algorand:master Aug 15, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants