+mod args;
pub mod bitcoind_client;
mod cli;
mod convert;
use crate::bitcoind_client::BitcoindClient;
use crate::disk::FilesystemLogger;
-use bitcoin::blockdata::constants::genesis_block;
use bitcoin::blockdata::transaction::Transaction;
use bitcoin::consensus::encode;
use bitcoin::network::constants::Network;
use bitcoin_bech32::WitnessProgram;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
-use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager, Recipient};
+use lightning::chain::keysinterface::{EntropySource, InMemorySigner, KeysManager};
use lightning::chain::{chainmonitor, ChannelMonitorUpdateStatus};
-use lightning::chain::{BestBlock, Filter, Watch};
+use lightning::chain::{Filter, Watch};
use lightning::ln::channelmanager;
use lightning::ln::channelmanager::{
ChainParameters, ChannelManagerReadArgs, SimpleArcChannelManager,
use lightning::onion_message::SimpleArcOnionMessenger;
use lightning::routing::gossip;
use lightning::routing::gossip::{NodeId, P2PGossipSync};
-use lightning::routing::scoring::ProbabilisticScorer;
+use lightning::routing::router::DefaultRouter;
use lightning::util::config::UserConfig;
-use lightning::util::events::{Event, PaymentPurpose};
+use lightning::events::{Event, PaymentPurpose};
use lightning::util::ser::ReadableArgs;
use lightning_background_processor::{BackgroundProcessor, GossipSync};
use lightning_block_sync::init;
use lightning_block_sync::poll;
use lightning_block_sync::SpvClient;
use lightning_block_sync::UnboundedCache;
-use lightning_invoice::payment;
-use lightning_invoice::utils::DefaultRouter;
use lightning_net_tokio::SocketDescriptor;
use lightning_persister::FilesystemPersister;
use rand::{thread_rng, Rng};
ChainMonitor,
BitcoindClient,
BitcoindClient,
- dyn chain::Access + Send + Sync,
+ BitcoindClient,
FilesystemLogger,
>;
pub(crate) type ChannelManager =
SimpleArcChannelManager<ChainMonitor, BitcoindClient, BitcoindClient, FilesystemLogger>;
-pub(crate) type InvoicePayer<E> =
- payment::InvoicePayer<Arc<ChannelManager>, Router, Arc<FilesystemLogger>, E>;
-
-type Router = DefaultRouter<
- Arc<NetworkGraph>,
- Arc<FilesystemLogger>,
- Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph>, Arc<FilesystemLogger>>>>,
->;
-
pub(crate) type NetworkGraph = gossip::NetworkGraph<Arc<FilesystemLogger>>;
type OnionMessenger = SimpleArcOnionMessenger<FilesystemLogger>;
io::stdout().flush().unwrap();
}
}
- Event::PaymentReceived { payment_hash, purpose, amount_msat } => {
+ Event::PaymentClaimable {
+ payment_hash,
+ purpose,
+ amount_msat,
+ receiver_node_id: _,
+ via_channel_id: _,
+ via_user_channel_id: _,
+ claim_deadline: _,
+ onion_fields: _,
+ } => {
println!(
"\nEVENT: received payment from payment hash {} of {} millisatoshis",
hex_utils::hex_str(&payment_hash.0),
};
channel_manager.claim_funds(payment_preimage.unwrap());
}
- Event::PaymentClaimed { payment_hash, purpose, amount_msat } => {
+ Event::PaymentClaimed { payment_hash, purpose, amount_msat, receiver_node_id: _ } => {
println!(
"\nEVENT: claimed payment from payment hash {} of {} millisatoshis",
hex_utils::hex_str(&payment_hash.0),
next_channel_id,
fee_earned_msat,
claim_from_onchain_tx,
+ outbound_amount_forwarded_msat,
} => {
let read_only_network_graph = network_graph.read_only();
let nodes = read_only_network_graph.nodes();
} 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) = fee_earned_msat {
println!(
- "\nEVENT: Forwarded payment{}{}, earning {} msat {}",
- from_prev_str, to_next_str, fee_earned, from_onchain_str
+ "\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{}{}, claiming onchain {}",
- from_prev_str, to_next_str, from_onchain_str
+ "\nEVENT: Forwarded payment for {} msat{}{}, claiming onchain {}",
+ amt_args, from_prev_str, to_next_str, from_onchain_str
);
}
print!("> ");
.unwrap();
bitcoind_client.broadcast_transaction(&spending_tx);
}
+ Event::ChannelPending { .. } => {}
+ Event::ChannelReady {
+ ref channel_id,
+ user_channel_id: _,
+ ref counterparty_node_id,
+ channel_type: _,
+ } => {
+ println!(
+ "\nEVENT: Channel {} with peer {} is ready to be used!",
+ hex_utils::hex_str(channel_id),
+ hex_utils::hex_str(&counterparty_node_id.serialize()),
+ );
+ print!("> ");
+ io::stdout().flush().unwrap();
+ }
Event::ChannelClosed { channel_id, reason, user_channel_id: _ } => {
println!(
"\nEVENT: Channel {} closed due to: {:?}",
// 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 { .. } => {}
}
}
async fn start_ldk() {
- let args = match cli::parse_startup_args() {
+ let args = match args::parse_startup_args() {
Ok(user_args) => user_args,
Err(()) => return,
};
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_username.clone(),
args.bitcoind_rpc_password.clone(),
tokio::runtime::Handle::current(),
+ Arc::clone(&logger),
)
.await
{
return;
}
- // ## Setup
- // Step 1: Initialize the FeeEstimator
+ // 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 2: Initialize the Logger
- let logger = Arc::new(FilesystemLogger::new(ldk_data_dir.clone()));
-
// Step 3: Initialize the BroadcasterInterface
// BitcoindClient implements the BroadcasterInterface trait, so it'll act as our transaction
let keys_manager = Arc::new(KeysManager::new(&keys_seed, cur.as_secs(), cur.subsec_nanos()));
// Step 7: Read ChannelMonitor state from disk
- let mut channelmonitors = persister.read_channelmonitors(keys_manager.clone()).unwrap();
+ let mut channelmonitors =
+ persister.read_channelmonitors(keys_manager.clone(), keys_manager.clone()).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()));
- // Step 8: Initialize the ChannelManager
+ let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
+ let scorer = Arc::new(Mutex::new(disk::read_scorer(
+ Path::new(&scorer_path),
+ Arc::clone(&network_graph),
+ Arc::clone(&logger),
+ )));
+
+ // Step 10: Create Router
+ let router = Arc::new(DefaultRouter::new(
+ network_graph.clone(),
+ logger.clone(),
+ keys_manager.get_secure_random_bytes(),
+ scorer.clone(),
+ ));
+
+ // Step 11: Initialize the ChannelManager
let mut user_config = UserConfig::default();
user_config.channel_handshake_limits.force_announced_channel_preference = false;
let mut restarting_node = true;
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,
} else {
// We're starting a fresh node.
restarting_node = false;
- let getinfo_resp = bitcoind_client.get_blockchain_info().await;
-
- let chain_params = ChainParameters {
- network: args.network,
- best_block: BestBlock::new(
- getinfo_resp.latest_blockhash,
- getinfo_resp.latest_height as u32,
- ),
- };
+
+ 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,
);
- (getinfo_resp.latest_blockhash, fresh_channel_manager)
+ (polled_best_block_hash, fresh_channel_manager)
}
};
- // Step 9: Sync ChannelMonitors and ChannelManager to chain tip
+ // Step 12: 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;
- if restarting_node {
+ let chain_tip = if restarting_node {
let mut chain_listeners = vec![(
channel_manager_blockhash,
&channel_manager as &(dyn chain::Listen + Send + Sync),
&monitor_listener_info.1 as &(dyn chain::Listen + Send + Sync),
));
}
- chain_tip = Some(
- init::synchronize_listeners(
- bitcoind_client.as_ref(),
- args.network,
- &mut cache,
- chain_listeners,
- )
- .await
- .unwrap(),
- );
- }
- // Step 10: Give ChannelMonitors to ChainMonitor
+ init::synchronize_listeners(
+ bitcoind_client.as_ref(),
+ args.network,
+ &mut cache,
+ chain_listeners,
+ )
+ .await
+ .unwrap()
+ } else {
+ polled_chain_tip
+ };
+
+ // Step 13: Give ChannelMonitors to ChainMonitor
for item in chain_listener_channel_monitors.drain(..) {
let channel_monitor = item.1 .0;
let funding_outpoint = item.2;
);
}
- // Step 11: Optional: Initialize the P2PGossipSync
- let genesis = genesis_block(args.network).header.block_hash();
- let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
- let network_graph =
- Arc::new(disk::read_network(Path::new(&network_graph_path), genesis, logger.clone()));
+ // Step 14: Optional: Initialize the P2PGossipSync
let gossip_sync = Arc::new(P2PGossipSync::new(
Arc::clone(&network_graph),
- None::<Arc<dyn chain::Access + Send + Sync>>,
+ None::<Arc<BitcoindClient>>,
logger.clone(),
));
- // Step 12: Initialize the PeerManager
+ // Step 15: 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),
IgnoringMessageHandler {},
};
let peer_manager: Arc<PeerManager> = Arc::new(PeerManager::new(
lightning_msg_handler,
- keys_manager.get_node_secret(Recipient::Node).unwrap(),
current_time.try_into().unwrap(),
&ephemeral_bytes,
logger.clone(),
IgnoringMessageHandler {},
+ Arc::clone(&keys_manager),
));
// ## Running LDK
- // Step 13: Initialize networking
+ // Step 16: 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!("0.0.0.0:{}", listening_port))
+ 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 {
}
});
- // Step 14: Connect and Disconnect Blocks
- if chain_tip.is_none() {
- chain_tip = Some(init::validate_best_block_header(bitcoind_client.as_ref()).await.unwrap());
- }
+ // Step 17: Connect and Disconnect Blocks
let channel_manager_listener = channel_manager.clone();
let chain_monitor_listener = chain_monitor.clone();
let bitcoind_block_source = bitcoind_client.clone();
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);
- let mut spv_client =
- SpvClient::new(chain_tip.unwrap(), chain_poller, &mut cache, &chain_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;
}
});
- // Step 15: Handle LDK Events
+ // Step 18: Handle LDK Events
let channel_manager_event_listener = channel_manager.clone();
let keys_manager_listener = keys_manager.clone();
// TODO: persist payment info to disk
let bitcoind_rpc = bitcoind_client.clone();
let network_graph_events = network_graph.clone();
let handle = tokio::runtime::Handle::current();
- let event_handler = move |event: &Event| {
+ let event_handler = move |event: Event| {
handle.block_on(handle_ldk_events(
&channel_manager_event_listener,
&bitcoind_rpc,
&inbound_pmts_for_events,
&outbound_pmts_for_events,
network,
- event,
+ &event,
));
};
- // Step 16: Initialize routing ProbabilisticScorer
- let scorer_path = format!("{}/scorer", ldk_data_dir.clone());
- let scorer = Arc::new(Mutex::new(disk::read_scorer(
- Path::new(&scorer_path),
- Arc::clone(&network_graph),
- Arc::clone(&logger),
- )));
-
- // Step 17: Create InvoicePayer
- let router = DefaultRouter::new(
- network_graph.clone(),
- logger.clone(),
- keys_manager.get_secure_random_bytes(),
- scorer.clone(),
- );
- let invoice_payer = Arc::new(InvoicePayer::new(
- channel_manager.clone(),
- router,
- logger.clone(),
- event_handler,
- payment::Retry::Timeout(Duration::from_secs(10)),
- ));
-
- // Step 18: Persist ChannelManager and NetworkGraph
+ // Step 19: Persist ChannelManager and NetworkGraph
let persister = Arc::new(FilesystemPersister::new(ldk_data_dir.clone()));
- // Step 19: Background Processing
+ // Step 20: Background Processing
let background_processor = BackgroundProcessor::start(
persister,
- invoice_payer.clone(),
+ event_handler,
chain_monitor.clone(),
channel_manager.clone(),
GossipSync::p2p(gossip_sync.clone()),
.list_channels()
.iter()
.map(|chan| chan.counterparty.node_id)
- .filter(|id| !peers.contains(id))
+ .filter(|id| !peers.iter().any(|(pk, _)| id == pk))
{
if stop_connect.load(Ordering::Acquire) {
return;
// Start the CLI.
cli::poll_for_user_input(
- Arc::clone(&invoice_payer),
Arc::clone(&peer_manager),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
projects / ldk-sample / blobdiff