Merge pull request #928 from TheBlueMatt/2021-05-really-tlv-ser
[rust-lightning] / lightning / src / routing / router.rs
index ca7f30e30631a9679938a6a7eec0ebf371adf8a4..46fe93e779962f4be80a1873a4884228921f6a72 100644 (file)
@@ -21,9 +21,11 @@ use routing::network_graph::{NetworkGraph, RoutingFees};
 use util::ser::{Writeable, Readable};
 use util::logger::Logger;
 
-use std::cmp;
-use std::collections::{HashMap, BinaryHeap};
-use std::ops::Deref;
+use prelude::*;
+use alloc::collections::BinaryHeap;
+use core::cmp;
+use std::collections::HashMap;
+use core::ops::Deref;
 
 /// A hop in a route
 #[derive(Clone, PartialEq)]
@@ -95,23 +97,30 @@ pub struct Route {
        pub paths: Vec<Vec<RouteHop>>,
 }
 
+const SERIALIZATION_VERSION: u8 = 1;
+const MIN_SERIALIZATION_VERSION: u8 = 1;
+
 impl Writeable for Route {
        fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+               write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
                (self.paths.len() as u64).write(writer)?;
                for hops in self.paths.iter() {
                        hops.write(writer)?;
                }
+               write_tlv_fields!(writer, {}, {});
                Ok(())
        }
 }
 
 impl Readable for Route {
        fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Route, DecodeError> {
+               let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
                let path_count: u64 = Readable::read(reader)?;
                let mut paths = Vec::with_capacity(cmp::min(path_count, 128) as usize);
                for _ in 0..path_count {
                        paths.push(Readable::read(reader)?);
                }
+               read_tlv_fields!(reader, {}, {});
                Ok(Route { paths })
        }
 }
@@ -1186,6 +1195,7 @@ mod tests {
        use bitcoin::secp256k1::key::{PublicKey,SecretKey};
        use bitcoin::secp256k1::{Secp256k1, All};
 
+       use prelude::*;
        use std::sync::Arc;
 
        // Using the same keys for LN and BTC ids
@@ -3850,8 +3860,8 @@ mod tests {
        use util::ser::Readable;
        /// Tries to open a network graph file, or panics with a URL to fetch it.
        pub(super) fn get_route_file() -> Result<std::fs::File, std::io::Error> {
-               let res = File::open("net_graph-2021-02-12.bin") // By default we're run in RL/lightning
-                       .or_else(|_| File::open("lightning/net_graph-2021-02-12.bin")) // We may be run manually in RL/
+               let res = File::open("net_graph-2021-05-27.bin") // By default we're run in RL/lightning
+                       .or_else(|_| File::open("lightning/net_graph-2021-05-27.bin")) // We may be run manually in RL/
                        .or_else(|_| { // Fall back to guessing based on the binary location
                                // path is likely something like .../rust-lightning/target/debug/deps/lightning-...
                                let mut path = std::env::current_exe().unwrap();
@@ -3860,7 +3870,7 @@ mod tests {
                                path.pop(); // debug
                                path.pop(); // target
                                path.push("lightning");
-                               path.push("net_graph-2021-02-12.bin");
+                               path.push("net_graph-2021-05-27.bin");
                                eprintln!("{}", path.to_str().unwrap());
                                File::open(path)
                        });
@@ -3872,7 +3882,7 @@ mod tests {
 
        pub(super) fn random_init_seed() -> u64 {
                // Because the default HashMap in std pulls OS randomness, we can use it as a (bad) RNG.
-               use std::hash::{BuildHasher, Hasher};
+               use core::hash::{BuildHasher, Hasher};
                let seed = std::collections::hash_map::RandomState::new().build_hasher().finish();
                println!("Using seed of {}", seed);
                seed
@@ -3883,7 +3893,7 @@ mod tests {
                let mut d = match get_route_file() {
                        Ok(f) => f,
                        Err(_) => {
-                               eprintln!("Please fetch https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin and place it at lightning/net_graph-2021-02-12.bin");
+                               eprintln!("Please fetch https://bitcoin.ninja/ldk-net_graph-45d86ead641d-2021-05-27.bin and place it at lightning/net_graph-2021-05-27.bin");
                                return;
                        },
                };
@@ -3910,7 +3920,7 @@ mod tests {
                let mut d = match get_route_file() {
                        Ok(f) => f,
                        Err(_) => {
-                               eprintln!("Please fetch https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin and place it at lightning/net_graph-2021-02-12.bin");
+                               eprintln!("Please fetch https://bitcoin.ninja/ldk-net_graph-45d86ead641d-2021-05-27.bin and place it at lightning/net_graph-2021-05-27.bin");
                                return;
                        },
                };
@@ -3938,6 +3948,7 @@ mod benches {
        use super::*;
        use util::logger::{Logger, Record};
 
+       use prelude::*;
        use test::Bencher;
 
        struct DummyLogger {}
@@ -3948,7 +3959,7 @@ mod benches {
        #[bench]
        fn generate_routes(bench: &mut Bencher) {
                let mut d = tests::get_route_file()
-                       .expect("Please fetch https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin and place it at lightning/net_graph-2021-02-12.bin");
+                       .expect("Please fetch https://bitcoin.ninja/ldk-net_graph-45d86ead641d-2021-05-27.bin and place it at lightning/net_graph-2021-05-27.bin");
                let graph = NetworkGraph::read(&mut d).unwrap();
 
                // First, get 100 (source, destination) pairs for which route-getting actually succeeds...
@@ -3980,7 +3991,7 @@ mod benches {
        #[bench]
        fn generate_mpp_routes(bench: &mut Bencher) {
                let mut d = tests::get_route_file()
-                       .expect("Please fetch https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin and place it at lightning/net_graph-2021-02-12.bin");
+                       .expect("Please fetch https://bitcoin.ninja/ldk-net_graph-45d86ead641d-2021-05-27.bin and place it at lightning/net_graph-2021-05-27.bin");
                let graph = NetworkGraph::read(&mut d).unwrap();
 
                // First, get 100 (source, destination) pairs for which route-getting actually succeeds...