mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 15:02:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

Rename ChannelDetails::is_live to is_usable

Browse source 
This matches is_usable_channels and slightly better captures the
meaning.
This commit is contained in:
Matt Corallo 2021-05-06 20:26:39 +00:00
parent 6a79eece21
commit 62f466a0a2
3 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
fuzz/src/router.rs
View file

@ -215,7 +215,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
inbound_capacity_msat: 0,
is_outbound: true,
is_funding_locked: true,
is_live: true,
is_usable: true,
is_public: true,
outbound_capacity_msat: 0,
counterparty_forwarding_info: None,

9
lightning/src/ln/channelmanager.rs
View file

@ -646,7 +646,7 @@ pub struct ChannelDetails {
/// channel is not currently negotiating a shutdown.
///
/// This is a strict superset of `is_funding_locked`.
pub is_live: bool,
pub is_usable: bool,
/// True if this channel is (or will be) publicly-announced.
pub is_public: bool,
/// Information on the fees and requirements that the counterparty requires when forwarding
@ -981,7 +981,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
user_id: channel.get_user_id(),
is_outbound: channel.is_outbound(),
is_funding_locked: channel.is_usable(),
is_live: channel.is_live(),
is_usable: channel.is_live(),
is_public: channel.should_announce(),
counterparty_forwarding_info: channel.counterparty_forwarding_info(),
});
@ -1005,8 +1005,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
/// Gets the list of usable channels, in random order. Useful as an argument to
/// get_route to ensure non-announced channels are used.
///
/// These are guaranteed to have their is_live value set to true, see the documentation for
/// ChannelDetails::is_live for more info on exactly what the criteria are.
/// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
/// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
/// are.
pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
// Note we use is_live here instead of usable which leads to somewhat confused
// internal/external nomenclature, but that's ok cause that's probably what the user

14
lightning/src/routing/router.rs
View file

@ -1635,7 +1635,7 @@ mod tests {
outbound_capacity_msat: 100000,
inbound_capacity_msat: 100000,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];
@ -1955,7 +1955,7 @@ mod tests {
outbound_capacity_msat: 250_000_000,
inbound_capacity_msat: 0,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];
let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
@ -2005,7 +2005,7 @@ mod tests {
outbound_capacity_msat: 250_000_000,
inbound_capacity_msat: 0,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];
let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
@ -2072,7 +2072,7 @@ mod tests {
outbound_capacity_msat: 250_000_000,
inbound_capacity_msat: 0,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];
let route = get_route(&our_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2], None, Some(&our_chans.iter().collect::<Vec<_>>()), &Vec::new(), 100, 42, Arc::clone(&logger)).unwrap();
@ -2211,7 +2211,7 @@ mod tests {
outbound_capacity_msat: 250_000_000,
inbound_capacity_msat: 0,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];
let mut last_hops = last_hops(&nodes);
@ -2342,7 +2342,7 @@ mod tests {
outbound_capacity_msat: 100000,
inbound_capacity_msat: 100000,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];
let route = get_route(&source_node_id, &NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash()), &target_node_id, None, Some(&our_chans.iter().collect::<Vec<_>>()), &last_hops.iter().collect::<Vec<_>>(), 100, 42, Arc::new(test_utils::TestLogger::new())).unwrap();
@ -2476,7 +2476,7 @@ mod tests {
outbound_capacity_msat: 200_000_000,
inbound_capacity_msat: 0,
is_outbound: true, is_funding_locked: true,
is_live: true, is_public: true,
is_usable: true, is_public: true,
counterparty_forwarding_info: None,
}];