Merge #306: Make serde renames consistent

tcharding · tcharding · commit 5e29ee611921 · 2025-07-22T15:05:53.000+10:00
e93eae9 Make serde renames consistent (Jamil Lambert, PhD) Pull request description: Some of the renaming of the rpc returned fields was inconsistent. Go through them all and make them them consistent. Fixes the issue #298, but not closing it with this PR since there is an open PR that is also affected. ACKs for top commit: jrakibi: ACK e93eae9 tcharding: ACK e93eae9 Tree-SHA512: 6050baa9faafeac6f14b18ea28d24c5d932ac140b2673f40195335332656c84aa46993031d93df10c4795e4539c086f2fc8328cf192f6110f70e80f807be8a30
diff --git a/client/src/client_sync/v17/mod.rs b/client/src/client_sync/v17/mod.rs
@@ -262,8 +262,8 @@ pub enum SetBanCommand {
 #[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
 pub struct ImportMultiRequest {
     /// Descriptor to import. If using descriptor, donot also provide address/scriptPubKey, scripts, or pubkeys.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub desc: Option<String>, // from core v18 onwards.
+    #[serde(rename = "desc", skip_serializing_if = "Option::is_none")]
+    pub descriptor: Option<String>, // from core v18 onwards.
     /// Type of scriptPubKey (string for script, json for address). Should not be provided if using descriptor.
     #[serde(rename = "scriptPubKey", skip_serializing_if = "Option::is_none")]
     pub script_pubkey: Option<ImportMultiScriptPubKey>,
diff --git a/client/src/client_sync/v21/mod.rs b/client/src/client_sync/v21/mod.rs
@@ -188,7 +188,8 @@ crate::impl_client_v17__wallet_process_psbt!();
 #[serde(deny_unknown_fields)]
 pub struct ImportDescriptorsRequest {
     /// Descriptor to import.
-    pub desc: String,
+    #[serde(rename = "desc")]
+    pub descriptor: String,
     /// Time from which to start rescanning the blockchain for this descriptor, in UNIX epoch time or "now".
     pub timestamp: serde_json::Value,
 }
diff --git a/integration_test/tests/wallet.rs b/integration_test/tests/wallet.rs
@@ -323,7 +323,7 @@ fn wallet__import_descriptors() {
     let descriptor = format!("addr({})", address);
 
     let request = ImportDescriptorsRequest {
-        desc: descriptor,
+        descriptor,
         timestamp: serde_json::Value::String("now".to_string()),
     };
 
@@ -413,14 +413,14 @@ fn wallet__import_multi() {
     // NOTE: On v17, use a wallet-generated address (not raw script)
     // to ensure import succeeds, since the wallet already knows the key.
     let req1 = ImportMultiRequest {
-        desc: None,
+        descriptor: None,
         script_pubkey: Some(ImportMultiScriptPubKey::Script(dummy_script_hex.to_string())),
         timestamp: ImportMultiTimestamp::Now,
     };
 
     // Uses an address (valid): success - false, with JSON-RPC error.
     let req2 = ImportMultiRequest {
-        desc: None,
+        descriptor: None,
         script_pubkey: Some(ImportMultiScriptPubKey::Address {
             address: addr.to_string(),
         }),
@@ -431,7 +431,7 @@ fn wallet__import_multi() {
     // on v18 onwards, it will return a watch-only warning.
     // NOTE: Works only for v18 onwards, as v17 doesn't support descriptors.
     let req3 = ImportMultiRequest {
-        desc: Some(dummy_desc.to_string()),
+        descriptor: Some(dummy_desc.to_string()),
         script_pubkey: None,
         timestamp: ImportMultiTimestamp::Time(1_700_000_000),
     };
diff --git a/types/src/lib.rs b/types/src/lib.rs
@@ -194,7 +194,7 @@ pub struct ScriptPubkey {
     /// Only returned before in versions prior to 22 or for version 22 onwards if
     /// config option `-deprecatedrpc=addresses` is passed.
     #[serde(rename = "reqSigs")]
-    pub req_sigs: Option<i64>,
+    pub required_signatures: Option<i64>,
     /// The type, eg pubkeyhash.
     #[serde(rename = "type")]
     pub type_: String,
diff --git a/types/src/model/wallet.rs b/types/src/model/wallet.rs
@@ -362,7 +362,7 @@ pub struct GetTransaction {
 #[serde(deny_unknown_fields)]
 pub struct GetTransactionDetail {
     /// Only returns true if imported addresses were involved in transaction. v20 and later only.
-    pub involves_watchonly: Option<bool>,
+    pub involves_watch_only: Option<bool>,
     /// DEPRECATED. The account name involved in the transaction, can be "" for the default account.
     pub account: Option<String>, // Docs are wrong, this is not documented as optional.
     /// The bitcoin address involved in the transaction.
@@ -787,7 +787,7 @@ pub struct WalletCreateFundedPsbt {
     #[serde(default, with = "bitcoin::amount::serde::as_btc")]
     pub fee: SignedAmount,
     /// The position of the added change output, or -1.
-    pub change_pos: u32,
+    pub change_position: u32,
 }
 
 /// Models the result of JSON-RPC method `walletdisplayaddress`.
diff --git a/types/src/psbt/mod.rs b/types/src/psbt/mod.rs
@@ -173,7 +173,7 @@ pub struct PsbtScript {
     pub hex: String,
     /// The type, eg 'pubkeyhash'.
     #[serde(rename = "type")]
-    pub script_type: String,
+    pub type_: String,
 }
 
 impl PsbtScript {
diff --git a/types/src/v17/raw_transactions/mod.rs b/types/src/v17/raw_transactions/mod.rs
@@ -253,7 +253,7 @@ pub struct DecodeScriptSegwit {
     pub addresses: Option<Vec<String>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segtwit: Option<String>,
+    pub p2sh_segwit: Option<String>,
 }
 
 /// Result of JSON-RPC method `finalizepsbt`.
diff --git a/types/src/v17/wallet/into.rs b/types/src/v17/wallet/into.rs
@@ -390,7 +390,7 @@ impl GetTransactionDetail {
         let fee = self.fee.map(|fee| SignedAmount::from_btc(fee).map_err(E::Fee)).transpose()?;
 
         Ok(model::GetTransactionDetail {
-            involves_watchonly: None, // v20 and later only.
+            involves_watch_only: None, // v20 and later only.
             account: self.account,
             address,
             category: self.category.into_model(),
@@ -742,8 +742,8 @@ impl WalletCreateFundedPsbt {
 
         let psbt = self.psbt.parse::<Psbt>().map_err(E::Psbt)?;
         let fee = SignedAmount::from_btc(self.fee).map_err(E::Fee)?;
-        let change_pos = crate::to_u32(self.change_pos, "change_pos")?;
-        Ok(model::WalletCreateFundedPsbt { psbt, fee, change_pos })
+        let change_position = crate::to_u32(self.change_position, "change_position")?;
+        Ok(model::WalletCreateFundedPsbt { psbt, fee, change_position })
     }
 }
 
diff --git a/types/src/v17/wallet/mod.rs b/types/src/v17/wallet/mod.rs
@@ -1056,7 +1056,7 @@ pub struct WalletCreateFundedPsbt {
     pub fee: f64,
     /// The position of the added change output, or -1.
     #[serde(rename = "changepos")]
-    pub change_pos: i64,
+    pub change_position: i64,
 }
 
 /// Result of the JSON-RPC method `walletprocesspsbt`.
diff --git a/types/src/v20/wallet/into.rs b/types/src/v20/wallet/into.rs
@@ -72,7 +72,7 @@ impl GetTransactionDetail {
         let fee = self.fee.map(|fee| SignedAmount::from_btc(fee).map_err(E::Fee)).transpose()?;
 
         Ok(model::GetTransactionDetail {
-            involves_watchonly: self.involves_watchonly,
+            involves_watch_only: self.involves_watch_only,
             account: self.account,
             address,
             category: self.category.into_model(),
diff --git a/types/src/v20/wallet/mod.rs b/types/src/v20/wallet/mod.rs
@@ -77,7 +77,7 @@ pub struct GetTransaction {
 pub struct GetTransactionDetail {
     /// Only returns true if imported addresses were involved in transaction. v20 and later only.
     #[serde(rename = "involvesWatchonly")]
-    pub involves_watchonly: Option<bool>,
+    pub involves_watch_only: Option<bool>,
     /// DEPRECATED. The account name involved in the transaction, can be "" for the default account.
     pub account: Option<String>, // Docs are wrong, this is not documented as optional.
     /// The bitcoin address involved in the transaction.
diff --git a/types/src/v21/network/mod.rs b/types/src/v21/network/mod.rs
@@ -152,9 +152,11 @@ pub struct PeerInfo {
     pub inflight: Vec<u64>,
     /// The total number of addresses processed, excluding those dropped due to rate limiting. v21 and
     /// later only.
-    pub addr_processed: usize,
+    #[serde(rename = "addr_processed")]
+    pub addresses_processed: usize,
     /// The total number of addresses dropped due to rate limiting. v21 and later only.
-    pub addr_rate_limited: usize,
+    #[serde(rename = "addr_rate_limited")]
+    pub addresses_rate_limited: usize,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
     /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
diff --git a/types/src/v22/network.rs b/types/src/v22/network.rs
@@ -126,9 +126,11 @@ pub struct PeerInfo {
     pub inflight: Vec<u64>,
     /// The total number of addresses processed, excluding those dropped due to rate limiting. v21 and
     /// later only.
-    pub addr_processed: usize,
+    #[serde(rename = "addr_processed")]
+    pub addresses_processed: usize,
     /// The total number of addresses dropped due to rate limiting. v21 and later only.
-    pub addr_rate_limited: usize,
+    #[serde(rename = "addr_rate_limited")]
+    pub addresses_rate_limited: usize,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
     /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
diff --git a/types/src/v22/raw_transactions/mod.rs b/types/src/v22/raw_transactions/mod.rs
@@ -64,5 +64,5 @@ pub struct DecodeScriptSegwit {
     pub addresses: Option<Vec<String>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segtwit: Option<String>,
+    pub p2sh_segwit: Option<String>,
 }
diff --git a/types/src/v23/network.rs b/types/src/v23/network.rs
@@ -100,12 +100,15 @@ pub struct PeerInfo {
     /// The heights of blocks we're currently asking from this peer.
     pub inflight: Option<Vec<u64>>,
     /// Whether we participate in address relay with this peer. v23 and later only.
-    pub addr_relay_enabled: Option<bool>,
+    #[serde(rename = "addr_relay_enabled")]
+    pub addresses_relay_enabled: Option<bool>,
     /// The total number of addresses processed, excluding those dropped due to rate limiting. v21 and
     /// later only.
-    pub addr_processed: Option<usize>,
+    #[serde(rename = "addr_processed")]
+    pub addresses_processed: Option<usize>,
     /// The total number of addresses dropped due to rate limiting. v21 and later only.
-    pub addr_rate_limited: Option<usize>,
+    #[serde(rename = "addr_rate_limited")]
+    pub addresses_rate_limited: Option<usize>,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
     /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
diff --git a/types/src/v23/raw_transactions/mod.rs b/types/src/v23/raw_transactions/mod.rs
@@ -186,5 +186,5 @@ pub struct DecodeScriptSegwit {
     pub descriptor: Option<String>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segtwit: Option<String>,
+    pub p2sh_segwit: Option<String>,
 }
diff --git a/types/src/v24/network.rs b/types/src/v24/network.rs
@@ -103,12 +103,15 @@ pub struct PeerInfo {
     /// The heights of blocks we're currently asking from this peer.
     pub inflight: Option<Vec<u64>>,
     /// Whether we participate in address relay with this peer. v23 and later only.
-    pub addr_relay_enabled: Option<bool>,
+    #[serde(rename = "addr_relay_enabled")]
+    pub addresses_relay_enabled: Option<bool>,
     /// The total number of addresses processed, excluding those dropped due to rate limiting. v21 and
     /// later only.
-    pub addr_processed: Option<usize>,
+    #[serde(rename = "addr_processed")]
+    pub addresses_processed: Option<usize>,
     /// The total number of addresses dropped due to rate limiting. v21 and later only.
-    pub addr_rate_limited: Option<usize>,
+    #[serde(rename = "addr_rate_limited")]
+    pub addresses_rate_limited: Option<usize>,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
     /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
diff --git a/types/src/v24/raw_transactions/into.rs b/types/src/v24/raw_transactions/into.rs
@@ -397,8 +397,8 @@ impl TaprootScript {
 
         let script = ScriptBuf::from_hex(&self.script).map_err(E::Script)?;
 
-        let leaf_ver = self.leaf_ver as u8; // FIXME: Is this cast ok?
-        let version = LeafVersion::from_consensus(leaf_ver).map_err(E::LeafVer)?;
+        let leaf_version = self.leaf_version as u8; // FIXME: Is this cast ok?
+        let version = LeafVersion::from_consensus(leaf_version).map_err(E::LeafVer)?;
 
         let control_block = control_block(&self.control_blocks).map_err(E::ControlBlocks)?;
 
@@ -452,8 +452,8 @@ fn build_taproot_tree(leaves: Vec<TaprootLeaf>) -> Result<TapTree, TaprootLeafEr
         // Cast ok because depth can never exceed 128.
         let depth = leaf.depth as u8;
 
-        let leaf_ver = leaf.leaf_ver as u8; // FIXME: Is this cast ok?
-        let version = LeafVersion::from_consensus(leaf_ver).map_err(E::LeafVer)?;
+        let leaf_version = leaf.leaf_version as u8; // FIXME: Is this cast ok?
+        let version = LeafVersion::from_consensus(leaf_version).map_err(E::LeafVer)?;
 
         let script = ScriptBuf::from_hex(&leaf.script).map_err(E::Script)?;
 
diff --git a/types/src/v24/raw_transactions/mod.rs b/types/src/v24/raw_transactions/mod.rs
@@ -164,7 +164,8 @@ pub struct TaprootScript {
     /// A leaf script.
     pub script: String,
     /// The version number for the leaf script.
-    pub leaf_ver: u32,
+    #[serde(rename = "leaf_ver")]
+    pub leaf_version: u32,
     /// The control blocks for this script.
     pub control_blocks: Vec<String>,
 }
@@ -190,7 +191,8 @@ pub struct TaprootLeaf {
     /// The depth of this element in the tree.
     pub depth: u32,
     /// The version of this leaf.
-    pub leaf_ver: u32,
+    #[serde(rename = "leaf_ver")]
+    pub leaf_version: u32,
     /// The hex-encoded script itself.
     pub script: String,
 }
diff --git a/types/src/v24/wallet/into.rs b/types/src/v24/wallet/into.rs
@@ -82,7 +82,7 @@ impl GetTransactionDetail {
         let fee = self.fee.map(|fee| SignedAmount::from_btc(fee).map_err(E::Fee)).transpose()?;
 
         Ok(model::GetTransactionDetail {
-            involves_watchonly: self.involves_watchonly,
+            involves_watch_only: self.involves_watch_only,
             account: self.account,
             address,
             category: self.category.into_model(),
diff --git a/types/src/v24/wallet/mod.rs b/types/src/v24/wallet/mod.rs
@@ -91,7 +91,7 @@ pub struct GetTransaction {
 pub struct GetTransactionDetail {
     /// Only returns true if imported addresses were involved in transaction. v20 and later only.
     #[serde(rename = "involvesWatchonly")]
-    pub involves_watchonly: Option<bool>,
+    pub involves_watch_only: Option<bool>,
     /// DEPRECATED. The account name involved in the transaction, can be "" for the default account.
     pub account: Option<String>, // Docs are wrong, this is not documented as optional.
     /// The bitcoin address involved in the transaction.
diff --git a/types/src/v26/network.rs b/types/src/v26/network.rs
@@ -103,12 +103,15 @@ pub struct PeerInfo {
     /// The heights of blocks we're currently asking from this peer.
     pub inflight: Option<Vec<u64>>,
     /// Whether we participate in address relay with this peer. v23 and later only.
-    pub addr_relay_enabled: Option<bool>,
+    #[serde(rename = "addr_relay_enabled")]
+    pub addresses_relay_enabled: Option<bool>,
     /// The total number of addresses processed, excluding those dropped due to rate limiting. v21 and
     /// later only.
-    pub addr_processed: Option<usize>,
+    #[serde(rename = "addr_processed")]
+    pub addresses_processed: Option<usize>,
     /// The total number of addresses dropped due to rate limiting. v21 and later only.
-    pub addr_rate_limited: Option<usize>,
+    #[serde(rename = "addr_rate_limited")]
+    pub addresses_rate_limited: Option<usize>,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
     /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.

Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ pub struct PsbtScript {`
`173`	`173`	`pub hex: String,`
`174`	`174`	`/// The type, eg 'pubkeyhash'.`
`175`	`175`	`#[serde(rename = "type")]`
`176`		`- pub script_type: String,`
	`176`	`+ pub type_: String,`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`impl PsbtScript {`
Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@ pub struct DecodeScriptSegwit {`
`253`	`253`	`pub addresses: Option<Vec<String>>,`
`254`	`254`	`/// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).`
`255`	`255`	`#[serde(rename = "p2sh-segwit")]`
`256`		`- pub p2sh_segtwit: Option<String>,`
	`256`	`+ pub p2sh_segwit: Option<String>,`
`257`	`257`	`}`
`258`	`258`
`259`	`259`	/// Result of JSON-RPC method `finalizepsbt`.
Original file line number	Diff line number	Diff line change
`@@ -1056,7 +1056,7 @@ pub struct WalletCreateFundedPsbt {`
`1056`	`1056`	`pub fee: f64,`
`1057`	`1057`	`/// The position of the added change output, or -1.`
`1058`	`1058`	`#[serde(rename = "changepos")]`
`1059`		`- pub change_pos: i64,`
	`1059`	`+ pub change_position: i64,`
`1060`	`1060`	`}`
`1061`	`1061`
`1062`	`1062`	/// Result of the JSON-RPC method `walletprocesspsbt`.