Type alias SignRawTransaction

Both `signrawtransactionwithkey` and `signrawtransactionwithwallet`
use the type `SignRawTransaction` in types and model.

Add aliases for these two RPC methods and a note in the docs explaining
why.

Author: jamillambert

types/src/model/mod.rs

@@ -44,7 +44,7 @@ pub use self::{
         DecodeScript, DescriptorProcessPsbt, FinalizePsbt, FundRawTransaction, GetRawTransaction,
         GetRawTransactionVerbose, JoinPsbts, MempoolAcceptance, MempoolAcceptanceFees,
         SendRawTransaction, SignFail, SignRawTransaction, SubmitPackage, SubmitPackageTxResult,
-        SubmitPackageTxResultFees, TestMempoolAccept, UtxoUpdatePsbt,
+        SubmitPackageTxResultFees, TestMempoolAccept, UtxoUpdatePsbt, SignRawTransactionWithKey,
     },
     util::{
         CreateMultisig, DeriveAddresses, DeriveAddressesMultipath, EstimateSmartFee,
@@ -62,6 +62,6 @@ pub use self::{
         ListUnspent, ListUnspentItem, ListWallets, LoadWallet, PsbtBumpFee, RescanBlockchain,
         ScriptType, Send, SendAll, SendMany, SendManyVerbose, SendToAddress, SignMessage,
         SimulateRawTransaction, TransactionCategory, TransactionItem, UnloadWallet,
-        WalletCreateFundedPsbt, WalletDisplayAddress, WalletProcessPsbt,
+        WalletCreateFundedPsbt, WalletDisplayAddress, WalletProcessPsbt, SignRawTransactionWithWallet,
     },
 };

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,
+        TestMempoolAccept, SignRawTransactionWithKey,
     },
     util::{
         CreateMultisig, CreateMultisigError, EstimateSmartFee, SignMessageWithPrivKey,
@@ -285,6 +285,7 @@ pub use self::{
         LoadWallet, LockUnspent, RescanBlockchain, ScriptType, SendMany, SendToAddress, SetTxFee,
         SignMessage, TransactionCategory, TransactionItem, TransactionItemError,
         WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
+        SignRawTransactionWithWallet,
     },
     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

@@ -285,4 +285,5 @@ pub use crate::v17::{
     TransactionItem, TransactionItemError, UploadTarget, ValidateAddress, ValidateAddressError,
     VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
     WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+    SignRawTransactionWithKey, SignRawTransactionWithWallet,
 };

types/src/v19/mod.rs

@@ -279,6 +279,7 @@ pub use crate::v17::{
     TestMempoolAccept, TransactionCategory, TransactionItem, TransactionItemError, UploadTarget,
     ValidateAddress, ValidateAddressError, VerifyChain, VerifyMessage, VerifyTxOutProof,
     WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+    SignRawTransactionWithKey, SignRawTransactionWithWallet,
 };
 #[doc(inline)]
 pub use crate::v18::{

types/src/v20/mod.rs

@@ -273,7 +273,7 @@ pub use crate::{
         SignRawTransactionError, SoftforkReject, TestMempoolAccept, TransactionCategory,
         UploadTarget, ValidateAddress, ValidateAddressError, VerifyChain, VerifyMessage,
         VerifyTxOutProof, WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
-        WitnessUtxo,
+        WitnessUtxo, SignRawTransactionWithKey, SignRawTransactionWithWallet,
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,

types/src/v21/mod.rs

@@ -289,6 +289,7 @@ pub use crate::{
         SoftforkReject, TransactionCategory, UploadTarget, ValidateAddress, ValidateAddressError,
         VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
         WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+        SignRawTransactionWithKey, SignRawTransactionWithWallet,
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,