-
Notifications
You must be signed in to change notification settings - Fork 94
/
main.rs
1178 lines (1098 loc) · 37.8 KB
/
main.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
mod args;
pub mod bitcoind_client;
mod cli;
mod convert;
mod disk;
mod hex_utils;
mod sweep;
use crate::bitcoind_client::BitcoindClient;
use crate::disk::FilesystemLogger;
use bitcoin::blockdata::transaction::Transaction;
use bitcoin::consensus::encode;
use bitcoin::network::constants::Network;
use bitcoin::BlockHash;
use bitcoin_bech32::WitnessProgram;
use disk::{INBOUND_PAYMENTS_FNAME, OUTBOUND_PAYMENTS_FNAME};
use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
use lightning::chain::{BestBlock, Filter, Watch};
use lightning::events::bump_transaction::{BumpTransactionEventHandler, Wallet};
use lightning::events::{Event, PaymentFailureReason, PaymentPurpose};
use lightning::ln::channelmanager::{self, RecentPaymentDetails};
use lightning::ln::channelmanager::{
ChainParameters, ChannelManagerReadArgs, PaymentId, SimpleArcChannelManager,
};
use lightning::ln::msgs::DecodeError;
use lightning::ln::peer_handler::{IgnoringMessageHandler, MessageHandler, SimpleArcPeerManager};
use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::onion_message::messenger::{DefaultMessageRouter, SimpleArcOnionMessenger};
use lightning::routing::gossip;
use lightning::routing::gossip::{NodeId, P2PGossipSync};
use lightning::routing::router::DefaultRouter;
use lightning::routing::scoring::ProbabilisticScoringFeeParameters;
use lightning::sign::{EntropySource, InMemorySigner, KeysManager};
use lightning::util::config::UserConfig;
use lightning::util::persist::{
self, KVStore, MonitorUpdatingPersister, OUTPUT_SWEEPER_PERSISTENCE_KEY,
OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE, OUTPUT_SWEEPER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
use lightning::util::sweep as ldk_sweep;
use lightning::{chain, impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
use lightning_background_processor::{process_events_async, GossipSync};
use lightning_block_sync::init;
use lightning_block_sync::poll;
use lightning_block_sync::SpvClient;
use lightning_block_sync::UnboundedCache;
use lightning_net_tokio::SocketDescriptor;
use lightning_persister::fs_store::FilesystemStore;
use rand::{thread_rng, Rng};
use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::convert::TryInto;
use std::fmt;
use std::fs;
use std::fs::File;
use std::io;
use std::io::Write;
use std::net::ToSocketAddrs;
use std::path::Path;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::time::{Duration, SystemTime};
#[derive(Copy, Clone)]
pub(crate) enum HTLCStatus {
Pending,
Succeeded,
Failed,
}
impl_writeable_tlv_based_enum!(HTLCStatus,
(0, Pending) => {},
(1, Succeeded) => {},
(2, Failed) => {};
);
pub(crate) struct MillisatAmount(Option<u64>);
impl fmt::Display for MillisatAmount {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self.0 {
Some(amt) => write!(f, "{}", amt),
None => write!(f, "unknown"),
}
}
}
impl Readable for MillisatAmount {
fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
let amt: Option<u64> = Readable::read(r)?;
Ok(MillisatAmount(amt))
}
}
impl Writeable for MillisatAmount {
fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
self.0.write(w)
}
}
pub(crate) struct PaymentInfo {
preimage: Option<PaymentPreimage>,
secret: Option<PaymentSecret>,
status: HTLCStatus,
amt_msat: MillisatAmount,
}
impl_writeable_tlv_based!(PaymentInfo, {
(0, preimage, required),
(2, secret, required),
(4, status, required),
(6, amt_msat, required),
});
pub(crate) struct InboundPaymentInfoStorage {
payments: HashMap<PaymentHash, PaymentInfo>,
}
impl_writeable_tlv_based!(InboundPaymentInfoStorage, {
(0, payments, required),
});
pub(crate) struct OutboundPaymentInfoStorage {
payments: HashMap<PaymentId, PaymentInfo>,
}
impl_writeable_tlv_based!(OutboundPaymentInfoStorage, {
(0, payments, required),
});
type ChainMonitor = chainmonitor::ChainMonitor<
InMemorySigner,
Arc<dyn Filter + Send + Sync>,
Arc<BitcoindClient>,
Arc<BitcoindClient>,
Arc<FilesystemLogger>,
Arc<
MonitorUpdatingPersister<
Arc<FilesystemStore>,
Arc<FilesystemLogger>,
Arc<KeysManager>,
Arc<KeysManager>,
>,
>,
>;
pub(crate) type GossipVerifier = lightning_block_sync::gossip::GossipVerifier<
lightning_block_sync::gossip::TokioSpawner,
Arc<lightning_block_sync::rpc::RpcClient>,
Arc<FilesystemLogger>,
>;
pub(crate) type PeerManager = SimpleArcPeerManager<
SocketDescriptor,
ChainMonitor,
BitcoindClient,
BitcoindClient,
GossipVerifier,
FilesystemLogger,
>;
pub(crate) type ChannelManager =
SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
type OnionMessenger =
SimpleArcOnionMessenger<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
pub(crate) type BumpTxEventHandler = BumpTransactionEventHandler<
Arc<BitcoindClient>,
Arc<Wallet<Arc<BitcoindClient>, Arc<FilesystemLogger>>>,
Arc<KeysManager>,
Arc<FilesystemLogger>,
>;
pub(crate) type OutputSweeper = ldk_sweep::OutputSweeper<
Arc<BitcoindClient>,
Arc<BitcoindClient>,
Arc<BitcoindClient>,
Arc<dyn Filter + Send + Sync>,
Arc<FilesystemStore>,
Arc<FilesystemLogger>,
Arc<KeysManager>,
>;
// Needed due to rust-lang/rust#63033.
struct OutputSweeperWrapper(Arc<OutputSweeper>);
async fn handle_ldk_events(
channel_manager: Arc<ChannelManager>, bitcoind_client: &BitcoindClient,
network_graph: &NetworkGraph, keys_manager: &KeysManager,
bump_tx_event_handler: &BumpTxEventHandler, peer_manager: Arc<PeerManager>,
inbound_payments: Arc<Mutex<InboundPaymentInfoStorage>>,
outbound_payments: Arc<Mutex<OutboundPaymentInfoStorage>>, fs_store: Arc<FilesystemStore>,
output_sweeper: OutputSweeperWrapper, network: Network, event: Event,
) {
match event {
Event::FundingGenerationReady {
temporary_channel_id,
counterparty_node_id,
channel_value_satoshis,
output_script,
..
} => {
// Construct the raw transaction with one output, that is paid the amount of the
// channel.
let addr = WitnessProgram::from_scriptpubkey(
&output_script.as_bytes(),
match network {
Network::Bitcoin => bitcoin_bech32::constants::Network::Bitcoin,
Network::Regtest => bitcoin_bech32::constants::Network::Regtest,
Network::Signet => bitcoin_bech32::constants::Network::Signet,
Network::Testnet | _ => bitcoin_bech32::constants::Network::Testnet,
},
)
.expect("Lightning funding tx should always be to a SegWit output")
.to_address();
let mut outputs = vec![HashMap::with_capacity(1)];
outputs[0].insert(addr, channel_value_satoshis as f64 / 100_000_000.0);
let raw_tx = bitcoind_client.create_raw_transaction(outputs).await;
// Have your wallet put the inputs into the transaction such that the output is
// satisfied.
let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
// Sign the final funding transaction and give it to LDK, who will eventually broadcast it.
let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex).await;
assert_eq!(signed_tx.complete, true);
let final_tx: Transaction =
encode::deserialize(&hex_utils::to_vec(&signed_tx.hex).unwrap()).unwrap();
// Give the funding transaction back to LDK for opening the channel.
if channel_manager
.funding_transaction_generated(
&temporary_channel_id,
&counterparty_node_id,
final_tx,
)
.is_err()
{
println!(
"\nERROR: Channel went away before we could fund it. The peer disconnected or refused the channel.");
print!("> ");
io::stdout().flush().unwrap();
}
},
Event::PaymentClaimable {
payment_hash,
purpose,
amount_msat,
receiver_node_id: _,
via_channel_id: _,
via_user_channel_id: _,
claim_deadline: _,
onion_fields: _,
counterparty_skimmed_fee_msat: _,
} => {
println!(
"\nEVENT: received payment from payment hash {} of {} millisatoshis",
payment_hash, amount_msat,
);
print!("> ");
io::stdout().flush().unwrap();
let payment_preimage = match purpose {
PaymentPurpose::Bolt11InvoicePayment { payment_preimage, .. } => payment_preimage,
PaymentPurpose::Bolt12OfferPayment { payment_preimage, .. } => payment_preimage,
PaymentPurpose::Bolt12RefundPayment { payment_preimage, .. } => payment_preimage,
PaymentPurpose::SpontaneousPayment(preimage) => Some(preimage),
};
channel_manager.claim_funds(payment_preimage.unwrap());
},
Event::PaymentClaimed {
payment_hash,
purpose,
amount_msat,
receiver_node_id: _,
htlcs: _,
sender_intended_total_msat: _,
} => {
println!(
"\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
payment_hash, amount_msat,
);
print!("> ");
io::stdout().flush().unwrap();
let (payment_preimage, payment_secret) = match purpose {
PaymentPurpose::Bolt11InvoicePayment {
payment_preimage, payment_secret, ..
} => (payment_preimage, Some(payment_secret)),
PaymentPurpose::Bolt12OfferPayment { payment_preimage, payment_secret, .. } => {
(payment_preimage, Some(payment_secret))
},
PaymentPurpose::Bolt12RefundPayment {
payment_preimage, payment_secret, ..
} => (payment_preimage, Some(payment_secret)),
PaymentPurpose::SpontaneousPayment(preimage) => (Some(preimage), None),
};
let mut inbound = inbound_payments.lock().unwrap();
match inbound.payments.entry(payment_hash) {
Entry::Occupied(mut e) => {
let payment = e.get_mut();
payment.status = HTLCStatus::Succeeded;
payment.preimage = payment_preimage;
payment.secret = payment_secret;
},
Entry::Vacant(e) => {
e.insert(PaymentInfo {
preimage: payment_preimage,
secret: payment_secret,
status: HTLCStatus::Succeeded,
amt_msat: MillisatAmount(Some(amount_msat)),
});
},
}
fs_store.write("", "", INBOUND_PAYMENTS_FNAME, &inbound.encode()).unwrap();
},
Event::PaymentSent {
payment_preimage, payment_hash, fee_paid_msat, payment_id, ..
} => {
let mut outbound = outbound_payments.lock().unwrap();
for (id, payment) in outbound.payments.iter_mut() {
if *id == payment_id.unwrap() {
payment.preimage = Some(payment_preimage);
payment.status = HTLCStatus::Succeeded;
println!(
"\nEVENT: successfully sent payment of {} millisatoshis{} from \
payment hash {} with preimage {}",
payment.amt_msat,
if let Some(fee) = fee_paid_msat {
format!(" (fee {} msat)", fee)
} else {
"".to_string()
},
payment_hash,
payment_preimage
);
print!("> ");
io::stdout().flush().unwrap();
}
}
fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
},
Event::OpenChannelRequest {
ref temporary_channel_id, ref counterparty_node_id, ..
} => {
let mut random_bytes = [0u8; 16];
random_bytes.copy_from_slice(&keys_manager.get_secure_random_bytes()[..16]);
let user_channel_id = u128::from_be_bytes(random_bytes);
let res = channel_manager.accept_inbound_channel(
temporary_channel_id,
counterparty_node_id,
user_channel_id,
);
if let Err(e) = res {
print!(
"\nEVENT: Failed to accept inbound channel ({}) from {}: {:?}",
temporary_channel_id,
hex_utils::hex_str(&counterparty_node_id.serialize()),
e,
);
} else {
print!(
"\nEVENT: Accepted inbound channel ({}) from {}",
temporary_channel_id,
hex_utils::hex_str(&counterparty_node_id.serialize()),
);
}
print!("> ");
io::stdout().flush().unwrap();
},
Event::PaymentPathSuccessful { .. } => {},
Event::PaymentPathFailed { .. } => {},
Event::ProbeSuccessful { .. } => {},
Event::ProbeFailed { .. } => {},
Event::PaymentFailed { payment_hash, reason, payment_id, .. } => {
print!(
"\nEVENT: Failed to send payment to payment hash {}: {:?}",
payment_hash,
if let Some(r) = reason { r } else { PaymentFailureReason::RetriesExhausted }
);
print!("> ");
io::stdout().flush().unwrap();
let mut outbound = outbound_payments.lock().unwrap();
if outbound.payments.contains_key(&payment_id) {
let payment = outbound.payments.get_mut(&payment_id).unwrap();
payment.status = HTLCStatus::Failed;
}
fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
},
Event::InvoiceRequestFailed { payment_id } => {
print!("\nEVENT: Failed to request invoice to send payment with id {}", payment_id);
print!("> ");
io::stdout().flush().unwrap();
let mut outbound = outbound_payments.lock().unwrap();
if outbound.payments.contains_key(&payment_id) {
let payment = outbound.payments.get_mut(&payment_id).unwrap();
payment.status = HTLCStatus::Failed;
}
fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound.encode()).unwrap();
},
Event::PaymentForwarded {
prev_channel_id,
next_channel_id,
total_fee_earned_msat,
claim_from_onchain_tx,
outbound_amount_forwarded_msat,
skimmed_fee_msat: _,
prev_user_channel_id: _,
next_user_channel_id: _,
} => {
let read_only_network_graph = network_graph.read_only();
let nodes = read_only_network_graph.nodes();
let channels = channel_manager.list_channels();
let node_str = |channel_id: &Option<ChannelId>| match channel_id {
None => String::new(),
Some(channel_id) => match channels.iter().find(|c| c.channel_id == *channel_id) {
None => String::new(),
Some(channel) => {
match nodes.get(&NodeId::from_pubkey(&channel.counterparty.node_id)) {
None => "private node".to_string(),
Some(node) => match &node.announcement_info {
None => "unnamed node".to_string(),
Some(announcement) => {
format!("node {}", announcement.alias)
},
},
}
},
},
};
let channel_str = |channel_id: &Option<ChannelId>| {
channel_id
.map(|channel_id| format!(" with channel {}", channel_id))
.unwrap_or_default()
};
let from_prev_str =
format!(" from {}{}", node_str(&prev_channel_id), channel_str(&prev_channel_id));
let to_next_str =
format!(" to {}{}", node_str(&next_channel_id), channel_str(&next_channel_id));
let from_onchain_str = if claim_from_onchain_tx {
"from onchain downstream claim"
} else {
"from HTLC fulfill message"
};
let amt_args = if let Some(v) = outbound_amount_forwarded_msat {
format!("{}", v)
} else {
"?".to_string()
};
if let Some(fee_earned) = total_fee_earned_msat {
println!(
"\nEVENT: Forwarded payment for {} msat{}{}, earning {} msat {}",
amt_args, from_prev_str, to_next_str, fee_earned, from_onchain_str
);
} else {
println!(
"\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
amt_args, from_prev_str, to_next_str, from_onchain_str
);
}
print!("> ");
io::stdout().flush().unwrap();
},
Event::HTLCHandlingFailed { .. } => {},
Event::PendingHTLCsForwardable { time_forwardable } => {
let forwarding_channel_manager = channel_manager.clone();
let min = time_forwardable.as_millis() as u64;
tokio::spawn(async move {
let millis_to_sleep = thread_rng().gen_range(min, min * 5) as u64;
tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
forwarding_channel_manager.process_pending_htlc_forwards();
});
},
Event::SpendableOutputs { outputs, channel_id } => {
output_sweeper.0.track_spendable_outputs(outputs, channel_id, false, None).unwrap();
},
Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
println!(
"\nEVENT: Channel {} with peer {} is pending awaiting funding lock-in!",
channel_id,
hex_utils::hex_str(&counterparty_node_id.serialize()),
);
print!("> ");
io::stdout().flush().unwrap();
},
Event::ChannelReady {
ref channel_id,
user_channel_id: _,
ref counterparty_node_id,
channel_type: _,
} => {
println!(
"\nEVENT: Channel {} with peer {} is ready to be used!",
channel_id,
hex_utils::hex_str(&counterparty_node_id.serialize()),
);
print!("> ");
io::stdout().flush().unwrap();
},
Event::ChannelClosed {
channel_id,
reason,
user_channel_id: _,
counterparty_node_id,
channel_capacity_sats: _,
channel_funding_txo: _,
} => {
println!(
"\nEVENT: Channel {} with counterparty {} closed due to: {:?}",
channel_id,
counterparty_node_id.map(|id| format!("{}", id)).unwrap_or("".to_owned()),
reason
);
print!("> ");
io::stdout().flush().unwrap();
},
Event::DiscardFunding { .. } => {
// A "real" node should probably "lock" the UTXOs spent in funding transactions until
// the funding transaction either confirms, or this event is generated.
},
Event::HTLCIntercepted { .. } => {},
Event::BumpTransaction(event) => bump_tx_event_handler.handle_event(&event),
Event::ConnectionNeeded { node_id, addresses } => {
tokio::spawn(async move {
for address in addresses {
if let Ok(sockaddrs) = address.to_socket_addrs() {
for addr in sockaddrs {
let pm = Arc::clone(&peer_manager);
if cli::connect_peer_if_necessary(node_id, addr, pm).await.is_ok() {
return;
}
}
}
}
});
},
}
}
async fn start_ldk() {
let args = match args::parse_startup_args() {
Ok(user_args) => user_args,
Err(()) => return,
};
// Initialize the LDK data directory if necessary.
let ldk_data_dir = format!("{}/.ldk", args.ldk_storage_dir_path);
fs::create_dir_all(ldk_data_dir.clone()).unwrap();
// ## Setup
// Step 1: Initialize the Logger
let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
// Initialize our bitcoind client.
let bitcoind_client = match BitcoindClient::new(
args.bitcoind_rpc_host.clone(),
args.bitcoind_rpc_port,
args.bitcoind_rpc_username.clone(),
args.bitcoind_rpc_password.clone(),
args.network,
tokio::runtime::Handle::current(),
Arc::clone(&logger),
)
.await
{
Ok(client) => Arc::new(client),
Err(e) => {
println!("Failed to connect to bitcoind client: {}", e);
return;
},
};
// Check that the bitcoind we've connected to is running the network we expect
let bitcoind_chain = bitcoind_client.get_blockchain_info().await.chain;
if bitcoind_chain
!= match args.network {
bitcoin::Network::Bitcoin => "main",
bitcoin::Network::Regtest => "regtest",
bitcoin::Network::Signet => "signet",
bitcoin::Network::Testnet | _ => "test",
} {
println!(
"Chain argument ({}) didn't match bitcoind chain ({})",
args.network, bitcoind_chain
);
return;
}
// Step 2: Initialize the FeeEstimator
// BitcoindClient implements the FeeEstimator trait, so it'll act as our fee estimator.
let fee_estimator = bitcoind_client.clone();
// Step 3: Initialize the BroadcasterInterface
// BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
// broadcaster.
let broadcaster = bitcoind_client.clone();
// Step 4: Initialize the KeysManager
// The key seed that we use to derive the node privkey (that corresponds to the node pubkey) and
// other secret key material.
let keys_seed_path = format!("{}/keys_seed", ldk_data_dir.clone());
let keys_seed = if let Ok(seed) = fs::read(keys_seed_path.clone()) {
assert_eq!(seed.len(), 32);
let mut key = [0; 32];
key.copy_from_slice(&seed);
key
} else {
let mut key = [0; 32];
thread_rng().fill_bytes(&mut key);
match File::create(keys_seed_path.clone()) {
Ok(mut f) => {
Write::write_all(&mut f, &key).expect("Failed to write node keys seed to disk");
f.sync_all().expect("Failed to sync node keys seed to disk");
},
Err(e) => {
println!("ERROR: Unable to create keys seed file {}: {}", keys_seed_path, e);
return;
},
}
key
};
let cur = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
let bump_tx_event_handler = Arc::new(BumpTransactionEventHandler::new(
Arc::clone(&broadcaster),
Arc::new(Wallet::new(Arc::clone(&bitcoind_client), Arc::clone(&logger))),
Arc::clone(&keys_manager),
Arc::clone(&logger),
));
// Step 5: Initialize Persistence
let fs_store = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
let persister = Arc::new(MonitorUpdatingPersister::new(
Arc::clone(&fs_store),
Arc::clone(&logger),
1000,
Arc::clone(&keys_manager),
Arc::clone(&keys_manager),
));
// Alternatively, you can use the `FilesystemStore` as a `Persist` directly, at the cost of
// larger `ChannelMonitor` update writes (but no deletion or cleanup):
//let persister = Arc::clone(&fs_store);
// Step 6: Initialize the ChainMonitor
let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
None,
Arc::clone(&broadcaster),
Arc::clone(&logger),
Arc::clone(&fee_estimator),
Arc::clone(&persister),
));
// Step 7: Read ChannelMonitor state from disk
let mut channelmonitors = persister
.read_all_channel_monitors_with_updates(&bitcoind_client, &bitcoind_client)
.unwrap();
// If you are using the `FilesystemStore` as a `Persist` directly, use
// `lightning::util::persist::read_channel_monitors` like this:
//read_channel_monitors(Arc::clone(&persister), Arc::clone(&keys_manager), Arc::clone(&keys_manager)).unwrap();
// Step 8: Poll for the best chain tip, which may be used by the channel manager & spv client
let polled_chain_tip = init::validate_best_block_header(bitcoind_client.as_ref())
.await
.expect("Failed to fetch best block header and best block");
// Step 9: Initialize routing ProbabilisticScorer
let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
let network_graph =
Arc::new(disk::read_network(Path::new(&network_graph_path), args.network, logger.clone()));
let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
let scorer = Arc::new(RwLock::new(disk::read_scorer(
Path::new(&scorer_path),
Arc::clone(&network_graph),
Arc::clone(&logger),
)));
// Step 10: Create Router
let scoring_fee_params = ProbabilisticScoringFeeParameters::default();
let router = Arc::new(DefaultRouter::new(
network_graph.clone(),
logger.clone(),
keys_manager.clone(),
scorer.clone(),
scoring_fee_params,
));
// Step 11: Initialize the ChannelManager
let mut user_config = UserConfig::default();
user_config.channel_handshake_limits.force_announced_channel_preference = false;
user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
user_config.manually_accept_inbound_channels = true;
let mut restarting_node = true;
let (channel_manager_blockhash, channel_manager) = {
if let Ok(mut f) = fs::File::open(format!("{}/manager", ldk_data_dir.clone())) {
let mut channel_monitor_mut_references = Vec::new();
for (_, channel_monitor) in channelmonitors.iter_mut() {
channel_monitor_mut_references.push(channel_monitor);
}
let read_args = ChannelManagerReadArgs::new(
keys_manager.clone(),
keys_manager.clone(),
keys_manager.clone(),
fee_estimator.clone(),
chain_monitor.clone(),
broadcaster.clone(),
router,
logger.clone(),
user_config,
channel_monitor_mut_references,
);
<(BlockHash, ChannelManager)>::read(&mut f, read_args).unwrap()
} else {
// We're starting a fresh node.
restarting_node = false;
let polled_best_block = polled_chain_tip.to_best_block();
let polled_best_block_hash = polled_best_block.block_hash;
let chain_params =
ChainParameters { network: args.network, best_block: polled_best_block };
let fresh_channel_manager = channelmanager::ChannelManager::new(
fee_estimator.clone(),
chain_monitor.clone(),
broadcaster.clone(),
router,
logger.clone(),
keys_manager.clone(),
keys_manager.clone(),
keys_manager.clone(),
user_config,
chain_params,
cur.as_secs() as u32,
);
(polled_best_block_hash, fresh_channel_manager)
}
};
// Step 12: Initialize the OutputSweeper.
let (sweeper_best_block, output_sweeper) = match fs_store.read(
OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
OUTPUT_SWEEPER_PERSISTENCE_SECONDARY_NAMESPACE,
OUTPUT_SWEEPER_PERSISTENCE_KEY,
) {
Err(e) if e.kind() == io::ErrorKind::NotFound => {
let sweeper = OutputSweeper::new(
channel_manager.current_best_block(),
broadcaster.clone(),
fee_estimator.clone(),
None,
keys_manager.clone(),
bitcoind_client.clone(),
fs_store.clone(),
logger.clone(),
);
(channel_manager.current_best_block(), sweeper)
},
Ok(mut bytes) => {
let read_args = (
broadcaster.clone(),
fee_estimator.clone(),
None,
keys_manager.clone(),
bitcoind_client.clone(),
fs_store.clone(),
logger.clone(),
);
let mut reader = io::Cursor::new(&mut bytes);
<(BestBlock, OutputSweeper)>::read(&mut reader, read_args)
.expect("Failed to deserialize OutputSweeper")
},
Err(e) => panic!("Failed to read OutputSweeper with {}", e),
};
// Step 13: Sync ChannelMonitors, ChannelManager and OutputSweeper to chain tip
let mut chain_listener_channel_monitors = Vec::new();
let mut cache = UnboundedCache::new();
let chain_tip = if restarting_node {
let mut chain_listeners = vec![
(channel_manager_blockhash, &channel_manager as &(dyn chain::Listen + Send + Sync)),
(sweeper_best_block.block_hash, &output_sweeper as &(dyn chain::Listen + Send + Sync)),
];
for (blockhash, channel_monitor) in channelmonitors.drain(..) {
let outpoint = channel_monitor.get_funding_txo().0;
chain_listener_channel_monitors.push((
blockhash,
(channel_monitor, broadcaster.clone(), fee_estimator.clone(), logger.clone()),
outpoint,
));
}
for monitor_listener_info in chain_listener_channel_monitors.iter_mut() {
chain_listeners.push((
monitor_listener_info.0,
&monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
));
}
init::synchronize_listeners(
bitcoind_client.as_ref(),
args.network,
&mut cache,
chain_listeners,
)
.await
.unwrap()
} else {
polled_chain_tip
};
// Step 14: Give ChannelMonitors to ChainMonitor
for item in chain_listener_channel_monitors.drain(..) {
let channel_monitor = item.1 .0;
let funding_outpoint = item.2;
assert_eq!(
chain_monitor.watch_channel(funding_outpoint, channel_monitor),
Ok(ChannelMonitorUpdateStatus::Completed)
);
}
// Step 15: Optional: Initialize the P2PGossipSync
let gossip_sync =
Arc::new(P2PGossipSync::new(Arc::clone(&network_graph), None, Arc::clone(&logger)));
// Step 16: Initialize the PeerManager
let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
let onion_messenger: Arc<OnionMessenger> = Arc::new(OnionMessenger::new(
Arc::clone(&keys_manager),
Arc::clone(&keys_manager),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::new(DefaultMessageRouter::new(Arc::clone(&network_graph), Arc::clone(&keys_manager))),
Arc::clone(&channel_manager),
IgnoringMessageHandler {},
));
let mut ephemeral_bytes = [0; 32];
let current_time = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
let lightning_msg_handler = MessageHandler {
chan_handler: channel_manager.clone(),
route_handler: gossip_sync.clone(),
onion_message_handler: onion_messenger.clone(),
custom_message_handler: IgnoringMessageHandler {},
};
let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
lightning_msg_handler,
current_time.try_into().unwrap(),
&ephemeral_bytes,
logger.clone(),
Arc::clone(&keys_manager),
));
// Install a GossipVerifier in in the P2PGossipSync
let utxo_lookup = GossipVerifier::new(
Arc::clone(&bitcoind_client.bitcoind_rpc_client),
lightning_block_sync::gossip::TokioSpawner,
Arc::clone(&gossip_sync),
Arc::clone(&peer_manager),
);
gossip_sync.add_utxo_lookup(Some(utxo_lookup));
// ## Running LDK
// Step 17: Initialize networking
let peer_manager_connection_handler = peer_manager.clone();
let listening_port = args.ldk_peer_listening_port;
let stop_listen_connect = Arc::new(AtomicBool::new(false));
let stop_listen = Arc::clone(&stop_listen_connect);
tokio::spawn(async move {
let listener = tokio::net::TcpListener::bind(format!("[::]:{}", listening_port))
.await
.expect("Failed to bind to listen port - is something else already listening on it?");
loop {
let peer_mgr = peer_manager_connection_handler.clone();
let tcp_stream = listener.accept().await.unwrap().0;
if stop_listen.load(Ordering::Acquire) {
return;
}
tokio::spawn(async move {
lightning_net_tokio::setup_inbound(
peer_mgr.clone(),
tcp_stream.into_std().unwrap(),
)
.await;
});
}
});
// Step 18: Connect and Disconnect Blocks
let output_sweeper: Arc<OutputSweeper> = Arc::new(output_sweeper);
let channel_manager_listener = channel_manager.clone();
let chain_monitor_listener = chain_monitor.clone();
let output_sweeper_listener = output_sweeper.clone();
let bitcoind_block_source = bitcoind_client.clone();
let network = args.network;
tokio::spawn(async move {
let chain_poller = poll::ChainPoller::new(bitcoind_block_source.as_ref(), network);
let chain_listener =
(chain_monitor_listener, &(channel_manager_listener, output_sweeper_listener));
let mut spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
loop {
spv_client.poll_best_tip().await.unwrap();
tokio::time::sleep(Duration::from_secs(1)).await;
}
});
let inbound_payments = Arc::new(Mutex::new(disk::read_inbound_payment_info(Path::new(
&format!("{}/{}", ldk_data_dir, INBOUND_PAYMENTS_FNAME),
))));
let outbound_payments = Arc::new(Mutex::new(disk::read_outbound_payment_info(Path::new(
&format!("{}/{}", ldk_data_dir, OUTBOUND_PAYMENTS_FNAME),
))));
let recent_payments_payment_ids = channel_manager
.list_recent_payments()
.into_iter()
.filter_map(|p| match p {
RecentPaymentDetails::Pending { payment_id, .. } => Some(payment_id),
RecentPaymentDetails::Fulfilled { payment_id, .. } => Some(payment_id),
RecentPaymentDetails::Abandoned { payment_id, .. } => Some(payment_id),
RecentPaymentDetails::AwaitingInvoice { payment_id } => Some(payment_id),
})
.collect::<Vec<PaymentId>>();
for (payment_id, payment_info) in outbound_payments
.lock()
.unwrap()
.payments
.iter_mut()
.filter(|(_, i)| matches!(i.status, HTLCStatus::Pending))
{
if !recent_payments_payment_ids.contains(payment_id) {
payment_info.status = HTLCStatus::Failed;
}
}
fs_store
.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.lock().unwrap().encode())
.unwrap();
// Step 19: Handle LDK Events
let channel_manager_event_listener = Arc::clone(&channel_manager);
let bitcoind_client_event_listener = Arc::clone(&bitcoind_client);
let network_graph_event_listener = Arc::clone(&network_graph);
let keys_manager_event_listener = Arc::clone(&keys_manager);
let inbound_payments_event_listener = Arc::clone(&inbound_payments);
let outbound_payments_event_listener = Arc::clone(&outbound_payments);
let fs_store_event_listener = Arc::clone(&fs_store);
let peer_manager_event_listener = Arc::clone(&peer_manager);
let output_sweeper_event_listener = Arc::clone(&output_sweeper);
let network = args.network;
let event_handler = move |event: Event| {
let channel_manager_event_listener = Arc::clone(&channel_manager_event_listener);
let bitcoind_client_event_listener = Arc::clone(&bitcoind_client_event_listener);
let network_graph_event_listener = Arc::clone(&network_graph_event_listener);
let keys_manager_event_listener = Arc::clone(&keys_manager_event_listener);
let bump_tx_event_handler = Arc::clone(&bump_tx_event_handler);
let inbound_payments_event_listener = Arc::clone(&inbound_payments_event_listener);
let outbound_payments_event_listener = Arc::clone(&outbound_payments_event_listener);
let fs_store_event_listener = Arc::clone(&fs_store_event_listener);
let peer_manager_event_listener = Arc::clone(&peer_manager_event_listener);
let output_sweeper_event_listener = Arc::clone(&output_sweeper_event_listener);
async move {
handle_ldk_events(
channel_manager_event_listener,
&bitcoind_client_event_listener,
&network_graph_event_listener,
&keys_manager_event_listener,
&bump_tx_event_handler,
peer_manager_event_listener,
inbound_payments_event_listener,
outbound_payments_event_listener,
fs_store_event_listener,
OutputSweeperWrapper(output_sweeper_event_listener),
network,
event,
)
.await;
}
};
// Step 20: Persist ChannelManager and NetworkGraph
let persister = Arc::new(FilesystemStore::new(ldk_data_dir.clone().into()));
// Step 21: Background Processing
let (bp_exit, bp_exit_check) = tokio::sync::watch::channel(());
let mut background_processor = tokio::spawn(process_events_async(
Arc::clone(&persister),
event_handler,
chain_monitor.clone(),
channel_manager.clone(),
GossipSync::p2p(gossip_sync.clone()),
peer_manager.clone(),
logger.clone(),