Skip to content

protocols/gossipsub/src/config: Document peer exchange default is false #2397

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Dec 22, 2021
Merged

protocols/gossipsub/src/config: Document peer exchange default is false #2397

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d24d53
protocols/gossipsub/src/config: Document peer exchange default is false
mxinden Dec 19, 2021
efb0763
protocols/gossipsub: Reference peer exchange tracking issue
mxinden Dec 21, 2021
f8f4f93
Merge branch 'master' into gossipsub-default-px
mxinden Dec 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions protocols/gossipsub/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,10 @@ impl GossipsubConfig {
}

/// Whether Peer eXchange is enabled; this should be enabled in bootstrappers and other well
/// connected/trusted nodes. The default is true.
/// connected/trusted nodes. The default is false.
///
/// Note: Peer exchange is not implemented today, see
/// https://github.com/libp2p/rust-libp2p/issues/2398.
pub fn do_px(&self) -> bool {
self.do_px
}
Expand Down Expand Up @@ -602,7 +605,10 @@ impl GossipsubConfigBuilder {
}

/// Enables Peer eXchange. This should be enabled in bootstrappers and other well
/// connected/trusted nodes. The default is true.
/// connected/trusted nodes. The default is false.
///
/// Note: Peer exchange is not implemented today, see
/// https://github.com/libp2p/rust-libp2p/issues/2398.
pub fn do_px(&mut self) -> &mut Self {
self.config.do_px = true;
self
Expand Down