Merge #364: Type alias SignRawTransaction

5b3fbcd Run the formatter (Jamil Lambert, PhD)
c84e07d Use the type alias of SignRawTransaction (Jamil Lambert, PhD)
e0f1311 Type alias SignRawTransaction (Jamil Lambert, PhD)

Pull request description:

  Both `signrawtransactionwithkey` and `signrawtransactionwithwallet` use the type `SignRawTransaction` in types and model. But the policy is to have a type for all RPCs with the same name, this makes everything uniform and easier to use without having to search for the correct type.

  - Add aliases for these two RPC methods and a note in the docs explaining why.
  - Use the new aliases in the tests.
  - Run the formatter. Reordering reexports only.

  Closes #357

ACKs for top commit:
  tcharding:
    ACK 5b3fbcd

Tree-SHA512: 9d8f7b29946c9fcbf91c064fc7ee0e96e2439b9c93b68b2c77b855984eead90501ae838ca61c8d10244e0cc5f580d305a5407ffc2d4f9aab91a3445cd3041d15

Author: tcharding

client/src/client_sync/v17/raw_transactions.rs

@@ -213,7 +213,7 @@ macro_rules! impl_client_v17__sign_raw_transaction_with_key {
                 &self,
                 tx: &bitcoin::Transaction,
                 keys: &[bitcoin::PrivateKey],
-            ) -> Result<SignRawTransaction> {
+            ) -> Result<SignRawTransactionWithKey> {
                 let hex = bitcoin::consensus::encode::serialize_hex(tx);
                 let keys = keys.iter().map(|k| format!("{}", k)).collect::<Vec<String>>();
                 self.call("signrawtransactionwithkey", &[hex.into(), into_json(keys)?])

client/src/client_sync/v17/wallet.rs

@@ -660,7 +660,7 @@ macro_rules! impl_client_v17__sign_raw_transaction_with_wallet {
             pub fn sign_raw_transaction_with_wallet(
                 &self,
                 tx: &bitcoin::Transaction,
-            ) -> Result<SignRawTransaction> {
+            ) -> Result<SignRawTransactionWithWallet> {
                 let hex = bitcoin::consensus::encode::serialize_hex(tx);
                 self.call("signrawtransactionwithwallet", &[into_json(hex)?])
             }

integration_test/tests/raw_transactions.rs

@@ -399,9 +399,9 @@ fn raw_transactions__test_mempool_accept__modelled() {
     let tx = create_a_raw_transaction(&node);
 
     // Sign (but don't broadcast).
-    let signed: SignRawTransaction =
+    let signed: SignRawTransactionWithWallet =
         node.client.sign_raw_transaction_with_wallet(&tx).expect("signrawtransactionwithwallet");
-    let signed_model: mtype::SignRawTransaction =
+    let signed_model: mtype::SignRawTransactionWithWallet =
         signed.into_model().expect("SignRawTransaction into model");
     let signed_tx = signed_model.tx;
 
@@ -474,10 +474,11 @@ fn create_sign_send(node: &Node) {
 
     // wallet.rs expects this call to exist, if you change it then you'll need to update the test
     // `wallet__sign_raw_transaction_with_wallet__modelled`.
-    let json: SignRawTransaction =
+    let json: SignRawTransactionWithWallet =
         node.client.sign_raw_transaction_with_wallet(&tx).expect("signrawtransactionwithwallet");
 
-    let model: Result<mtype::SignRawTransaction, SignRawTransactionError> = json.into_model();
+    let model: Result<mtype::SignRawTransactionWithWallet, SignRawTransactionError> =
+        json.into_model();
     let sign_raw_transaction = model.unwrap();
 
     // The proves we did everything correctly.
@@ -533,9 +534,10 @@ fn create_sign_with_key_send(node: &Node) {
     let model: mtype::DumpPrivKey = json.into_model().expect("DumpPrivKey");
     let key = model.0;
 
-    let json: SignRawTransaction =
+    let json: SignRawTransactionWithKey =
         node.client.sign_raw_transaction_with_key(&tx, &[key]).expect("signrawtransactionwithkey");
-    let model: Result<mtype::SignRawTransaction, SignRawTransactionError> = json.into_model();
+    let model: Result<mtype::SignRawTransactionWithKey, SignRawTransactionError> =
+        json.into_model();
     let sign_raw_transaction = model.unwrap();
 
     // The proves we did everything correctly.
@@ -580,12 +582,13 @@ fn create_fund_sign_send(node: &Node) {
     let funded = json.transaction().unwrap();
 
     // This method is from the wallet section.
-    let json: SignRawTransaction = node
+    let json: SignRawTransactionWithWallet = node
         .client
         .sign_raw_transaction_with_wallet(&funded)
         .expect("signrawtransactionwithwallet");
     // This proves we did everything correctly.
-    let model: Result<mtype::SignRawTransaction, SignRawTransactionError> = json.into_model();
+    let model: Result<mtype::SignRawTransactionWithWallet, SignRawTransactionError> =
+        json.into_model();
     let sign_raw_transaction = model.unwrap();
     let _ =
         node.client.send_raw_transaction(&sign_raw_transaction.tx).expect("createrawtransaction");

types/src/model/mod.rs

@@ -43,8 +43,8 @@ pub use self::{
         ConvertToPsbt, CreatePsbt, CreateRawTransaction, DecodePsbt, DecodeRawTransaction,
         DecodeScript, DescriptorProcessPsbt, FinalizePsbt, FundRawTransaction, GetRawTransaction,
         GetRawTransactionVerbose, JoinPsbts, MempoolAcceptance, MempoolAcceptanceFees,
-        SendRawTransaction, SignFail, SignRawTransaction, SubmitPackage, SubmitPackageTxResult,
-        SubmitPackageTxResultFees, TestMempoolAccept, UtxoUpdatePsbt,
+        SendRawTransaction, SignFail, SignRawTransaction, SignRawTransactionWithKey, SubmitPackage,
+        SubmitPackageTxResult, SubmitPackageTxResultFees, TestMempoolAccept, UtxoUpdatePsbt,
     },
     util::{
         CreateMultisig, DeriveAddresses, DeriveAddressesMultipath, EstimateSmartFee,
@@ -61,7 +61,7 @@ pub use self::{
         ListReceivedByLabel, ListReceivedByLabelItem, ListSinceBlock, ListTransactions,
         ListUnspent, ListUnspentItem, ListWallets, LoadWallet, PsbtBumpFee, RescanBlockchain,
         ScriptType, Send, SendAll, SendMany, SendManyVerbose, SendToAddress, SignMessage,
-        SimulateRawTransaction, TransactionCategory, TransactionItem, UnloadWallet,
-        WalletCreateFundedPsbt, WalletDisplayAddress, WalletProcessPsbt,
+        SignRawTransactionWithWallet, SimulateRawTransaction, TransactionCategory, TransactionItem,
+        UnloadWallet, WalletCreateFundedPsbt, WalletDisplayAddress, WalletProcessPsbt,
     },
 };

types/src/model/raw_transactions.rs

@@ -202,6 +202,12 @@ pub struct SignRawTransaction {
     pub errors: Vec<SignFail>,
 }
 
+/// Models the result of JSON-RPC method `signrawtransactionwithkey`.
+///
+/// **Note:** This is a type alias of [`SignRawTransaction`] because the RPC response
+/// shape is identical, and our policy is to have a return type for every RPC method.
+pub type SignRawTransactionWithKey = SignRawTransaction;
+
 /// A script verification error. Part of `signrawtransaction`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]

types/src/model/wallet.rs

@@ -16,6 +16,8 @@ use bitcoin::{
 };
 use serde::{Deserialize, Serialize};
 
+use super::SignRawTransaction;
+
 /// The purpose of an address. Part of `getaddressesbylabel`.
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 pub enum AddressPurpose {
@@ -828,6 +830,12 @@ pub struct SendToAddress {
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct SignMessage(pub sign_message::MessageSignature);
 
+/// Models the result of JSON-RPC method `signrawtransactionwithwallet`.
+///
+/// **Note:** This is a type alias of [`SignRawTransaction`] because the RPC response
+/// shape is identical, and our policy is to have a return type for every RPC method.
+pub type SignRawTransactionWithWallet = SignRawTransaction;
+
 /// Models the result of JSON-RPC method `simulaterawtransaction`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]

types/src/v17/mod.rs

@@ -264,7 +264,7 @@ pub use self::{
         GetRawTransaction, GetRawTransactionVerbose, GetRawTransactionVerboseError,
         MempoolAcceptance, PsbtInput, PsbtInputError, PsbtOutput, PsbtOutputError,
         SendRawTransaction, SignFail, SignFailError, SignRawTransaction, SignRawTransactionError,
-        TestMempoolAccept,
+        SignRawTransactionWithKey, TestMempoolAccept,
     },
     util::{
         CreateMultisig, CreateMultisigError, EstimateSmartFee, SignMessageWithPrivKey,
@@ -283,8 +283,9 @@ pub use self::{
         ListReceivedByAddressError, ListReceivedByAddressItem, ListSinceBlock, ListSinceBlockError,
         ListTransactions, ListUnspent, ListUnspentItem, ListUnspentItemError, ListWallets,
         LoadWallet, LockUnspent, RescanBlockchain, ScriptType, SendMany, SendToAddress, SetTxFee,
-        SignMessage, TransactionCategory, TransactionItem, TransactionItemError,
-        WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
+        SignMessage, SignRawTransactionWithWallet, TransactionCategory, TransactionItem,
+        TransactionItemError, WalletCreateFundedPsbt, WalletCreateFundedPsbtError,
+        WalletProcessPsbt,
     },
     zmq::GetZmqNotifications,
 };

types/src/v17/raw_transactions/mod.rs

@@ -396,7 +396,7 @@ pub struct SendRawTransaction(
     pub String,
 );
 
-/// Result of JSON-RPC method `signrawtransactionwithkey` (and deprecated `signrawtransaction`).
+/// Result of JSON-RPC method `signrawtransaction`.
 ///
 /// > signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )
 /// >
@@ -420,6 +420,24 @@ pub struct SignRawTransaction {
     pub errors: Option<Vec<SignFail>>,
 }
 
+/// Result of JSON-RPC method `signrawtransactionwithkey`.
+///
+/// > signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )
+/// >
+/// > Sign inputs for raw transaction (serialized, hex-encoded).
+/// > The second argument is an array of base58-encoded private
+/// > keys that will be the only keys used to sign the transaction.
+/// > The third optional argument (may be null) is an array of previous transaction outputs that
+/// > this transaction depends on but may not yet be in the block chain.
+/// >
+/// > Arguments:
+/// > 1. "hexstring"                      (string, required) The transaction hex string
+/// > 2. "privkeys"                       (string, required) A json array of base58-encoded private keys for signing
+///
+/// **Note:** This is a type alias of [`SignRawTransaction`] because the RPC response
+/// shape is identical, and our policy is to have a return type for every RPC method.
+pub type SignRawTransactionWithKey = SignRawTransaction;
+
 /// A script verification error. Part of `signrawtransaction`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]

types/src/v17/wallet/mod.rs

@@ -16,6 +16,7 @@ use serde::{Deserialize, Serialize};
 
 // TODO: Remove wildcard, use explicit types.
 pub use self::error::*;
+use super::SignRawTransaction;
 
 /// Result of JSON-RPC method `abortrescan`.
 ///
@@ -961,6 +962,21 @@ pub struct SignMessage(
     pub String,
 );
 
+/// Result of JSON-RPC method `signrawtransactionwithwallet`.
+///
+/// > signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )
+/// >
+/// > Sign inputs for raw transaction (serialized, hex-encoded).
+/// > The second optional argument (may be null) is an array of previous transaction outputs that
+/// > this transaction depends on but may not yet be in the block chain.
+/// >
+/// > Arguments:
+/// > 1. "hexstring"                      (string, required) The transaction hex string
+///
+/// **Note:** This is a type alias of [`SignRawTransaction`] because the RPC response
+/// shape is identical, and our policy is to have a return type for every RPC method.
+pub type SignRawTransactionWithWallet = SignRawTransaction;
+
 /// Result of the JSON-RPC method `walletcreatefundedpsbt`.
 ///
 /// > walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs )

types/src/v18/mod.rs

@@ -281,8 +281,9 @@ pub use crate::v17::{
     PsbtScript, RawTransaction, RawTransactionError, RawTransactionInput, RawTransactionOutput,
     RescanBlockchain, ScriptType, SendMany, SendRawTransaction, SendToAddress, SetNetworkActive,
     SetTxFee, SignFail, SignFailError, SignMessage, SignMessageWithPrivKey, SignRawTransaction,
-    SignRawTransactionError, Softfork, SoftforkReject, TestMempoolAccept, TransactionCategory,
-    TransactionItem, TransactionItemError, UploadTarget, ValidateAddress, ValidateAddressError,
-    VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
-    WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+    SignRawTransactionError, SignRawTransactionWithKey, SignRawTransactionWithWallet, Softfork,
+    SoftforkReject, TestMempoolAccept, TransactionCategory, TransactionItem, TransactionItemError,
+    UploadTarget, ValidateAddress, ValidateAddressError, VerifyChain, VerifyMessage,
+    VerifyTxOutProof, WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
+    WitnessUtxo,
 };