add rustfmt + CI + other fixups
[ldk-sample] / src / main.rs
1 mod bitcoind_client;
2 mod cli;
3 mod convert;
4 mod disk;
5 mod hex_utils;
6
7 use crate::bitcoind_client::BitcoindClient;
8 use crate::disk::FilesystemLogger;
9 use bitcoin::blockdata::constants::genesis_block;
10 use bitcoin::blockdata::transaction::Transaction;
11 use bitcoin::consensus::encode;
12 use bitcoin::hashes::sha256::Hash as Sha256;
13 use bitcoin::hashes::Hash;
14 use bitcoin::network::constants::Network;
15 use bitcoin::secp256k1::Secp256k1;
16 use bitcoin::BlockHash;
17 use bitcoin_bech32::WitnessProgram;
18 use lightning::chain;
19 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
20 use lightning::chain::chainmonitor::ChainMonitor;
21 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
22 use lightning::chain::transaction::OutPoint;
23 use lightning::chain::Filter;
24 use lightning::chain::Watch;
25 use lightning::ln::channelmanager;
26 use lightning::ln::channelmanager::{
27         ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage, SimpleArcChannelManager,
28 };
29 use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
30 use lightning::routing::network_graph::NetGraphMsgHandler;
31 use lightning::util::config::UserConfig;
32 use lightning::util::events::{Event, EventsProvider};
33 use lightning::util::ser::ReadableArgs;
34 use lightning_background_processor::BackgroundProcessor;
35 use lightning_block_sync::init;
36 use lightning_block_sync::poll;
37 use lightning_block_sync::SpvClient;
38 use lightning_block_sync::UnboundedCache;
39 use lightning_net_tokio::SocketDescriptor;
40 use lightning_persister::FilesystemPersister;
41 use rand::{thread_rng, Rng};
42 use std::collections::HashMap;
43 use std::fmt;
44 use std::fs;
45 use std::fs::File;
46 use std::io;
47 use std::io::Write;
48 use std::path::Path;
49 use std::sync::{Arc, Mutex};
50 use std::thread;
51 use std::time::{Duration, SystemTime};
52 use tokio::runtime::Runtime;
53 use tokio::sync::mpsc;
54
55 #[derive(PartialEq)]
56 pub(crate) enum HTLCDirection {
57         Inbound,
58         Outbound,
59 }
60
61 pub(crate) enum HTLCStatus {
62         Pending,
63         Succeeded,
64         Failed,
65 }
66
67 pub(crate) struct SatoshiAmount(Option<u64>);
68
69 impl fmt::Display for SatoshiAmount {
70         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
71                 match self.0 {
72                         Some(amt) => write!(f, "{}", amt),
73                         None => write!(f, "unknown"),
74                 }
75         }
76 }
77
78 pub(crate) type PaymentInfoStorage = Arc<
79         Mutex<
80                 HashMap<PaymentHash, (Option<PaymentPreimage>, HTLCDirection, HTLCStatus, SatoshiAmount)>,
81         >,
82 >;
83
84 type ArcChainMonitor = ChainMonitor<
85         InMemorySigner,
86         Arc<dyn Filter>,
87         Arc<BitcoindClient>,
88         Arc<BitcoindClient>,
89         Arc<FilesystemLogger>,
90         Arc<FilesystemPersister>,
91 >;
92
93 pub(crate) type PeerManager = SimpleArcPeerManager<
94         SocketDescriptor,
95         ArcChainMonitor,
96         BitcoindClient,
97         BitcoindClient,
98         dyn chain::Access,
99         FilesystemLogger,
100 >;
101
102 pub(crate) type ChannelManager =
103         SimpleArcChannelManager<ArcChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
104
105 fn handle_ldk_events(
106         peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
107         chain_monitor: Arc<ArcChainMonitor>, bitcoind_client: Arc<BitcoindClient>,
108         keys_manager: Arc<KeysManager>, payment_storage: PaymentInfoStorage, network: Network,
109 ) {
110         let mut pending_txs: HashMap<OutPoint, Transaction> = HashMap::new();
111         loop {
112                 peer_manager.process_events();
113                 let loop_channel_manager = channel_manager.clone();
114                 let mut events = channel_manager.get_and_clear_pending_events();
115                 events.append(&mut chain_monitor.get_and_clear_pending_events());
116                 for event in events {
117                         match event {
118                                 Event::FundingGenerationReady {
119                                         temporary_channel_id,
120                                         channel_value_satoshis,
121                                         output_script,
122                                         ..
123                                 } => {
124                                         // Construct the raw transaction with one output, that is paid the amount of the
125                                         // channel.
126                                         let addr = WitnessProgram::from_scriptpubkey(
127                                                 &output_script[..],
128                                                 match network {
129                                                         Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
130                                                         Network::Testnet => bitcoin_bech32::constants::Network::Testnet,
131                                                         Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
132                                                         Network::Signet => panic!("Signet unsupported"),
133                                                 },
134                                         )
135                                         .expect("Lightning funding tx should always be to a SegWit output")
136                                         .to_address();
137                                         let mut outputs = vec![HashMap::with_capacity(1)];
138                                         outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
139                                         let raw_tx = bitcoind_client.create_raw_transaction(outputs);
140
141                                         // Have your wallet put the inputs into the transaction such that the output is
142                                         // satisfied.
143                                         let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx);
144                                         let change_output_position = funded_tx.changepos;
145                                         assert!(change_output_position == 0 || change_output_position == 1);
146
147                                         // Sign the final funding transaction and broadcast it.
148                                         let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex);
149                                         assert_eq!(signed_tx.complete, true);
150                                         let final_tx: Transaction =
151                                                 encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
152                                         let outpoint = OutPoint {
153                                                 txid: final_tx.txid(),
154                                                 index: if change_output_position == 0 { 1 } else { 0 },
155                                         };
156                                         // Give the funding transaction back to LDK for opening the channel.
157                                         loop_channel_manager
158                                                 .funding_transaction_generated(&temporary_channel_id, outpoint);
159                                         pending_txs.insert(outpoint, final_tx);
160                                 }
161                                 Event::FundingBroadcastSafe { funding_txo, .. } => {
162                                         let funding_tx = pending_txs.remove(&funding_txo).unwrap();
163                                         bitcoind_client.broadcast_transaction(&funding_tx);
164                                         println!("\nEVENT: broadcasted funding transaction");
165                                         print!("> ");
166                                         io::stdout().flush().unwrap();
167                                 }
168                                 Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
169                                         let mut payments = payment_storage.lock().unwrap();
170                                         if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
171                                                 assert!(loop_channel_manager.claim_funds(
172                                                         preimage.clone(),
173                                                         &payment_secret,
174                                                         amt_msat
175                                                 ));
176                                                 println!(
177                                                         "\nEVENT: received payment from payment_hash {} of {} satoshis",
178                                                         hex_utils::hex_str(&payment_hash.0),
179                                                         amt_msat / 1000
180                                                 );
181                                                 print!("> ");
182                                                 io::stdout().flush().unwrap();
183                                                 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
184                                                 *status = HTLCStatus::Succeeded;
185                                         } else {
186                                                 println!("\nERROR: we received a payment but didn't know the preimage");
187                                                 print!("> ");
188                                                 io::stdout().flush().unwrap();
189                                                 loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
190                                                 payments.insert(
191                                                         payment_hash,
192                                                         (None, HTLCDirection::Inbound, HTLCStatus::Failed, SatoshiAmount(None)),
193                                                 );
194                                         }
195                                 }
196                                 Event::PaymentSent { payment_preimage } => {
197                                         let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
198                                         let mut payments = payment_storage.lock().unwrap();
199                                         for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut()
200                                         {
201                                                 if *payment_hash == hashed {
202                                                         *preimage_option = Some(payment_preimage);
203                                                         *status = HTLCStatus::Succeeded;
204                                                         println!(
205                                                                 "\nEVENT: successfully sent payment of {} satoshis from \
206                                          payment hash {:?} with preimage {:?}",
207                                                                 amt_sat,
208                                                                 hex_utils::hex_str(&payment_hash.0),
209                                                                 hex_utils::hex_str(&payment_preimage.0)
210                                                         );
211                                                         print!("> ");
212                                                         io::stdout().flush().unwrap();
213                                                 }
214                                         }
215                                 }
216                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
217                                         print!(
218                                                 "\nEVENT: Failed to send payment to payment hash {:?}: ",
219                                                 hex_utils::hex_str(&payment_hash.0)
220                                         );
221                                         if rejected_by_dest {
222                                                 println!("rejected by destination node");
223                                         } else {
224                                                 println!("route failed");
225                                         }
226                                         print!("> ");
227                                         io::stdout().flush().unwrap();
228
229                                         let mut payments = payment_storage.lock().unwrap();
230                                         if payments.contains_key(&payment_hash) {
231                                                 let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
232                                                 *status = HTLCStatus::Failed;
233                                         }
234                                 }
235                                 Event::PendingHTLCsForwardable { time_forwardable } => {
236                                         let forwarding_channel_manager = loop_channel_manager.clone();
237                                         thread::spawn(move || {
238                                                 let min = time_forwardable.as_secs();
239                                                 let seconds_to_sleep = thread_rng().gen_range(min, min * 5);
240                                                 thread::sleep(Duration::new(seconds_to_sleep, 0));
241                                                 forwarding_channel_manager.process_pending_htlc_forwards();
242                                         });
243                                 }
244                                 Event::SpendableOutputs { outputs } => {
245                                         let destination_address = bitcoind_client.get_new_address();
246                                         let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
247                                         let tx_feerate =
248                                                 bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
249                                         let spending_tx = keys_manager
250                                                 .spend_spendable_outputs(
251                                                         output_descriptors,
252                                                         Vec::new(),
253                                                         destination_address.script_pubkey(),
254                                                         tx_feerate,
255                                                         &Secp256k1::new(),
256                                                 )
257                                                 .unwrap();
258                                         bitcoind_client.broadcast_transaction(&spending_tx);
259                                         // XXX maybe need to rescan and blah?
260                                 }
261                         }
262                 }
263                 thread::sleep(Duration::new(1, 0));
264         }
265 }
266
267 fn main() {
268         let args = match cli::parse_startup_args() {
269                 Ok(user_args) => user_args,
270                 Err(()) => return,
271         };
272
273         // Initialize the LDK data directory if necessary.
274         let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
275         fs::create_dir_all(ldk_data_dir.clone()).unwrap();
276
277         // Initialize our bitcoind client.
278         let bitcoind_client = match BitcoindClient::new(
279                 args.bitcoind_rpc_host.clone(),
280                 args.bitcoind_rpc_port,
281                 args.bitcoind_rpc_username.clone(),
282                 args.bitcoind_rpc_password.clone(),
283         ) {
284                 Ok(client) => Arc::new(client),
285                 Err(e) => {
286                         println!("Failed to connect to bitcoind client: {}", e);
287                         return;
288                 }
289         };
290         let mut bitcoind_rpc_client = bitcoind_client.get_new_rpc_client().unwrap();
291
292         // ## Setup
293         // Step 1: Initialize the FeeEstimator
294
295         // BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
296         let fee_estimator = bitcoind_client.clone();
297
298         // Step 2: Initialize the Logger
299         let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
300
301         // Step 3: Initialize the BroadcasterInterface
302
303         // BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
304         // broadcaster.
305         let broadcaster = bitcoind_client.clone();
306
307         // Step 4: Initialize Persist
308         let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
309
310         // Step 5: Initialize the ChainMonitor
311         let chain_monitor: Arc<ArcChainMonitor> = Arc::new(ChainMonitor::new(
312                 None,
313                 broadcaster.clone(),
314                 logger.clone(),
315                 fee_estimator.clone(),
316                 persister.clone(),
317         ));
318
319         // Step 6: Initialize the KeysManager
320
321         // The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
322         // other secret key material.
323         let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
324         let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
325                 assert_eq!(seed.len(), 32);
326                 let mut key = [0; 32];
327                 key.copy_from_slice(&seed);
328                 key
329         } else {
330                 let mut key = [0; 32];
331                 thread_rng().fill_bytes(&mut key);
332                 let mut f = File::create(keys_seed_path).unwrap();
333                 f.write_all(&key).expect("Failed to write node keys seed to disk");
334                 f.sync_all().expect("Failed to sync node keys seed to disk");
335                 key
336         };
337         let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
338         let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
339
340         // Step 7: Read ChannelMonitor state from disk
341         let monitors_path = format!("{}/monitors", ldk_data_dir.clone());
342         let mut outpoint_to_channelmonitor =
343                 disk::read_channelmonitors(monitors_path.to_string(), keys_manager.clone()).unwrap();
344
345         // Step 9: Initialize the ChannelManager
346         let user_config = UserConfig::default();
347         let runtime = Runtime::new().unwrap();
348         let mut restarting_node = true;
349         let (channel_manager_blockhash, mut channel_manager) = {
350                 if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
351                         let mut channel_monitor_mut_references = Vec::new();
352                         for (_, channel_monitor) in outpoint_to_channelmonitor.iter_mut() {
353                                 channel_monitor_mut_references.push(&mut channel_monitor.1);
354                         }
355                         let read_args = ChannelManagerReadArgs::new(
356                                 keys_manager.clone(),
357                                 fee_estimator.clone(),
358                                 chain_monitor.clone(),
359                                 broadcaster.clone(),
360                                 logger.clone(),
361                                 user_config,
362                                 channel_monitor_mut_references,
363                         );
364                         <(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
365                 } else {
366                         // We're starting a fresh node.
367                         restarting_node = false;
368                         let getinfo_resp = bitcoind_client.get_blockchain_info();
369                         let chain_params = ChainParameters {
370                                 network: args.network,
371                                 latest_hash: getinfo_resp.latest_blockhash,
372                                 latest_height: getinfo_resp.latest_height,
373                         };
374                         let fresh_channel_manager = channelmanager::ChannelManager::new(
375                                 fee_estimator.clone(),
376                                 chain_monitor.clone(),
377                                 broadcaster.clone(),
378                                 logger.clone(),
379                                 keys_manager.clone(),
380                                 user_config,
381                                 chain_params,
382                         );
383                         (getinfo_resp.latest_blockhash, fresh_channel_manager)
384                 }
385         };
386
387         // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
388         let mut chain_listener_channel_monitors = Vec::new();
389         let mut cache = UnboundedCache::new();
390         let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
391         if restarting_node {
392                 let mut chain_listeners =
393                         vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
394
395                 for (outpoint, blockhash_and_monitor) in outpoint_to_channelmonitor.drain() {
396                         let blockhash = blockhash_and_monitor.0;
397                         let channel_monitor = blockhash_and_monitor.1;
398                         chain_listener_channel_monitors.push((
399                                 blockhash,
400                                 (channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
401                                 outpoint,
402                         ));
403                 }
404
405                 for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
406                         chain_listeners.push((
407                                 monitor_listener_info.0,
408                                 &mut monitor_listener_info.1 as &mut dyn chain::Listen,
409                         ));
410                 }
411                 chain_tip = Some(
412                         runtime
413                                 .block_on(init::synchronize_listeners(
414                                         &mut bitcoind_rpc_client,
415                                         args.network,
416                                         &mut cache,
417                                         chain_listeners,
418                                 ))
419                                 .unwrap(),
420                 );
421         }
422
423         // Step 11: Give ChannelMonitors to ChainMonitor
424         for item in chain_listener_channel_monitors.drain(..) {
425                 let channel_monitor = item.1 .0;
426                 let funding_outpoint = item.2;
427                 chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
428         }
429
430         // Step 13: Optional: Initialize the NetGraphMsgHandler
431         // XXX persist routing data
432         let genesis = genesis_block(args.network).header.block_hash();
433         let router =
434                 Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
435
436         // Step 14: Initialize the PeerManager
437         let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
438         let mut ephemeral_bytes = [0; 32];
439         rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
440         let lightning_msg_handler =
441                 MessageHandler { chan_handler: channel_manager.clone(), route_handler: router.clone() };
442         let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
443                 lightning_msg_handler,
444                 keys_manager.get_node_secret(),
445                 &ephemeral_bytes,
446                 logger.clone(),
447         ));
448
449         // ## Running LDK
450         // Step 16: Initialize Peer Connection Handling
451
452         // We poll for events in handle_ldk_events(..) rather than waiting for them over the
453         // mpsc::channel, so we can leave the event receiver as unused.
454         let (event_ntfn_sender, mut _event_ntfn_receiver) = mpsc::channel(2);
455         let peer_manager_connection_handler = peer_manager.clone();
456         let event_notifier = event_ntfn_sender.clone();
457         let listening_port = args.ldk_peer_listening_port;
458         runtime.spawn(async move {
459                 let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
460                 loop {
461                         let tcp_stream = listener.accept().unwrap().0;
462                         lightning_net_tokio::setup_inbound(
463                                 peer_manager_connection_handler.clone(),
464                                 event_notifier.clone(),
465                                 tcp_stream,
466                         )
467                         .await;
468                 }
469         });
470
471         // Step 17: Connect and Disconnect Blocks
472         if chain_tip.is_none() {
473                 chain_tip = Some(
474                         runtime.block_on(init::validate_best_block_header(&mut bitcoind_rpc_client)).unwrap(),
475                 );
476         }
477         let channel_manager_listener = channel_manager.clone();
478         let chain_monitor_listener = chain_monitor.clone();
479         let network = args.network;
480         runtime.spawn(async move {
481                 let chain_poller = poll::ChainPoller::new(&mut bitcoind_rpc_client, network);
482                 let chain_listener = (chain_monitor_listener, channel_manager_listener);
483                 let mut spv_client =
484                         SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
485                 loop {
486                         spv_client.poll_best_tip().await.unwrap();
487                         thread::sleep(Duration::new(1, 0));
488                 }
489         });
490
491         // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
492         // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
493         let runtime_handle = runtime.handle();
494         let data_dir = ldk_data_dir.clone();
495         let persist_channel_manager_callback =
496                 move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
497         BackgroundProcessor::start(
498                 persist_channel_manager_callback,
499                 channel_manager.clone(),
500                 logger.clone(),
501         );
502
503         let peer_manager_processor = peer_manager.clone();
504         runtime_handle.spawn(async move {
505                 loop {
506                         peer_manager_processor.timer_tick_occurred();
507                         thread::sleep(Duration::new(60, 0));
508                 }
509         });
510
511         // Step 15: Initialize LDK Event Handling
512         let peer_manager_event_listener = peer_manager.clone();
513         let channel_manager_event_listener = channel_manager.clone();
514         let chain_monitor_event_listener = chain_monitor.clone();
515         let keys_manager_listener = keys_manager.clone();
516         let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
517         let payment_info_for_events = payment_info.clone();
518         let handle = runtime_handle.clone();
519         let network = args.network;
520         thread::spawn(move || {
521                 handle_ldk_events(
522                         peer_manager_event_listener,
523                         channel_manager_event_listener,
524                         chain_monitor_event_listener,
525                         bitcoind_client.clone(),
526                         keys_manager_listener,
527                         payment_info_for_events,
528                         network,
529                 );
530         });
531
532         // Reconnect to channel peers if possible.
533         let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
534         match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
535                 Ok(mut info) => {
536                         for (pubkey, peer_addr) in info.drain() {
537                                 let _ = cli::connect_peer_if_necessary(
538                                         pubkey,
539                                         peer_addr,
540                                         peer_manager.clone(),
541                                         event_ntfn_sender.clone(),
542                                         handle.clone(),
543                                 );
544                         }
545                 }
546                 Err(e) => println!("ERROR: errored reading channel peer info from disk: {:?}", e),
547         }
548
549         // Start the CLI.
550         cli::poll_for_user_input(
551                 peer_manager.clone(),
552                 channel_manager.clone(),
553                 router.clone(),
554                 payment_info,
555                 keys_manager.get_node_secret(),
556                 event_ntfn_sender,
557                 ldk_data_dir.clone(),
558                 logger.clone(),
559                 handle,
560                 args.network,
561         );
562 }