Add send method, model and test

jamillambert · jamillambert · commit 2eecd0f554ba · 2025-07-11T08:48:49.000+01:00
Add the RPC `send` type to v21 and add reexports.
Add model, client macro and test.

Update types table up to v29.
diff --git a/client/src/client_sync/v21/mod.rs b/client/src/client_sync/v21/mod.rs
@@ -166,6 +166,7 @@ crate::impl_client_v17__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v21/wallet.rs b/client/src/client_sync/v21/wallet.rs
@@ -45,6 +45,18 @@ macro_rules! impl_client_v21__import_descriptors {
     };
 }
 
+/// Implements Bitcoin Core JSON-RPC API method `send`.
+#[macro_export]
+macro_rules! impl_client_v21__send {
+    () => {
+        impl Client {
+            pub fn send(&self, outputs: &BTreeMap<String, f64>) -> Result<Send> {
+                self.call("send", &[into_json(outputs)?])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `unloadwallet`
 #[macro_export]
 macro_rules! impl_client_v21__unload_wallet {
diff --git a/client/src/client_sync/v22/mod.rs b/client/src/client_sync/v22/mod.rs
@@ -164,6 +164,7 @@ crate::impl_client_v17__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v23/mod.rs b/client/src/client_sync/v23/mod.rs
@@ -166,6 +166,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v24/mod.rs b/client/src/client_sync/v24/mod.rs
@@ -163,6 +163,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v25/mod.rs b/client/src/client_sync/v25/mod.rs
@@ -165,6 +165,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v26/mod.rs b/client/src/client_sync/v26/mod.rs
@@ -169,6 +169,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v27/mod.rs b/client/src/client_sync/v27/mod.rs
@@ -165,6 +165,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v28/mod.rs b/client/src/client_sync/v28/mod.rs
@@ -167,6 +167,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/client/src/client_sync/v29/mod.rs b/client/src/client_sync/v29/mod.rs
@@ -167,6 +167,7 @@ crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
diff --git a/integration_test/tests/wallet.rs b/integration_test/tests/wallet.rs
@@ -566,6 +566,23 @@ fn wallet__unload_wallet() {
     create_load_unload_wallet();
 }
 
+#[cfg(not(feature = "v20_and_below"))]
+#[test]
+fn wallet__send__modelled() {
+    use std::collections::BTreeMap;
+
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+    let address = node.client.new_address().expect("failed to create new address");
+
+    let mut outputs = BTreeMap::new();
+    outputs.insert(address.to_string(), 0.001);
+
+    let json: Send = node.client.send(&outputs).expect("send");
+    let model: Result<mtype::Send, SendError> = json.into_model();
+    model.unwrap();
+}
+
 #[test]
 fn wallet__send_to_address__modelled() {
     let node = Node::with_wallet(Wallet::Default, &[]);
diff --git a/types/src/model/mod.rs b/types/src/model/mod.rs
@@ -59,7 +59,7 @@ pub use self::{
         ListLockUnspent, ListLockUnspentItem, ListReceivedByAddress, ListReceivedByAddressItem,
         ListReceivedByLabel, ListReceivedByLabelItem, ListSinceBlock, ListSinceBlockTransaction,
         ListTransactions, ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets,
-        LoadWallet, RescanBlockchain, ScriptType, SendMany, SendToAddress, SignMessage,
+        LoadWallet, RescanBlockchain, ScriptType, Send, SendMany, SendToAddress, SignMessage,
         TransactionCategory, UnloadWallet, WalletCreateFundedPsbt, WalletProcessPsbt,
     },
 };
diff --git a/types/src/model/wallet.rs b/types/src/model/wallet.rs
@@ -722,6 +722,21 @@ pub struct RescanBlockchain {
     pub stop_height: u32,
 }
 
+/// Models the result of JSON-RPC method `send`.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Send {
+    /// If the transaction has a complete set of signatures.
+    pub complete: bool,
+    /// The transaction id for the send.
+    pub txid: Option<Txid>,
+    /// If add_to_wallet is false, the hex-encoded raw transaction with signature(s).
+    pub hex: Option<Transaction>,
+    /// If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially)
+    /// signed transaction.
+    pub psbt: Option<Psbt>,
+}
+
 /// Models the result of JSON-RPC method `sendmany`.
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
diff --git a/types/src/v21/mod.rs b/types/src/v21/mod.rs
@@ -203,7 +203,7 @@
 //! | lockunspent                        | version         |                                        |
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
 //! | sethdseed                          | returns nothing |                                        |
@@ -247,7 +247,7 @@ pub use self::{
     generating::{GenerateBlock, GenerateBlockError},
     network::{GetNetworkInfo, GetPeerInfo},
     util::{GetIndexInfo, GetIndexInfoName},
-    wallet::{ImportDescriptors, ImportDescriptorsResult, UnloadWallet},
+    wallet::{ImportDescriptors, ImportDescriptorsResult, Send, SendError, UnloadWallet},
 };
 #[doc(inline)]
 pub use crate::{
diff --git a/types/src/v21/wallet/error.rs b/types/src/v21/wallet/error.rs
@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use core::fmt;
+
+use bitcoin::consensus::encode;
+use bitcoin::hex;
+use bitcoin::psbt::PsbtParseError;
+
+use crate::error::write_err;
+use crate::NumericError;
+
+/// Error when converting a `Send` type into the model type.
+#[derive(Debug)]
+pub enum SendError {
+    /// Conversion of the `txid` field failed.
+    Txid(hex::HexToArrayError),
+    /// Conversion of the `hex` field failed.
+    Hex(encode::FromHexError),
+    /// Conversion of the `psbt` field failed.
+    Psbt(PsbtParseError),
+    /// Conversion of numeric type to expected type failed.
+    Numeric(NumericError),
+}
+
+impl fmt::Display for SendError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use SendError as E;
+
+        match *self {
+            E::Txid(ref e) => write_err!(f, "conversion of the `txid` field failed"; e),
+            E::Hex(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
+            E::Psbt(ref e) => write_err!(f, "conversion of the `psbt` field failed"; e),
+            E::Numeric(ref e) => write_err!(f, "numeric"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for SendError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use SendError as E;
+
+        match *self {
+            E::Txid(ref e) => Some(e),
+            E::Hex(ref e) => Some(e),
+            E::Psbt(ref e) => Some(e),
+            E::Numeric(ref e) => Some(e),
+        }
+    }
+}
+
+impl From<NumericError> for SendError {
+    fn from(e: NumericError) -> Self { Self::Numeric(e) }
+}
diff --git a/types/src/v21/wallet/into.rs b/types/src/v21/wallet/into.rs
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: CC0-1.0
 
-use super::UnloadWallet;
+use super::{Send, SendError, UnloadWallet};
 use crate::model;
 
 impl UnloadWallet {
@@ -9,3 +9,23 @@ impl UnloadWallet {
         model::UnloadWallet { warnings: vec![self.warning] }
     }
 }
+
+impl Send {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::Send, SendError> {
+        use SendError as E;
+
+        let txid = self.txid.as_ref().map(|s| s.parse()).transpose().map_err(E::Txid)?;
+
+        let hex = self
+            .hex
+            .as_ref()
+            .map(|h| bitcoin::consensus::encode::deserialize_hex(h))
+            .transpose()
+            .map_err(E::Hex)?;
+
+        let psbt = self.psbt.as_ref().map(|p| p.parse()).transpose().map_err(E::Psbt)?;
+
+        Ok(model::Send { complete: self.complete, txid, hex, psbt })
+    }
+}
diff --git a/types/src/v21/wallet/mod.rs b/types/src/v21/wallet/mod.rs
@@ -4,10 +4,13 @@
 //!
 //! Types for methods found under the `== Wallet ==` section of the API docs.
 
+mod error;
 mod into;
 
 use serde::{Deserialize, Serialize};
 
+pub use self::error::SendError;
+
 /// Result of JSON-RPC method `importdescriptors`.
 ///
 /// > Import descriptors. This will trigger a rescan of the blockchain based on the earliest
@@ -61,6 +64,29 @@ pub struct ImportDescriptorsResult {
     pub error: Option<serde_json::Value>,
 }
 
+/// Result of JSON-RPC method `send`.
+///
+/// > EXPERIMENTAL warning: this call may be changed in future releases.
+/// >
+/// > Send a transaction.
+/// >
+/// > Arguments:
+/// > 1. outputs (json array, required) The outputs (key-value pairs), where none of the keys are duplicated.
+/// >    That is, each address can only appear once and there can only be one 'data' object.
+/// >    For convenience, a dictionary, which holds the key-value pairs directly, is also accepted.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Send {
+    /// If the transaction has a complete set of signatures.
+    pub complete: bool,
+    /// The transaction id for the send.
+    pub txid: Option<String>,
+    /// If add_to_wallet is false, the hex-encoded raw transaction with signature(s).
+    pub hex: Option<String>,
+    /// If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially) signed transaction.
+    pub psbt: Option<String>,
+}
+
 /// Result of the JSON-RPC method `unloadwallet`.
 ///
 /// > unloadwallet ( "wallet_name" load_on_startup )
diff --git a/types/src/v22/mod.rs b/types/src/v22/mod.rs
@@ -213,7 +213,7 @@
 //! | lockunspent                        | version         |                                        |
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
 //! | sethdseed                          | returns nothing |                                        |
@@ -308,7 +308,7 @@ pub use crate::{
     v21::{
         Bip9SoftforkInfo, GenerateBlock, GenerateBlockError, GetBlockchainInfo, GetIndexInfo,
         GetIndexInfoName, GetMempoolEntry, GetNetworkInfo, ImportDescriptors,
-        ImportDescriptorsResult, Softfork, SoftforkType, UnloadWallet,
+        ImportDescriptorsResult, Send, SendError, Softfork, SoftforkType, UnloadWallet,
     },
     ScriptPubkey,
 };
diff --git a/types/src/v23/mod.rs b/types/src/v23/mod.rs
@@ -206,7 +206,7 @@
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
 //! | restorewallet                      | version + model | TODO                                   |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
 //! | sethdseed                          | returns nothing |                                        |
@@ -307,7 +307,7 @@ pub use crate::{
     v20::{GenerateToDescriptor, GetTransactionDetail},
     v21::{
         GenerateBlock, GenerateBlockError, GetIndexInfo, GetIndexInfoName, GetNetworkInfo,
-        ImportDescriptors, ImportDescriptorsResult, UnloadWallet,
+        ImportDescriptors, ImportDescriptorsResult, Send, SendError, UnloadWallet,
     },
     v22::{Banned, GetMempoolInfo, ListBanned, ScriptPubkey},
 };
diff --git a/types/src/v24/mod.rs b/types/src/v24/mod.rs
@@ -208,7 +208,7 @@
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
 //! | restorewallet                      | version + model | TODO                                   |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendall                            | version + model | TODO                                   |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
@@ -308,7 +308,7 @@ pub use crate::{
     v20::GenerateToDescriptor,
     v21::{
         GenerateBlock, GenerateBlockError, GetIndexInfo, GetIndexInfoName, GetNetworkInfo,
-        ImportDescriptors, ImportDescriptorsResult, UnloadWallet,
+        ImportDescriptors, ImportDescriptorsResult, Send, SendError, UnloadWallet,
     },
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{
diff --git a/types/src/v25/mod.rs b/types/src/v25/mod.rs
@@ -209,7 +209,7 @@
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
 //! | restorewallet                      | version + model | TODO                                   |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendall                            | version + model | TODO                                   |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
@@ -303,6 +303,7 @@ pub use crate::{
     v20::GenerateToDescriptor,
     v21::{
         GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
+        Send, SendError,
     },
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
diff --git a/types/src/v26/mod.rs b/types/src/v26/mod.rs
@@ -217,7 +217,7 @@
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
 //! | restorewallet                      | version + model | TODO                                   |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendall                            | version + model | TODO                                   |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
@@ -321,6 +321,7 @@ pub use crate::{
     v20::GenerateToDescriptor,
     v21::{
         GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
+        Send, SendError,
     },
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
diff --git a/types/src/v27/mod.rs b/types/src/v27/mod.rs
@@ -217,7 +217,7 @@
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
 //! | restorewallet                      | version + model | TODO                                   |
-//! | send                               | version + model | TODO                                   |
+//! | send                               | version + model |                                        |
 //! | sendall                            | version + model | TODO                                   |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
@@ -298,6 +298,7 @@ pub use crate::{
     v20::GenerateToDescriptor,
     v21::{
         GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
+        Send, SendError,
     },
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
diff --git a/types/src/v28/mod.rs b/types/src/v28/mod.rs
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs
