-use crate::convert::{BlockchainInfo, FeeResponse, FundedTx, NewAddress, RawTx, SignedTx};
+use crate::convert::{
+ BlockchainInfo, FeeResponse, FundedTx, ListUnspentResponse, MempoolMinFeeResponse, NewAddress,
+ RawTx, SignedTx,
+};
+use crate::disk::FilesystemLogger;
+use crate::hex_utils;
use base64;
-use bitcoin::blockdata::block::Block;
+use bitcoin::address::{Address, Payload, WitnessVersion};
+use bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR;
+use bitcoin::blockdata::script::ScriptBuf;
use bitcoin::blockdata::transaction::Transaction;
-use bitcoin::consensus::encode;
+use bitcoin::consensus::{encode, Decodable, Encodable};
use bitcoin::hash_types::{BlockHash, Txid};
-use bitcoin::util::address::Address;
+use bitcoin::hashes::Hash;
+use bitcoin::key::XOnlyPublicKey;
+use bitcoin::psbt::PartiallySignedTransaction;
+use bitcoin::{Network, OutPoint, TxOut, WPubkeyHash};
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
+use lightning::events::bump_transaction::{Utxo, WalletSource};
+use lightning::log_error;
+use lightning::util::logger::Logger;
use lightning_block_sync::http::HttpEndpoint;
use lightning_block_sync::rpc::RpcClient;
-use lightning_block_sync::{AsyncBlockSourceResult, BlockHeaderData, BlockSource};
+use lightning_block_sync::{AsyncBlockSourceResult, BlockData, BlockHeaderData, BlockSource};
use serde_json;
use std::collections::HashMap;
use std::str::FromStr;
use std::sync::atomic::{AtomicU32, Ordering};
use std::sync::Arc;
use std::time::Duration;
-use tokio::sync::Mutex;
pub struct BitcoindClient {
- bitcoind_rpc_client: Arc<Mutex<RpcClient>>,
+ pub(crate) bitcoind_rpc_client: Arc<RpcClient>,
+ network: Network,
host: String,
port: u16,
rpc_user: String,
rpc_password: String,
- fees: Arc<HashMap<Target, AtomicU32>>,
+ fees: Arc<HashMap<ConfirmationTarget, AtomicU32>>,
handle: tokio::runtime::Handle,
+ logger: Arc<FilesystemLogger>,
}
-#[derive(Clone, Eq, Hash, PartialEq)]
-pub enum Target {
- Background,
- Normal,
- HighPriority,
-}
-
-impl BlockSource for &BitcoindClient {
+impl BlockSource for BitcoindClient {
fn get_header<'a>(
- &'a mut self, header_hash: &'a BlockHash, height_hint: Option<u32>,
+ &'a self, header_hash: &'a BlockHash, height_hint: Option<u32>,
) -> AsyncBlockSourceResult<'a, BlockHeaderData> {
- Box::pin(async move {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
- rpc.get_header(header_hash, height_hint).await
- })
+ Box::pin(async move { self.bitcoind_rpc_client.get_header(header_hash, height_hint).await })
}
fn get_block<'a>(
- &'a mut self, header_hash: &'a BlockHash,
- ) -> AsyncBlockSourceResult<'a, Block> {
- Box::pin(async move {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
- rpc.get_block(header_hash).await
- })
+ &'a self, header_hash: &'a BlockHash,
+ ) -> AsyncBlockSourceResult<'a, BlockData> {
+ Box::pin(async move { self.bitcoind_rpc_client.get_block(header_hash).await })
}
- fn get_best_block<'a>(&'a mut self) -> AsyncBlockSourceResult<(BlockHash, Option<u32>)> {
- Box::pin(async move {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
- rpc.get_best_block().await
- })
+ fn get_best_block<'a>(&'a self) -> AsyncBlockSourceResult<(BlockHash, Option<u32>)> {
+ Box::pin(async move { self.bitcoind_rpc_client.get_best_block().await })
}
}
const MIN_FEERATE: u32 = 253;
impl BitcoindClient {
- pub async fn new(
- host: String, port: u16, rpc_user: String, rpc_password: String,
- handle: tokio::runtime::Handle,
+ pub(crate) async fn new(
+ host: String, port: u16, rpc_user: String, rpc_password: String, network: Network,
+ handle: tokio::runtime::Handle, logger: Arc<FilesystemLogger>,
) -> std::io::Result<Self> {
let http_endpoint = HttpEndpoint::for_host(host.clone()).with_port(port);
let rpc_credentials =
base64::encode(format!("{}:{}", rpc_user.clone(), rpc_password.clone()));
- let mut bitcoind_rpc_client = RpcClient::new(&rpc_credentials, http_endpoint)?;
+ let bitcoind_rpc_client = RpcClient::new(&rpc_credentials, http_endpoint)?;
let _dummy = bitcoind_rpc_client
.call_method::<BlockchainInfo>("getblockchaininfo", &vec![])
.await
std::io::Error::new(std::io::ErrorKind::PermissionDenied,
"Failed to make initial call to bitcoind - please check your RPC user/password and access settings")
})?;
- let mut fees: HashMap<Target, AtomicU32> = HashMap::new();
- fees.insert(Target::Background, AtomicU32::new(MIN_FEERATE));
- fees.insert(Target::Normal, AtomicU32::new(2000));
- fees.insert(Target::HighPriority, AtomicU32::new(5000));
+ let mut fees: HashMap<ConfirmationTarget, AtomicU32> = HashMap::new();
+ fees.insert(ConfirmationTarget::OnChainSweep, AtomicU32::new(5000));
+ fees.insert(
+ ConfirmationTarget::MinAllowedAnchorChannelRemoteFee,
+ AtomicU32::new(MIN_FEERATE),
+ );
+ fees.insert(
+ ConfirmationTarget::MinAllowedNonAnchorChannelRemoteFee,
+ AtomicU32::new(MIN_FEERATE),
+ );
+ fees.insert(ConfirmationTarget::AnchorChannelFee, AtomicU32::new(MIN_FEERATE));
+ fees.insert(ConfirmationTarget::NonAnchorChannelFee, AtomicU32::new(2000));
+ fees.insert(ConfirmationTarget::ChannelCloseMinimum, AtomicU32::new(MIN_FEERATE));
+
let client = Self {
- bitcoind_rpc_client: Arc::new(Mutex::new(bitcoind_rpc_client)),
+ bitcoind_rpc_client: Arc::new(bitcoind_rpc_client),
host,
port,
rpc_user,
rpc_password,
+ network,
fees: Arc::new(fees),
handle: handle.clone(),
+ logger,
};
BitcoindClient::poll_for_fee_estimates(
client.fees.clone(),
}
fn poll_for_fee_estimates(
- fees: Arc<HashMap<Target, AtomicU32>>, rpc_client: Arc<Mutex<RpcClient>>,
+ fees: Arc<HashMap<ConfirmationTarget, AtomicU32>>, rpc_client: Arc<RpcClient>,
handle: tokio::runtime::Handle,
) {
handle.spawn(async move {
loop {
+ let mempoolmin_estimate = {
+ let resp = rpc_client
+ .call_method::<MempoolMinFeeResponse>("getmempoolinfo", &vec![])
+ .await
+ .unwrap();
+ match resp.feerate_sat_per_kw {
+ Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
+ None => MIN_FEERATE,
+ }
+ };
let background_estimate = {
- let mut rpc = rpc_client.lock().await;
let background_conf_target = serde_json::json!(144);
let background_estimate_mode = serde_json::json!("ECONOMICAL");
- let resp = rpc
+ let resp = rpc_client
.call_method::<FeeResponse>(
"estimatesmartfee",
&vec![background_conf_target, background_estimate_mode],
};
let normal_estimate = {
- let mut rpc = rpc_client.lock().await;
let normal_conf_target = serde_json::json!(18);
let normal_estimate_mode = serde_json::json!("ECONOMICAL");
- let resp = rpc
+ let resp = rpc_client
.call_method::<FeeResponse>(
"estimatesmartfee",
&vec![normal_conf_target, normal_estimate_mode],
};
let high_prio_estimate = {
- let mut rpc = rpc_client.lock().await;
let high_prio_conf_target = serde_json::json!(6);
let high_prio_estimate_mode = serde_json::json!("CONSERVATIVE");
- let resp = rpc
+ let resp = rpc_client
.call_method::<FeeResponse>(
"estimatesmartfee",
&vec![high_prio_conf_target, high_prio_estimate_mode],
}
};
- fees.get(&Target::Background)
+ fees.get(&ConfirmationTarget::OnChainSweep)
+ .unwrap()
+ .store(high_prio_estimate, Ordering::Release);
+ fees.get(&ConfirmationTarget::MinAllowedAnchorChannelRemoteFee)
+ .unwrap()
+ .store(mempoolmin_estimate, Ordering::Release);
+ fees.get(&ConfirmationTarget::MinAllowedNonAnchorChannelRemoteFee)
+ .unwrap()
+ .store(background_estimate - 250, Ordering::Release);
+ fees.get(&ConfirmationTarget::AnchorChannelFee)
.unwrap()
.store(background_estimate, Ordering::Release);
- fees.get(&Target::Normal).unwrap().store(normal_estimate, Ordering::Release);
- fees.get(&Target::HighPriority)
+ fees.get(&ConfirmationTarget::NonAnchorChannelFee)
.unwrap()
- .store(high_prio_estimate, Ordering::Release);
+ .store(normal_estimate, Ordering::Release);
+ fees.get(&ConfirmationTarget::ChannelCloseMinimum)
+ .unwrap()
+ .store(background_estimate, Ordering::Release);
+
tokio::time::sleep(Duration::from_secs(60)).await;
}
});
}
pub async fn create_raw_transaction(&self, outputs: Vec<HashMap<String, f64>>) -> RawTx {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
-
let outputs_json = serde_json::json!(outputs);
- rpc.call_method::<RawTx>("createrawtransaction", &vec![serde_json::json!([]), outputs_json])
+ self.bitcoind_rpc_client
+ .call_method::<RawTx>(
+ "createrawtransaction",
+ &vec![serde_json::json!([]), outputs_json],
+ )
.await
.unwrap()
}
pub async fn fund_raw_transaction(&self, raw_tx: RawTx) -> FundedTx {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
-
let raw_tx_json = serde_json::json!(raw_tx.0);
let options = serde_json::json!({
// LDK gives us feerates in satoshis per KW but Bitcoin Core here expects fees
// denominated in satoshis per vB. First we need to multiply by 4 to convert weight
// units to virtual bytes, then divide by 1000 to convert KvB to vB.
- "fee_rate": self.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as f64 / 250.0,
+ "fee_rate": self
+ .get_est_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee) as f64 / 250.0,
// While users could "cancel" a channel open by RBF-bumping and paying back to
// themselves, we don't allow it here as its easy to have users accidentally RBF bump
// and pay to the channel funding address, which results in loss of funds. Real
// change address or to a new channel output negotiated with the same node.
"replaceable": false,
});
- rpc.call_method("fundrawtransaction", &[raw_tx_json, options]).await.unwrap()
+ self.bitcoind_rpc_client
+ .call_method("fundrawtransaction", &[raw_tx_json, options])
+ .await
+ .unwrap()
}
pub async fn send_raw_transaction(&self, raw_tx: RawTx) {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
-
let raw_tx_json = serde_json::json!(raw_tx.0);
- rpc.call_method::<Txid>("sendrawtransaction", &[raw_tx_json]).await.unwrap();
+ self.bitcoind_rpc_client
+ .call_method::<Txid>("sendrawtransaction", &[raw_tx_json])
+ .await
+ .unwrap();
}
pub async fn sign_raw_transaction_with_wallet(&self, tx_hex: String) -> SignedTx {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
-
let tx_hex_json = serde_json::json!(tx_hex);
- rpc.call_method("signrawtransactionwithwallet", &vec![tx_hex_json]).await.unwrap()
+ self.bitcoind_rpc_client
+ .call_method("signrawtransactionwithwallet", &vec![tx_hex_json])
+ .await
+ .unwrap()
}
pub async fn get_new_address(&self) -> Address {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
-
let addr_args = vec![serde_json::json!("LDK output address")];
- let addr = rpc.call_method::<NewAddress>("getnewaddress", &addr_args).await.unwrap();
- Address::from_str(addr.0.as_str()).unwrap()
+ let addr = self
+ .bitcoind_rpc_client
+ .call_method::<NewAddress>("getnewaddress", &addr_args)
+ .await
+ .unwrap();
+ Address::from_str(addr.0.as_str()).unwrap().require_network(self.network).unwrap()
}
pub async fn get_blockchain_info(&self) -> BlockchainInfo {
- let mut rpc = self.bitcoind_rpc_client.lock().await;
- rpc.call_method::<BlockchainInfo>("getblockchaininfo", &vec![]).await.unwrap()
+ self.bitcoind_rpc_client
+ .call_method::<BlockchainInfo>("getblockchaininfo", &vec![])
+ .await
+ .unwrap()
+ }
+
+ pub async fn list_unspent(&self) -> ListUnspentResponse {
+ self.bitcoind_rpc_client
+ .call_method::<ListUnspentResponse>("listunspent", &vec![])
+ .await
+ .unwrap()
}
}
impl FeeEstimator for BitcoindClient {
fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32 {
- match confirmation_target {
- ConfirmationTarget::Background => {
- self.fees.get(&Target::Background).unwrap().load(Ordering::Acquire)
- }
- ConfirmationTarget::Normal => {
- self.fees.get(&Target::Normal).unwrap().load(Ordering::Acquire)
- }
- ConfirmationTarget::HighPriority => {
- self.fees.get(&Target::HighPriority).unwrap().load(Ordering::Acquire)
- }
- }
+ self.fees.get(&confirmation_target).unwrap().load(Ordering::Acquire)
}
}
impl BroadcasterInterface for BitcoindClient {
- fn broadcast_transaction(&self, tx: &Transaction) {
- let bitcoind_rpc_client = self.bitcoind_rpc_client.clone();
- let tx_serialized = serde_json::json!(encode::serialize_hex(tx));
- self.handle.spawn(async move {
- let mut rpc = bitcoind_rpc_client.lock().await;
- // This may error due to RL calling `broadcast_transaction` with the same transaction
- // multiple times, but the error is safe to ignore.
- match rpc.call_method::<Txid>("sendrawtransaction", &vec![tx_serialized]).await {
- Ok(_) => {}
- Err(e) => {
- let err_str = e.get_ref().unwrap().to_string();
- if !err_str.contains("Transaction already in block chain")
- && !err_str.contains("Inputs missing or spent")
- && !err_str.contains("bad-txns-inputs-missingorspent")
- && !err_str.contains("non-BIP68-final")
- && !err_str.contains("insufficient fee, rejecting replacement ")
+ fn broadcast_transactions(&self, txs: &[&Transaction]) {
+ // TODO: Rather than calling `sendrawtransaction` in a a loop, we should probably use
+ // `submitpackage` once it becomes available.
+ for tx in txs {
+ let bitcoind_rpc_client = Arc::clone(&self.bitcoind_rpc_client);
+ let tx_serialized = encode::serialize_hex(tx);
+ let tx_json = serde_json::json!(tx_serialized);
+ let logger = Arc::clone(&self.logger);
+ self.handle.spawn(async move {
+ // This may error due to RL calling `broadcast_transactions` with the same transaction
+ // multiple times, but the error is safe to ignore.
+ match bitcoind_rpc_client
+ .call_method::<Txid>("sendrawtransaction", &vec![tx_json])
+ .await
{
- panic!("{}", e);
+ Ok(_) => {}
+ Err(e) => {
+ let err_str = e.get_ref().unwrap().to_string();
+ log_error!(logger,
+ "Warning, failed to broadcast a transaction, this is likely okay but may indicate an error: {}\nTransaction: {}",
+ err_str,
+ tx_serialized);
+ print!("Warning, failed to broadcast a transaction, this is likely okay but may indicate an error: {}\n> ", err_str);
+ }
}
+ });
+ }
+ }
+}
+
+impl WalletSource for BitcoindClient {
+ fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
+ let utxos = tokio::task::block_in_place(move || {
+ self.handle.block_on(async move { self.list_unspent().await }).0
+ });
+ Ok(utxos
+ .into_iter()
+ .filter_map(|utxo| {
+ let outpoint = OutPoint { txid: utxo.txid, vout: utxo.vout };
+ match utxo.address.payload.clone() {
+ Payload::WitnessProgram(wp) => match wp.version() {
+ WitnessVersion::V0 => WPubkeyHash::from_slice(wp.program().as_bytes())
+ .map(|wpkh| Utxo::new_v0_p2wpkh(outpoint, utxo.amount, &wpkh))
+ .ok(),
+ // TODO: Add `Utxo::new_v1_p2tr` upstream.
+ WitnessVersion::V1 => XOnlyPublicKey::from_slice(wp.program().as_bytes())
+ .map(|_| Utxo {
+ outpoint,
+ output: TxOut {
+ value: utxo.amount,
+ script_pubkey: ScriptBuf::new_witness_program(&wp),
+ },
+ satisfaction_weight: 1 /* empty script_sig */ * WITNESS_SCALE_FACTOR as u64 +
+ 1 /* witness items */ + 1 /* schnorr sig len */ + 64, /* schnorr sig */
+ })
+ .ok(),
+ _ => None,
+ },
+ _ => None,
}
- }
+ })
+ .collect())
+ }
+
+ fn get_change_script(&self) -> Result<ScriptBuf, ()> {
+ tokio::task::block_in_place(move || {
+ Ok(self.handle.block_on(async move { self.get_new_address().await.script_pubkey() }))
+ })
+ }
+
+ fn sign_psbt(&self, tx: PartiallySignedTransaction) -> Result<Transaction, ()> {
+ let mut tx_bytes = Vec::new();
+ let _ = tx.unsigned_tx.consensus_encode(&mut tx_bytes).map_err(|_| ());
+ let tx_hex = hex_utils::hex_str(&tx_bytes);
+ let signed_tx = tokio::task::block_in_place(move || {
+ self.handle.block_on(async move { self.sign_raw_transaction_with_wallet(tx_hex).await })
});
+ let signed_tx_bytes = hex_utils::to_vec(&signed_tx.hex).ok_or(())?;
+ Transaction::consensus_decode(&mut signed_tx_bytes.as_slice()).map_err(|_| ())
}
}
projects / ldk-sample / blobdiff