Use an explicit handle when spawning RPC calls
[ldk-sample] / src / bitcoind_client.rs
index 7dc67c5fdc51451689798646a5e1b270871c444d..0b37ac34823e9c44dc62135141170c9cc375714b 100644 (file)
@@ -3,7 +3,7 @@ use base64;
 use bitcoin::blockdata::block::Block;
 use bitcoin::blockdata::transaction::Transaction;
 use bitcoin::consensus::encode;
-use bitcoin::hash_types::BlockHash;
+use bitcoin::hash_types::{BlockHash, Txid};
 use bitcoin::util::address::Address;
 use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
 use lightning_block_sync::http::HttpEndpoint;
@@ -24,6 +24,7 @@ pub struct BitcoindClient {
        rpc_user: String,
        rpc_password: String,
        fees: Arc<HashMap<Target, AtomicU32>>,
+       handle: tokio::runtime::Handle,
 }
 
 #[derive(Clone, Eq, Hash, PartialEq)]
@@ -60,9 +61,13 @@ impl BlockSource for &BitcoindClient {
        }
 }
 
+/// The minimum feerate we are allowed to send, as specify by LDK.
+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,
        ) -> std::io::Result<Self> {
                let http_endpoint = HttpEndpoint::for_host(host.clone()).with_port(port);
                let rpc_credentials =
@@ -76,7 +81,7 @@ impl BitcoindClient {
                                "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(253));
+               fees.insert(Target::Background, AtomicU32::new(MIN_FEERATE));
                fees.insert(Target::Normal, AtomicU32::new(2000));
                fees.insert(Target::HighPriority, AtomicU32::new(5000));
                let client = Self {
@@ -86,19 +91,21 @@ impl BitcoindClient {
                        rpc_user,
                        rpc_password,
                        fees: Arc::new(fees),
+                       handle: handle.clone(),
                };
                BitcoindClient::poll_for_fee_estimates(
                        client.fees.clone(),
                        client.bitcoind_rpc_client.clone(),
-               )
-               .await;
+                       handle,
+               );
                Ok(client)
        }
 
-       async fn poll_for_fee_estimates(
+       fn poll_for_fee_estimates(
                fees: Arc<HashMap<Target, AtomicU32>>, rpc_client: Arc<Mutex<RpcClient>>,
+               handle: tokio::runtime::Handle,
        ) {
-               tokio::spawn(async move {
+               handle.spawn(async move {
                        loop {
                                let background_estimate = {
                                        let mut rpc = rpc_client.lock().await;
@@ -111,12 +118,11 @@ impl BitcoindClient {
                                                )
                                                .await
                                                .unwrap();
-                                       match resp.feerate {
-                                               Some(fee) => fee,
-                                               None => 253,
+                                       match resp.feerate_sat_per_kw {
+                                               Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
+                                               None => MIN_FEERATE,
                                        }
                                };
-                               // if background_estimate.
 
                                let normal_estimate = {
                                        let mut rpc = rpc_client.lock().await;
@@ -129,8 +135,8 @@ impl BitcoindClient {
                                                )
                                                .await
                                                .unwrap();
-                                       match resp.feerate {
-                                               Some(fee) => fee,
+                                       match resp.feerate_sat_per_kw {
+                                               Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
                                                None => 2000,
                                        }
                                };
@@ -147,8 +153,8 @@ impl BitcoindClient {
                                                .await
                                                .unwrap();
 
-                                       match resp.feerate {
-                                               Some(fee) => fee,
+                                       match resp.feerate_sat_per_kw {
+                                               Some(feerate) => std::cmp::max(feerate, MIN_FEERATE),
                                                None => 5000,
                                        }
                                };
@@ -185,14 +191,26 @@ impl BitcoindClient {
                let mut rpc = self.bitcoind_rpc_client.lock().await;
 
                let raw_tx_json = serde_json::json!(raw_tx.0);
-               rpc.call_method("fundrawtransaction", &[raw_tx_json]).await.unwrap()
+               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,
+                       // 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
+                       // LDK-based applications should enable RBF bumping and RBF bump either to a local
+                       // 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()
        }
 
        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::<RawTx>("sendrawtransaction", &[raw_tx_json]).await.unwrap();
+               rpc.call_method::<Txid>("sendrawtransaction", &[raw_tx_json]).await.unwrap();
        }
 
        pub async fn sign_raw_transaction_with_wallet(&self, tx_hex: String) -> SignedTx {
@@ -236,9 +254,24 @@ 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));
-               tokio::spawn(async move {
+               self.handle.spawn(async move {
                        let mut rpc = bitcoind_rpc_client.lock().await;
-                       rpc.call_method::<RawTx>("sendrawtransaction", &vec![tx_serialized]).await.unwrap();
+                       // 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 ")
+                                       {
+                                               panic!("{}", e);
+                                       }
+                               }
+                       }
                });
        }
 }