Add walletdisplayaddress struct and model

jamillambert · jamillambert · commit 801711c136fc · 2025-07-15T15:53:42.000+01:00
Add the struct, model, client macro, and reexports.

Currently untested.
diff --git a/client/src/client_sync/v22/mod.rs b/client/src/client_sync/v22/mod.rs
@@ -181,6 +181,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v22/wallet.rs b/client/src/client_sync/v22/wallet.rs
@@ -32,3 +32,15 @@ macro_rules! impl_client_v22__load_wallet {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `walletdisplayaddress`
+#[macro_export]
+macro_rules! impl_client_v22__wallet_display_address {
+    () => {
+        impl Client {
+            pub fn wallet_display_address(&self, address: &str) -> Result<WalletDisplayAddress> {
+                self.call("walletdisplayaddress", &[address.into()])
+            }
+        }
+    };
+}
diff --git a/client/src/client_sync/v23/mod.rs b/client/src/client_sync/v23/mod.rs
@@ -182,6 +182,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v24/mod.rs b/client/src/client_sync/v24/mod.rs
@@ -179,6 +179,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v25/mod.rs b/client/src/client_sync/v25/mod.rs
@@ -181,6 +181,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v26/mod.rs b/client/src/client_sync/v26/mod.rs
@@ -185,6 +185,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v27/mod.rs b/client/src/client_sync/v27/mod.rs
@@ -181,6 +181,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v28/mod.rs b/client/src/client_sync/v28/mod.rs
@@ -183,6 +183,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/client/src/client_sync/v29/mod.rs b/client/src/client_sync/v29/mod.rs
@@ -183,6 +183,7 @@ crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
+crate::impl_client_v22__wallet_display_address!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_passphrase!();
 crate::impl_client_v17__wallet_passphrase_change!();
diff --git a/types/src/model/mod.rs b/types/src/model/mod.rs
@@ -60,6 +60,7 @@ pub use self::{
         ListReceivedByLabel, ListReceivedByLabelItem, ListSinceBlock, ListSinceBlockTransaction,
         ListTransactions, ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets,
         LoadWallet, PsbtBumpFee, RescanBlockchain, ScriptType, Send, SendMany, SendToAddress,
-        SignMessage, TransactionCategory, UnloadWallet, WalletCreateFundedPsbt, WalletProcessPsbt,
+        SignMessage, TransactionCategory, UnloadWallet, WalletCreateFundedPsbt,
+        WalletDisplayAddress, WalletProcessPsbt,
     },
 };
diff --git a/types/src/model/wallet.rs b/types/src/model/wallet.rs
@@ -790,6 +790,14 @@ pub struct WalletCreateFundedPsbt {
     pub change_pos: u32,
 }
 
+/// Models the result of JSON-RPC method `walletdisplayaddress`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct WalletDisplayAddress {
+    /// The address as confirmed by the signer
+    pub address: Address<NetworkUnchecked>,
+}
+
 /// Models the result of JSON-RPC method `walletprocesspsbt`.
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
diff --git a/types/src/v22/mod.rs b/types/src/v22/mod.rs
@@ -225,7 +225,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -257,7 +257,7 @@ pub use self::{
     network::{Banned, GetPeerInfo, ListBanned},
     raw_transactions::{DecodeScript, DecodeScriptError},
     signer::EnumerateSigners,
-    wallet::ListDescriptors,
+    wallet::{ListDescriptors, WalletDisplayAddress, WalletDisplayAddressError},
 };
 #[doc(inline)]
 pub use crate::{
diff --git a/types/src/v22/wallet/error.rs b/types/src/v22/wallet/error.rs
@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use core::fmt;
+
+use bitcoin::address;
+
+use crate::error::write_err;
+
+/// Error when converting a `WalletDisplayAddress` type into the model type.
+#[derive(Debug)]
+pub enum WalletDisplayAddressError {
+    /// Conversion of the `address` field failed.
+    Address(address::ParseError),
+}
+
+impl fmt::Display for WalletDisplayAddressError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use WalletDisplayAddressError::*;
+        match *self {
+            Address(ref e) => write_err!(f, "conversion of the `address` field failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for WalletDisplayAddressError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use WalletDisplayAddressError::*;
+        match *self {
+            Address(ref e) => Some(e),
+        }
+    }
+}
diff --git a/types/src/v22/wallet/into.rs b/types/src/v22/wallet/into.rs
@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use bitcoin::Address;
+
+use super::{WalletDisplayAddress, WalletDisplayAddressError};
+use crate::model;
+
+impl WalletDisplayAddress {
+    pub fn into_model(self) -> Result<model::WalletDisplayAddress, WalletDisplayAddressError> {
+        let address =
+            self.address.parse::<Address<_>>().map_err(WalletDisplayAddressError::Address)?;
+        Ok(model::WalletDisplayAddress { address })
+    }
+}
diff --git a/types/src/v22/wallet/mod.rs b/types/src/v22/wallet/mod.rs
@@ -4,8 +4,13 @@
 //!
 //! Types for methods found under the `== Wallet ==` section of the API docs.
 
+mod error;
+mod into;
+
 use serde::{Deserialize, Serialize};
 
+pub use self::error::WalletDisplayAddressError;
+
 /// Result of JSON-RPC method `listdescriptors`.
 ///
 /// > List descriptors imported into a descriptor-enabled wallet.
@@ -36,3 +41,13 @@ pub struct DescriptorInfo {
     /// The next index to generate addresses from; defined only for ranged descriptors.
     pub next: Option<u64>,
 }
+
+/// Result of JSON-RPC method `walletdisplayaddress`.
+///
+/// > Display address on an external signer for verification.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct WalletDisplayAddress {
+    /// The address as confirmed by the signer
+    pub address: String,
+}
diff --git a/types/src/v23/mod.rs b/types/src/v23/mod.rs
@@ -218,7 +218,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -310,5 +310,8 @@ pub use crate::{
         ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
         UnloadWallet, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, GetMempoolInfo, ListBanned, ListDescriptors, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, GetMempoolInfo, ListBanned, ListDescriptors, ScriptPubkey,
+        WalletDisplayAddress, WalletDisplayAddressError,
+    },
 };
diff --git a/types/src/v24/mod.rs b/types/src/v24/mod.rs
@@ -222,7 +222,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -311,7 +311,10 @@ pub use crate::{
         ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
         UnloadWallet, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, ListBanned, ListDescriptors, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, ListBanned, ListDescriptors, ScriptPubkey, WalletDisplayAddress,
+        WalletDisplayAddressError,
+    },
     v23::{
         CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, Logging, SaveMempool,
     },
diff --git a/types/src/v25/mod.rs b/types/src/v25/mod.rs
@@ -223,7 +223,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -305,7 +305,10 @@ pub use crate::{
         GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
         PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, ListBanned, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, ListBanned, ScriptPubkey, WalletDisplayAddress,
+        WalletDisplayAddressError,
+    },
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
     v24::{
         DecodePsbt, DecodePsbtError, GetMempoolEntry, GetMempoolInfo, GetPeerInfo, GetTransaction,
diff --git a/types/src/v26/mod.rs b/types/src/v26/mod.rs
@@ -231,7 +231,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -323,7 +323,10 @@ pub use crate::{
         GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
         PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, ListBanned, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, ListBanned, ScriptPubkey, WalletDisplayAddress,
+        WalletDisplayAddressError,
+    },
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
     v24::{
         DecodePsbt, DecodePsbtError, GetMempoolEntry, GetMempoolInfo, GetTransactionDetail,
diff --git a/types/src/v27/mod.rs b/types/src/v27/mod.rs
@@ -231,7 +231,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -300,7 +300,10 @@ pub use crate::{
         GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
         PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, ListBanned, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, ListBanned, ScriptPubkey, WalletDisplayAddress,
+        WalletDisplayAddressError,
+    },
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
     v24::{
         DecodePsbt, DecodePsbtError, GetMempoolEntry, GetMempoolInfo, GetTransactionDetail,
diff --git a/types/src/v28/mod.rs b/types/src/v28/mod.rs
@@ -233,7 +233,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -321,7 +321,10 @@ pub use crate::{
         GetIndexInfo, GetIndexInfoName, ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee,
         PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, ListBanned, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, ListBanned, ScriptPubkey, WalletDisplayAddress,
+        WalletDisplayAddressError,
+    },
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, SaveMempool},
     v24::{
         DecodePsbt, DecodePsbtError, GetMempoolEntry, GetMempoolInfo, GetTransactionDetail,
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs
@@ -234,7 +234,7 @@
 //! | unloadwallet                       | returns nothing |                                        |
 //! | upgradewallet                      | version         |                                        |
 //! | walletcreatefundedpsbt             | version + model | UNTESTED                               |
-//! | walletdisplayaddress               | version + model | TODO                                   |
+//! | walletdisplayaddress               | version + model | UNTESTED                               |
 //! | walletlock                         | returns nothing |                                        |
 //! | walletpassphrase                   | returns nothing |                                        |
 //! | walletpassphrasechange             | returns nothing |                                        |
@@ -319,7 +319,10 @@ pub use crate::{
         GetIndexInfo, GetIndexInfoName, ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee,
         PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
-    v22::{Banned, EnumerateSigners, ListBanned, ScriptPubkey},
+    v22::{
+        Banned, EnumerateSigners, ListBanned, ScriptPubkey, WalletDisplayAddress,
+        WalletDisplayAddressError,
+    },
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, SaveMempool},
     v24::{
         DecodePsbt, DecodePsbtError, GetMempoolEntry, GetMempoolInfo, GetTransactionDetail,
