-use crate::disk;
+use crate::disk::{self, INBOUND_PAYMENTS_FNAME, OUTBOUND_PAYMENTS_FNAME};
use crate::hex_utils;
use crate::{
- ChannelManager, FilesystemLogger, HTLCStatus, MillisatAmount, PaymentInfo, PaymentInfoStorage,
- PeerManager,
+ ChannelManager, HTLCStatus, InboundPaymentInfoStorage, MillisatAmount, NetworkGraph,
+ OnionMessenger, OutboundPaymentInfoStorage, PaymentInfo, PeerManager,
};
+use bitcoin::hashes::sha256::Hash as Sha256;
use bitcoin::hashes::Hash;
use bitcoin::network::constants::Network;
-use bitcoin::secp256k1::key::PublicKey;
-use lightning::chain;
-use lightning::chain::keysinterface::KeysManager;
-use lightning::ln::features::InvoiceFeatures;
-use lightning::ln::msgs::NetAddress;
-use lightning::ln::{PaymentHash, PaymentSecret};
-use lightning::routing::network_graph::NetGraphMsgHandler;
-use lightning::routing::router;
-use lightning::routing::router::RouteHint;
-use lightning::util::config::{ChannelConfig, ChannelHandshakeLimits, UserConfig};
-use lightning_invoice::{utils, Currency, Invoice};
+use bitcoin::secp256k1::PublicKey;
+use lightning::ln::channelmanager::{PaymentId, RecipientOnionFields, Retry};
+use lightning::ln::msgs::SocketAddress;
+use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage};
+use lightning::offers::offer::{self, Offer};
+use lightning::onion_message::messenger::Destination;
+use lightning::onion_message::packet::OnionMessageContents;
+use lightning::routing::gossip::NodeId;
+use lightning::routing::router::{PaymentParameters, RouteParameters};
+use lightning::sign::{EntropySource, KeysManager};
+use lightning::util::config::{ChannelHandshakeConfig, ChannelHandshakeLimits, UserConfig};
+use lightning::util::persist::KVStore;
+use lightning::util::ser::{Writeable, Writer};
+use lightning_invoice::payment::payment_parameters_from_invoice;
+use lightning_invoice::payment::payment_parameters_from_zero_amount_invoice;
+use lightning_invoice::{utils, Bolt11Invoice, Currency};
+use lightning_persister::fs_store::FilesystemStore;
use std::env;
use std::io;
-use std::io::{BufRead, Write};
-use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
-use std::ops::Deref;
+use std::io::Write;
+use std::net::{SocketAddr, ToSocketAddrs};
use std::path::Path;
use std::str::FromStr;
-use std::sync::Arc;
+use std::sync::{Arc, Mutex};
use std::time::Duration;
pub(crate) struct LdkUserInfo {
pub(crate) bitcoind_rpc_host: String,
pub(crate) ldk_storage_dir_path: String,
pub(crate) ldk_peer_listening_port: u16,
- pub(crate) ldk_announced_listen_addr: Vec<NetAddress>,
+ pub(crate) ldk_announced_listen_addr: Vec<SocketAddress>,
pub(crate) ldk_announced_node_name: [u8; 32],
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(());
- }
- 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(());
- }
- 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(net) => {
- panic!("Unsupported network provided. Options are: `regtest`, `testnet`. 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],
- };
+#[derive(Debug)]
+struct UserOnionMessageContents {
+ tlv_type: u64,
+ data: Vec<u8>,
+}
- 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 OnionMessageContents for UserOnionMessageContents {
+ fn tlv_type(&self) -> u64 {
+ self.tlv_type
}
+}
- 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,
- })
+impl Writeable for UserOnionMessageContents {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), std::io::Error> {
+ w.write_all(&self.data)
+ }
}
-pub(crate) async fn poll_for_user_input(
+pub(crate) fn poll_for_user_input(
peer_manager: Arc<PeerManager>, channel_manager: Arc<ChannelManager>,
- keys_manager: Arc<KeysManager>,
- router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
- inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage,
- ldk_data_dir: String, logger: Arc<FilesystemLogger>, network: Network,
+ keys_manager: Arc<KeysManager>, network_graph: Arc<NetworkGraph>,
+ onion_messenger: Arc<OnionMessenger>, inbound_payments: Arc<Mutex<InboundPaymentInfoStorage>>,
+ outbound_payments: Arc<Mutex<OutboundPaymentInfoStorage>>, ldk_data_dir: String,
+ network: Network, logger: Arc<disk::FilesystemLogger>, fs_store: Arc<FilesystemStore>,
) {
- 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();
- print!("> ");
- io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
- for line in stdin.lock().lines() {
- let line = line.unwrap();
+ 'read_command: loop {
+ print!("> ");
+ io::stdout().flush().unwrap(); // Without flushing, the `>` doesn't print
+ 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 {
let peer_pubkey_and_ip_addr = words.next();
let channel_value_sat = words.next();
if peer_pubkey_and_ip_addr.is_none() || channel_value_sat.is_none() {
- println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public]");
- print!("> ");
- io::stdout().flush().unwrap();
+ println!("ERROR: openchannel has 2 required arguments: `openchannel pubkey@host:port channel_amt_satoshis` [--public] [--with-anchors]");
continue;
}
let peer_pubkey_and_ip_addr = peer_pubkey_and_ip_addr.unwrap();
Ok(info) => info,
Err(e) => {
println!("{:?}", e.into_inner().unwrap());
- print!("> ");
- io::stdout().flush().unwrap();
continue;
- }
+ },
};
let chan_amt_sat: Result<u64, _> = channel_value_sat.unwrap().parse();
if chan_amt_sat.is_err() {
println!("ERROR: channel amount must be a number");
- print!("> ");
- io::stdout().flush().unwrap();
continue;
}
- if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
- .await
+ if tokio::runtime::Handle::current()
+ .block_on(connect_peer_if_necessary(
+ pubkey,
+ peer_addr,
+ peer_manager.clone(),
+ ))
.is_err()
{
- print!("> ");
- io::stdout().flush().unwrap();
continue;
};
- let announce_channel = match words.next() {
- Some("--public") | Some("--public=true") => true,
- Some("--public=false") => false,
- Some(_) => {
- println!("ERROR: invalid `--public` command format. Valid formats: `--public`, `--public=true` `--public=false`");
- print!("> ");
- io::stdout().flush().unwrap();
- continue;
+ let (mut announce_channel, mut with_anchors) = (false, false);
+ while let Some(word) = words.next() {
+ match word {
+ "--public" | "--public=true" => announce_channel = true,
+ "--public=false" => announce_channel = false,
+ "--with-anchors" | "--with-anchors=true" => with_anchors = true,
+ "--with-anchors=false" => with_anchors = false,
+ _ => {
+ println!("ERROR: invalid boolean flag format. Valid formats: `--option`, `--option=true` `--option=false`");
+ continue;
+ },
}
- None => false,
- };
+ }
if open_channel(
pubkey,
chan_amt_sat.unwrap(),
announce_channel,
+ with_anchors,
channel_manager.clone(),
)
.is_ok()
peer_pubkey_and_ip_addr,
);
}
- }
+ },
"sendpayment" => {
let invoice_str = words.next();
if invoice_str.is_none() {
println!("ERROR: sendpayment requires an invoice: `sendpayment <invoice>`");
- print!("> ");
- io::stdout().flush().unwrap();
continue;
}
- let invoice = match Invoice::from_str(invoice_str.unwrap()) {
- Ok(inv) => inv,
- Err(e) => {
- println!("ERROR: invalid invoice: {:?}", e);
- print!("> ");
- io::stdout().flush().unwrap();
+ let mut user_provided_amt: Option<u64> = None;
+ if let Some(amt_msat_str) = words.next() {
+ match amt_msat_str.parse() {
+ Ok(amt) => user_provided_amt = Some(amt),
+ Err(e) => {
+ println!("ERROR: couldn't parse amount_msat: {}", e);
+ continue;
+ },
+ };
+ }
+
+ if let Ok(offer) = Offer::from_str(invoice_str.unwrap()) {
+ let random_bytes = keys_manager.get_secure_random_bytes();
+ let payment_id = PaymentId(random_bytes);
+
+ let amt_msat = match (offer.amount(), user_provided_amt) {
+ (Some(offer::Amount::Bitcoin { amount_msats }), _) => *amount_msats,
+ (_, Some(amt)) => amt,
+ (amt, _) => {
+ println!("ERROR: Cannot process non-Bitcoin-denominated offer value {:?}", amt);
+ continue;
+ },
+ };
+ if user_provided_amt.is_some() && user_provided_amt != Some(amt_msat) {
+ println!("Amount didn't match offer of {}msat", amt_msat);
continue;
}
- };
- let last_hops = invoice.route_hints();
- let amt_pico_btc = invoice.amount_pico_btc();
- if amt_pico_btc.is_none() {
- println!("ERROR: invalid invoice: must contain amount to pay");
- print!("> ");
- io::stdout().flush().unwrap();
- continue;
- }
- let amt_msat = amt_pico_btc.unwrap() / 10;
+ while user_provided_amt.is_none() {
+ print!("Paying offer for {} msat. Continue (Y/N)? >", amt_msat);
+ io::stdout().flush().unwrap();
- let payee_pubkey = invoice.recover_payee_pub_key();
- let final_cltv = invoice.min_final_cltv_expiry() as u32;
- let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
- let payment_secret = Some(invoice.payment_secret().clone());
- let invoice_features = invoice.features().cloned();
+ if let Err(e) = io::stdin().read_line(&mut line) {
+ println!("ERROR: {}", e);
+ break 'read_command;
+ }
- send_payment(
- payee_pubkey,
- amt_msat,
- final_cltv,
- payment_hash,
- payment_secret,
- invoice_features,
- last_hops,
- router.clone(),
- channel_manager.clone(),
- outbound_payments.clone(),
- logger.clone(),
- );
- }
+ if line.len() == 0 {
+ // We hit EOF / Ctrl-D
+ break 'read_command;
+ }
+
+ if line.starts_with("Y") {
+ break;
+ }
+ if line.starts_with("N") {
+ continue 'read_command;
+ }
+ }
+
+ outbound_payments.lock().unwrap().payments.insert(
+ payment_id,
+ PaymentInfo {
+ preimage: None,
+ secret: None,
+ status: HTLCStatus::Pending,
+ amt_msat: MillisatAmount(Some(amt_msat)),
+ },
+ );
+ fs_store
+ .write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode())
+ .unwrap();
+
+ let retry = Retry::Timeout(Duration::from_secs(10));
+ let amt = Some(amt_msat);
+ let pay = channel_manager
+ .pay_for_offer(&offer, None, amt, None, payment_id, retry, None);
+ if pay.is_err() {
+ println!("ERROR: Failed to pay: {:?}", pay);
+ }
+ } else {
+ match Bolt11Invoice::from_str(invoice_str.unwrap()) {
+ Ok(invoice) => send_payment(
+ &channel_manager,
+ &invoice,
+ user_provided_amt,
+ &mut outbound_payments.lock().unwrap(),
+ Arc::clone(&fs_store),
+ ),
+ Err(e) => {
+ println!("ERROR: invalid invoice: {:?}", e);
+ },
+ }
+ }
+ },
"keysend" => {
let dest_pubkey = match words.next() {
Some(dest) => match hex_utils::to_compressed_pubkey(dest) {
Some(pk) => pk,
None => {
println!("ERROR: couldn't parse destination pubkey");
- print!("> ");
- io::stdout().flush().unwrap();
continue;
- }
+ },
},
None => {
println!("ERROR: keysend requires a destination pubkey: `keysend <dest_pubkey> <amt_msat>`");
- print!("> ");
- io::stdout().flush().unwrap();
continue;
- }
+ },
};
let amt_msat_str = match words.next() {
Some(amt) => amt,
None => {
println!("ERROR: keysend requires an amount in millisatoshis: `keysend <dest_pubkey> <amt_msat>`");
-
- print!("> ");
- io::stdout().flush().unwrap();
continue;
- }
+ },
};
let amt_msat: u64 = match amt_msat_str.parse() {
Ok(amt) => amt,
Err(e) => {
println!("ERROR: couldn't parse amount_msat: {}", e);
- print!("> ");
- io::stdout().flush().unwrap();
continue;
- }
+ },
};
keysend(
+ &channel_manager,
dest_pubkey,
amt_msat,
- router.clone(),
- channel_manager.clone(),
- outbound_payments.clone(),
- logger.clone(),
+ &*keys_manager,
+ &mut outbound_payments.lock().unwrap(),
+ Arc::clone(&fs_store),
);
- }
+ },
+ "getoffer" => {
+ let offer_builder = channel_manager.create_offer_builder(String::new());
+ if let Err(e) = offer_builder {
+ println!("ERROR: Failed to initiate offer building: {:?}", e);
+ continue;
+ }
+
+ let amt_str = words.next();
+ let offer = if amt_str.is_some() {
+ let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
+ if amt_msat.is_err() {
+ println!("ERROR: getoffer provided payment amount was not a number");
+ continue;
+ }
+ offer_builder.unwrap().amount_msats(amt_msat.unwrap()).build()
+ } else {
+ offer_builder.unwrap().build()
+ };
+
+ if offer.is_err() {
+ println!("ERROR: Failed to build offer: {:?}", offer.unwrap_err());
+ } else {
+ // Note that unlike BOLT11 invoice creation we don't bother to add a
+ // pending inbound payment here, as offers can be reused and don't
+ // correspond with individual payments.
+ println!("{}", offer.unwrap());
+ }
+ },
"getinvoice" => {
let amt_str = words.next();
if amt_str.is_none() {
println!("ERROR: getinvoice requires an amount in millisatoshis");
- print!("> ");
- io::stdout().flush().unwrap();
continue;
}
let amt_msat: Result<u64, _> = amt_str.unwrap().parse();
if amt_msat.is_err() {
println!("ERROR: getinvoice provided payment amount was not a number");
- print!("> ");
- io::stdout().flush().unwrap();
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;
+ }
+
+ let mut inbound_payments = inbound_payments.lock().unwrap();
get_invoice(
amt_msat.unwrap(),
- inbound_payments.clone(),
- channel_manager.clone(),
- keys_manager.clone(),
+ &mut inbound_payments,
+ &channel_manager,
+ Arc::clone(&keys_manager),
network,
+ expiry_secs.unwrap(),
+ Arc::clone(&logger),
);
- }
+ fs_store
+ .write("", "", INBOUND_PAYMENTS_FNAME, &inbound_payments.encode())
+ .unwrap();
+ },
"connectpeer" => {
let peer_pubkey_and_ip_addr = words.next();
if peer_pubkey_and_ip_addr.is_none() {
println!("ERROR: connectpeer requires peer connection info: `connectpeer pubkey@host:port`");
- print!("> ");
- io::stdout().flush().unwrap();
continue;
}
let (pubkey, peer_addr) =
Ok(info) => info,
Err(e) => {
println!("{:?}", e.into_inner().unwrap());
- print!("> ");
- io::stdout().flush().unwrap();
continue;
- }
+ },
};
- if connect_peer_if_necessary(pubkey, peer_addr, peer_manager.clone())
- .await
+ if tokio::runtime::Handle::current()
+ .block_on(connect_peer_if_necessary(
+ pubkey,
+ peer_addr,
+ peer_manager.clone(),
+ ))
.is_ok()
{
println!("SUCCESS: connected to peer {}", pubkey);
}
- }
- "listchannels" => list_channels(channel_manager.clone()),
- "listpayments" => {
- list_payments(inbound_payments.clone(), outbound_payments.clone())
- }
+ },
+ "disconnectpeer" => {
+ let peer_pubkey = words.next();
+ if peer_pubkey.is_none() {
+ println!("ERROR: disconnectpeer requires peer public key: `disconnectpeer <peer_pubkey>`");
+ continue;
+ }
+
+ let peer_pubkey =
+ match bitcoin::secp256k1::PublicKey::from_str(peer_pubkey.unwrap()) {
+ Ok(pubkey) => pubkey,
+ Err(e) => {
+ println!("ERROR: {}", e.to_string());
+ continue;
+ },
+ };
+
+ if do_disconnect_peer(
+ peer_pubkey,
+ peer_manager.clone(),
+ channel_manager.clone(),
+ )
+ .is_ok()
+ {
+ println!("SUCCESS: disconnected from peer {}", peer_pubkey);
+ }
+ },
+ "listchannels" => list_channels(&channel_manager, &network_graph),
+ "listpayments" => list_payments(
+ &inbound_payments.lock().unwrap(),
+ &outbound_payments.lock().unwrap(),
+ ),
"closechannel" => {
let channel_id_str = words.next();
if channel_id_str.is_none() {
- println!("ERROR: closechannel requires a channel ID: `closechannel <channel_id>`");
- print!("> ");
- io::stdout().flush().unwrap();
+ 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());
- if channel_id_vec.is_none() {
- println!("ERROR: couldn't parse channel_id as hex");
- print!("> ");
- io::stdout().flush().unwrap();
+ if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
+ println!("ERROR: couldn't parse channel_id");
continue;
}
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>`");
- print!("> ");
- io::stdout().flush().unwrap();
+ 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());
- if channel_id_vec.is_none() {
- println!("ERROR: couldn't parse channel_id as hex");
- print!("> ");
- io::stdout().flush().unwrap();
+ if channel_id_vec.is_none() || channel_id_vec.as_ref().unwrap().len() != 32 {
+ println!("ERROR: couldn't parse channel_id");
continue;
}
let mut channel_id = [0; 32];
channel_id.copy_from_slice(&channel_id_vec.unwrap());
- force_close_channel(channel_id, channel_manager.clone());
- }
- "nodeinfo" => node_info(channel_manager.clone(), peer_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()),
+ "signmessage" => {
+ const MSG_STARTPOS: usize = "signmessage".len() + 1;
+ if line.trim().as_bytes().len() <= MSG_STARTPOS {
+ println!("ERROR: signmsg requires a message");
+ continue;
+ }
+ println!(
+ "{:?}",
+ lightning::util::message_signing::sign(
+ &line.trim().as_bytes()[MSG_STARTPOS..],
+ &keys_manager.get_node_secret_key()
+ )
+ );
+ },
+ "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 intermediate_nodes = 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;
+ },
+ };
+ intermediate_nodes.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 = Destination::Node(intermediate_nodes.pop().unwrap());
+ match onion_messenger.send_onion_message(
+ UserOnionMessageContents { tlv_type, data },
+ destination,
+ None,
+ ) {
+ Ok(success) => {
+ println!("SUCCESS: forwarded onion message to first hop {:?}", success)
+ },
+ Err(e) => println!("ERROR: failed to send onion message: {:?}", e),
+ }
+ },
+ "quit" | "exit" => break,
_ => println!("Unknown command. See `\"help\" for available commands."),
}
}
- print!("> ");
- io::stdout().flush().unwrap();
}
}
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");
+ 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] [--with-anchors]");
+ println!(" closechannel <channel_id> <peer_pubkey>");
+ println!(" forceclosechannel <channel_id> <peer_pubkey>");
+ println!(" listchannels");
+ println!("\n Peers:");
+ println!(" connectpeer pubkey@host:port");
+ println!(" disconnectpeer <peer_pubkey>");
+ println!(" listpeers");
+ println!("\n Payments:");
+ println!(" sendpayment <invoice|offer> [<amount_msat>]");
+ println!(" keysend <dest_pubkey> <amt_msats>");
+ println!(" listpayments");
+ println!("\n Invoices:");
+ println!(" getinvoice <amt_msats> <expiry_secs>");
+ println!(" getoffer [<amt_msats>]");
+ 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>) {
+fn node_info(channel_manager:
&Arc<ChannelManager>, peer_manager: &Arc<PeerManager>) {
println!("\t{{");
println!("\t\t node_pubkey: {}", channel_manager.get_our_node_id());
- println!("\t\t num_channels: {}", channel_manager.list_channels().len());
- println!("\t\t num_usable_channels: {}", channel_manager.list_usable_channels().len());
+ let chans = channel_manager.list_channels();
+ println!("\t\t num_channels: {}", chans.len());
+ println!("\t\t num_usable_channels: {}", chans.iter().filter(|c| c.is_usable).count());
+ let local_balance_msat = chans.iter().map(|c| c.balance_msat).sum::<u64>();
+ println!("\t\t local_balance_msat: {}", local_balance_msat);
println!("\t\t num_peers: {}", peer_manager.get_peer_node_ids().len());
println!("\t}},");
}
fn list_peers(peer_manager: Arc<PeerManager>) {
println!("\t{{");
- for pubkey in peer_manager.get_peer_node_ids() {
+ for (pubkey, _) in peer_manager.get_peer_node_ids() {
println!("\t\t pubkey: {}", pubkey);
}
println!("\t}},");
}
-fn list_channels(channel_manager: Arc<ChannelManager>) {
+fn list_channels(channel_manager: &Arc<ChannelManager>, network_graph: &Arc<NetworkGraph>) {
print!("[");
for chan_info in channel_manager.list_channels() {
println!("");
println!("\t{{");
- println!("\t\tchannel_id: {},", hex_utils::hex_str(&chan_info.channel_id[..]));
+ println!("\t\tchannel_id: {},", chan_info.channel_id);
if let Some(funding_txo) = chan_info.funding_txo {
println!("\t\tfunding_txid: {},", funding_txo.txid);
}
+
println!(
"\t\tpeer_pubkey: {},",
hex_utils::hex_str(&chan_info.counterparty.node_id.serialize())
);
+ if let Some(node_info) = network_graph
+ .read_only()
+ .nodes()
+ .get(&NodeId::from_pubkey(&chan_info.counterparty.node_id))
+ {
+ if let Some(announcement) = &node_info.announcement_info {
+ 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.outbound_capacity_msat
- + chan_info.unspendable_punishment_reserve.unwrap_or(0) * 1000
- );
+ println!("\t\toutbound_capacity_msat: {},", chan_info.outbound_capacity_msat);
if chan_info.is_usable {
println!("\t\tavailable_balance_for_send_msat: {},", chan_info.outbound_capacity_msat);
println!("\t\tavailable_balance_for_recv_msat: {},", chan_info.inbound_capacity_msat);
println!("]");
}
-fn list_payments(inbound_payments: PaymentInfoStorage, outbound_payments: PaymentInfoStorage) {
- let inbound = inbound_payments.lock().unwrap();
- let outbound = outbound_payments.lock().unwrap();
+fn list_payments(
+ inbound_payments: &InboundPaymentInfoStorage, outbound_payments: &OutboundPaymentInfoStorage,
+) {
print!("[");
- for (payment_hash, payment_info) in inbound.deref() {
+ for (payment_hash, payment_info) in &inbound_payments.payments {
println!("");
println!("\t{{");
println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
- println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
+ println!("\t\tpayment_hash: {},", payment_hash);
println!("\t\thtlc_direction: inbound,");
println!(
"\t\thtlc_status: {},",
println!("\t}},");
}
- for (payment_hash, payment_info) in outbound.deref() {
+ for (payment_hash, payment_info) in &outbound_payments.payments {
println!("");
println!("\t{{");
println!("\t\tamount_millisatoshis: {},", payment_info.amt_msat);
- println!("\t\tpayment_hash: {},", hex_utils::hex_str(&payment_hash.0));
+ println!("\t\tpayment_hash: {},", payment_hash);
println!("\t\thtlc_direction: outbound,");
println!(
"\t\thtlc_status: {},",
pub(crate) async fn connect_peer_if_necessary(
pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
) -> Result<(), ()> {
- for node_pubkey in peer_manager.get_peer_node_ids() {
+ for (node_pubkey, _) in peer_manager.get_peer_node_ids() {
if node_pubkey == pubkey {
return Ok(());
}
}
+ let res = do_connect_peer(pubkey, peer_addr, peer_manager).await;
+ if res.is_err() {
+ println!("ERROR: failed to connect to peer");
+ }
+ res
+}
+
+pub(crate) async fn do_connect_peer(
+ pubkey: PublicKey, peer_addr: SocketAddr, peer_manager: Arc<PeerManager>,
+) -> Result<(), ()> {
match lightning_net_tokio::connect_outbound(Arc::clone(&peer_manager), pubkey, peer_addr).await
{
Some(connection_closed_future) => {
let mut connection_closed_future = Box::pin(connection_closed_future);
loop {
- match futures::poll!(&mut connection_closed_future) {
- std::task::Poll::Ready(_) => {
- println!("ERROR: Peer disconnected before we finished the handshake");
- return Err(());
- }
- std::task::Poll::Pending => {}
- }
- // Avoid blocking the tokio context by sleeping a bit
- match peer_manager.get_peer_node_ids().iter().find(|id| **id == pubkey) {
- Some(_) => break,
- None => tokio::time::sleep(Duration::from_millis(10)).await,
+ tokio::select! {
+ _ = &mut connection_closed_future => return Err(()),
+ _ = tokio::time::sleep(Duration::from_millis(10)) => {},
+ };
+ if peer_manager.get_peer_node_ids().iter().find(|(id, _)| *id == pubkey).is_some() {
+ return Ok(());
}
}
- }
- None => {
- println!("ERROR: failed to connect to peer");
+ },
+ None => Err(()),
+ }
+}
+
+fn do_disconnect_peer(
+ pubkey: bitcoin::secp256k1::PublicKey, peer_manager: Arc<PeerManager>,
+ channel_manager: Arc<ChannelManager>,
+) -> Result<(), ()> {
+ //check for open channels with peer
+ for channel in channel_manager.list_channels() {
+ if channel.counterparty.node_id == pubkey {
+ println!("Error: Node has an active channel with this peer, close any channels first");
return Err(());
}
}
+
+ //check the pubkey matches a valid connected peer
+ let peers = peer_manager.get_peer_node_ids();
+ if !peers.iter().any(|(pk, _)| &pubkey == pk) {
+ println!("Error: Could not find peer {}", pubkey);
+ return Err(());
+ }
+
+ peer_manager.disconnect_by_node_id(pubkey);
Ok(())
}
fn open_channel(
- peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool,
+ peer_pubkey: PublicKey, channel_amt_sat: u64, announced_channel: bool, with_anchors: bool,
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,
+ negotiate_anchors_zero_fee_htlc_tx: with_anchors,
+ ..Default::default()
+ },
..Default::default()
};
- match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, Some(config)) {
+ match channel_manager.create_channel(peer_pubkey, channel_amt_sat, 0, 0, None, Some(config)) {
Ok(_) => {
println!("EVENT: initiated channel with peer {}. ", peer_pubkey);
return Ok(());
- }
+ },
Err(e) => {
println!("ERROR: failed to open channel: {:?}", e);
return Err(());
- }
+ },
}
}
fn send_payment(
- payee: PublicKey, amt_msat: u64, final_cltv: u32, payment_hash: PaymentHash,
- payment_secret: Option<PaymentSecret>, payee_features: Option<InvoiceFeatures>,
- route_hints: Vec<&RouteHint>,
- router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
- channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
- logger: Arc<FilesystemLogger>,
+ channel_manager: &ChannelManager, invoice: &Bolt11Invoice, required_amount_msat: Option<u64>,
+ outbound_payments: &mut OutboundPaymentInfoStorage, fs_store: Arc<FilesystemStore>,
) {
- let network_graph = &router.network_graph;
- let first_hops = channel_manager.list_usable_channels();
- let payer_pubkey = channel_manager.get_our_node_id();
-
- let route = router::get_route(
- &payer_pubkey,
- &network_graph,
- &payee,
- payee_features,
- Some(&first_hops.iter().collect::<Vec<_>>()),
- &route_hints,
- amt_msat,
- final_cltv,
- logger,
- );
- if let Err(e) = route {
- println!("ERROR: failed to find route: {}", e.err);
- return;
- }
- let status = match channel_manager.send_payment(&route.unwrap(), payment_hash, &payment_secret)
- {
- Ok(()) => {
- println!("EVENT: initiated sending {} msats to {}", amt_msat, payee);
- HTLCStatus::Pending
+ let payment_id = PaymentId((*invoice.payment_hash()).to_byte_array());
+ let payment_secret = Some(*invoice.payment_secret());
+ let zero_amt_invoice =
+ invoice.amount_milli_satoshis().is_none() || invoice.amount_milli_satoshis() == Some(0);
+ let pay_params_opt = if zero_amt_invoice {
+ if let Some(amt_msat) = required_amount_msat {
+ payment_parameters_from_zero_amount_invoice(invoice, amt_msat)
+ } else {
+ println!("Need an amount for the given 0-value invoice");
+ print!("> ");
+ return;
}
- Err(e) => {
- println!("ERROR: failed to send payment: {:?}", e);
- HTLCStatus::Failed
+ } else {
+ if required_amount_msat.is_some() && invoice.amount_milli_satoshis() != required_amount_msat
+ {
+ println!(
+ "Amount didn't match invoice value of {}msat",
+ invoice.amount_milli_satoshis().unwrap_or(0)
+ );
+ print!("> ");
+ return;
}
+ payment_parameters_from_invoice(invoice)
};
- let mut payments = payment_storage.lock().unwrap();
- payments.insert(
- payment_hash,
+ let (payment_hash, recipient_onion, route_params) = match pay_params_opt {
+ Ok(res) => res,
+ Err(e) => {
+ println!("Failed to parse invoice: {:?}", e);
+ print!("> ");
+ return;
+ },
+ };
+ outbound_payments.payments.insert(
+ payment_id,
PaymentInfo {
preimage: None,
secret: payment_secret,
- status,
- amt_msat: MillisatAmount(Some(amt_msat)),
+ status: HTLCStatus::Pending,
+ amt_msat: MillisatAmount(invoice.amount_milli_satoshis()),
},
);
-}
+ fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
-fn keysend(
- payee: PublicKey, amt_msat: u64,
- router: Arc<NetGraphMsgHandler<Arc<dyn chain::Access + Send + Sync>, Arc<FilesystemLogger>>>,
- channel_manager: Arc<ChannelManager>, payment_storage: PaymentInfoStorage,
- logger: Arc<FilesystemLogger>,
-) {
- let network_graph = &router.network_graph;
- let first_hops = channel_manager.list_usable_channels();
- let payer_pubkey = channel_manager.get_our_node_id();
-
- let route = match router::get_keysend_route(
- &payer_pubkey,
- &network_graph,
- &payee,
- Some(&first_hops.iter().collect::<Vec<_>>()),
- &vec![],
- amt_msat,
- 40,
- logger,
+ match channel_manager.send_payment(
+ payment_hash,
+ recipient_onion,
+ payment_id,
+ route_params,
+ Retry::Timeout(Duration::from_secs(10)),
) {
- Ok(r) => r,
+ Ok(_) => {
+ let payee_pubkey = invoice.recover_payee_pub_key();
+ let amt_msat = invoice.amount_milli_satoshis().unwrap();
+ println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
+ print!("> ");
+ },
Err(e) => {
- println!("ERROR: failed to find route: {}", e.err);
- return;
- }
+ println!("ERROR: failed to send payment: {:?}", e);
+ print!("> ");
+ outbound_payments.payments.get_mut(&payment_id).unwrap().status = HTLCStatus::Failed;
+ fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
+ },
};
+}
- let mut payments = payment_storage.lock().unwrap();
- let payment_hash = channel_manager.send_spontaneous_payment(&route, None).unwrap();
- payments.insert(
- payment_hash,
+fn keysend<E: EntropySource>(
+ channel_manager: &ChannelManager, payee_pubkey: PublicKey, amt_msat: u64, entropy_source: &E,
+ outbound_payments: &mut OutboundPaymentInfoStorage, fs_store: Arc<FilesystemStore>,
+) {
+ let payment_preimage = PaymentPreimage(entropy_source.get_secure_random_bytes());
+ let payment_id = PaymentId(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
+
+ let route_params = RouteParameters::from_payment_params_and_value(
+ PaymentParameters::for_keysend(payee_pubkey, 40, false),
+ amt_msat,
+ );
+ outbound_payments.payments.insert(
+ payment_id,
PaymentInfo {
preimage: None,
secret: None,
amt_msat: MillisatAmount(Some(amt_msat)),
},
);
+ fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
+ match channel_manager.send_spontaneous_payment_with_retry(
+ Some(payment_preimage),
+ RecipientOnionFields::spontaneous_empty(),
+ payment_id,
+ route_params,
+ Retry::Timeout(Duration::from_secs(10)),
+ ) {
+ Ok(_payment_hash) => {
+ println!("EVENT: initiated sending {} msats to {}", amt_msat, payee_pubkey);
+ print!("> ");
+ },
+ Err(e) => {
+ println!("ERROR: failed to send payment: {:?}", e);
+ print!("> ");
+ outbound_payments.payments.get_mut(&payment_id).unwrap().status = HTLCStatus::Failed;
+ fs_store.write("", "", OUTBOUND_PAYMENTS_FNAME, &outbound_payments.encode()).unwrap();
+ },
+ };
}
fn get_invoice(
- amt_msat: u64, payment_storage: PaymentInfoStorage, channel_manager: Arc<ChannelManager>,
- keys_manager: Arc<KeysManager>, network: Network,
+ amt_msat: u64, inbound_payments: &mut InboundPaymentInfoStorage,
+ 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::Bitcoin => Currency::Bitcoin,
- Network::Testnet => Currency::BitcoinTestnet,
Network::Regtest => Currency::Regtest,
- Network::Signet => panic!("Signet unsupported"),
+ Network::Signet => Currency::Signet,
+ Network::Testnet | _ => Currency::BitcoinTestnet,
};
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,
+ None,
) {
Ok(inv) => {
println!("SUCCESS: generated invoice: {}", inv);
inv
- }
+ },
Err(e) => {
println!("ERROR: failed to create invoice: {:?}", e);
return;
- }
+ },
};
- let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
- payments.insert(
+ let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
+ inbound_payments.payments.insert(
payment_hash,
PaymentInfo {
preimage: None,
);
}
-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(&ChannelId(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(&ChannelId(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