Implement scantxoutset method and test

Author: GideonBature

client/src/client_sync/v17/blockchain.rs

@@ -318,6 +318,30 @@ macro_rules! impl_client_v17__savemempool {
     };
 }
 
+/// Implements Bitcoin Core JSON-RPC API method `scantxoutset`
+#[macro_export]
+macro_rules! impl_client_v17__scantxoutset {
+    () => {
+        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__verifychain {

client/src/client_sync/v17/mod.rs

@@ -48,6 +48,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v17__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 
@@ -214,3 +215,24 @@ pub struct WalletCreateFundedPsbtInput {
     txid: Txid,
     vout: u32,
 }
+
+/// Args for the `scantxoutset`
+///
+/// Represents the action for the `scantxoutset` RPC call.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum ScanAction {
+    Start,
+    Abort,
+    Status,
+}
+
+/// Represents a scan object for scantxoutset (descriptor string or object).
+#[derive(Clone, Debug, PartialEq, Deserialize, 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

@@ -19,7 +19,10 @@ use crate::types::v18::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddressType, Input, Output, ScanAction, ScanObject, TemplateRequest,
+        TemplateRules, WalletCreateFundedPsbtInput
+    },
 };
 
 // This publicly re-exports `Client`.
@@ -48,6 +51,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v17__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v19/mod.rs

@@ -18,7 +18,10 @@ use crate::types::v19::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddressType, Input, Output, ScanAction, ScanObject, TemplateRequest,
+        TemplateRules, WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v19");
@@ -47,6 +50,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v17__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v20.rs

@@ -15,7 +15,10 @@ use crate::types::v20::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddressType, Input, Output, ScanAction, ScanObject, TemplateRequest,
+        TemplateRules, WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v20");
@@ -44,6 +47,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v17__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v21/mod.rs

@@ -17,7 +17,10 @@ use crate::types::v21::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddressType, Input, Output, ScanAction, ScanObject, TemplateRequest,
+        TemplateRules, WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v21");
@@ -46,6 +49,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v17__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v22/mod.rs

@@ -17,7 +17,10 @@ use crate::types::v22::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddressType, Input, Output, ScanAction, ScanObject, TemplateRequest,
+        TemplateRules, WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v22");
@@ -46,6 +49,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v17__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v23/mod.rs

@@ -19,7 +19,10 @@ use crate::types::v23::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        Input, Output, ScanAction, ScanObject, TemplateRequest,
+        TemplateRules, WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v23");
@@ -48,6 +51,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v23__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v24.rs

@@ -15,7 +15,10 @@ use crate::types::v24::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        Input, Output, ScanAction, ScanObject, TemplateRequest, TemplateRules,
+        WalletCreateFundedPsbtInput
+    },
     v23::AddressType,
 };
 
@@ -45,6 +48,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v23__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();
 

client/src/client_sync/v25.rs renamed to client/src/client_sync/v25/mod.rs

@@ -15,7 +15,10 @@ use crate::types::v25::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        Input, Output, ScanAction, ScanObject, TemplateRequest, TemplateRules,
+        WalletCreateFundedPsbtInput
+    },
     v23::AddressType,
 };
 
@@ -45,6 +48,7 @@ crate::impl_client_v17__gettxoutsetinfo!();
 crate::impl_client_v17__preciousblock!();
 crate::impl_client_v17__pruneblockchain!();
 crate::impl_client_v23__savemempool!();
+crate::impl_client_v17__scantxoutset!();
 crate::impl_client_v17__verifychain!();
 crate::impl_client_v17__verifytxoutproof!();