Add gettxspendingprevout method, model and test

Add the struct for the RPC, the model, client macro,
reexports and test.

Author: jamillambert

client/src/client_sync/v24/blockchain.rs

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Blockchain ==` section of the
+//! API docs of Bitcoin Core `v24`.
+//!
+//! All macros require `Client` to be in scope.
+//!
+//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+
+/// Implements Bitcoin Core JSON-RPC API method `gettxspendingprevout`
+#[macro_export]
+macro_rules! impl_client_v24__get_tx_spending_prevout {
+    () => {
+        impl Client {
+            pub fn get_tx_spending_prevout(
+                &self,
+                outputs: &[bitcoin::OutPoint],
+            ) -> Result<GetTxSpendingPrevout> {
+                let json_outputs: Vec<_> = outputs.iter().map(|out| {
+                    serde_json::json!({
+                        "txid": out.txid.to_string(),
+                        "vout": out.vout,
+                    })
+                }).collect();
+                self.call("gettxspendingprevout", &[json_outputs.into()])
+            }
+        }
+    };
+}

client/src/client_sync/v24/mod.rs

@@ -4,6 +4,8 @@
 //!
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
+pub mod blockchain;
+
 use std::collections::BTreeMap;
 use std::path::Path;
 
@@ -48,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v17__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();

client/src/client_sync/v25/mod.rs

@@ -50,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v17__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();

client/src/client_sync/v26/mod.rs

@@ -52,6 +52,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();

client/src/client_sync/v27/mod.rs

@@ -48,6 +48,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();

client/src/client_sync/v28/mod.rs

@@ -50,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();

client/src/client_sync/v29/mod.rs

@@ -50,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();

integration_test/tests/blockchain.rs

@@ -302,6 +302,35 @@ fn blockchain__get_tx_out_set_info__modelled() {
     model.unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v23_and_below"))]
+fn blockchain__get_tx_spending_prevout__modelled() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+
+    let (_address1, txid_1) = node.create_mempool_transaction();
+    let (_address2, txid_2) = node.create_mempool_transaction();
+
+    let inputs = vec![
+        bitcoin::OutPoint {
+            txid: txid_1,
+            vout: 0,
+        },
+        bitcoin::OutPoint {
+            txid: txid_2,
+            vout: 0,
+        },
+    ];
+
+    let json: GetTxSpendingPrevout = node.client.get_tx_spending_prevout(&inputs).expect("gettxspendingprevout");
+    let model: Result<mtype::GetTxSpendingPrevout, GetTxSpendingPrevoutError> = json.into_model();
+    let spending_prevout = model.unwrap();
+
+    assert_eq!(spending_prevout.0.len(), 2);
+    assert_eq!(spending_prevout.0[0].outpoint.txid, txid_1);
+    assert_eq!(spending_prevout.0[0].outpoint.vout, 0);
+}
+
 #[test]
 fn blockchain__precious_block() {
     let node = Node::with_wallet(Wallet::Default, &[]);

types/src/model/blockchain.rs

@@ -9,8 +9,8 @@ use alloc::collections::BTreeMap;
 
 use bitcoin::address::NetworkUnchecked;
 use bitcoin::{
-    block, Address, Amount, Block, BlockHash, CompactTarget, FeeRate, Network, ScriptBuf, Target,
-    TxMerkleNode, TxOut, Txid, Weight, Work, Wtxid,
+    block, Address, Amount, Block, BlockHash, CompactTarget, FeeRate, Network, OutPoint, ScriptBuf,
+    Target, TxMerkleNode, TxOut, Txid, Weight, Work, Wtxid,
 };
 use serde::{Deserialize, Serialize};
 
@@ -626,6 +626,21 @@ pub struct GetTxOutSetInfo {
     pub total_amount: Amount,
 }
 
+/// Models the result of JSON-RPC method `gettxspendingprevout`.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GetTxSpendingPrevout(pub Vec<GetTxSpendingPrevoutItem>);
+
+/// An individual result item from `gettxspendingprevout`.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GetTxSpendingPrevoutItem {
+    /// The outpoint containing the transaction id and vout value of the checked output.
+    pub outpoint: OutPoint,
+    /// The transaction id of the mempool transaction spending this output (omitted if unspent).
+    pub spending_txid: Option<Txid>,
+}
+
 /// Models the result of JSON-RPC method `verifytxoutproof`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]

types/src/model/mod.rs

@@ -28,8 +28,9 @@ pub use self::{
         GetChainTxStats, GetDeploymentInfo, GetDescriptorActivity, GetDifficulty,
         GetMempoolAncestors, GetMempoolAncestorsVerbose, GetMempoolDescendants,
         GetMempoolDescendantsVerbose, GetMempoolEntry, GetMempoolInfo, GetRawMempool,
-        GetRawMempoolVerbose, GetTxOut, GetTxOutSetInfo, MempoolEntry, MempoolEntryFees,
-        ReceiveActivity, Softfork, SoftforkType, SpendActivity, VerifyTxOutProof,
+        GetRawMempoolVerbose, GetTxOut, GetTxOutSetInfo, GetTxSpendingPrevout,
+        GetTxSpendingPrevoutItem, MempoolEntry, MempoolEntryFees, ReceiveActivity, Softfork,
+        SoftforkType, SpendActivity, VerifyTxOutProof,
     },
     generating::{Generate, GenerateBlock, GenerateToAddress, GenerateToDescriptor},
     mining::{