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