Add verify tool

Add a tool to help verify that what we have done is correct.

Adds crate that when run produces:

```bash
Verifying support for Bitcoin Core v17

        Checking he documented methods are correct for this version of Core ... ✓
        The documented status is correct ... ✓
```

Run the tool for v17 module and fix the few mistakes it found - WIN!

Then fix up the docs in v18 and run the tool to verify the v18 stuff
is correct.

Author: tcharding

Cargo-minimal.lock

@@ -2,6 +2,21 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "aho-corasick"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "anyhow"
+version = "1.0.94"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1fd03a028ef38ba2276dce7e33fcd6369c158a1bca17946c4b1b701891c1ff7"
+
 [[package]]
 name = "arrayvec"
 version = "0.7.4"
@@ -169,6 +184,12 @@ version = "0.4.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "518ef76f2f87365916b142844c16d8fefd85039bc5699050210a7778ee1cd1de"
 
+[[package]]
+name = "memchr"
+version = "2.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
+
 [[package]]
 name = "minreq"
 version = "2.11.2"
@@ -198,6 +219,35 @@ dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "regex"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
+
 [[package]]
 name = "ryu"
 version = "1.0.18"
@@ -283,6 +333,14 @@ version = "1.0.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4"
 
+[[package]]
+name = "verify"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "regex",
+]
+
 [[package]]
 name = "winapi"
 version = "0.3.9"

Cargo-recent.lock

@@ -2,6 +2,21 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "aho-corasick"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "anyhow"
+version = "1.0.94"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1fd03a028ef38ba2276dce7e33fcd6369c158a1bca17946c4b1b701891c1ff7"
+
 [[package]]
 name = "arrayvec"
 version = "0.7.4"
@@ -169,6 +184,12 @@ version = "0.4.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "518ef76f2f87365916b142844c16d8fefd85039bc5699050210a7778ee1cd1de"
 
+[[package]]
+name = "memchr"
+version = "2.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
+
 [[package]]
 name = "minreq"
 version = "2.11.2"
@@ -198,6 +219,35 @@ dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "regex"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
+
 [[package]]
 name = "ryu"
 version = "1.0.18"
@@ -283,6 +333,14 @@ version = "1.0.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4"
 
+[[package]]
+name = "verify"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "regex",
+]
+
 [[package]]
 name = "winapi"
 version = "0.3.9"

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["client", "types", "jsonrpc"]
+members = ["client", "types", "jsonrpc", "verify"]
 exclude = ["integration_test", "node"]
 resolver = "2"
 

integration_test/tests/blockchain.rs

@@ -76,22 +76,25 @@ fn get_block_header_verbose() { // verbose = true
 // optional as suggested in the docs but to no avail.
 #[test]
 #[cfg(feature = "0_17_1")]
+fn get_block_stats() {
+    get_block_stats_by_height();
+    get_block_stats_by_hash();
+}
+
 fn get_block_stats_by_height() {
     let node = Node::new_no_wallet();
     let json = node.client.get_block_stats_by_height(0).expect("getblockstats");
     assert!(json.into_model().is_ok());
 }
 
-// FIXME: Same as get_block_stats_by_height above.
-#[test]
-#[cfg(feature = "0_17_1")]
 fn get_block_stats_by_hash() { // verbose = true
     let node = Node::new_no_wallet();
     let block_hash = best_block_hash();
     let json = node.client.get_block_stats_by_block_hash(&block_hash).expect("getblockstats");
     assert!(json.into_model().is_ok());
 }
 
+
 #[test]
 fn get_block_stats_by_height_txindex() {
     let node = Node::new_no_wallet_txindex();
@@ -130,37 +133,37 @@ fn get_difficulty() {
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_mempool_ancestors() {}
+fn get_mempool_ancestors() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_mempool_descendants() {}
+fn get_mempool_descendants() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_mempool_entry() {}
+fn get_mempool_entry() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_mempool_info() {}
+fn get_mempool_info() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_raw_mempool() {}
+fn get_raw_mempool() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_tx_out() {}
+fn get_tx_out() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_tx_out_proof() {}
+fn get_tx_out_proof() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn get_tx_out_set_info() {}
+fn get_tx_out_set_info() { todo!() }
 
 #[test]
 #[cfg(feature = "TODO")]
-fn verify_tx_out_proof() {}
+fn verify_tx_out_proof() { todo!() }
 

types/src/v17/mod.rs

@@ -184,7 +184,7 @@
 //! | lockunspent                        | omitted         |
 //! | move                               | omitted         |
 //! | removeprunedfunds                  | omitted         |
-//! | rescanblockchain                   | done            |
+//! | rescanblockchain                   | done (untested) |
 //! | sendfrom                           | omitted         |
 //! | sendmany                           | done (untested) |
 //! | sendtoaddress                      | done            |
@@ -207,7 +207,7 @@
 //!
 //! | JSON-PRC Method Name               | Status          |
 //! |:-----------------------------------|:---------------:|
-//! | getzmqnotifications`               | done (untested) |
+//! | getzmqnotifications                | done (untested) |
 //!
 //! </details>
 //!
@@ -260,4 +260,5 @@ pub use self::{
         SignErrorData, SignMessage, SignRawTransactionWithWallet, TransactionCategory,
         WalletCreateFundedPsbt, WalletProcessPsbt,
     },
+    zmq::GetZmqNotifications,
 };