Add support for getblockfilter

tcharding · tcharding · commit 0c38486b886b · 2025-03-14T10:26:42.000+11:00
Add support for all versions and test it.
diff --git a/client/src/client_sync/v19/blockchain.rs b/client/src/client_sync/v19/blockchain.rs
@@ -9,6 +9,18 @@
 //!
 //! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
 
+/// Implements Bitcoin Core JSON-RPC API method `getblockfilter`
+#[macro_export]
+macro_rules! impl_client_v19__getblockfilter {
+    () => {
+        impl Client {
+            pub fn get_block_filter(&self, block: BlockHash) -> Result<GetBlockFilter> {
+                self.call("getblockfilter", &[into_json(block)?])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `getmempoolancestors`
 #[macro_export]
 macro_rules! impl_client_v19__getmempoolancestors {
diff --git a/client/src/client_sync/v19/mod.rs b/client/src/client_sync/v19/mod.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v20.rs b/client/src/client_sync/v20.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v21.rs b/client/src/client_sync/v21.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v22/mod.rs b/client/src/client_sync/v22/mod.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v23.rs b/client/src/client_sync/v23.rs
@@ -18,6 +18,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v24.rs b/client/src/client_sync/v24.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v25.rs b/client/src/client_sync/v25.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v26/mod.rs b/client/src/client_sync/v26/mod.rs
@@ -22,6 +22,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v27.rs b/client/src/client_sync/v27.rs
@@ -20,6 +20,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/client/src/client_sync/v28/mod.rs b/client/src/client_sync/v28/mod.rs
@@ -22,6 +22,7 @@ crate::impl_client_v17__getbestblockhash!();
 crate::impl_client_v17__getblock!();
 crate::impl_client_v17__getblockchaininfo!();
 crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
 crate::impl_client_v17__getblockhash!();
 crate::impl_client_v17__getblockheader!();
 crate::impl_client_v17__getblockstats!();
diff --git a/integration_test/src/lib.rs b/integration_test/src/lib.rs
@@ -23,6 +23,7 @@ pub enum Wallet {
     None,
 }
 
+
 pub trait NodeExt {
     /// Returns a handle to a `bitcoind` instance after leading wallet if present.
     fn with_wallet(wallet: Wallet, args: &[&str]) -> Node;
diff --git a/integration_test/tests/blockchain.rs b/integration_test/tests/blockchain.rs
@@ -41,6 +41,18 @@ fn get_block_count() {
     let _ = json.into_model();
 }
 
+#[test]
+#[cfg(not(feature = "v17"))]
+#[cfg(not(feature = "v18"))]
+fn get_block_filter() {
+    let node = Node::with_wallet(Wallet::Default, &["-blockfilterindex"]);
+    node.mine_a_block();
+    let hash = node.client.best_block_hash().expect("best_block_hash failed");
+
+    let json = node.client.get_block_filter(hash).expect("getblockfilter");
+    let _ = json.into_model();
+}
+
 #[test]
 fn get_block_hash() {
     let node = Node::with_wallet(Wallet::None, &[]);
diff --git a/types/src/model/blockchain.rs b/types/src/model/blockchain.rs
@@ -179,6 +179,15 @@ pub struct Bip9SoftforkStatistics {
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 pub struct GetBlockCount(pub u64);
 
+/// Models the result of JSON-RPC method `getblockfilter`.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct GetBlockFilter {
+    /// The filter data.
+    pub filter: Vec<u8>,
+    /// The hex-encoded filter header.
+    pub header: bitcoin::bip158::FilterHash,
+}
+
 /// Models the result of JSON-RPC method `getblockhash`.
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 pub struct GetBlockHash(pub BlockHash);
diff --git a/types/src/model/mod.rs b/types/src/model/mod.rs
@@ -22,9 +22,9 @@ mod zmq;
 pub use self::{
     blockchain::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, ChainTips, ChainTipsStatus,
-        GetBestBlockHash, GetBlockCount, GetBlockHash, GetBlockHeader, GetBlockHeaderVerbose,
-        GetBlockStats, GetBlockVerbosityOne, GetBlockVerbosityZero, GetBlockchainInfo,
-        GetChainTips, GetChainTxStats, GetDifficulty, GetMempoolAncestors,
+        GetBestBlockHash, GetBlockCount, GetBlockFilter, GetBlockHash, GetBlockHeader,
+        GetBlockHeaderVerbose, GetBlockStats, GetBlockVerbosityOne, GetBlockVerbosityZero,
+        GetBlockchainInfo, GetChainTips, GetChainTxStats, GetDifficulty, GetMempoolAncestors,
         GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
         GetMempoolEntry, GetMempoolInfo, GetRawMempool, GetRawMempoolVerbose, GetTxOut,
         GetTxOutSetInfo, MempoolEntry, MempoolEntryFees, Softfork, SoftforkType, VerifyTxOutProof,
diff --git a/types/src/v19/blockchain/error.rs b/types/src/v19/blockchain/error.rs
@@ -55,6 +55,38 @@ impl From<NumericError> for GetBlockchainInfoError {
     fn from(e: NumericError) -> Self { Self::Numeric(e) }
 }
 
+/// Error when converting a `GetBlockFilter` into the model type.
+#[derive(Debug)]
+pub enum GetBlockFilterError {
+    /// Conversion of the `filter` field failed.
+    Filter(hex::HexToBytesError),
+    /// Conversion of the `header` field failed.
+    Header(hex::HexToArrayError),
+}
+
+impl fmt::Display for GetBlockFilterError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use GetBlockFilterError as E;
+
+        match *self {
+            E::Filter(ref e) => write_err!(f, "conversion of the `filter` field failed"; e),
+            E::Header(ref e) => write_err!(f, "conversion of the `header` field failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for GetBlockFilterError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use GetBlockFilterError as E;
+
+        match *self {
+            E::Filter(ref e) => Some(e),
+            E::Header(ref e) => Some(e),
+        }
+    }
+}
+
 /// Error when converting a `MapMempoolEntry` into the model type.
 #[derive(Debug)]
 pub enum MapMempoolEntryError {
diff --git a/types/src/v19/blockchain/into.rs b/types/src/v19/blockchain/into.rs
@@ -2,14 +2,15 @@
 
 use std::collections::BTreeMap;
 
-use bitcoin::{hex, Amount, BlockHash, Network, Txid, Work, Wtxid};
+use bitcoin::hex::{self, FromHex as _};
+use bitcoin::{bip158, Amount, BlockHash, Network, Txid, Work, Wtxid};
 
 use super::error::{
-    GetBlockchainInfoError, MapMempoolEntryError, MempoolEntryError,
+    GetBlockFilterError, GetBlockchainInfoError, MapMempoolEntryError, MempoolEntryError,
     MempoolEntryFeesError,
 };
 use super::{
-    GetBlockchainInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
+    GetBlockFilter, GetBlockchainInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
     GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MempoolEntry,
     MempoolEntryFees,
 };
@@ -51,6 +52,17 @@ impl GetBlockchainInfo {
     }
 }
 
+impl GetBlockFilter {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetBlockFilter, GetBlockFilterError> {
+        use GetBlockFilterError as E;
+
+        let filter = Vec::from_hex(&self.filter).map_err(E::Filter)?;
+        let header = self.header.parse::<bip158::FilterHash>().map_err(E::Header)?;
+        Ok(model::GetBlockFilter { filter, header })
+    }
+}
+
 impl GetMempoolAncestors {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> Result<model::GetMempoolAncestors, hex::HexToArrayError> {
diff --git a/types/src/v19/blockchain/mod.rs b/types/src/v19/blockchain/mod.rs
@@ -138,6 +138,23 @@ pub struct Bip9SoftforkStatistics {
     pub possible: Option<bool>,
 }
 
+/// Result of JSON-RPC method `getblockfilter`.
+///
+/// > getblockfilter "blockhash" ( "filtertype" )
+/// >
+/// > Retrieve a BIP 157 content filter for a particular block.
+/// >
+/// > Arguments:
+/// > 1. blockhash     (string, required) The hash of the block
+/// > 2. filtertype    (string, optional, default=basic) The type name of the filter
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct GetBlockFilter {
+    /// The hex-encoded filter data.
+    pub filter: String,
+    /// The hex-encoded filter header.
+    pub header: String,
+}
+
 /// Result of JSON-RPC method `getmempoolancestors` with verbose set to `false`.
 ///
 /// > getmempoolancestors txid (verbose)
diff --git a/types/src/v19/mod.rs b/types/src/v19/mod.rs
@@ -21,7 +21,7 @@
 //! | getblock                           | done            |
 //! | getblockchaininfo                  | done            |
 //! | getblockcount                      | done            |
-//! | getblockfilter                     | todo            |
+//! | getblockfilter                     | done            |
 //! | getblockhash                       | done            |
 //! | getblockheader                     | done            |
 //! | getblockstats                      | done            |
@@ -229,11 +229,11 @@ mod wallet;
 #[doc(inline)]
 pub use self::{
     blockchain::{
-        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBlockchainInfo,
-        GetBlockchainInfoError, GetMempoolAncestors, GetMempoolAncestorsVerbose,
-        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
-        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
-        SoftforkType,
+        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBlockFilter,
+        GetBlockFilterError, GetBlockchainInfo, GetBlockchainInfoError, GetMempoolAncestors,
+        GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
+        GetMempoolEntry, MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
+        MempoolEntryFeesError, Softfork, SoftforkType,
     },
     wallet::{GetBalances, GetBalancesMine, GetBalancesWatchOnly},
 };
diff --git a/types/src/v20/mod.rs b/types/src/v20/mod.rs
@@ -21,7 +21,7 @@
 //! | getblock                           | done            |
 //! | getblockchaininfo                  | done            |
 //! | getblockcount                      | done            |
-//! | getblockfilter                     | todo            |
+//! | getblockfilter                     | done            |
 //! | getblockhash                       | done            |
 //! | getblockheader                     | done            |
 //! | getblockstats                      | done            |
@@ -252,9 +252,10 @@ pub use crate::{
     v18::{ActiveCommand, GetRpcInfo},
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
-        GetBalancesWatchOnly, GetBlockchainInfo, GetBlockchainInfoError, GetMempoolAncestors,
-        GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
-        GetMempoolEntry, MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
-        MempoolEntryFeesError, Softfork, SoftforkType,
+        GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfo,
+        GetBlockchainInfoError, GetMempoolAncestors, GetMempoolAncestorsVerbose,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
+        SoftforkType,
     },
 };
diff --git a/types/src/v21/mod.rs b/types/src/v21/mod.rs
@@ -21,7 +21,7 @@
 //! | getblock                           | done            |
 //! | getblockchaininfo                  | done            |
 //! | getblockcount                      | done            |
-//! | getblockfilter                     | todo            |
+//! | getblockfilter                     | done            |
 //! | getblockhash                       | done            |
 //! | getblockheader                     | done            |
 //! | getblockstats                      | done            |
@@ -258,10 +258,11 @@ pub use crate::{
     v18::{ActiveCommand, GetRpcInfo},
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
-        GetBalancesWatchOnly, GetBlockchainInfo, GetBlockchainInfoError, GetMempoolAncestors,
-        GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
-        GetMempoolEntry, MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
-        MempoolEntryFeesError, Softfork, SoftforkType,
+        GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfo,
+        GetBlockchainInfoError, GetMempoolAncestors, GetMempoolAncestorsVerbose,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
+        SoftforkType,
     },
     v20::Logging,
 };
diff --git a/types/src/v22/mod.rs b/types/src/v22/mod.rs
@@ -21,7 +21,7 @@
 //! | getblock                           | done            |
 //! | getblockchaininfo                  | done            |
 //! | getblockcount                      | done            |
-//! | getblockfilter                     | todo            |
+//! | getblockfilter                     | done            |
 //! | getblockhash                       | done            |
 //! | getblockheader                     | done            |
 //! | getblockstats                      | done            |
@@ -273,10 +273,11 @@ pub use crate::{
     v18::{ActiveCommand, GetRpcInfo},
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
-        GetBalancesWatchOnly, GetBlockchainInfo, GetBlockchainInfoError, GetMempoolAncestors,
-        GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
-        GetMempoolEntry, MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
-        MempoolEntryFeesError, Softfork, SoftforkType,
+        GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfo,
+        GetBlockchainInfoError, GetMempoolAncestors, GetMempoolAncestorsVerbose,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
+        SoftforkType,
     },
     v21::UnloadWallet,
 };
diff --git a/types/src/v23/mod.rs b/types/src/v23/mod.rs
@@ -21,7 +21,7 @@
 //! | getblock                           | done            |
 //! | getblockchaininfo                  | done            |
 //! | getblockcount                      | done            |
-//! | getblockfilter                     | todo            |
+//! | getblockfilter                     | done            |
 //! | getblockfrompeer                   | todo            |
 //! | getblockhash                       | done            |
 //! | getblockheader                     | done            |
@@ -257,10 +257,11 @@ pub use crate::{
     v18::{ActiveCommand, GetRpcInfo},
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
-        GetBalancesWatchOnly, GetBlockchainInfo, GetBlockchainInfoError, GetMempoolAncestors,
-        GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
-        GetMempoolEntry, MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
-        MempoolEntryFeesError, Softfork, SoftforkType,
+        GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfo,
+        GetBlockchainInfoError, GetMempoolAncestors, GetMempoolAncestorsVerbose,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
+        SoftforkType,
     },
     v21::UnloadWallet,
     v22::{GetTxOut, GetTxOutError, Logging, ScriptPubkey},
diff --git a/types/src/v24/mod.rs b/types/src/v24/mod.rs
diff --git a/types/src/v25/mod.rs b/types/src/v25/mod.rs
diff --git a/types/src/v26/mod.rs b/types/src/v26/mod.rs
diff --git a/types/src/v27/mod.rs b/types/src/v27/mod.rs
diff --git a/types/src/v28/mod.rs b/types/src/v28/mod.rs
diff --git a/verify/src/method/v19.rs b/verify/src/method/v19.rs
