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