-mod bitcoind_client;
+pub mod bitcoind_client;
mod cli;
mod convert;
mod disk;
use bitcoin_bech32::WitnessProgram;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
-use lightning::chain::chainmonitor::ChainMonitor;
+use lightning::chain::chainmonitor;
use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
-use lightning::chain::transaction::OutPoint;
use lightning::chain::Filter;
use lightning::chain::Watch;
use lightning::ln::channelmanager;
use lightning::ln::channelmanager::{
- ChainParameters, ChannelManagerReadArgs, PaymentHash, PaymentPreimage, SimpleArcChannelManager,
+ BestBlock, ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
};
use lightning::ln::peer_handler::{MessageHandler, SimpleArcPeerManager};
+use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::routing::network_graph::NetGraphMsgHandler;
use lightning::util::config::UserConfig;
use lightning::util::events::{Event, EventsProvider};
use lightning_net_tokio::SocketDescriptor;
use lightning_persister::FilesystemPersister;
use rand::{thread_rng, Rng};
+use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::fmt;
use std::fs;
use std::fs::File;
use std::io;
use std::io::Write;
+use std::ops::Deref;
use std::path::Path;
use std::sync::{Arc, Mutex};
-use std::thread;
use std::time::{Duration, SystemTime};
-use tokio::runtime::Runtime;
use tokio::sync::mpsc;
-
-#[derive(PartialEq)]
-pub(crate) enum HTLCDirection {
- Inbound,
- Outbound,
-}
+use tokio::sync::mpsc::Receiver;
pub(crate) enum HTLCStatus {
Pending,
Failed,
}
-pub(crate) struct SatoshiAmount(Option<u64>);
+pub(crate) struct MillisatAmount(Option<u64>);
-impl fmt::Display for SatoshiAmount {
+impl fmt::Display for MillisatAmount {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self.0 {
Some(amt) => write!(f, "{}", amt),
}
}
-pub(crate) type PaymentInfoStorage = Arc<
- Mutex<
- HashMap<PaymentHash, (Option<PaymentPreimage>, HTLCDirection, HTLCStatus, SatoshiAmount)>,
- >,
->;
+pub(crate) struct PaymentInfo {
+ preimage: Option<PaymentPreimage>,
+ secret: Option<PaymentSecret>,
+ status: HTLCStatus,
+ amt_msat: MillisatAmount,
+}
+
+pub(crate) type PaymentInfoStorage = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
-type ArcChainMonitor = ChainMonitor<
+type ChainMonitor = chainmonitor::ChainMonitor<
InMemorySigner,
- Arc<dyn Filter>,
+ Arc<dyn Filter + Send + Sync>,
Arc<BitcoindClient>,
Arc<BitcoindClient>,
Arc<FilesystemLogger>,
pub(crate) type PeerManager = SimpleArcPeerManager<
SocketDescriptor,
- ArcChainMonitor,
+ ChainMonitor,
BitcoindClient,
BitcoindClient,
- dyn chain::Access,
+ dyn chain::Access + Send + Sync,
FilesystemLogger,
>;
pub(crate) type ChannelManager =
- SimpleArcChannelManager<ArcChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
+ SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
-fn handle_ldk_events(
- peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
- chain_monitor: Arc<ArcChainMonitor>, bitcoind_client: Arc<BitcoindClient>,
- keys_manager: Arc<KeysManager>, payment_storage: PaymentInfoStorage, network: Network,
+async fn handle_ldk_events(
+ channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
+ bitcoind_client: Arc<BitcoindClient>, keys_manager: Arc<KeysManager>,
+ inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage, network: Network,
+ mut event_receiver: Receiver<()>,
) {
- let mut pending_txs: HashMap<OutPoint, Transaction> = HashMap::new();
loop {
- peer_manager.process_events();
+ let received = event_receiver.recv();
+ if received.await.is_none() {
+ println!("LDK Event channel closed!");
+ return;
+ }
let loop_channel_manager = channel_manager.clone();
let mut events = channel_manager.get_and_clear_pending_events();
events.append(&mut chain_monitor.get_and_clear_pending_events());
.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);
+ 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);
+ let funded_tx = bitcoind_client.fund_raw_transaction(raw_tx).await;
let change_output_position = funded_tx.changepos;
assert!(change_output_position == 0 || change_output_position == 1);
// Sign the final funding transaction and broadcast it.
- let signed_tx = bitcoind_client.sign_raw_transaction_with_wallet(funded_tx.hex);
+ 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();
- let outpoint = OutPoint {
- txid: final_tx.txid(),
- index: if change_output_position == 0 { 1 } else { 0 },
- };
// Give the funding transaction back to LDK for opening the channel.
loop_channel_manager
- .funding_transaction_generated(&temporary_channel_id, outpoint);
- pending_txs.insert(outpoint, final_tx);
- }
- Event::FundingBroadcastSafe { funding_txo, .. } => {
- let funding_tx = pending_txs.remove(&funding_txo).unwrap();
- bitcoind_client.broadcast_transaction(&funding_tx);
- println!("\nEVENT: broadcasted funding transaction");
- print!("> ");
- io::stdout().flush().unwrap();
+ .funding_transaction_generated(&temporary_channel_id, final_tx)
+ .unwrap();
}
- Event::PaymentReceived { payment_hash, payment_secret, amt: amt_msat } => {
- let mut payments = payment_storage.lock().unwrap();
- if let Some((Some(preimage), _, _, _)) = payments.get(&payment_hash) {
- assert!(loop_channel_manager.claim_funds(
- preimage.clone(),
- &payment_secret,
- amt_msat
- ));
- println!(
- "\nEVENT: received payment from payment_hash {} of {} satoshis",
- hex_utils::hex_str(&payment_hash.0),
- amt_msat / 1000
- );
- print!("> ");
- io::stdout().flush().unwrap();
- let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
- *status = HTLCStatus::Succeeded;
- } else {
- println!("\nERROR: we received a payment but didn't know the preimage");
- print!("> ");
- io::stdout().flush().unwrap();
- loop_channel_manager.fail_htlc_backwards(&payment_hash, &payment_secret);
- payments.insert(
- payment_hash,
- (None, HTLCDirection::Inbound, HTLCStatus::Failed, SatoshiAmount(None)),
- );
+ Event::PaymentReceived {
+ payment_hash,
+ payment_preimage,
+ payment_secret,
+ amt,
+ ..
+ } => {
+ let mut payments = inbound_payments.lock().unwrap();
+ let status = match loop_channel_manager.claim_funds(payment_preimage.unwrap()) {
+ true => {
+ println!(
+ "\nEVENT: received payment from payment hash {} of {} millisatoshis",
+ hex_utils::hex_str(&payment_hash.0),
+ amt
+ );
+ print!("> ");
+ io::stdout().flush().unwrap();
+ HTLCStatus::Succeeded
+ }
+ _ => HTLCStatus::Failed,
+ };
+ match payments.entry(payment_hash) {
+ Entry::Occupied(mut e) => {
+ let payment = e.get_mut();
+ payment.status = status;
+ payment.preimage = Some(payment_preimage.unwrap());
+ payment.secret = Some(payment_secret);
+ }
+ Entry::Vacant(e) => {
+ e.insert(PaymentInfo {
+ preimage: Some(payment_preimage.unwrap()),
+ secret: Some(payment_secret),
+ status,
+ amt_msat: MillisatAmount(Some(amt)),
+ });
+ }
}
}
Event::PaymentSent { payment_preimage } => {
let hashed = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
- let mut payments = payment_storage.lock().unwrap();
- for (payment_hash, (preimage_option, _, status, amt_sat)) in payments.iter_mut()
- {
+ let mut payments = outbound_payments.lock().unwrap();
+ for (payment_hash, payment) in payments.iter_mut() {
if *payment_hash == hashed {
- *preimage_option = Some(payment_preimage);
- *status = HTLCStatus::Succeeded;
+ payment.preimage = Some(payment_preimage);
+ payment.status = HTLCStatus::Succeeded;
println!(
- "\nEVENT: successfully sent payment of {} satoshis from \
+ "\nEVENT: successfully sent payment of {} millisatoshis from \
payment hash {:?} with preimage {:?}",
- amt_sat,
+ payment.amt_msat,
hex_utils::hex_str(&payment_hash.0),
hex_utils::hex_str(&payment_preimage.0)
);
print!("> ");
io::stdout().flush().unwrap();
- let mut payments = payment_storage.lock().unwrap();
+ let mut payments = outbound_payments.lock().unwrap();
if payments.contains_key(&payment_hash) {
- let (_, _, ref mut status, _) = payments.get_mut(&payment_hash).unwrap();
- *status = HTLCStatus::Failed;
+ let payment = payments.get_mut(&payment_hash).unwrap();
+ payment.status = HTLCStatus::Failed;
}
}
Event::PendingHTLCsForwardable { time_forwardable } => {
let forwarding_channel_manager = loop_channel_manager.clone();
- thread::spawn(move || {
- let min = time_forwardable.as_secs();
- let seconds_to_sleep = thread_rng().gen_range(min, min * 5);
- thread::sleep(Duration::new(seconds_to_sleep, 0));
+ tokio::spawn(async move {
+ let min = time_forwardable.as_millis() as u64;
+ 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 } => {
- let destination_address = bitcoind_client.get_new_address();
+ let destination_address = bitcoind_client.get_new_address().await;
let output_descriptors = &outputs.iter().map(|a| a).collect::<Vec<_>>();
let tx_feerate =
bitcoind_client.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
)
.unwrap();
bitcoind_client.broadcast_transaction(&spending_tx);
- // XXX maybe need to rescan and blah?
}
}
}
- thread::sleep(Duration::new(1, 0));
+ tokio::time::sleep(Duration::from_secs(1)).await;
}
}
-fn main() {
+async fn start_ldk() {
let args = match cli::parse_startup_args() {
Ok(user_args) => user_args,
Err(()) => return,
args.bitcoind_rpc_port,
args.bitcoind_rpc_username.clone(),
args.bitcoind_rpc_password.clone(),
- ) {
+ )
+ .await
+ {
Ok(client) => Arc::new(client),
Err(e) => {
println!("Failed to connect to bitcoind client: {}", e);
return;
}
};
- let mut bitcoind_rpc_client = bitcoind_client.get_new_rpc_client().unwrap();
+
+ // 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::Testnet => "test",
+ bitcoin::Network::Regtest => "regtest",
+ bitcoin::Network::Signet => "signet",
+ } {
+ println!(
+ "Chain argument ({}) didn't match bitcoind chain ({})",
+ args.network, bitcoind_chain
+ );
+ return;
+ }
// ## Setup
// Step 1: Initialize the FeeEstimator
let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
// Step 5: Initialize the ChainMonitor
- let chain_monitor: Arc<ArcChainMonitor> = Arc::new(ChainMonitor::new(
+ let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
None,
broadcaster.clone(),
logger.clone(),
} else {
let mut key = [0; 32];
thread_rng().fill_bytes(&mut key);
- let mut f = File::create(keys_seed_path).unwrap();
- f.write_all(&key).expect("Failed to write node keys seed to disk");
- f.sync_all().expect("Failed to sync node keys seed to disk");
+ match File::create(keys_seed_path.clone()) {
+ Ok(mut f) => {
+ f.write_all(&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()));
// Step 7: Read ChannelMonitor state from disk
- let monitors_path = format!("{}/monitors", ldk_data_dir.clone());
- let mut outpoint_to_channelmonitor =
- disk::read_channelmonitors(monitors_path.to_string(), keys_manager.clone()).unwrap();
+ let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
- // Step 9: Initialize the ChannelManager
+ // Step 8: Initialize the ChannelManager
let user_config = UserConfig::default();
- let runtime = Runtime::new().unwrap();
let mut restarting_node = true;
let (channel_manager_blockhash, mut 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 outpoint_to_channelmonitor.iter_mut() {
- channel_monitor_mut_references.push(&mut channel_monitor.1);
+ for (_, channel_monitor) in channelmonitors.iter_mut() {
+ channel_monitor_mut_references.push(channel_monitor);
}
let read_args = ChannelManagerReadArgs::new(
keys_manager.clone(),
} else {
// We're starting a fresh node.
restarting_node = false;
- let getinfo_resp = bitcoind_client.get_blockchain_info();
+ let getinfo_resp = bitcoind_client.get_blockchain_info().await;
+
let chain_params = ChainParameters {
network: args.network,
- latest_hash: getinfo_resp.latest_blockhash,
- latest_height: getinfo_resp.latest_height,
+ best_block: BestBlock::new(
+ getinfo_resp.latest_blockhash,
+ getinfo_resp.latest_height as u32,
+ ),
};
let fresh_channel_manager = channelmanager::ChannelManager::new(
fee_estimator.clone(),
}
};
- // Step 10: Sync ChannelMonitors and ChannelManager to chain tip
+ // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
let mut chain_listener_channel_monitors = Vec::new();
let mut cache = UnboundedCache::new();
let mut chain_tip: Option<poll::ValidatedBlockHeader> = None;
let mut chain_listeners =
vec![(channel_manager_blockhash, &mut channel_manager as &mut dyn chain::Listen)];
- for (outpoint, blockhash_and_monitor) in outpoint_to_channelmonitor.drain() {
- let blockhash = blockhash_and_monitor.0;
- let channel_monitor = blockhash_and_monitor.1;
+ 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()),
));
}
chain_tip = Some(
- runtime
- .block_on(init::synchronize_listeners(
- &mut bitcoind_rpc_client,
- args.network,
- &mut cache,
- chain_listeners,
- ))
- .unwrap(),
+ init::synchronize_listeners(
+ &mut bitcoind_client.deref(),
+ args.network,
+ &mut cache,
+ chain_listeners,
+ )
+ .await
+ .unwrap(),
);
}
- // Step 11: Give ChannelMonitors to ChainMonitor
+ // Step 10: Give ChannelMonitors to ChainMonitor
for item in chain_listener_channel_monitors.drain(..) {
let channel_monitor = item.1 .0;
let funding_outpoint = item.2;
chain_monitor.watch_channel(funding_outpoint, channel_monitor).unwrap();
}
- // Step 13: Optional: Initialize the NetGraphMsgHandler
+ // Step 11: Optional: Initialize the NetGraphMsgHandler
// XXX persist routing data
let genesis = genesis_block(args.network).header.block_hash();
- let router =
- Arc::new(NetGraphMsgHandler::new(genesis, None::<Arc<dyn chain::Access>>, logger.clone()));
+ let router = Arc::new(NetGraphMsgHandler::new(
+ genesis,
+ None::<Arc<dyn chain::Access + Send + Sync>>,
+ logger.clone(),
+ ));
- // Step 14: Initialize the PeerManager
+ // Step 12: Initialize the PeerManager
let channel_manager: Arc<ChannelManager> = Arc::new(channel_manager);
let mut ephemeral_bytes = [0; 32];
rand::thread_rng().fill_bytes(&mut ephemeral_bytes);
));
// ## Running LDK
- // Step 16: Initialize Peer Connection Handling
+ // Step 13: Initialize networking
// We poll for events in handle_ldk_events(..) rather than waiting for them over the
// mpsc::channel, so we can leave the event receiver as unused.
- let (event_ntfn_sender, mut _event_ntfn_receiver) = mpsc::channel(2);
+ let (event_ntfn_sender, event_ntfn_receiver) = mpsc::channel(2);
let peer_manager_connection_handler = peer_manager.clone();
let event_notifier = event_ntfn_sender.clone();
let listening_port = args.ldk_peer_listening_port;
- runtime.spawn(async move {
- let listener = std::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).unwrap();
+ tokio::spawn(async move {
+ let listener = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", listening_port)).await.unwrap();
loop {
- let tcp_stream = listener.accept().unwrap().0;
- lightning_net_tokio::setup_inbound(
- peer_manager_connection_handler.clone(),
- event_notifier.clone(),
- tcp_stream,
- )
- .await;
+ let peer_mgr = peer_manager_connection_handler.clone();
+ let notifier = event_notifier.clone();
+ let tcp_stream = listener.accept().await.unwrap().0;
+ tokio::spawn(async move {
+ lightning_net_tokio::setup_inbound(peer_mgr.clone(), notifier.clone(), tcp_stream.into_std().unwrap())
+ .await;
+ });
}
});
- // Step 17: Connect and Disconnect Blocks
+ // Step 14: Connect and Disconnect Blocks
if chain_tip.is_none() {
- chain_tip = Some(
- runtime.block_on(init::validate_best_block_header(&mut bitcoind_rpc_client)).unwrap(),
- );
+ chain_tip =
+ Some(init::validate_best_block_header(&mut bitcoind_client.deref()).await.unwrap());
}
let channel_manager_listener = channel_manager.clone();
let chain_monitor_listener = chain_monitor.clone();
+ let bitcoind_block_source = bitcoind_client.clone();
let network = args.network;
- runtime.spawn(async move {
- let chain_poller = poll::ChainPoller::new(&mut bitcoind_rpc_client, network);
+ tokio::spawn(async move {
+ let mut derefed = bitcoind_block_source.deref();
+ let chain_poller = poll::ChainPoller::new(&mut derefed, network);
let chain_listener = (chain_monitor_listener, channel_manager_listener);
let mut spv_client =
SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_listener);
}
});
- // Step 17 & 18: Initialize ChannelManager persistence & Once Per Minute: ChannelManager's
- // timer_chan_freshness_every_min() and PeerManager's timer_tick_occurred
- let runtime_handle = runtime.handle();
- let data_dir = ldk_data_dir.clone();
- let persist_channel_manager_callback =
- move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
- BackgroundProcessor::start(
- persist_channel_manager_callback,
- channel_manager.clone(),
- logger.clone(),
- );
-
- let peer_manager_processor = peer_manager.clone();
- thread::spawn(move || loop {
- peer_manager_processor.timer_tick_occurred();
- thread::sleep(Duration::new(60, 0));
- });
-
// Step 15: Initialize LDK Event Handling
- let peer_manager_event_listener = peer_manager.clone();
let channel_manager_event_listener = channel_manager.clone();
let chain_monitor_event_listener = chain_monitor.clone();
let keys_manager_listener = keys_manager.clone();
- let payment_info: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
- let payment_info_for_events = payment_info.clone();
+ // TODO: persist payment info to disk
+ let inbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
+ let outbound_payments: PaymentInfoStorage = Arc::new(Mutex::new(HashMap::new()));
+ let inbound_pmts_for_events = inbound_payments.clone();
+ let outbound_pmts_for_events = outbound_payments.clone();
let network = args.network;
- thread::spawn(move || {
+ let bitcoind_rpc = bitcoind_client.clone();
+ tokio::spawn(async move {
handle_ldk_events(
- peer_manager_event_listener,
channel_manager_event_listener,
chain_monitor_event_listener,
- bitcoind_client.clone(),
+ bitcoind_rpc,
keys_manager_listener,
- payment_info_for_events,
+ inbound_pmts_for_events,
+ outbound_pmts_for_events,
network,
- );
+ event_ntfn_receiver,
+ )
+ .await;
});
+ // Step 16 & 17: Persist ChannelManager & Background Processing
+ let data_dir = ldk_data_dir.clone();
+ let persist_channel_manager_callback =
+ move |node: &ChannelManager| FilesystemPersister::persist_manager(data_dir.clone(), &*node);
+ BackgroundProcessor::start(
+ persist_channel_manager_callback,
+ channel_manager.clone(),
+ peer_manager.clone(),
+ logger.clone(),
+ );
+
// Reconnect to channel peers if possible.
- let handle = runtime_handle.clone();
let peer_data_path = format!("{}/channel_peer_data", ldk_data_dir.clone());
match disk::read_channel_peer_data(Path::new(&peer_data_path)) {
Ok(mut info) => {
peer_addr,
peer_manager.clone(),
event_ntfn_sender.clone(),
- handle.clone(),
);
}
}
cli::poll_for_user_input(
peer_manager.clone(),
channel_manager.clone(),
+ keys_manager.clone(),
router.clone(),
- payment_info,
- keys_manager.get_node_secret(),
+ inbound_payments,
+ outbound_payments,
event_ntfn_sender,
ldk_data_dir.clone(),
logger.clone(),
- handle,
args.network,
- );
+ )
+ .await;
+}
+
+#[tokio::main]
+pub async fn main() {
+ start_ldk().await;
}
projects / ldk-sample / blobdiff