Add simulaterawtransaction method, model and test

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

Author: jamillambert

client/src/client_sync/v24/mod.rs

@@ -186,6 +186,7 @@ crate::impl_client_v17__set_tx_fee!();
 crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
+crate::impl_client_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v24/wallet.rs

@@ -32,3 +32,18 @@ macro_rules! impl_client_v24__send_all {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `simulaterawtransaction`.
+#[macro_export]
+macro_rules! impl_client_v24__simulate_raw_transaction {
+    () => {
+        impl Client {
+            pub fn simulate_raw_transaction(
+                &self,
+                rawtxs: &[String],
+            ) -> Result<SimulateRawTransaction> {
+                self.call("simulaterawtransaction", &[into_json(rawtxs)?])
+            }
+        }
+    };
+}

client/src/client_sync/v25/mod.rs

@@ -185,6 +185,7 @@ crate::impl_client_v17__set_tx_fee!();
 crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
+crate::impl_client_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v26/mod.rs

@@ -189,6 +189,7 @@ crate::impl_client_v17__set_tx_fee!();
 crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
+crate::impl_client_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v27/mod.rs

@@ -185,6 +185,7 @@ crate::impl_client_v17__set_tx_fee!();
 crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
+crate::impl_client_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v28/mod.rs

@@ -187,6 +187,7 @@ crate::impl_client_v17__set_tx_fee!();
 crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
+crate::impl_client_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v29/mod.rs

@@ -187,6 +187,7 @@ crate::impl_client_v17__set_tx_fee!();
 crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
+crate::impl_client_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

integration_test/tests/wallet.rs

@@ -737,6 +737,45 @@ fn wallet__sign_message__modelled() {
     let _ = res.expect("SignMessage into model");
 }
 
+#[cfg(not(feature = "v23_and_below"))]
+#[test]
+fn wallet__simulate_raw_transaction() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+
+    let address = node.client.new_address().expect("failed to create new address");
+    let amount = Amount::from_sat(10_000);
+
+    let txid1 = node
+        .client
+        .send_to_address(&address, amount)
+        .expect("sendtoaddress")
+        .txid()
+        .unwrap();
+    let raw_tx1 = node.client.get_raw_transaction(txid1).expect("getrawtransaction");
+
+    let txid2 = node
+        .client
+        .send_to_address(&address, amount)
+        .expect("sendtoaddress")
+        .txid()
+        .unwrap();
+    let raw_tx2 = node.client.get_raw_transaction(txid2).expect("getrawtransaction");
+
+    // Simulate raw transaction with the 2 transactions
+    let rawtxs = vec![raw_tx1.0, raw_tx2.0];
+    let json: SimulateRawTransaction = node
+        .client
+        .simulate_raw_transaction(&rawtxs)
+        .expect("simulaterawtransaction");
+
+    let model: Result<mtype::SimulateRawTransaction, _> = json.into_model();
+    let model = model.unwrap();
+
+    // Should show a negative balance change since we're sending money
+    assert!(model.balance_change.is_negative());
+}
+
 #[test]
 fn wallet__wallet_lock() {
     let node = Node::with_wallet(Wallet::Default, &[]);

types/src/model/mod.rs

@@ -63,6 +63,6 @@ pub use self::{
         ListTransactions, ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets,
         LoadWallet, PsbtBumpFee, RescanBlockchain, ScriptType, Send, SendAll, SendMany, SendToAddress,
         SignMessage, TransactionCategory, UnloadWallet, WalletCreateFundedPsbt,
-        WalletDisplayAddress, WalletProcessPsbt,
+        WalletDisplayAddress, WalletProcessPsbt, SimulateRawTransaction
     },
 };

types/src/model/wallet.rs

@@ -782,6 +782,15 @@ pub struct SendToAddress {
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct SignMessage(pub sign_message::MessageSignature);
 
+/// Models the result of JSON-RPC method `simulaterawtransaction`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct SimulateRawTransaction {
+    /// The wallet balance change (negative means decrease).
+    #[serde(default, with = "bitcoin::amount::serde::as_btc")]
+    pub balance_change: SignedAmount,
+}
+
 /// Models the result of JSON-RPC method `unloadwallet`.
 ///
 /// Core version v0.21 onwards.