_ Git - ldk-sample/blob - src/bitcoind_client.rs

   1 use crate::convert::{BlockchainInfo, FeeResponse, FundedTx, NewAddress, RawTx, SignedTx};
   2 use base64;
   3 use bitcoin::blockdata::block::Block;
   4 use bitcoin::blockdata::transaction::Transaction;
   5 use bitcoin::consensus::encode;
   6 use bitcoin::hash_types::{BlockHash, Txid};
   7 use bitcoin::util::address::Address;
   8 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
   9 use lightning_block_sync::http::HttpEndpoint;
  10 use lightning_block_sync::rpc::RpcClient;
  11 use lightning_block_sync::{AsyncBlockSourceResult, BlockHeaderData, BlockSource};
  12 use serde_json;
  13 use std::collections::HashMap;
  14 use std::str::FromStr;
  15 use std::sync::atomic::{AtomicU32, Ordering};
  16 use std::sync::Arc;
  17 use std::time::Duration;
  18 use tokio::sync::Mutex;
  19
  20 pub struct BitcoindClient {
  21         bitcoind_rpc_client: Arc<Mutex<RpcClient>>,
  22         host: String,
  23         port: u16,
  24         rpc_user: String,
  25         rpc_password: String,
  26         fees: Arc<HashMap<Target, AtomicU32>>,
  27 }
  28
  29 #[derive(Clone, Eq, Hash, PartialEq)]
  30 pub enum Target {
  31         Background,
  32         Normal,
  33         HighPriority,
  34 }
  35
  36 impl BlockSource for &BitcoindClient {
  37         fn get_header<'a>(
  38                 &'a mut self, header_hash: &'a BlockHash, height_hint: Option<u32>,
  39         ) -> AsyncBlockSourceResult<'a, BlockHeaderData> {
  40                 Box::pin(async move {
  41                         let mut rpc = self.bitcoind_rpc_client.lock().await;
  42                         rpc.get_header(header_hash, height_hint).await
  43                 })
  44         }
  45
  46         fn get_block<'a>(
  47                 &'a mut self, header_hash: &'a BlockHash,
  48         ) -> AsyncBlockSourceResult<'a, Block> {
  49                 Box::pin(async move {
  50                         let mut rpc = self.bitcoind_rpc_client.lock().await;
  51                         rpc.get_block(header_hash).await
  52                 })
  53         }
  54
  55         fn get_best_block<'a>(&'a mut self) -> AsyncBlockSourceResult<(BlockHash, Option<u32>)> {
  56                 Box::pin(async move {
  57                         let mut rpc = self.bitcoind_rpc_client.lock().await;
  58                         rpc.get_best_block().await
  59                 })
  60         }
  61 }
  62
  63 /// The minimum feerate we are allowed to send, as specify by LDK.
  64 const MIN_FEERATE: u32 = 253;
  65
  66 impl BitcoindClient {
  67         pub async fn new(
  68                 host: String, port: u16, rpc_user: String, rpc_password: String,
  69         ) -> std::io::Result<Self> {
  70                 let http_endpoint = HttpEndpoint::for_host(host.clone()).with_port(port);
  71                 let rpc_credentials =
  72                         base64::encode(format!("{}:{}", rpc_user.clone(), rpc_password.clone()));
  73                 let mut bitcoind_rpc_client = RpcClient::new(&rpc_credentials, http_endpoint)?;
  74                 let _dummy = bitcoind_rpc_client
  75                         .call_method::<BlockchainInfo>("getblockchaininfo", &vec![])
  76                         .await
  77                         .map_err(|_| {
  78                                 std::io::Error::new(std::io::ErrorKind::PermissionDenied,
  79                                 "Failed to make initial call to bitcoind - please check your RPC user/password and access settings")
  80                         })?;
  81                 let mut fees: HashMap<Target, AtomicU32> = HashMap::new();
  82                 fees.insert(Target::Background, AtomicU32::new(MIN_FEERATE));
  83                 fees.insert(Target::Normal, AtomicU32::new(2000));
  84                 fees.insert(Target::HighPriority, AtomicU32::new(5000));
  85                 let client = Self {
  86                         bitcoind_rpc_client: Arc::new(Mutex::new(bitcoind_rpc_client)),
  87                         host,
  88                         port,
  89                         rpc_user,
  90                         rpc_password,
  91                         fees: Arc::new(fees),
  92                 };
  93                 BitcoindClient::poll_for_fee_estimates(
  94                         client.fees.clone(),
  95                         client.bitcoind_rpc_client.clone(),
  96                 )
  97                 .await;
  98                 Ok(client)
  99         }
 100
 101         async fn poll_for_fee_estimates(
 102                 fees: Arc<HashMap<Target, AtomicU32>>, rpc_client: Arc<Mutex<RpcClient>>,
 103         ) {
 104                 tokio::spawn(async move {
 105                         loop {
 106                                 let background_estimate = {
 107                                         let mut rpc = rpc_client.lock().await;
 108                                         let background_conf_target = serde_json::json!(144);
 109                                         let background_estimate_mode = serde_json::json!("ECONOMICAL");
 110                                         let resp = rpc
 111                                                 .call_method::<FeeResponse>(
 112                                                         "estimatesmartfee",
 113                                                         &vec![background_conf_target, background_estimate_mode],
 114                                                 )
 115                                                 .await
 116                                                 .unwrap();
 117                                         match resp.feerate_sat_per_kw {
 118                                                 Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
 119                                                 None => MIN_FEERATE,
 120                                         }
 121                                 };
 122
 123                                 let normal_estimate = {
 124                                         let mut rpc = rpc_client.lock().await;
 125                                         let normal_conf_target = serde_json::json!(18);
 126                                         let normal_estimate_mode = serde_json::json!("ECONOMICAL");
 127                                         let resp = rpc
 128                                                 .call_method::<FeeResponse>(
 129                                                         "estimatesmartfee",
 130                                                         &vec![normal_conf_target, normal_estimate_mode],
 131                                                 )
 132                                                 .await
 133                                                 .unwrap();
 134                                         match resp.feerate_sat_per_kw {
 135                                                 Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
 136                                                 None => 2000,
 137                                         }
 138                                 };
 139
 140                                 let high_prio_estimate = {
 141                                         let mut rpc = rpc_client.lock().await;
 142                                         let high_prio_conf_target = serde_json::json!(6);
 143                                         let high_prio_estimate_mode = serde_json::json!("CONSERVATIVE");
 144                                         let resp = rpc
 145                                                 .call_method::<FeeResponse>(
 146                                                         "estimatesmartfee",
 147                                                         &vec![high_prio_conf_target, high_prio_estimate_mode],
 148                                                 )
 149                                                 .await
 150                                                 .unwrap();
 151
 152                                         match resp.feerate_sat_per_kw {
 153                                                 Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
 154                                                 None => 5000,
 155                                         }
 156                                 };
 157
 158                                 fees.get(&Target::Background)
 159                                         .unwrap()
 160                                         .store(background_estimate, Ordering::Release);
 161                                 fees.get(&Target::Normal).unwrap().store(normal_estimate, Ordering::Release);
 162                                 fees.get(&Target::HighPriority)
 163                                         .unwrap()
 164                                         .store(high_prio_estimate, Ordering::Release);
 165                                 tokio::time::sleep(Duration::from_secs(60)).await;
 166                         }
 167                 });
 168         }
 169
 170         pub fn get_new_rpc_client(&self) -> std::io::Result<RpcClient> {
 171                 let http_endpoint = HttpEndpoint::for_host(self.host.clone()).with_port(self.port);
 172                 let rpc_credentials =
 173                         base64::encode(format!("{}:{}", self.rpc_user.clone(), self.rpc_password.clone()));
 174                 RpcClient::new(&rpc_credentials, http_endpoint)
 175         }
 176
 177         pub async fn create_raw_transaction(&self, outputs: Vec<HashMap<String, f64>>) -> RawTx {
 178                 let mut rpc = self.bitcoind_rpc_client.lock().await;
 179
 180                 let outputs_json = serde_json::json!(outputs);
 181                 rpc.call_method::<RawTx>("createrawtransaction", &vec![serde_json::json!([]), outputs_json])
 182                         .await
 183                         .unwrap()
 184         }
 185
 186         pub async fn fund_raw_transaction(&self, raw_tx: RawTx) -> FundedTx {
 187                 let mut rpc = self.bitcoind_rpc_client.lock().await;
 188
 189                 let raw_tx_json = serde_json::json!(raw_tx.0);
 190                 let options = serde_json::json!({
 191                         // LDK gives us feerates in satoshis per KW but Bitcoin Core here expects fees
 192                         // denominated in satoshis per vB. First we need to multiply by 4 to convert weight
 193                         // units to virtual bytes, then divide by 1000 to convert KvB to vB.
 194                         "fee_rate": self.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as f64 / 250.0,
 195                         // While users could "cancel" a channel open by RBF-bumping and paying back to
 196                         // themselves, we don't allow it here as its easy to have users accidentally RBF bump
 197                         // and pay to the channel funding address, which results in loss of funds. Real
 198                         // LDK-based applications should enable RBF bumping and RBF bump either to a local
 199                         // change address or to a new channel output negotiated with the same node.
 200                         "replaceable": false,
 201                 });
 202                 rpc.call_method("fundrawtransaction", &[raw_tx_json, options]).await.unwrap()
 203         }
 204
 205         pub async fn send_raw_transaction(&self, raw_tx: RawTx) {
 206                 let mut rpc = self.bitcoind_rpc_client.lock().await;
 207
 208                 let raw_tx_json = serde_json::json!(raw_tx.0);
 209                 rpc.call_method::<Txid>("sendrawtransaction", &[raw_tx_json]).await.unwrap();
 210         }
 211
 212         pub async fn sign_raw_transaction_with_wallet(&self, tx_hex: String) -> SignedTx {
 213                 let mut rpc = self.bitcoind_rpc_client.lock().await;
 214
 215                 let tx_hex_json = serde_json::json!(tx_hex);
 216                 rpc.call_method("signrawtransactionwithwallet", &vec![tx_hex_json]).await.unwrap()
 217         }
 218
 219         pub async fn get_new_address(&self) -> Address {
 220                 let mut rpc = self.bitcoind_rpc_client.lock().await;
 221
 222                 let addr_args = vec![serde_json::json!("LDK output address")];
 223                 let addr = rpc.call_method::<NewAddress>("getnewaddress", &addr_args).await.unwrap();
 224                 Address::from_str(addr.0.as_str()).unwrap()
 225         }
 226
 227         pub async fn get_blockchain_info(&self) -> BlockchainInfo {
 228                 let mut rpc = self.bitcoind_rpc_client.lock().await;
 229                 rpc.call_method::<BlockchainInfo>("getblockchaininfo", &vec![]).await.unwrap()
 230         }
 231 }
 232
 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)
 238                         }
 239                         ConfirmationTarget::Normal => {
 240                                 self.fees.get(&Target::Normal).unwrap().load(Ordering::Acquire)
 241                         }
 242                         ConfirmationTarget::HighPriority => {
 243                                 self.fees.get(&Target::HighPriority).unwrap().load(Ordering::Acquire)
 244                         }
 245                 }
 246         }
 247 }
 248
 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                 tokio::spawn(async move {
 254                         let mut rpc = bitcoind_rpc_client.lock().await;
 255                         // This may error due to RL calling `broadcast_transaction` with the same transaction
 256                         // multiple times, but the error is safe to ignore.
 257                         match rpc.call_method::<Txid>("sendrawtransaction", &vec![tx_serialized]).await {
 258                                 Ok(_) => {}
 259                                 Err(e) => {
 260                                         let err_str = e.get_ref().unwrap().to_string();
 261                                         if !err_str.contains("Transaction already in block chain")
 262                                                 && !err_str.contains("Inputs missing or spent")
 263                                                 && !err_str.contains("bad-txns-inputs-missingorspent")
 264                                                 && !err_str.contains("non-BIP68-final")
 265                                                 && !err_str.contains("insufficient fee, rejecting replacement ")
 266                                         {
 267                                                 panic!("{}", e);
 268                                         }
 269                                 }
 270                         }
 271                 });
 272         }
 273 }