Implement scantxoutset method and test

Author: GideonBature

client/src/client_sync/v17/blockchain.rs

@@ -318,6 +318,30 @@ macro_rules! impl_client_v17__save_mempool {
     };
 }
 
+/// Implements Bitcoin Core JSON-RPC API method `scantxoutset`
+#[macro_export]
+macro_rules! impl_client_v17__scan_tx_out_set {
+    () => {
+        impl Client {
+            pub fn scan_tx_out_set(
+                &self,
+                action: ScanAction,
+                scan_objects: &[ScanObject],
+            ) -> Result<ScanTxOutSet> {
+                let params = match action {
+                    ScanAction::Start => {
+                        vec![into_json(action)?, into_json(scan_objects)?]
+                    }
+                    ScanAction::Abort | ScanAction::Status => {
+                        vec![into_json(action)?]
+                    }
+                };
+                self.call("scantxoutset", &params)
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `verifychain`
 #[macro_export]
 macro_rules! impl_client_v17__verify_chain {

client/src/client_sync/v17/mod.rs

@@ -48,6 +48,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v17__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 
@@ -302,3 +303,24 @@ impl Serialize for ImportMultiTimestamp {
         }
     }
 }
+
+/// Args for the `scantxoutset`
+///
+/// Represents the action for the `scantxoutset` RPC call.
+#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum ScanAction {
+    Start,
+    Abort,
+    Status,
+}
+
+/// Represents a scan object for scantxoutset (descriptor string or object).
+#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
+#[serde(untagged)]
+pub enum ScanObject {
+    /// Plain descriptor string
+    Descriptor(String),
+    /// Object containing descriptor and optional range
+    WithDesc { desc: String },
+}

client/src/client_sync/v18/mod.rs

@@ -24,7 +24,7 @@ use crate::types::v18::*;
 pub use crate::client_sync::{
     v17::{
         AddNodeCommand, AddressType, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest,
-        TemplateRules, WalletCreateFundedPsbtInput,
+        TemplateRules, WalletCreateFundedPsbtInput,ScanAction, ScanObject,
     },
 };
 
@@ -54,6 +54,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v17__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v19/mod.rs

@@ -21,6 +21,7 @@ pub use crate::client_sync::{
     v17::{
         AddNodeCommand, AddressType, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest,
         TemplateRules, WalletCreateFundedPsbtInput,
+        ScanAction, ScanObject,
     },
 };
 
@@ -50,6 +51,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v17__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v20/mod.rs

@@ -19,7 +19,7 @@ use crate::types::v20::*;
 pub use crate::client_sync::{
     v17::{
         AddressType, AddNodeCommand, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest, TemplateRules,
-        WalletCreateFundedPsbtInput,
+        WalletCreateFundedPsbtInput, ScanAction, ScanObject,
     },
 };
 
@@ -49,6 +49,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v17__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v21/mod.rs

@@ -22,7 +22,7 @@ use crate::types::v21::*;
 pub use crate::client_sync::{
     v17::{
         AddNodeCommand, AddressType, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest,
-        TemplateRules, WalletCreateFundedPsbtInput,
+        TemplateRules, WalletCreateFundedPsbtInput,ScanAction, ScanObject,
     },
 };
 
@@ -52,6 +52,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v17__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v22/mod.rs

@@ -19,7 +19,7 @@ use crate::types::v22::*;
 pub use crate::client_sync::{
     v17::{
         AddNodeCommand, AddressType, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest,
-        TemplateRules, WalletCreateFundedPsbtInput,
+        TemplateRules, WalletCreateFundedPsbtInput, ScanAction, ScanObject,
     },
     v21::ImportDescriptorsRequest,
 };
@@ -50,6 +50,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v17__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v23/mod.rs

@@ -21,7 +21,7 @@ use crate::types::v23::*;
 pub use crate::client_sync::{
     v17::{
         AddNodeCommand, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest, TemplateRules,
-        WalletCreateFundedPsbtInput,
+        WalletCreateFundedPsbtInput, ScanAction, ScanObject,
     },
     v21::ImportDescriptorsRequest,
 };
@@ -52,6 +52,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v24/mod.rs

@@ -17,7 +17,7 @@ use crate::types::v24::*;
 pub use crate::client_sync::{
     v17::{
         AddNodeCommand, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest, TemplateRules,
-        WalletCreateFundedPsbtInput,
+        WalletCreateFundedPsbtInput, ScanAction, ScanObject,
     },
     v21::ImportDescriptorsRequest,
     v23::AddressType,
@@ -49,6 +49,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();
 

client/src/client_sync/v25/mod.rs

@@ -19,7 +19,7 @@ use crate::types::v25::*;
 pub use crate::client_sync::{
     v17::{
         AddNodeCommand, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest, TemplateRules,
-        WalletCreateFundedPsbtInput,
+        WalletCreateFundedPsbtInput, ScanAction, ScanObject,
     },
     v21::ImportDescriptorsRequest,
     v23::AddressType,
@@ -51,6 +51,7 @@ crate::impl_client_v17__get_tx_out_set_info!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
+crate::impl_client_v17__scan_tx_out_set!();
 crate::impl_client_v17__verify_chain!();
 crate::impl_client_v17__verify_tx_out_proof!();