Compatibility with Bitcoin Core v0.21

shesek · shesek · commit a6878c8a5dc6 · 2021-01-19T15:25:50.000+02:00
- Uses the new `connections_in` field to determine if we have inbound connections, instead of checking the list of peers via `listpeers`. This also avoids using the `listpeers` command for v0.21+, which isn't yet compatible in rust-bitcoincore-rpc, pending the acceptance of rust-bitcoin/rust-bitcoincore-rpc#158. - Identify the updated message for "wallet already exists" errors. - Update CI to run tests against v0.21
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Compatibility with Bitcoin Core v0.21
+
 - New `create_wallet_if_missing` option to ease the creation of a designated bitcoind wallet (#76)
 
 ## 0.2.1 - 2021-01-14
diff --git a/scripts/ci-test-deps.sh b/scripts/ci-test-deps.sh
@@ -1,10 +1,10 @@
 #!/bin/bash
 set -eo pipefail
 
-BITCOIN_VERSION=0.20.0
+BITCOIN_VERSION=0.21.0
 BITCOIN_FILENAME=bitcoin-$BITCOIN_VERSION-x86_64-linux-gnu.tar.gz
 BITCOIN_URL=https://bitcoincore.org/bin/bitcoin-core-$BITCOIN_VERSION/$BITCOIN_FILENAME
-BITCOIN_SHA256=35ec10f87b6bc1e44fd9cd1157e5dfa483eaf14d7d9a9c274774539e7824c427
+BITCOIN_SHA256=da7766775e3f9c98d7a9145429f2be8297c2672fe5b118fd3dc2411fb48e0032
 
 ELECTRUM_URL=https://download.electrum.org/4.0.3/electrum-4.0.3-x86_64.AppImage
 ELECTRUM_SHA256=512b58c437847048a9629cb6bf2eb786b8969a1e17b7b51510b11672c9b29fc7
diff --git a/scripts/setup-env.sh b/scripts/setup-env.sh
@@ -72,15 +72,16 @@ walletnotify=nc -U $BWT_SOCKET > /dev/null 2>&1
 
 [regtest]
 rpcport=$BTC_RPC_PORT
-wallet=internal
 EOL
 
 bitcoind -datadir=$BTC_DIR $BTC_OPTS &
 
 echo - Waiting for bitcoind to warm up...
 btc -rpcwait getblockchaininfo > /dev/null
-echo - Creating watch-only wallet...
-btc createwallet bwt true > /dev/null
+
+echo - Creating wallets...
+btc createwallet internal > /dev/null
+btc createwallet bwt true true > /dev/null
 
 echo - Generating some blocks...
 btc generatetoaddress 110 `btc getnewaddress` > /dev/null
diff --git a/src/app.rs b/src/app.rs
@@ -220,14 +220,18 @@ impl App {
 // and create the wallet if the `create_wallet_if_missing` option was set
 fn load_wallet(rpc: &RpcClient, name: &str, create_if_missing: bool) -> Result<()> {
     use crate::util::bitcoincore_ext::{RPC_WALLET_ERROR, RPC_WALLET_NOT_FOUND};
-    // needs to be identified by the error message string because it uses a generic wallet error code
-    const MSG_ALREADY_LOADED_SUFF: &str = "Duplicate -wallet filename specified.";
+    // Needs to be identified by the error message string because it uses a generic wallet error code.
+    // The error message changed in Bitcoin Core v0.21.
+    const MSG_ALREADY_LOADED_OLD: &str = "Duplicate -wallet filename specified.";
+    const MSG_ALREADY_LOADED_NEW: &str = "is already loaded.";
 
     match rpc.load_wallet(name) {
         Ok(_) => Ok(()),
         // Wallet already loaded
         Err(rpc::Error::JsonRpc(rpc::jsonrpc::Error::Rpc(ref e)))
-            if e.code == RPC_WALLET_ERROR && e.message.ends_with(MSG_ALREADY_LOADED_SUFF) =>
+            if e.code == RPC_WALLET_ERROR
+                && (e.message.ends_with(MSG_ALREADY_LOADED_OLD)
+                    || e.message.ends_with(MSG_ALREADY_LOADED_NEW)) =>
         {
             Ok(())
         }
diff --git a/src/util/banner.rs b/src/util/banner.rs
@@ -16,15 +16,21 @@ const HALVING_INTERVAL: u64 = 210_000;
 pub fn get_welcome_banner(query: &Query, omit_donation: bool) -> Result<String> {
     let rpc = query.rpc();
 
-    let net_info = rpc.get_network_info()?;
+    let net_info = rpc.get_network_info_()?;
     let chain_info = rpc.get_blockchain_info()?;
     let mempool_info = rpc.get_mempool_info()?;
     let net_totals = rpc.get_net_totals()?;
-    let peers = rpc.get_peer_info()?;
     let hash_rate_7d = rpc.get_network_hash_ps(Some(1008), None)?;
     let uptime = dur_from_secs(rpc.uptime()?);
     let tip = rpc.get_block_stats(&rpc.get_best_block_hash()?)?;
 
+    // Bitcoin Core v0.21 has a `connections_in` field. For older version,
+    // retreive the list of peers and check if there are any inbound ones.
+    let has_inbound = net_info.connections_in.map_or_else(
+        || -> Result<bool> { Ok(rpc.get_peer_info()?.iter().any(|p| p.inbound)) },
+        |connections_in| Ok(connections_in > 0),
+    )?;
+
     let est_fee = |target| {
         query
             .estimate_fee(target)
@@ -65,8 +71,6 @@ pub fn get_welcome_banner(query: &Query, omit_donation: bool) -> Result<String>
     // sat/kb -> sat/vB
     let mempool_min_fee = mempool_info.mempool_min_fee.as_sat() as f64 / 1000f64;
 
-    let has_inbound = peers.iter().any(|p| p.inbound);
-
     let modes = [
         if chain_info.pruned {
             "✂️ ᴘʀᴜɴᴇᴅ"
diff --git a/src/util/bitcoincore_ext.rs b/src/util/bitcoincore_ext.rs
@@ -16,6 +16,11 @@ pub const RPC_IN_WARMUP: i32 = -28;
 pub const RPC_METHOD_NOT_FOUND: i32 = -32601;
 
 pub trait RpcApiExt: RpcApi {
+    // Pending https://github.com/rust-bitcoin/rust-bitcoincore-rpc/pull/158
+    fn get_network_info_(&self) -> RpcResult<GetNetworkInfoResult> {
+        self.call("getnetworkinfo", &[])
+    }
+
     fn list_labels(&self) -> RpcResult<Vec<String>> {
         self.call("listlabels", &[])
     }
@@ -86,6 +91,41 @@ pub struct GetMempoolInfoResult {
     pub mempool_min_fee: bitcoin::Amount,
 }
 
+// Pending https://github.com/rust-bitcoin/rust-bitcoincore-rpc/pull/158
+#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
+pub struct GetNetworkInfoResult {
+    pub version: usize,
+    pub subversion: String,
+    #[serde(rename = "protocolversion")]
+    pub protocol_version: usize,
+    #[serde(rename = "localservices")]
+    pub local_services: String,
+    #[serde(rename = "localrelay")]
+    pub local_relay: bool,
+    #[serde(rename = "timeoffset")]
+    pub time_offset: isize,
+    pub connections: usize,
+    /// The number of inbound connections
+    /// Added in Bitcoin Core v0.21
+    pub connections_in: Option<usize>,
+    /// The number of outbound connections
+    /// Added in Bitcoin Core v0.21
+    pub connectiosn_out: Option<usize>,
+    #[serde(rename = "networkactive")]
+    pub network_active: bool,
+    pub networks: Vec<json::GetNetworkInfoResultNetwork>,
+    #[serde(rename = "relayfee", with = "bitcoin::util::amount::serde::as_btc")]
+    pub relay_fee: bitcoin::Amount,
+    #[serde(
+        rename = "incrementalfee",
+        with = "bitcoin::util::amount::serde::as_btc"
+    )]
+    pub incremental_fee: bitcoin::Amount,
+    #[serde(rename = "localaddresses")]
+    pub local_addresses: Vec<json::GetNetworkInfoResultAddress>,
+    pub warnings: String,
+}
+
 // Wrap rust-bitcoincore-rpc's RescanSince to enable deserialization
 // Pending https://github.com/rust-bitcoin/rust-bitcoincore-rpc/pull/150
 // XXX The PR does not include null handling
