Skip to content

Commit 3edf026

Browse files
tchardingtcharding
authored
Merge pull request #110 from tcharding/03-20-unloadwallet
Fix `unloadwallet` method
2 parents 5db564b + 79e814b commit 3edf026

File tree

29 files changed

+141
-47
lines changed

29 files changed

+141
-47
lines changed

‎client/src/client_sync/v17/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ crate::impl_client_v17__sendmany!();
101101
crate::impl_client_v17__sendtoaddress!();
102102
crate::impl_client_v17__signmessage!();
103103
crate::impl_client_v17__signrawtransactionwithwallet!();
104+
crate::impl_client_v17__unloadwallet!();
104105
crate::impl_client_v17__walletcreatefundedpsbt!();
105106
crate::impl_client_v17__walletprocesspsbt!();
106107

‎client/src/client_sync/v17/wallet.rs

+16
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,22 @@ macro_rules! impl_client_v17__signrawtransactionwithwallet {
432432
};
433433
}
434434

435+
/// Implements Bitcoin Core JSON-RPC API method `unloadwallet`.
436+
#[macro_export]
437+
macro_rules! impl_client_v17__unloadwallet {
438+
() => {
439+
impl Client {
440+
pub fn unload_wallet(&self, wallet_name: &str) -> Result<()> {
441+
match self.call("unloadwallet", &[into_json(wallet_name)?]) {
442+
Ok(serde_json::Value::Null) => Ok(()),
443+
Ok(res) => Err(Error::Returned(res.to_string())),
444+
Err(err) => Err(err.into()),
445+
}
446+
}
447+
}
448+
};
449+
}
450+
435451
/// Implements Bitcoin Core JSON-RPC API method `walletcreatefundedpsbt`.
436452
#[macro_export]
437453
macro_rules! impl_client_v17__walletcreatefundedpsbt {

‎client/src/client_sync/v18/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -96,5 +96,6 @@ crate::impl_client_v17__sendmany!();
9696
crate::impl_client_v17__sendtoaddress!();
9797
crate::impl_client_v17__signmessage!();
9898
crate::impl_client_v17__signrawtransactionwithwallet!();
99+
crate::impl_client_v17__unloadwallet!();
99100
crate::impl_client_v17__walletcreatefundedpsbt!();
100101
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v19/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,6 @@ crate::impl_client_v17__sendmany!();
9494
crate::impl_client_v17__sendtoaddress!();
9595
crate::impl_client_v17__signmessage!();
9696
crate::impl_client_v17__signrawtransactionwithwallet!();
97+
crate::impl_client_v17__unloadwallet!();
9798
crate::impl_client_v17__walletcreatefundedpsbt!();
9899
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v20.rs

+1
Original file line numberDiff line numberDiff line change
@@ -92,5 +92,6 @@ crate::impl_client_v17__sendmany!();
9292
crate::impl_client_v17__sendtoaddress!();
9393
crate::impl_client_v17__signmessage!();
9494
crate::impl_client_v17__signrawtransactionwithwallet!();
95+
crate::impl_client_v17__unloadwallet!();
9596
crate::impl_client_v17__walletcreatefundedpsbt!();
9697
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v21.rs ‎client/src/client_sync/v21/mod.rs

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
//!
55
//! We ignore option arguments unless they effect the shape of the returned JSON data.
66
7+
mod wallet;
8+
79
use std::collections::BTreeMap;
810
use std::path::Path;
911

@@ -92,5 +94,6 @@ crate::impl_client_v17__sendmany!();
9294
crate::impl_client_v17__sendtoaddress!();
9395
crate::impl_client_v17__signmessage!();
9496
crate::impl_client_v17__signrawtransactionwithwallet!();
97+
crate::impl_client_v21__unloadwallet!();
9598
crate::impl_client_v17__walletcreatefundedpsbt!();
9699
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v21/wallet.rs

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// SPDX-License-Identifier: CC0-1.0
2+
3+
//! Macros for implementing JSON-RPC methods on a client.
4+
//!
5+
//! Specifically this is methods found under the `== Wallet ==` section of the
6+
//! API docs of Bitcoin Core `v21`.
7+
//!
8+
//! All macros require `Client` to be in scope.
9+
//!
10+
//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
11+
12+
/// Implements Bitcoin Core JSON-RPC API method `unloadwallet`
13+
#[macro_export]
14+
macro_rules! impl_client_v21__unloadwallet {
15+
() => {
16+
impl Client {
17+
pub fn unload_wallet(&self, wallet: &str) -> Result<UnloadWallet> {
18+
self.call("unloadwallet", &[wallet.into()])
19+
}
20+
}
21+
};
22+
}

‎client/src/client_sync/v22/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -95,5 +95,6 @@ crate::impl_client_v17__sendmany!();
9595
crate::impl_client_v17__sendtoaddress!();
9696
crate::impl_client_v17__signmessage!();
9797
crate::impl_client_v17__signrawtransactionwithwallet!();
98+
crate::impl_client_v21__unloadwallet!();
9899
crate::impl_client_v17__walletcreatefundedpsbt!();
99100
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v22/wallet.rs

-12
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@
99
//!
1010
//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
1111
12-
/// Implements Bitcoin Core JSON-RPC API method `unloadwallet`
13-
#[macro_export]
14-
macro_rules! impl_client_v22__unloadwallet {
15-
() => {
16-
impl Client {
17-
pub fn unload_wallet(&self, wallet: &str) -> Result<UnloadWallet> {
18-
self.call("unloadwallet", &[wallet.into()])
19-
}
20-
}
21-
};
22-
}
23-
2412
/// Implements Bitcoin Core JSON-RPC API method `loadwallet`
2513
#[macro_export]
2614
macro_rules! impl_client_v22__loadwallet {

‎client/src/client_sync/v23.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ crate::impl_client_v17__sendmany!();
9393
crate::impl_client_v17__sendtoaddress!();
9494
crate::impl_client_v17__signmessage!();
9595
crate::impl_client_v17__signrawtransactionwithwallet!();
96-
crate::impl_client_v22__unloadwallet!();
96+
crate::impl_client_v21__unloadwallet!();
9797
crate::impl_client_v17__walletcreatefundedpsbt!();
9898
crate::impl_client_v17__walletprocesspsbt!();
9999

‎client/src/client_sync/v24.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ crate::impl_client_v17__sendmany!();
9292
crate::impl_client_v17__sendtoaddress!();
9393
crate::impl_client_v17__signmessage!();
9494
crate::impl_client_v17__signrawtransactionwithwallet!();
95-
crate::impl_client_v22__unloadwallet!();
95+
crate::impl_client_v21__unloadwallet!();
9696
crate::impl_client_v17__walletcreatefundedpsbt!();
9797
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v25.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ crate::impl_client_v17__sendmany!();
9292
crate::impl_client_v17__sendtoaddress!();
9393
crate::impl_client_v17__signmessage!();
9494
crate::impl_client_v17__signrawtransactionwithwallet!();
95-
crate::impl_client_v22__unloadwallet!();
95+
crate::impl_client_v21__unloadwallet!();
9696
crate::impl_client_v17__walletcreatefundedpsbt!();
9797
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v26/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,6 @@ crate::impl_client_v17__sendmany!();
9494
crate::impl_client_v17__sendtoaddress!();
9595
crate::impl_client_v17__signmessage!();
9696
crate::impl_client_v17__signrawtransactionwithwallet!();
97-
crate::impl_client_v22__unloadwallet!();
97+
crate::impl_client_v21__unloadwallet!();
9898
crate::impl_client_v17__walletcreatefundedpsbt!();
9999
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v27.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ crate::impl_client_v17__sendmany!();
9292
crate::impl_client_v17__sendtoaddress!();
9393
crate::impl_client_v17__signmessage!();
9494
crate::impl_client_v17__signrawtransactionwithwallet!();
95-
crate::impl_client_v22__unloadwallet!();
95+
crate::impl_client_v21__unloadwallet!();
9696
crate::impl_client_v17__walletcreatefundedpsbt!();
9797
crate::impl_client_v17__walletprocesspsbt!();

‎client/src/client_sync/v28/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,6 @@ crate::impl_client_v17__sendmany!();
9595
crate::impl_client_v17__sendtoaddress!();
9696
crate::impl_client_v17__signmessage!();
9797
crate::impl_client_v17__signrawtransactionwithwallet!();
98-
crate::impl_client_v22__unloadwallet!();
98+
crate::impl_client_v21__unloadwallet!();
9999
crate::impl_client_v17__walletcreatefundedpsbt!();
100100
crate::impl_client_v17__walletprocesspsbt!();

‎integration_test/tests/wallet.rs

+22-9
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
55
#[cfg(feature = "TODO")]
66
use bitcoin::address::{Address, NetworkChecked};
7+
#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
78
use bitcoin::Amount;
89
use integration_test::{Node, NodeExt as _, Wallet};
10+
#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
911
use node::AddressType;
1012

1113
#[test]
@@ -43,9 +45,6 @@ pub fn bump_fee() {
4345
pub fn create_wallet() {
4446
// Implicitly tests `createwallet` because we create the default wallet.
4547
let _ = Node::with_wallet(Wallet::Default, &[]);
46-
47-
// TODO: We are not currently testing the `warnings` field. This field was changed from an
48-
// optional `String` to an optional vector of strings in v25. Needs testing.
4948
}
5049

5150
#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
@@ -188,19 +187,33 @@ fn get_transaction() {
188187

189188
#[test]
190189
fn load_wallet() {
191-
// Implicitly test loadwalled because we load the default wallet.
192-
let _ = Node::with_wallet(Wallet::Default, &[]);
190+
create_load_unload_wallet();
193191
}
194192

195-
#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]
196193
#[test]
197-
#[cfg(not(any(feature = "v17", feature = "v18", feature = "v19", feature = "v20")))]
198194
fn unload_wallet() {
195+
create_load_unload_wallet();
196+
}
197+
198+
fn create_load_unload_wallet() {
199199
let node = Node::with_wallet(Wallet::None, &[]);
200+
200201
let wallet = format!("wallet-{}", rand::random::<u32>()).to_string();
201202
node.client.create_wallet(&wallet).expect("failed to create wallet");
202-
let json = node.client.unload_wallet(&wallet).expect("unloadwallet");
203-
assert!(json.into_model().is_ok())
203+
204+
// Upto version 20 Core returns null for `unloadwallet`.
205+
#[cfg(any(feature = "v17", feature = "v18", feature = "v19", feature = "v20"))]
206+
let _ = node.client.unload_wallet(&wallet).expect("unloadwallet");
207+
208+
// From version 21 Core returns warnings for `unloadwallet`.
209+
#[cfg(all(not(feature = "v17"), not(feature = "v18"), not(feature = "v19"), not(feature = "v20")))]
210+
{
211+
let json = node.client.unload_wallet(&wallet).expect("unloadwallet");
212+
let _ = json.into_model();
213+
}
214+
215+
let json = node.client.load_wallet(&wallet).expect("loadwallet");
216+
let _ = json.into_model();
204217
}
205218

206219
#[cfg(any(feature = "0_17_1", feature = "0_18_1"))]

‎types/src/v17/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@
193193
//! | settxfee | omitted |
194194
//! | signmessage | done (untested) |
195195
//! | signrawtransactionwithwallet | done (untested) |
196-
//! | unloadwallet | omitted |
196+
//! | unloadwallet | done |
197197
//! | walletcreatefundedpsbt | done (untested) |
198198
//! | walletlock | omitted |
199199
//! | walletpassphrase | omitted |

‎types/src/v18/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@
200200
//! | settxfee | omitted |
201201
//! | signmessage | done (untested) |
202202
//! | signrawtransactionwithwallet | done (untested) |
203-
//! | unloadwallet | omitted |
203+
//! | unloadwallet | done |
204204
//! | walletcreatefundedpsbt | done (untested) |
205205
//! | walletlock | omitted |
206206
//! | walletpassphrase | omitted |

‎types/src/v19/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@
197197
//! | setwalletflag | todo |
198198
//! | signmessage | done (untested) |
199199
//! | signrawtransactionwithwallet | done (untested) |
200-
//! | unloadwallet | omitted |
200+
//! | unloadwallet | done |
201201
//! | walletcreatefundedpsbt | done (untested) |
202202
//! | walletlock | omitted |
203203
//! | walletpassphrase | omitted |

‎types/src/v20/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@
198198
//! | setwalletflag | todo |
199199
//! | signmessage | done (untested) |
200200
//! | signrawtransactionwithwallet | done (untested) |
201-
//! | unloadwallet | omitted |
201+
//! | unloadwallet | done |
202202
//! | walletcreatefundedpsbt | done (untested) |
203203
//! | walletlock | omitted |
204204
//! | walletpassphrase | omitted |

‎types/src/v22/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@
213213
//! | setwalletflag | todo |
214214
//! | signmessage | done (untested) |
215215
//! | signrawtransactionwithwallet | done (untested) |
216-
//! | unloadwallet | omitted |
216+
//! | unloadwallet | done |
217217
//! | upgradewallet | todo |
218218
//! | walletcreatefundedpsbt | done (untested) |
219219
//! | walletdisplayaddress | todo |

‎types/src/v23/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@
206206
//! | setwalletflag | todo |
207207
//! | signmessage | done (untested) |
208208
//! | signrawtransactionwithwallet | done (untested) |
209-
//! | unloadwallet | omitted |
209+
//! | unloadwallet | done |
210210
//! | upgradewallet | todo |
211211
//! | walletcreatefundedpsbt | done (untested) |
212212
//! | walletdisplayaddress | todo |

‎types/src/v24/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
//! | signmessage | done (untested) |
211211
//! | signrawtransactionwithwallet | done (untested) |
212212
//! | simulaterawtransaction | todo |
213-
//! | unloadwallet | omitted |
213+
//! | unloadwallet | done |
214214
//! | upgradewallet | todo |
215215
//! | walletcreatefundedpsbt | done (untested) |
216216
//! | walletdisplayaddress | todo |

‎types/src/v25/mod.rs

+2-3
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@
211211
//! | signmessage | done (untested) |
212212
//! | signrawtransactionwithwallet | done (untested) |
213213
//! | simulaterawtransaction | todo |
214-
//! | unloadwallet | omitted |
214+
//! | unloadwallet | done |
215215
//! | upgradewallet | todo |
216216
//! | walletcreatefundedpsbt | done (untested) |
217217
//! | walletdisplayaddress | todo |
@@ -241,7 +241,7 @@
241241
mod wallet;
242242

243243
#[doc(inline)]
244-
pub use self::wallet::{CreateWallet, LoadWallet};
244+
pub use self::wallet::{CreateWallet, LoadWallet, UnloadWallet};
245245
#[doc(inline)]
246246
pub use crate::{
247247
v17::{
@@ -273,6 +273,5 @@ pub use crate::{
273273
MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
274274
SoftforkType,
275275
},
276-
v21::UnloadWallet,
277276
v22::{GetTxOut, GetTxOutError, Logging, ScriptPubkey},
278277
};

‎types/src/v25/wallet.rs

+29-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ impl CreateWallet {
6565
pub struct LoadWallet {
6666
/// The wallet name if loaded successfully.
6767
pub name: String,
68-
/// Warning messages, if any, related to creating the wallet. Multiple messages will be delimited by newlines.
68+
/// Warning messages, if any, related to loading the wallet. Multiple messages will be delimited by newlines.
6969
///
7070
/// DEPRECATED, returned only if config option -deprecatedrpc=walletwarningfield is passed. As
7171
/// the content would still be the same as `warnings`, we simply ignore the field.
@@ -85,3 +85,31 @@ impl LoadWallet {
8585
/// Returns the loaded wallet name.
8686
pub fn name(self) -> String { self.into_model().name }
8787
}
88+
89+
/// Result of the JSON-RPC method `unloadwallet`.
90+
///
91+
/// > unloadwallet ( "wallet_name" load_on_startup )
92+
/// >
93+
/// > Unloads the wallet referenced by the request endpoint otherwise unloads the wallet specified in the argument.
94+
/// > Specifying the wallet name on a wallet endpoint is invalid.
95+
/// >
96+
/// > Arguments:
97+
/// > 1. wallet_name (string, optional, default=the wallet name from the RPC endpoint) The name of the wallet to unload. If provided both here and in the RPC endpoint, the two must be identical.
98+
/// > 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.
99+
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
100+
pub struct UnloadWallet {
101+
/// Warning messages, if any, related to unloading the wallet. Multiple messages will be delimited by newlines.
102+
///
103+
/// DEPRECATED, returned only if config option -deprecatedrpc=walletwarningfield is passed. As
104+
/// the content would still be the same as `warnings`, we simply ignore the field.
105+
pub warning: Option<String>,
106+
/// Warning messages, if any, related to loading the wallet.
107+
pub warnings: Option<Vec<String>>,
108+
}
109+
110+
impl UnloadWallet {
111+
/// Converts version specific type to a version nonspecific, more strongly typed type.
112+
pub fn into_model(self) -> model::UnloadWallet {
113+
model::UnloadWallet { warnings: self.warnings.unwrap_or_default() }
114+
}
115+
}

‎types/src/v26/mod.rs

+2-3
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
//! | signmessage | done (untested) |
220220
//! | signrawtransactionwithwallet | done (untested) |
221221
//! | simulaterawtransaction | todo |
222-
//! | unloadwallet | omitted |
222+
//! | unloadwallet | done |
223223
//! | upgradewallet | todo |
224224
//! | walletcreatefundedpsbt | done (untested) |
225225
//! | walletdisplayaddress | todo |
@@ -251,7 +251,7 @@ mod wallet;
251251

252252
#[doc(inline)]
253253
pub use self::blockchain::{GetTxOutSetInfo, GetTxOutSetInfoError};
254-
pub use self::wallet::{CreateWallet, LoadWallet};
254+
pub use self::wallet::{CreateWallet, LoadWallet, UnloadWallet};
255255
#[doc(inline)]
256256
pub use crate::{
257257
v17::{
@@ -283,6 +283,5 @@ pub use crate::{
283283
MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
284284
SoftforkType,
285285
},
286-
v21::UnloadWallet,
287286
v22::{GetTxOut, GetTxOutError, Logging, ScriptPubkey},
288287
};

0 commit comments

Comments
 (0)