WIP: feat(rpc/v17 - v28) Add initial implementation for pruneblockchain (rust-bitcoin#115)

Author: GideonBature

client/src/client_sync/v17/blockchain.rs

@@ -297,3 +297,16 @@ macro_rules! impl_client_v17__verifytxoutproof {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `pruneblockchain`
+#[macro_export]
+macro_rules! impl_client_v17__pruneblockchain {
+    () => {
+        impl Client {
+            /// Instructs the node to prune the blockchain up to a specified height or timestamp.
+            pub fn prune_blockchain(&self, target: u64) -> Result<PruneBlockchain> {
+                self.call("pruneblockchain", &[into_json(target)?])
+            }
+        }
+    };
+}

client/src/client_sync/v17/mod.rs

@@ -49,6 +49,7 @@ crate::impl_client_v17__gettxoutproof!();
 crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__verifytxoutproof!();
+crate::impl_client_v17__pruneblockchain!();
 
 // == Control ==
 crate::impl_client_v17__getmemoryinfo!();

client/src/client_sync/v28/mod.rs

@@ -42,6 +42,7 @@ crate::impl_client_v17__gettxoutproof!();
 crate::impl_client_v26__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__verifytxoutproof!();
+crate::impl_client_v17__pruneblockchain!();
 
 // == Control ==
 crate::impl_client_v17__getmemoryinfo!();

integration_test/tests/blockchain.rs

@@ -255,3 +255,30 @@ fn verify_tx_out_proof() {
     let txids = node.client.verify_tx_out_proof(&proof).expect("verifytxoutproof");
     assert_eq!(txids.0.len(), 1);
 }
+
+// Implicitly tests the omitted method `pruneblockchain`
+#[test]
+fn prune_blockchain() {
+    let node = Node::with_wallet(Wallet::Default, &["-prune=550"]);
+    // Generate 1001 blocks to exceed regtest's nPruneAfterHeight (1000)
+    let num_blocks_to_mine = 1001;
+    // (Using a loop with mine_a_block is necessary as generate() is deprecated in v28)
+    for _ in 0..num_blocks_to_mine {
+        node.mine_a_block();
+    }
+
+    // Verify block count
+    let count = node.client.get_block_count().expect("getblockcount").0;
+    assert!(
+        count >= num_blocks_to_mine as u64,
+        "Failed to mine enough blocks. Expected: {}, Got: {}",
+        num_blocks_to_mine,
+        count
+    );
+
+    let target_height: u64 = 500;
+
+    let _ = node.client
+        .prune_blockchain(target_height)
+        .expect("pruneblockchain RPC call failed");
+}

node/src/versions.rs

@@ -1,7 +1,7 @@
 // An explicit version of Bitcoin Core must be selected by enabling some feature.
 // We check this here instead of in `lib.rs` because this file is included in `build.rs`.
 #[cfg(all(
-    not(feature = "28_0"),
+    feature = "28_0",
     not(feature = "27_2"),
     not(feature = "27_1"),
     not(feature = "27_0"),

types/src/model/blockchain.rs

@@ -486,3 +486,7 @@ pub struct GetTxOutSetInfo {
 /// Models the result of JSON-RPC method `verifytxoutproof`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct VerifyTxOutProof(pub Vec<Txid>);
+
+/// Models the result of JSON-RPC method `pruneblockchain`.
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize)]
+pub struct PruneBlockchain(pub u32);

types/src/model/mod.rs

@@ -27,7 +27,7 @@ pub use self::{
         GetBlockchainInfo, GetChainTips, GetChainTxStats, GetDifficulty, GetMempoolAncestors,
         GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
         GetMempoolEntry, GetMempoolInfo, GetRawMempool, GetRawMempoolVerbose, GetTxOut,
-        GetTxOutSetInfo, MempoolEntry, MempoolEntryFees, Softfork, SoftforkType, VerifyTxOutProof,
+        GetTxOutSetInfo, MempoolEntry, MempoolEntryFees, Softfork, SoftforkType, VerifyTxOutProof, PruneBlockchain,
     },
     generating::{Generate, GenerateToAddress},
     mining::{

types/src/v17/blockchain/error.rs

@@ -560,3 +560,37 @@ impl std::error::Error for GetTxOutSetInfoError {
 impl From<NumericError> for GetTxOutSetInfoError {
     fn from(e: NumericError) -> Self { Self::Numeric(e) }
 }
+
+/// Error when converting the `PruneBlockchain` JSON type to the Model type.
+#[derive(Debug)]
+pub enum PruneBlockchainError {
+    /// Conversion of the returned height to the expected numeric type failed.
+    Numeric(NumericError),
+}
+
+impl fmt::Display for PruneBlockchainError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use PruneBlockchainError::*;
+
+        match *self {
+            Numeric(ref e) => write_err!(f, "numeric conversion of pruned height failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for PruneBlockchainError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use PruneBlockchainError::*;
+
+        match *self {
+            Numeric(ref e) => Some(e),
+        }
+    }
+}
+
+impl From<NumericError> for PruneBlockchainError {
+    fn from(e: NumericError) -> Self {
+        Self::Numeric(e)
+    }
+}

types/src/v17/blockchain/into.rs

@@ -545,3 +545,13 @@ impl VerifyTxOutProof {
         Ok(model::VerifyTxOutProof(proofs))
     }
 }
+
+impl PruneBlockchain {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::PruneBlockchain, PruneBlockchainError> {
+        // Use the helper function to convert the i64 height to u32, handling potential errors.
+        let height = crate::to_u32(self.0, "pruned_height")?;
+        // Wrap the u32 height in the model struct.
+        Ok(model::PruneBlockchain(height))
+    }
+}

types/src/v17/blockchain/mod.rs

@@ -667,3 +667,20 @@ pub struct GetTxOutSetInfo {
 /// Inner field is the txid(s) which the proof commits to, or empty array if the proof can not be validated.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct VerifyTxOutProof(pub Vec<String>);
+
+
+/// Result of JSON-RPC method `pruneblockchain`.
+///
+/// > pruneblockchain height
+/// >
+/// > Arguments:
+/// > 1. "height"       (numeric, required) The block height to prune up to. May be set to a discrete height, or a unix timestamp
+/// >                   to prune blocks whose block time is at least 2 hours older than the provided timestamp.
+/// >
+/// > Result:
+/// > n    (numeric) Height of the last block pruned.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct PruneBlockchain(
+    /// The height of the last block pruned.
+    pub i64
+);

types/src/v17/mod.rs

@@ -235,7 +235,7 @@ pub use self::{
         GetRawMempool, GetRawMempoolVerbose, GetTxOut, GetTxOutError, GetTxOutSetInfo,
         GetTxOutSetInfoError, MapMempoolEntryError, MempoolEntry, MempoolEntryError,
         MempoolEntryFees, MempoolEntryFeesError, ScriptPubkey, Softfork, SoftforkReject,
-        VerifyTxOutProof,
+        VerifyTxOutProof, PruneBlockchain
     },
     control::{GetMemoryInfoStats, Locked, Logging},
     generating::{Generate, GenerateToAddress},

types/src/v28/mod.rs

@@ -280,7 +280,7 @@ pub use crate::{
         ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets, Locked, PeerInfo,
         RescanBlockchain, SendMany, SendRawTransaction, SendToAddress, SignErrorData, SignMessage,
         SignRawTransactionWithWallet, SoftforkReject, TransactionCategory, UploadTarget,
-        VerifyTxOutProof, WalletCreateFundedPsbt, WalletProcessPsbt,
+        VerifyTxOutProof, WalletCreateFundedPsbt, WalletProcessPsbt, PruneBlockchain,
     },
     v18::{ActiveCommand, GetRpcInfo},
     v19::{

verify/rpc-api-v17.txt

@@ -18,7 +18,7 @@ gettxout "txid" n ( include_mempool )
 gettxoutproof ["txid",...] ( blockhash )
 gettxoutsetinfo
 preciousblock "blockhash"
-pruneblockchain
+pruneblockchain height
 savemempool
 scantxoutset <action> ( <scanobjects> )
 verifychain ( checklevel nblocks )
@@ -85,7 +85,7 @@ abandontransaction "txid"
 abortrescan
 addmultisigaddress nrequired ["key",...] ( "label" "address_type" )
 backupwallet "destination"
-bumpfee "txid" ( options ) 
+bumpfee "txid" ( options )
 createwallet "wallet_name" ( disable_private_keys )
 dumpprivkey "address"
 dumpwallet "filename"

verify/src/method/v17.rs

@@ -29,11 +29,12 @@ pub const METHODS: &[Method] = &[
     Method::new_string("gettxoutproof", "get_tx_out_proof"),
     Method::new_modeled("gettxoutsetinfo", "GetTxOutSetInfo", "get_tx_out_set_info"),
     Method::new_nothing("preciousblock", "precious_block"),
-    Method::new_numeric("pruneblockchain", "prune_blockchain"),
     Method::new_nothing("savemempool", "save_mempool"),
     Method::new_modeled("scantxoutset", "ScanTxOutSet", "scan_tx_out_set"),
     Method::new_bool("verifychain", "verify_chain"),
     Method::new_modeled("verifytxoutproof", "VerifyTxOutProof", "verify_tx_out_proof"),
+    Method::new_no_model("pruneblockchain", "PruneBlockchain", "prune_blockchain"),
+
     Method::new_no_model("getmemoryinfo", "GetMemoryInfoStats", "get_memory_info"),
     Method::new_string("help", "help"),
     Method::new_no_model("logging", "Logging", "logging"),