use crate::disk;
use crate::hex_utils;
use crate::{
- ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, PaymentInfo, PaymentInfoStorage,
- PeerManager,
+ ChannelManager, HTLCStatus, InvoicePayer, MillisatAmount, NetworkGraph, OnionMessenger,
+ PaymentInfo, PaymentInfoStorage, PeerManager,
};
use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hashes::Hash;
use bitcoin::network::constants::Network;
-use bitcoin::secp256k1::key::PublicKey;
+use bitcoin::secp256k1::PublicKey;
use lightning::chain::keysinterface::{KeysInterface, KeysManager, Recipient};
-use lightning::ln::msgs::NetAddress;
+use lightning::ln::msgs::{DecodeError, NetAddress};
use lightning::ln::{PaymentHash, PaymentPreimage};
-use lightning::routing::network_graph::{NetworkGraph, NodeId};
-use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
+use lightning::onion_message::{CustomOnionMessageContents, Destination, OnionMessageContents};
+use lightning::routing::gossip::NodeId;
+use lightning::util::config::{ChannelHandshakeConfig, ChannelHandshakeLimits, UserConfig};
use lightning::util::events::EventHandler;
+use lightning::util::ser::{MaybeReadableArgs, Writeable, Writer};
use lightning_invoice::payment::PaymentError;
use lightning_invoice::{utils, Currency, Invoice};
use std::env;
use std::io;
-use std::io::{BufRead, Write};
-use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
+use std::io::Write;
+use std::net::{SocketAddr, ToSocketAddrs};
use std::ops::Deref;
use std::path::Path;
use std::str::FromStr;
pub(crate) network: Network,
}
-pub(crate) fn parse_startup_args() -> Result<LdkUserInfo, ()> {
- if env::args().len() < 3 {
- println!("ldk-tutorial-node requires 3 arguments: `cargo run <bitcoind-rpc-username>:<bitcoind-rpc-password>@<bitcoind-rpc-host>:<bitcoind-rpc-port> ldk_storage_directory_path [<ldk-incoming-peer-listening-port>] [bitcoin-network] [announced-node-name announced-listen-addr*]`");
- return Err(());
- }
- let bitcoind_rpc_info = env::args().skip(1).next().unwrap();
- let bitcoind_rpc_info_parts: Vec<&str> = bitcoind_rpc_info.rsplitn(2, "@").collect();
- if bitcoind_rpc_info_parts.len() != 2 {
- println!("ERROR: bad bitcoind RPC URL provided");
- return Err(());
- }
- let rpc_user_and_password: Vec<&str> = bitcoind_rpc_info_parts[1].split(":").collect();
- if rpc_user_and_password.len() != 2 {
- println!("ERROR: bad bitcoind RPC username/password combo provided");
- return Err(());
+struct UserOnionMessageContents {
+ tlv_type: u64,
+ data: Vec<u8>,
+}
+
+impl CustomOnionMessageContents for UserOnionMessageContents {
+ fn tlv_type(&self) -> u64 {
+ self.tlv_type
}
- let bitcoind_rpc_username = rpc_user_and_password[0].to_string();
- let bitcoind_rpc_password = rpc_user_and_password[1].to_string();
- let bitcoind_rpc_path: Vec<&str> = bitcoind_rpc_info_parts[0].split(":").collect();
- if bitcoind_rpc_path.len() != 2 {
- println!("ERROR: bad bitcoind RPC path provided");
- return Err(());
+}
+impl MaybeReadableArgs<u64> for UserOnionMessageContents {
+ fn read<R: std::io::Read>(_r: &mut R, _args: u64) -> Result<Option<Self>, DecodeError> {
+ // UserOnionMessageContents is only ever passed to `send_onion_message`, never to an
+ // `OnionMessageHandler`, thus it does not need to implement the read side here.
+ unreachable!();
}
- let bitcoind_rpc_host = bitcoind_rpc_path[0].to_string();
- let bitcoind_rpc_port = bitcoind_rpc_path[1].parse::<u16>().unwrap();
-
- let ldk_storage_dir_path = env::args().skip(2).next().unwrap();
-
- let mut ldk_peer_port_set = true;
- let ldk_peer_listening_port: u16 = match env::args().skip(3).next().map(|p| p.parse()) {
- Some(Ok(p)) => p,
- Some(Err(_)) => {
- ldk_peer_port_set = false;
- 9735
- }
- None => {
- ldk_peer_port_set = false;
- 9735
- }
- };
-
- let mut arg_idx = match ldk_peer_port_set {
- true => 4,
- false => 3,
- };
- let network: Network = match env::args().skip(arg_idx).next().as_ref().map(String::as_str) {
- Some("testnet") => Network::Testnet,
- Some("regtest") => Network::Regtest,
- Some("signet") => Network::Signet,
- Some(net) => {
- panic!("Unsupported network provided. Options are: `regtest`, `testnet`, and `signet`. Got {}", net);
- }
- None => Network::Testnet,
- };
-
- let ldk_announced_node_name = match env::args().skip(arg_idx + 1).next().as_ref() {
- Some(s) => {
- if s.len() > 32 {
- panic!("Node Alias can not be longer than 32 bytes");
- }
- arg_idx += 1;
- let mut bytes = [0; 32];
- bytes[..s.len()].copy_from_slice(s.as_bytes());
- bytes
- }
- None => [0; 32],
- };
-
- let mut ldk_announced_listen_addr = Vec::new();
- loop {
- match env::args().skip(arg_idx + 1).next().as_ref() {
- Some(s) => match IpAddr::from_str(s) {
- Ok(IpAddr::V4(a)) => {
- ldk_announced_listen_addr
- .push(NetAddress::IPv4 { addr: a.octets(), port: ldk_peer_listening_port });
- arg_idx += 1;
- }
- Ok(IpAddr::V6(a)) => {
- ldk_announced_listen_addr
- .push(NetAddress::IPv6 { addr: a.octets(), port: ldk_peer_listening_port });
- arg_idx += 1;
- }
- Err(_) => panic!("Failed to parse announced-listen-addr into an IP address"),
- },
- None => break,
- }
+}
+impl Writeable for UserOnionMessageContents {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
+ w.write_all(&self.data)
}
-
- Ok(LdkUserInfo {
- bitcoind_rpc_username,
- bitcoind_rpc_password,
- bitcoind_rpc_host,
- bitcoind_rpc_port,
- ldk_storage_dir_path,
- ldk_peer_listening_port,
- ldk_announced_listen_addr,
- ldk_announced_node_name,
- network,
- })
}
pub(crate) async fn poll_for_user_input<E: EventHandler>(
invoice_payer: Arc<InvoicePayer<E>>, peer_manager: Arc<PeerManager>,
channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
- network_graph: Arc<NetworkGraph>, inbound_payments: PaymentInfoStorage,
- outbound_payments: PaymentInfoStorage, ldk_data_dir: String, network: Network,
+ network_graph: Arc<NetworkGraph>, onion_messenger: Arc<OnionMessenger>,
+ inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
+ ldk_data_dir: String, network: Network, logger: Arc<disk::FilesystemLogger>,
) {
- println!("LDK startup successful. To view available commands: \"help\".");
+ println!(
+ "LDK startup successful. Enter \"help\" to view available commands. Press Ctrl-D to quit."
+ );
println!("LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs");
println!("Local Node ID is {}.", channel_manager.get_our_node_id());
- let stdin = io::stdin();
- let mut line_reader = stdin.lock().lines();
loop {
print!("> ");
io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
- let line = match line_reader.next() {
- Some(l) => l.unwrap(),
- None => break,
- };
+ let mut line = String::new();
+ if let Err(e) = io::stdin().read_line(&mut line) {
+ break println!("ERROR: {}", e);
+ }
+
+ if line.len() == 0 {
+ // We hit EOF / Ctrl-D
+ break;
+ }
+
let mut words = line.split_whitespace();
if let Some(word) = words.next() {
match word {
println!("ERROR: getinvoice provided payment amount was not a number");
continue;
}
+
+ let expiry_secs_str = words.next();
+ if expiry_secs_str.is_none() {
+ println!("ERROR: getinvoice requires an expiry in seconds");
+ continue;
+ }
+
+ let expiry_secs: Result<u32, _> = expiry_secs_str.unwrap().parse();
+ if expiry_secs.is_err() {
+ println!("ERROR: getinvoice provided expiry was not a number");
+ continue;
+ }
+
get_invoice(
amt_msat.unwrap(),
- inbound_payments.clone(),
- channel_manager.clone(),
- keys_manager.clone(),
+ Arc::clone(&inbound_payments),
+ &*channel_manager,
+ Arc::clone(&keys_manager),
network,
+ expiry_secs.unwrap(),
+ Arc::clone(&logger),
);
}
"connectpeer" => {
"closechannel" => {
let channel_id_str = words.next();
if channel_id_str.is_none() {
- println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
+ println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id> <peer_pubkey>`");
continue;
}
let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
}
let mut channel_id = [0; 32];
channel_id.copy_from_slice(&channel_id_vec.unwrap());
- close_channel(channel_id, channel_manager.clone());
+
+ let peer_pubkey_str = words.next();
+ if peer_pubkey_str.is_none() {
+ println!("ERROR: closechannel requires a peer pubkey: `closechannel <channel_id> <peer_pubkey>`");
+ continue;
+ }
+ let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
+ Some(peer_pubkey_vec) => peer_pubkey_vec,
+ None => {
+ println!("ERROR: couldn't parse peer_pubkey");
+ continue;
+ }
+ };
+ let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
+ Ok(peer_pubkey) => peer_pubkey,
+ Err(_) => {
+ println!("ERROR: couldn't parse peer_pubkey");
+ continue;
+ }
+ };
+
+ close_channel(channel_id, peer_pubkey, channel_manager.clone());
}
"forceclosechannel" => {
let channel_id_str = words.next();
if channel_id_str.is_none() {
- println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id>`");
+ println!("ERROR: forceclosechannel requires a channel ID: `forceclosechannel <channel_id> <peer_pubkey>`");
continue;
}
let channel_id_vec = hex_utils::to_vec(channel_id_str.unwrap());
}
let mut channel_id = [0; 32];
channel_id.copy_from_slice(&channel_id_vec.unwrap());
- force_close_channel(channel_id, channel_manager.clone());
+
+ let peer_pubkey_str = words.next();
+ if peer_pubkey_str.is_none() {
+ println!("ERROR: forceclosechannel requires a peer pubkey: `forceclosechannel <channel_id> <peer_pubkey>`");
+ continue;
+ }
+ let peer_pubkey_vec = match hex_utils::to_vec(peer_pubkey_str.unwrap()) {
+ Some(peer_pubkey_vec) => peer_pubkey_vec,
+ None => {
+ println!("ERROR: couldn't parse peer_pubkey");
+ continue;
+ }
+ };
+ let peer_pubkey = match PublicKey::from_slice(&peer_pubkey_vec) {
+ Ok(peer_pubkey) => peer_pubkey,
+ Err(_) => {
+ println!("ERROR: couldn't parse peer_pubkey");
+ continue;
+ }
+ };
+
+ force_close_channel(channel_id, peer_pubkey, channel_manager.clone());
}
"nodeinfo" => node_info(&channel_manager, &peer_manager),
"listpeers" => list_peers(peer_manager.clone()),
)
);
}
+ "sendonionmessage" => {
+ let path_pks_str = words.next();
+ if path_pks_str.is_none() {
+ println!(
+ "ERROR: sendonionmessage requires at least one node id for the path"
+ );
+ continue;
+ }
+ let mut node_pks = Vec::new();
+ let mut errored = false;
+ for pk_str in path_pks_str.unwrap().split(",") {
+ let node_pubkey_vec = match hex_utils::to_vec(pk_str) {
+ Some(peer_pubkey_vec) => peer_pubkey_vec,
+ None => {
+ println!("ERROR: couldn't parse peer_pubkey");
+ errored = true;
+ break;
+ }
+ };
+ let node_pubkey = match PublicKey::from_slice(&node_pubkey_vec) {
+ Ok(peer_pubkey) => peer_pubkey,
+ Err(_) => {
+ println!("ERROR: couldn't parse peer_pubkey");
+ errored = true;
+ break;
+ }
+ };
+ node_pks.push(node_pubkey);
+ }
+ if errored {
+ continue;
+ }
+ let tlv_type = match words.next().map(|ty_str| ty_str.parse()) {
+ Some(Ok(ty)) if ty >= 64 => ty,
+ _ => {
+ println!("Need an integral message type above 64");
+ continue;
+ }
+ };
+ let data = match words.next().map(|s| hex_utils::to_vec(s)) {
+ Some(Some(data)) => data,
+ _ => {
+ println!("Need a hex data string");
+ continue;
+ }
+ };
+ let destination_pk = node_pks.pop().unwrap();
+ match onion_messenger.send_onion_message(
+ &node_pks,
+ Destination::Node(destination_pk),
+ OnionMessageContents::Custom(UserOnionMessageContents { tlv_type, data }),
+ None,
+ ) {
+ Ok(()) => println!("SUCCESS: forwarded onion message to first hop"),
+ Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
+ }
+ }
+ "quit" | "exit" => break,
_ => println!("Unknown command. See `\"help\" for available commands."),
}
}
}
fn help() {
- println!("openchannel pubkey@host:port <amt_satoshis>");
- println!("sendpayment <invoice>");
- println!("getinvoice <amt_millisatoshis>");
- println!("connectpeer pubkey@host:port");
- println!("listchannels");
- println!("listpayments");
- println!("closechannel <channel_id>");
- println!("forceclosechannel <channel_id>");
- println!("nodeinfo");
- println!("listpeers");
- println!("signmessage <message>");
+ let package_version = env!("CARGO_PKG_VERSION");
+ let package_name = env!("CARGO_PKG_NAME");
+ println!("\nVERSION:");
+ println!(" {} v{}", package_name, package_version);
+ println!("\nUSAGE:");
+ println!(" Command [arguments]");
+ println!("\nCOMMANDS:");
+ println!(" help\tShows a list of commands.");
+ println!(" quit\tClose the application.");
+ println!("\n Channels:");
+ println!(" openchannel pubkey@host:port <amt_satoshis> [--public]");
+ println!(" closechannel <channel_id> <peer_pubkey>");
+ println!(" forceclosechannel <channel_id> <peer_pubkey>");
+ println!(" listchannels");
+ println!("\n Peers:");
+ println!(" connectpeer pubkey@host:port");
+ println!(" listpeers");
+ println!("\n Payments:");
+ println!(" sendpayment <invoice>");
+ println!(" keysend <dest_pubkey> <amt_msats>");
+ println!(" listpayments");
+ println!("\n Invoices:");
+ println!(" getinvoice <amt_msats> <expiry_secs>");
+ println!("\n Other:");
+ println!(" signmessage <message>");
+ println!(
+ " sendonionmessage <node_id_1,node_id_2,..,destination_node_id> <type> <hex_bytes>"
+ );
+ println!(" nodeinfo");
}
fn node_info(channel_manager: &Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
println!("\t}},");
}
-/// Takes some untrusted bytes and returns a sanitized string that is safe to print
-fn sanitize_string(bytes: &[u8]) -> String {
- let mut ret = String::with_capacity(bytes.len());
- // We should really support some sane subset of UTF-8 here, but limiting to printable ASCII
- // instead makes this trivial.
- for b in bytes {
- if *b >= 0x20 && *b <= 0x7e {
- ret.push(*b as char);
- }
- }
- ret
-}
-
fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
print!("[");
for chan_info in channel_manager.list_channels() {
.get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
{
if let Some(announcement) = &node_info.announcement_info {
- println!("\t\tpeer_alias: {}", sanitize_string(&announcement.alias));
+ println!("\t\tpeer_alias: {}", announcement.alias);
}
}
if let Some(id) = chan_info.short_channel_id {
println!("\t\tshort_channel_id: {},", id);
}
- println!("\t\tis_confirmed_onchain: {},", chan_info.is_funding_locked);
+ println!("\t\tis_channel_ready: {},", chan_info.is_channel_ready);
println!("\t\tchannel_value_satoshis: {},", chan_info.channel_value_satoshis);
println!("\t\tlocal_balance_msat: {},", chan_info.balance_msat);
if chan_info.is_usable {
channel_manager: Arc<ChannelManager>,
) -> Result<(), ()> {
let config = UserConfig {
- peer_channel_config_limits: ChannelHandshakeLimits {
+ channel_handshake_limits: ChannelHandshakeLimits {
// lnd's max to_self_delay is 2016, so we want to be compatible.
their_to_self_delay: 2016,
..Default::default()
},
- channel_options: ChannelConfig { announced_channel, ..Default::default() },
+ channel_handshake_config: ChannelHandshakeConfig {
+ announced_channel,
+ ..Default::default()
+ },
..Default::default()
};
}
fn get_invoice(
- amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
- keys_manager: Arc<KeysManager>, network: Network,
+ amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: &ChannelManager,
+ keys_manager: Arc<KeysManager>, network: Network, expiry_secs: u32,
+ logger: Arc<disk::FilesystemLogger>,
) {
let mut payments = payment_storage.lock().unwrap();
let currency = match network {
Network::Signet => Currency::Signet,
};
let invoice = match utils::create_invoice_from_channelmanager(
- &channel_manager,
+ channel_manager,
keys_manager,
+ logger,
currency,
Some(amt_msat),
"ldk-tutorial-node".to_string(),
+ expiry_secs,
) {
Ok(inv) => {
println!("SUCCESS: generated invoice: {}", inv);
);
}
-fn close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
- match channel_manager.close_channel(&channel_id) {
+fn close_channel(
+ channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
+) {
+ match channel_manager.close_channel(&channel_id, &counterparty_node_id) {
Ok(()) => println!("EVENT: initiating channel close"),
Err(e) => println!("ERROR: failed to close channel: {:?}", e),
}
}
-fn force_close_channel(channel_id: [u8; 32], channel_manager: Arc<ChannelManager>) {
- match channel_manager.force_close_channel(&channel_id) {
+fn force_close_channel(
+ channel_id: [u8; 32], counterparty_node_id: PublicKey, channel_manager: Arc<ChannelManager>,
+) {
+ match channel_manager.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id) {
Ok(()) => println!("EVENT: initiating channel force-close"),
Err(e) => println!("ERROR: failed to force-close channel: {:?}", e),
}
let mut pubkey_and_addr = peer_pubkey_and_ip_addr.split("@");
let pubkey = pubkey_and_addr.next();
let peer_addr_str = pubkey_and_addr.next();
- if peer_addr_str.is_none() || peer_addr_str.is_none() {
+ if peer_addr_str.is_none() {
return Err(std::io::Error::new(
std::io::ErrorKind::Other,
"ERROR: incorrectly formatted peer info. Should be formatted as: `pubkey@host:port`",
projects / ldk-sample / blobdiff