1 use crate::convert::{BlockchainInfo, FeeResponse, FundedTx, NewAddress, RawTx, SignedTx};
3 use bitcoin::blockdata::transaction::Transaction;
4 use bitcoin::consensus::encode;
5 use bitcoin::hash_types::{BlockHash, Txid};
6 use bitcoin::util::address::Address;
7 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
8 use lightning::routing::utxo::{UtxoLookup, UtxoResult};
9 use lightning_block_sync::http::HttpEndpoint;
10 use lightning_block_sync::rpc::RpcClient;
11 use lightning_block_sync::{AsyncBlockSourceResult, BlockData, BlockHeaderData, BlockSource};
13 use std::collections::HashMap;
14 use std::str::FromStr;
15 use std::sync::atomic::{AtomicU32, Ordering};
17 use std::time::Duration;
19 pub struct BitcoindClient {
20 bitcoind_rpc_client: Arc<RpcClient>,
25 fees: Arc<HashMap<Target, AtomicU32>>,
26 handle: tokio::runtime::Handle,
29 #[derive(Clone, Eq, Hash, PartialEq)]
36 impl BlockSource for BitcoindClient {
38 &'a self, header_hash: &'a BlockHash, height_hint: Option<u32>,
39 ) -> AsyncBlockSourceResult<'a, BlockHeaderData> {
40 Box::pin(async move { self.bitcoind_rpc_client.get_header(header_hash, height_hint).await })
44 &'a self, header_hash: &'a BlockHash,
45 ) -> AsyncBlockSourceResult<'a, BlockData> {
46 Box::pin(async move { self.bitcoind_rpc_client.get_block(header_hash).await })
49 fn get_best_block<'a>(&'a self) -> AsyncBlockSourceResult<(BlockHash, Option<u32>)> {
50 Box::pin(async move { self.bitcoind_rpc_client.get_best_block().await })
54 /// The minimum feerate we are allowed to send, as specify by LDK.
55 const MIN_FEERATE: u32 = 253;
59 host: String, port: u16, rpc_user: String, rpc_password: String,
60 handle: tokio::runtime::Handle,
61 ) -> std::io::Result<Self> {
62 let http_endpoint = HttpEndpoint::for_host(host.clone()).with_port(port);
64 base64::encode(format!("{}:{}", rpc_user.clone(), rpc_password.clone()));
65 let bitcoind_rpc_client = RpcClient::new(&rpc_credentials, http_endpoint)?;
66 let _dummy = bitcoind_rpc_client
67 .call_method::<BlockchainInfo>("getblockchaininfo", &vec![])
70 std::io::Error::new(std::io::ErrorKind::PermissionDenied,
71 "Failed to make initial call to bitcoind - please check your RPC user/password and access settings")
73 let mut fees: HashMap<Target, AtomicU32> = HashMap::new();
74 fees.insert(Target::Background, AtomicU32::new(MIN_FEERATE));
75 fees.insert(Target::Normal, AtomicU32::new(2000));
76 fees.insert(Target::HighPriority, AtomicU32::new(5000));
78 bitcoind_rpc_client: Arc::new(bitcoind_rpc_client),
84 handle: handle.clone(),
86 BitcoindClient::poll_for_fee_estimates(
88 client.bitcoind_rpc_client.clone(),
94 fn poll_for_fee_estimates(
95 fees: Arc<HashMap<Target, AtomicU32>>, rpc_client: Arc<RpcClient>,
96 handle: tokio::runtime::Handle,
98 handle.spawn(async move {
100 let background_estimate = {
101 let background_conf_target = serde_json::json!(144);
102 let background_estimate_mode = serde_json::json!("ECONOMICAL");
103 let resp = rpc_client
104 .call_method::<FeeResponse>(
106 &vec![background_conf_target, background_estimate_mode],
110 match resp.feerate_sat_per_kw {
111 Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
116 let normal_estimate = {
117 let normal_conf_target = serde_json::json!(18);
118 let normal_estimate_mode = serde_json::json!("ECONOMICAL");
119 let resp = rpc_client
120 .call_method::<FeeResponse>(
122 &vec![normal_conf_target, normal_estimate_mode],
126 match resp.feerate_sat_per_kw {
127 Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
132 let high_prio_estimate = {
133 let high_prio_conf_target = serde_json::json!(6);
134 let high_prio_estimate_mode = serde_json::json!("CONSERVATIVE");
135 let resp = rpc_client
136 .call_method::<FeeResponse>(
138 &vec![high_prio_conf_target, high_prio_estimate_mode],
143 match resp.feerate_sat_per_kw {
144 Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
149 fees.get(&Target::Background)
151 .store(background_estimate, Ordering::Release);
152 fees.get(&Target::Normal).unwrap().store(normal_estimate, Ordering::Release);
153 fees.get(&Target::HighPriority)
155 .store(high_prio_estimate, Ordering::Release);
156 tokio::time::sleep(Duration::from_secs(60)).await;
161 pub fn get_new_rpc_client(&self) -> std::io::Result<RpcClient> {
162 let http_endpoint = HttpEndpoint::for_host(self.host.clone()).with_port(self.port);
163 let rpc_credentials =
164 base64::encode(format!("{}:{}", self.rpc_user.clone(), self.rpc_password.clone()));
165 RpcClient::new(&rpc_credentials, http_endpoint)
168 pub async fn create_raw_transaction(&self, outputs: Vec<HashMap<String, f64>>) -> RawTx {
169 let outputs_json = serde_json::json!(outputs);
170 self.bitcoind_rpc_client
171 .call_method::<RawTx>(
172 "createrawtransaction",
173 &vec![serde_json::json!([]), outputs_json],
179 pub async fn fund_raw_transaction(&self, raw_tx: RawTx) -> FundedTx {
180 let raw_tx_json = serde_json::json!(raw_tx.0);
181 let options = serde_json::json!({
182 // LDK gives us feerates in satoshis per KW but Bitcoin Core here expects fees
183 // denominated in satoshis per vB. First we need to multiply by 4 to convert weight
184 // units to virtual bytes, then divide by 1000 to convert KvB to vB.
185 "fee_rate": self.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as f64 / 250.0,
186 // While users could "cancel" a channel open by RBF-bumping and paying back to
187 // themselves, we don't allow it here as its easy to have users accidentally RBF bump
188 // and pay to the channel funding address, which results in loss of funds. Real
189 // LDK-based applications should enable RBF bumping and RBF bump either to a local
190 // change address or to a new channel output negotiated with the same node.
191 "replaceable": false,
193 self.bitcoind_rpc_client
194 .call_method("fundrawtransaction", &[raw_tx_json, options])
199 pub async fn send_raw_transaction(&self, raw_tx: RawTx) {
200 let raw_tx_json = serde_json::json!(raw_tx.0);
201 self.bitcoind_rpc_client
202 .call_method::<Txid>("sendrawtransaction", &[raw_tx_json])
207 pub async fn sign_raw_transaction_with_wallet(&self, tx_hex: String) -> SignedTx {
208 let tx_hex_json = serde_json::json!(tx_hex);
209 self.bitcoind_rpc_client
210 .call_method("signrawtransactionwithwallet", &vec![tx_hex_json])
215 pub async fn get_new_address(&self) -> Address {
216 let addr_args = vec![serde_json::json!("LDK output address")];
219 .call_method::<NewAddress>("getnewaddress", &addr_args)
222 Address::from_str(addr.0.as_str()).unwrap()
225 pub async fn get_blockchain_info(&self) -> BlockchainInfo {
226 self.bitcoind_rpc_client
227 .call_method::<BlockchainInfo>("getblockchaininfo", &vec![])
233 impl FeeEstimator for BitcoindClient {
234 fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32 {
235 match confirmation_target {
236 ConfirmationTarget::Background => {
237 self.fees.get(&Target::Background).unwrap().load(Ordering::Acquire)
239 ConfirmationTarget::Normal => {
240 self.fees.get(&Target::Normal).unwrap().load(Ordering::Acquire)
242 ConfirmationTarget::HighPriority => {
243 self.fees.get(&Target::HighPriority).unwrap().load(Ordering::Acquire)
249 impl BroadcasterInterface for BitcoindClient {
250 fn broadcast_transaction(&self, tx: &Transaction) {
251 let bitcoind_rpc_client = self.bitcoind_rpc_client.clone();
252 let tx_serialized = serde_json::json!(encode::serialize_hex(tx));
253 self.handle.spawn(async move {
254 // This may error due to RL calling `broadcast_transaction` with the same transaction
255 // multiple times, but the error is safe to ignore.
256 match bitcoind_rpc_client
257 .call_method::<Txid>("sendrawtransaction", &vec![tx_serialized])
262 let err_str = e.get_ref().unwrap().to_string();
263 if !err_str.contains("Transaction already in block chain")
264 && !err_str.contains("Inputs missing or spent")
265 && !err_str.contains("bad-txns-inputs-missingorspent")
266 && !err_str.contains("txn-mempool-conflict")
267 && !err_str.contains("non-BIP68-final")
268 && !err_str.contains("insufficient fee, rejecting replacement ")
278 impl UtxoLookup for BitcoindClient {
279 fn get_utxo(&self, _genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
280 // P2PGossipSync takes None for a UtxoLookup, so this will never be called.