Skip to content

Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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
TheBlueMatt merged 1 commit into from
Feb 22, 2024
Merged

Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information #2905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
},
// 15, 16, 17, 18 is above
19 => {
let mut list = loss_detector.handler.get_peer_node_ids();
list.sort_by_key(|v| v.0);
if let Some((id, _)) = list.get(0) {
loss_detector.handler.disconnect_by_node_id(*id);
let mut list = loss_detector.handler.list_peers();
list.sort_by_key(|v| v.counterparty_node_id);
if let Some(peer_details) = list.get(0) {
loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
}
},
20 => loss_detector.handler.disconnect_all_peers(),
Expand Down
88 changes: 73 additions & 15 deletions lightning/src/ln/peer_handler.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
/// The node id of the peer.
///
/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
/// passed in to [`PeerManager::new_outbound_connection`].
pub counterparty_node_id: PublicKey,
/// The socket address the peer provided in the initial handshake.
///
/// Will only be `Some` if an address had been previously provided to
/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
pub socket_address: Option<SocketAddress>,
/// The features the peer provided in the initial handshake.
pub init_features: InitFeatures,
/// Indicates the direction of the peer connection.
///
/// Will be `true` for inbound connections, and `false` for outbound connections.
pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
}
}

/// Get a list of tuples mapping from node id to network addresses for peers which have
/// completed the initial handshake.
///
/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
/// handshake has completed and we are sure the remote peer has the private key for the given
/// [`PublicKey`].
///
/// The returned `Option`s will only be `Some` if an address had been previously given via
/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
/// handshake.
pub fn list_peers(&self) -> Vec<PeerDetails> {
let peers = self.peers.read().unwrap();
peers.values().filter_map(|peer_mutex| {
let p = peer_mutex.lock().unwrap();
if !p.handshake_complete() {
return None;
}
Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
let details = PeerDetails {
// unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
// completed.
counterparty_node_id: p.their_node_id.unwrap().0,
socket_address: p.their_socket_address.clone(),
// unwrap safety: their_features is guaranteed to be `Some` after the handshake
// completed.
init_features: p.their_features.clone().unwrap(),
is_inbound_connection: p.inbound_connection,
};
Some(details)
}).collect()
}

/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
///
/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
let peers = self.peers.read().unwrap();
peers.values().find_map(|peer_mutex| {
let p = peer_mutex.lock().unwrap();
if !p.handshake_complete() {
return None;
}

// unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
// completed.
let counterparty_node_id = p.their_node_id.unwrap().0;

if counterparty_node_id != *their_node_id {
return None;
}

let details = PeerDetails {
counterparty_node_id,
socket_address: p.their_socket_address.clone(),
// unwrap safety: their_features is guaranteed to be `Some` after the handshake
// completed.
init_features: p.their_features.clone().unwrap(),
is_inbound_connection: p.inbound_connection,
};
Some(details)
})
}

fn get_ephemeral_key(&self) -> SecretKey {
let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
};
let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
let features_a = peer_a.init_features(&id_b);
let features_b = peer_b.init_features(&id_a);
let mut fd_b = FileDescriptor {
fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
(fd_a.clone(), fd_b.clone())
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Refactor `PeerManager::get_peer_node_ids` in favor of `list_peers`/`peer_by_node_id` returning additional information by tnull · Pull Request #2905 · lightningdevkit/rust-lightning · GitHub
Skip to content
Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information#2905

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

TheBlueMatt
merged 1 commit into

from

Feb 22, 2024
 Merged


Refactor PeerManager::get_peer_node_ids in favor of list_peers/peer_by_node_id returning additional information
#2905
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 4 additions & 4 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -737,10 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
 },
 // 15, 16, 17, 18 is above
 19 => {
 let mut list = loss_detector.handler.get_peer_node_ids();
 list.sort_by_key(|v| v.0);
 if let Some((id, _)) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(*id);
 let mut list = loss_detector.handler.list_peers();
 list.sort_by_key(|v| v.counterparty_node_id);
 if let Some(peer_details) = list.get(0) {
 loss_detector.handler.disconnect_by_node_id(peer_details.counterparty_node_id);
 }
 },
 20 => loss_detector.handler.disconnect_all_peers(),
Expand Down

88 changes: 73 additions & 15 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -431,6 +431,26 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
	fn disconnect_socket(&mut self);
}

/// Details of a connected peer as returned by [`PeerManager::list_peers`].
pub struct PeerDetails {
	/// The node id of the peer.
	///
	/// For outbound connections, this [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`PeerManager::new_outbound_connection`].
	pub counterparty_node_id: PublicKey,
	/// The socket address the peer provided in the initial handshake.
	///
	/// Will only be `Some` if an address had been previously provided to
	/// [`PeerManager::new_outbound_connection`] or [`PeerManager::new_inbound_connection`].
	pub socket_address: Option<SocketAddress>,
	/// The features the peer provided in the initial handshake.
	pub init_features: InitFeatures,
	/// Indicates the direction of the peer connection.
	///
	/// Will be `true` for inbound connections, and `false` for outbound connections.
	pub is_inbound_connection: bool,
}

/// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
/// descriptor.
Expand DownExpand Up@@ -958,27 +978,60 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 }
	}

	/// Get a list of tuples mapping from node id to network addresses for peers which have
	/// completed the initial handshake.
	///
	/// For outbound connections, the [`PublicKey`] will be the same as the `their_node_id` parameter
	/// passed in to [`Self::new_outbound_connection`], however entries will only appear once the initial
	/// handshake has completed and we are sure the remote peer has the private key for the given
	/// [`PublicKey`].
	///
	/// The returned `Option`s will only be `Some` if an address had been previously given via
	/// [`Self::new_outbound_connection`] or [`Self::new_inbound_connection`].
	pub fn get_peer_node_ids(&self) -> Vec<(PublicKey, Option<SocketAddress>)> {
	/// Returns a list of [`PeerDetails`] for connected peers that have completed the initial
	/// handshake.
	pub fn list_peers(&self) -> Vec<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().filter_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }
 Some((p.their_node_id.unwrap().0, p.their_socket_address.clone()))
 let details = PeerDetails {
 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 counterparty_node_id: p.their_node_id.unwrap().0,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 }).collect()
	}

	/// Returns the [`PeerDetails`] of a connected peer that has completed the initial handshake.
	///
	/// Will return `None` if the peer is unknown or it hasn't completed the initial handshake.
	pub fn peer_by_node_id(&self, their_node_id: &PublicKey) -> Option<PeerDetails> {
 let peers = self.peers.read().unwrap();
 peers.values().find_map(|peer_mutex| {
 let p = peer_mutex.lock().unwrap();
 if !p.handshake_complete() {
 return None;
 }

 // unwrap safety: their_node_id is guaranteed to be `Some` after the handshake
 // completed.
 let counterparty_node_id = p.their_node_id.unwrap().0;

 if counterparty_node_id != *their_node_id {
 return None;
 }

 let details = PeerDetails {
 counterparty_node_id,
 socket_address: p.their_socket_address.clone(),
 // unwrap safety: their_features is guaranteed to be `Some` after the handshake
 // completed.
 init_features: p.their_features.clone().unwrap(),
 is_inbound_connection: p.inbound_connection,
 };
 Some(details)
 })
	}

	fn get_ephemeral_key(&self) -> SecretKey {
 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 let counter = self.peer_counter.get_increment();
Expand DownExpand Up@@ -2746,6 +2799,8 @@ mod tests {
 };
 let addr_a = SocketAddress::TcpIpV4{addr: [127, 0, 0, 1], port: 1000};
 let id_b = peer_b.node_signer.get_node_id(Recipient::Node).unwrap();
 let features_a = peer_a.init_features(&id_b);
 let features_b = peer_b.init_features(&id_a);
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
Expand All@@ -2767,9 +2822,12 @@ mod tests {
 let a_data = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &a_data).unwrap(), false);

 assert!(peer_a.get_peer_node_ids().contains(&(id_b, Some(addr_b))));
 assert!(peer_b.get_peer_node_ids().contains(&(id_a, Some(addr_a))));

 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().counterparty_node_id, id_b);
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().socket_address, Some(addr_b));
 assert_eq!(peer_a.peer_by_node_id(&id_b).unwrap().init_features, features_b);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().counterparty_node_id, id_a);
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().socket_address, Some(addr_a));
 assert_eq!(peer_b.peer_by_node_id(&id_a).unwrap().init_features, features_a);
 (fd_a.clone(), fd_b.clone())
	}

Expand Down