expose `feerate_sat_per_1000_weight` in `ChannelDetails`
[rust-lightning] / fuzz / src / router.rs
index e80e080f31786bc76b40b10bc9b6fb96d27c8e2a..568dcdf0250057c68e1cf946b4b543f97c8933c0 100644 (file)
@@ -11,22 +11,24 @@ use bitcoin::blockdata::script::Builder;
 use bitcoin::blockdata::transaction::TxOut;
 use bitcoin::hash_types::BlockHash;
 
-use lightning::chain;
-use lightning::ln::channelmanager::ChannelDetails;
-use lightning::ln::features::InitFeatures;
+use lightning::chain::transaction::OutPoint;
+use lightning::ln::channelmanager::{self, ChannelDetails, ChannelCounterparty};
 use lightning::ln::msgs;
-use lightning::routing::router::{get_route, RouteHintHop};
-use lightning::util::logger::Logger;
+use lightning::routing::gossip::{NetworkGraph, RoutingFees};
+use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};
+use lightning::routing::router::{find_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
+use lightning::routing::scoring::ProbabilisticScorer;
+use lightning::util::config::UserConfig;
 use lightning::util::ser::Readable;
-use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
 
-use bitcoin::secp256k1::key::PublicKey;
+use bitcoin::hashes::Hash;
+use bitcoin::secp256k1::PublicKey;
 use bitcoin::network::constants::Network;
-use bitcoin::blockdata::constants::genesis_block;
 
-use utils::test_logger;
+use crate::utils::test_logger;
 
-use std::collections::HashSet;
+use std::convert::TryInto;
+use hashbrown::HashSet;
 use std::sync::Arc;
 use std::sync::atomic::{AtomicUsize, Ordering};
 
@@ -78,17 +80,36 @@ impl InputData {
        }
 }
 
-struct FuzzChainSource {
+struct FuzzChainSource<'a, 'b, Out: test_logger::Output> {
        input: Arc<InputData>,
+       net_graph: &'a NetworkGraph<&'b test_logger::TestLogger<Out>>,
 }
-impl chain::Access for FuzzChainSource {
-       fn get_utxo(&self, _genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
-               match self.input.get_slice(2) {
-                       Some(&[0, _]) => Err(chain::AccessError::UnknownChain),
-                       Some(&[1, _]) => Err(chain::AccessError::UnknownTx),
-                       Some(&[_, x]) => Ok(TxOut { value: 0, script_pubkey: Builder::new().push_int(x as i64).into_script().to_v0_p2wsh() }),
-                       None => Err(chain::AccessError::UnknownTx),
-                       _ => unreachable!(),
+impl<Out: test_logger::Output> UtxoLookup for FuzzChainSource<'_, '_, Out> {
+       fn get_utxo(&self, _genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
+               let input_slice = self.input.get_slice(2);
+               if input_slice.is_none() { return UtxoResult::Sync(Err(UtxoLookupError::UnknownTx)); }
+               let input_slice = input_slice.unwrap();
+               let txo_res = TxOut {
+                       value: if input_slice[0] % 2 == 0 { 1_000_000 } else { 1_000 },
+                       script_pubkey: Builder::new().push_int(input_slice[1] as i64).into_script().to_v0_p2wsh(),
+               };
+               match input_slice {
+                       &[0, _] => UtxoResult::Sync(Err(UtxoLookupError::UnknownChain)),
+                       &[1, _] => UtxoResult::Sync(Err(UtxoLookupError::UnknownTx)),
+                       &[2, _] => {
+                               let future = UtxoFuture::new();
+                               future.resolve_without_forwarding(self.net_graph, Ok(txo_res));
+                               UtxoResult::Async(future.clone())
+                       },
+                       &[3, _] => {
+                               let future = UtxoFuture::new();
+                               future.resolve_without_forwarding(self.net_graph, Err(UtxoLookupError::UnknownTx));
+                               UtxoResult::Async(future.clone())
+                       },
+                       &[4, _] => {
+                               UtxoResult::Async(UtxoFuture::new()) // the future will never resolve
+                       },
+                       &[..] => UtxoResult::Sync(Ok(txo_res)),
                }
        }
 }
@@ -131,6 +152,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
                                        msgs::DecodeError::BadLengthDescriptor => return,
                                        msgs::DecodeError::ShortRead => panic!("We picked the length..."),
                                        msgs::DecodeError::Io(e) => panic!("{:?}", e),
+                                       msgs::DecodeError::UnsupportedCompression => return,
                                }
                        }
                }}
@@ -145,6 +167,15 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
                }
        }
 
+       macro_rules! get_pubkey_from_node_id {
+               ($node_id: expr ) => {
+                       match PublicKey::from_slice($node_id.as_slice()) {
+                               Ok(pk) => pk,
+                               Err(_) => return,
+                       }
+               }
+       }
+
        macro_rules! get_pubkey {
                () => {
                        match PublicKey::from_slice(get_slice!(33)) {
@@ -154,10 +185,14 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
                }
        }
 
-       let logger: Arc<dyn Logger> = Arc::new(test_logger::TestLogger::new("".to_owned(), out));
+       let logger = test_logger::TestLogger::new("".to_owned(), out);
 
        let our_pubkey = get_pubkey!();
-       let mut net_graph = NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash());
+       let net_graph = NetworkGraph::new(Network::Bitcoin, &logger);
+       let chain_source = FuzzChainSource {
+               input: Arc::clone(&input),
+               net_graph: &net_graph,
+       };
 
        let mut node_pks = HashSet::new();
        let mut scid = 42;
@@ -171,27 +206,28 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
                                        return;
                                }
                                let msg = decode_msg_with_len16!(msgs::UnsignedNodeAnnouncement, 288);
-                               node_pks.insert(msg.node_id);
+                               node_pks.insert(get_pubkey_from_node_id!(msg.node_id));
                                let _ = net_graph.update_node_from_unsigned_announcement(&msg);
                        },
                        1 => {
                                let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
-                               node_pks.insert(msg.node_id_1);
-                               node_pks.insert(msg.node_id_2);
-                               let _ = net_graph.update_channel_from_unsigned_announcement::<&FuzzChainSource>(&msg, &None);
+                               node_pks.insert(get_pubkey_from_node_id!(msg.node_id_1));
+                               node_pks.insert(get_pubkey_from_node_id!(msg.node_id_2));
+                               let _ = net_graph.update_channel_from_unsigned_announcement::
+                                       <&FuzzChainSource<'_, '_, Out>>(&msg, &None);
                        },
                        2 => {
                                let msg = decode_msg_with_len16!(msgs::UnsignedChannelAnnouncement, 32+8+33*4);
-                               node_pks.insert(msg.node_id_1);
-                               node_pks.insert(msg.node_id_2);
-                               let _ = net_graph.update_channel_from_unsigned_announcement(&msg, &Some(&FuzzChainSource { input: Arc::clone(&input) }));
+                               node_pks.insert(get_pubkey_from_node_id!(msg.node_id_1));
+                               node_pks.insert(get_pubkey_from_node_id!(msg.node_id_2));
+                               let _ = net_graph.update_channel_from_unsigned_announcement(&msg, &Some(&chain_source));
                        },
                        3 => {
                                let _ = net_graph.update_channel_unsigned(&decode_msg!(msgs::UnsignedChannelUpdate, 72));
                        },
                        4 => {
                                let short_channel_id = slice_to_be64(get_slice!(8));
-                               net_graph.close_channel_from_update(short_channel_id, false);
+                               net_graph.channel_failed(short_channel_id, false);
                        },
                        _ if node_pks.is_empty() => {},
                        _ => {
@@ -201,30 +237,50 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
                                        count => {
                                                for _ in 0..count {
                                                        scid += 1;
-                                                       let rnid = node_pks.iter().skip(slice_to_be16(get_slice!(2))as usize % node_pks.len()).next().unwrap();
+                                                       let rnid = node_pks.iter().skip(u16::from_be_bytes(get_slice!(2).try_into().unwrap()) as usize % node_pks.len()).next().unwrap();
+                                                       let capacity = u64::from_be_bytes(get_slice!(8).try_into().unwrap());
                                                        first_hops_vec.push(ChannelDetails {
                                                                channel_id: [0; 32],
+                                                               counterparty: ChannelCounterparty {
+                                                                       node_id: *rnid,
+                                                                       features: channelmanager::provided_init_features(&UserConfig::default()),
+                                                                       unspendable_punishment_reserve: 0,
+                                                                       forwarding_info: None,
+                                                                       outbound_htlc_minimum_msat: None,
+                                                                       outbound_htlc_maximum_msat: None,
+                                                               },
+                                                               funding_txo: Some(OutPoint { txid: bitcoin::Txid::from_slice(&[0; 32]).unwrap(), index: 0 }),
+                                                               channel_type: None,
                                                                short_channel_id: Some(scid),
-                                                               remote_network_id: *rnid,
-                                                               counterparty_features: InitFeatures::known(),
-                                                               channel_value_satoshis: slice_to_be64(get_slice!(8)),
-                                                               user_id: 0,
-                                                               inbound_capacity_msat: 0,
-                                                               is_live: true,
-                                                               outbound_capacity_msat: 0,
-                                                               counterparty_forwarding_info: None,
+                                                               inbound_scid_alias: None,
+                                                               outbound_scid_alias: None,
+                                                               channel_value_satoshis: capacity,
+                                                               user_channel_id: 0, inbound_capacity_msat: 0,
+                                                               unspendable_punishment_reserve: None,
+                                                               confirmations_required: None,
+                                                               confirmations: None,
+                                                               force_close_spend_delay: None,
+                                                               is_outbound: true, is_channel_ready: true,
+                                                               is_usable: true, is_public: true,
+                                                               balance_msat: 0,
+                                                               outbound_capacity_msat: capacity.saturating_mul(1000),
+                                                               next_outbound_htlc_limit_msat: capacity.saturating_mul(1000),
+                                                               inbound_htlc_minimum_msat: None,
+                                                               inbound_htlc_maximum_msat: None,
+                                                               config: None,
+                                                               feerate_sat_per_1000_weight: None,
                                                        });
                                                }
                                                Some(&first_hops_vec[..])
                                        },
                                };
-                               let mut last_hops_vec = Vec::new();
+                               let mut last_hops = Vec::new();
                                {
                                        let count = get_slice!(1)[0];
                                        for _ in 0..count {
                                                scid += 1;
                                                let rnid = node_pks.iter().skip(slice_to_be16(get_slice!(2))as usize % node_pks.len()).next().unwrap();
-                                               last_hops_vec.push(RouteHintHop {
+                                               last_hops.push(RouteHint(vec![RouteHintHop {
                                                        src_node_id: *rnid,
                                                        short_channel_id: scid,
                                                        fees: RoutingFees {
@@ -234,15 +290,22 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
                                                        cltv_expiry_delta: slice_to_be16(get_slice!(2)),
                                                        htlc_minimum_msat: Some(slice_to_be64(get_slice!(8))),
                                                        htlc_maximum_msat: None,
-                                               });
+                                               }]));
                                        }
                                }
-                               let last_hops = &last_hops_vec[..];
+                               let scorer = ProbabilisticScorer::new(Default::default(), &net_graph, &logger);
+                               let random_seed_bytes: [u8; 32] = [get_slice!(1)[0]; 32];
                                for target in node_pks.iter() {
-                                       let _ = get_route(&our_pubkey, &net_graph, target, None,
+                                       let final_value_msat = slice_to_be64(get_slice!(8));
+                                       let final_cltv_expiry_delta = slice_to_be32(get_slice!(4));
+                                       let route_params = RouteParameters {
+                                               payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
+                                                       .with_route_hints(last_hops.clone()),
+                                               final_value_msat,
+                                       };
+                                       let _ = find_route(&our_pubkey, &route_params, &net_graph,
                                                first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
-                                               &last_hops.iter().collect::<Vec<_>>(),
-                                               slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
+                                               &logger, &scorer, &random_seed_bytes);
                                }
                        },
                }