Merge pull request #108 from tnull/2025-03-fix-createloadwallet-v25

Fix `{create,load}wallet` on `v25`

Author: tcharding

integration_test/tests/wallet.rs

@@ -2,8 +2,6 @@
 
 //! Tests for methods found under the `== Wallet ==` section of the API docs.
 
-#![cfg(any(feature = "0_17_1", feature = "0_18_1"))]
-
 #[cfg(feature = "TODO")]
 use bitcoin::address::{Address, NetworkChecked};
 use bitcoin::Amount;
@@ -23,6 +21,7 @@ pub fn add_multisig_address() {
     assert!(json.into_model().is_ok());
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 pub fn bump_fee() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -49,6 +48,7 @@ pub fn create_wallet() {
     // optional `String` to an optional vector of strings in v25. Needs testing.
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 pub fn dump_priv_key() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -57,6 +57,7 @@ pub fn dump_priv_key() {
     assert!(json.into_model().is_ok());
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 pub fn dump_wallet() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -65,6 +66,7 @@ pub fn dump_wallet() {
     let _ = json.into_model();
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 pub fn get_addresses_by_label() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -76,6 +78,7 @@ pub fn get_addresses_by_label() {
     assert!(map.get(&addr).is_some());
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 // TODO: Consider testing a few different address types.
 #[cfg(feature = "TODO")]
@@ -86,6 +89,7 @@ pub fn get_address_info() {
     assert!(json.into_model().is_ok());
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 fn get_balance() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -97,6 +101,7 @@ fn get_balance() {
     assert!(json.into_model().is_ok());
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 #[cfg(feature = "v19")]
 fn get_balances() {
@@ -108,6 +113,7 @@ fn get_balances() {
     assert!(model.mine.trusted > Amount::ZERO); 
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 fn get_new_address() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -132,13 +138,15 @@ fn get_new_address() {
         .unwrap();
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 fn get_raw_change_address() {
     let node = Node::with_wallet(Wallet::Default, &[]);
     let json = node.client.get_raw_change_address().expect("getrawchangeaddress");
     assert!(json.into_model().is_ok());
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 fn get_received_by_address() {
     let amount = Amount::from_sat(10_000);
@@ -160,6 +168,7 @@ fn get_received_by_address() {
     assert_eq!(model.0, amount);
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 fn get_transaction() {
     let node = Node::with_wallet(Wallet::Default, &[]);
@@ -183,6 +192,7 @@ fn load_wallet() {
     let _ = Node::with_wallet(Wallet::Default, &[]);
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 #[cfg(not(any(feature = "v17", feature = "v18", feature = "v19", feature = "v20")))]
 fn unload_wallet() {
@@ -193,6 +203,7 @@ fn unload_wallet() {
     assert!(json.into_model().is_ok())
 }
 
+#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 #[test]
 fn send_to_address() {
     let node = Node::with_wallet(Wallet::Default, &[]);

types/src/v25/wallet.rs

@@ -29,13 +29,20 @@ pub struct CreateWallet {
     ///
     /// If the wallet was created using a full path, the wallet_name will be the full path.
     pub name: String,
+    /// Warning messages, if any, related to creating the wallet. Multiple messages will be delimited by newlines.
+    ///
+    /// DEPRECATED, returned only if config option -deprecatedrpc=walletwarningfield is passed. As
+    /// the content would still be the same as `warnings`, we simply ignore the field.
+    pub warning: Option<String>,
     /// Warning messages, if any, related to creating and loading the wallet.
     pub warnings: Option<Vec<String>>,
 }
 
 impl CreateWallet {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> model::CreateWallet {
+        // As the content of the deprecated `warning` field would be the same as `warnings`, we
+        // simply ignore the field, even in case it's set.
         model::CreateWallet { name: self.name, warnings: self.warnings.unwrap_or_default() }
     }
 
@@ -58,13 +65,20 @@ impl CreateWallet {
 pub struct LoadWallet {
     /// The wallet name if loaded successfully.
     pub name: String,
+    /// Warning messages, if any, related to creating the wallet. Multiple messages will be delimited by newlines.
+    ///
+    /// DEPRECATED, returned only if config option -deprecatedrpc=walletwarningfield is passed. As
+    /// the content would still be the same as `warnings`, we simply ignore the field.
+    pub warning: Option<String>,
     /// Warning messages, if any, related to loading the wallet.
     pub warnings: Option<Vec<String>>,
 }
 
 impl LoadWallet {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> model::LoadWallet {
+        // As the content of the deprecated `warning` field would be the same as `warnings`, we
+        // simply ignore the field, even in case it's set.
         model::LoadWallet { name: self.name, warnings: self.warnings.unwrap_or_default() }
     }
 

types/src/v26/mod.rs

@@ -247,9 +247,11 @@
 //! - Method is deprecated.
 
 mod blockchain;
+mod wallet;
 
 #[doc(inline)]
 pub use self::blockchain::{GetTxOutSetInfo, GetTxOutSetInfoError};
+pub use self::wallet::{CreateWallet, LoadWallet};
 #[doc(inline)]
 pub use crate::{
     v17::{
@@ -283,5 +285,4 @@ pub use crate::{
     },
     v21::UnloadWallet,
     v22::{GetTxOut, GetTxOutError, Logging, ScriptPubkey},
-    v25::{CreateWallet, LoadWallet},
 };

types/src/v26/wallet.rs

@@ -0,0 +1,73 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v26` - wallet.
+//!
+//! Types for methods found under the `== Wallet ==` section of the API docs.
+
+use serde::{Deserialize, Serialize};
+
+use crate::model;
+
+/// Result of the JSON-RPC method `createwallet`.
+///
+/// > createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors load_on_startup external_signer )
+///
+/// > Creates and loads a new wallet.
+///
+/// > Arguments:
+/// > 1. wallet_name             (string, required) The name for the new wallet. If this is a path, the wallet will be created at the path location.
+/// > 2. disable_private_keys    (boolean, optional, default=false) Disable the possibility of private keys (only watchonlys are possible in this mode).
+/// > 3. blank                   (boolean, optional, default=false) Create a blank wallet. A blank wallet has no keys or HD seed. One can be set using sethdseed.
+/// > 4. passphrase              (string, optional) Encrypt the wallet with this passphrase.
+/// > 5. avoid_reuse             (boolean, optional, default=false) Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind.
+/// > 6. descriptors             (boolean, optional, default=true) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation. Setting to "false" will create a legacy wallet; however, the legacy wallet type is being deprecated and support for creating and opening legacy wallets will be removed in the future.
+/// > 7. load_on_startup         (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged.
+/// > 8. external_signer         (boolean, optional, default=false) Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct CreateWallet {
+    /// The wallet name if created successfully.
+    ///
+    /// If the wallet was created using a full path, the wallet_name will be the full path.
+    pub name: String,
+    /// Warning messages, if any, related to creating and loading the wallet.
+    pub warnings: Option<Vec<String>>,
+}
+
+impl CreateWallet {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> model::CreateWallet {
+        model::CreateWallet { name: self.name, warnings: self.warnings.unwrap_or_default() }
+    }
+
+    /// Returns the created wallet name.
+    pub fn name(self) -> String { self.into_model().name }
+}
+
+/// Result of the JSON-RPC method `loadwallet`.
+///
+/// > loadwallet "filename" ( load_on_startup )
+///
+/// > Loads a wallet from a wallet file or directory.
+/// > Note that all wallet command-line options used when starting bitcoind will be
+/// > applied to the new wallet.
+///
+/// > Arguments:
+/// > 1. filename           (string, required) The wallet directory or .dat file.
+/// > 2. load_on_startup    (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct LoadWallet {
+    /// The wallet name if loaded successfully.
+    pub name: String,
+    /// Warning messages, if any, related to loading the wallet.
+    pub warnings: Option<Vec<String>>,
+}
+
+impl LoadWallet {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> model::LoadWallet {
+        model::LoadWallet { name: self.name, warnings: self.warnings.unwrap_or_default() }
+    }
+
+    /// Returns the loaded wallet name.
+    pub fn name(self) -> String { self.into_model().name }
+}

types/src/v27/mod.rs

@@ -279,6 +279,5 @@ pub use crate::{
     },
     v21::UnloadWallet,
     v22::{GetTxOut, GetTxOutError, Logging, ScriptPubkey},
-    v25::{CreateWallet, LoadWallet},
-    v26::{GetTxOutSetInfo, GetTxOutSetInfoError},
+    v26::{CreateWallet, GetTxOutSetInfo, GetTxOutSetInfoError, LoadWallet},
 };

types/src/v28/mod.rs

@@ -292,6 +292,5 @@ pub use crate::{
     },
     v21::UnloadWallet,
     v22::{GetTxOut, GetTxOutError, Logging, ScriptPubkey},
-    v25::{CreateWallet, LoadWallet},
-    v26::{GetTxOutSetInfo, GetTxOutSetInfoError},
+    v26::{CreateWallet, GetTxOutSetInfo, GetTxOutSetInfoError, LoadWallet},
 };