Merge #334: Fix getnodeaddresses test

tcharding · tcharding · commit 42e808fc7e97 · 2025-08-20T14:13:43.000+10:00
c9cf940 Run the formatter (Jamil Lambert, PhD) 5bdcdc8 Fix getnodeaddresses test (Jamil Lambert, PhD) 8be0a12 Move getnodeaddresses redefinition from v27 to v22 (Jamil Lambert, PhD) cfbba65 Add hidden RPC addpeeraddress to v21 (Jamil Lambert, PhD) Pull request description: The return shape of the RPC is not tested since an empty list is returned. - Add the hidden RPC `addpeeraddress` in v21 in a new module called `hidden`. - In the `getnodeaddresses` test use the hidden RPC `addpeeraddress` for v21 and later to add an address to the address manager table. Assert that the returned `GetNodeAddresses` contains the added peer address and port. Closes #320 ACKs for top commit: tcharding: ACK c9cf940 Tree-SHA512: 42e51f6345b59ae8108a9a9624da8bdec1458d102eaf70548fc9eee8ad09db3b33ac1985e9617db49260f1cc09ef1a5d7fb469f7da218d0c6ca035947c796c96
diff --git a/client/src/client_sync/v21/hidden.rs b/client/src/client_sync/v21/hidden.rs
@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Generating ==` section of the
+//! API docs of Bitcoin Core `v0.21`.
+//!
+//! All macros require `Client` to be in scope.
+//!
+//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+
+/// Implements Bitcoin Core JSON-RPC API method `addpeeraddress`.
+#[macro_export]
+macro_rules! impl_client_v21_add_peer_address {
+    () => {
+        impl Client {
+            pub fn add_peer_address(&self, address: &str, port: u16) -> Result<AddPeerAddress> {
+                self.call("addpeeraddress", &[address.into(), port.into()])
+            }
+        }
+    };
+}
diff --git a/client/src/client_sync/v21/mod.rs b/client/src/client_sync/v21/mod.rs
@@ -5,6 +5,7 @@
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
 mod generating;
+mod hidden;
 mod util;
 mod wallet;
 
@@ -69,6 +70,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v22/mod.rs b/client/src/client_sync/v22/mod.rs
@@ -68,6 +68,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v23/mod.rs b/client/src/client_sync/v23/mod.rs
@@ -71,6 +71,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v24/mod.rs b/client/src/client_sync/v24/mod.rs
@@ -72,6 +72,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v25/mod.rs b/client/src/client_sync/v25/mod.rs
@@ -73,6 +73,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v26/mod.rs b/client/src/client_sync/v26/mod.rs
@@ -79,6 +79,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v27/mod.rs b/client/src/client_sync/v27/mod.rs
@@ -73,6 +73,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v28/mod.rs b/client/src/client_sync/v28/mod.rs
@@ -76,6 +76,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/client/src/client_sync/v29/mod.rs b/client/src/client_sync/v29/mod.rs
@@ -76,6 +76,9 @@ crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
+// == Hidden ==
+crate::impl_client_v21_add_peer_address!();
+
 // == Mining ==
 crate::impl_client_v17__get_block_template!();
 crate::impl_client_v17__get_mining_info!();
diff --git a/integration_test/tests/network.rs b/integration_test/tests/network.rs
@@ -88,13 +88,23 @@ fn network__get_network_info__modelled() {
 #[test]
 #[cfg(not(feature = "v17"))]
 fn network__get_node_addresses() {
-    let (node1, node2, node3) = integration_test::three_node_network();
-
-    node1.mine_a_block();
-    node2.mine_a_block();
-    node3.mine_a_block();
+    let node = Node::with_wallet(Wallet::None, &[]);
 
-    let _: GetNodeAddresses = node1.client.get_node_addresses().expect("getnodeaddresses");
+    #[cfg(feature = "v20_and_below")]
+    {
+        let _: GetNodeAddresses = node.client.get_node_addresses().expect("getnodeaddresses");
+    }
+    #[cfg(not(feature = "v20_and_below"))]
+    {
+        let peer_address = "1.2.3.4";
+        let peer_port = 1234;
+        node.client.add_peer_address(peer_address, peer_port).expect("addpeeraddress node2");
+
+        let json: GetNodeAddresses = node.client.get_node_addresses().expect("getnodeaddresses");
+
+        assert_eq!(json.0[0].address, peer_address);
+        assert_eq!(json.0[0].port, peer_port);
+    }
 }
 
 #[test]
diff --git a/types/src/v21/hidden.rs b/types/src/v21/hidden.rs
@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v21` - hidden.
+//!
+//! Types for methods that are excluded from the API docs by default.
+
+use serde::{Deserialize, Serialize};
+
+/// Result of JSON-RPC method `addpeeraddress`.
+///
+/// > addpeeraddress "address" port
+/// >
+/// > Add the address of a potential peer to the address manager. This RPC is for testing only.
+/// >
+/// > Arguments:
+/// > 1. address    (string, required) The IP address of the peer
+/// > 2. port       (numeric, required) The port of the peer
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct AddPeerAddress {
+    /// Whether the peer address was successfully added to the address manager.
+    pub success: bool,
+}
diff --git a/types/src/v21/mod.rs b/types/src/v21/mod.rs
@@ -234,6 +234,7 @@
 // JSON-RPC types by API section.
 mod blockchain;
 mod generating;
+mod hidden;
 mod network;
 mod raw_transactions;
 mod util;
@@ -247,6 +248,7 @@ pub use self::{
         MempoolEntry, Softfork, SoftforkType,
     },
     generating::GenerateBlock,
+    hidden::AddPeerAddress,
     network::{GetNetworkInfo, GetPeerInfo, PeerInfo},
     raw_transactions::{
         MempoolAcceptance, MempoolAcceptanceError, TestMempoolAccept, TestMempoolAcceptError,
diff --git a/types/src/v22/mod.rs b/types/src/v22/mod.rs
@@ -254,7 +254,7 @@ mod wallet;
 pub use self::{
     blockchain::GetMempoolInfo,
     control::Logging,
-    network::{Banned, GetPeerInfo, ListBanned, PeerInfo},
+    network::{Banned, GetNodeAddresses, GetPeerInfo, ListBanned, NodeAddress, PeerInfo},
     raw_transactions::{
         DecodeScript, DecodeScriptError, MempoolAcceptance, MempoolAcceptanceError,
         TestMempoolAccept, TestMempoolAcceptError,
@@ -297,10 +297,10 @@ pub use crate::{
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
-        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetNodeAddresses,
-        GetReceivedByLabel, ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError,
-        ListReceivedByLabel, ListReceivedByLabelError, ListUnspent, ListUnspentItem, ListWalletDir,
-        ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
+        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetReceivedByLabel,
+        ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError, ListReceivedByLabel,
+        ListReceivedByLabelError, ListUnspent, ListUnspentItem, ListWalletDir, ListWalletDirWallet,
+        UtxoUpdatePsbt,
     },
     v19::{
         Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesError, GetBalancesMine,
@@ -313,8 +313,8 @@ pub use crate::{
         GetTransactionDetail,
     },
     v21::{
-        Bip9SoftforkInfo, GenerateBlock, GetBlockchainInfo, GetIndexInfo, GetIndexInfoName,
-        GetMempoolAncestors, GetMempoolAncestorsVerbose, GetMempoolDescendants,
+        AddPeerAddress, Bip9SoftforkInfo, GenerateBlock, GetBlockchainInfo, GetIndexInfo,
+        GetIndexInfoName, GetMempoolAncestors, GetMempoolAncestorsVerbose, GetMempoolDescendants,
         GetMempoolDescendantsVerbose, GetMempoolEntry, GetNetworkInfo, ImportDescriptors,
         ImportDescriptorsResult, MempoolEntry, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
         Softfork, SoftforkType, UnloadWallet, UpgradeWallet,
diff --git a/types/src/v22/network.rs b/types/src/v22/network.rs
@@ -8,6 +8,33 @@ use alloc::collections::BTreeMap;
 
 use serde::{Deserialize, Serialize};
 
+/// Result of JSON-RPC method `getnodeaddresses`.
+///
+/// > getnodeaddresses ( count "network" )
+/// >
+/// > Return known addresses, after filtering for quality and recency.
+/// > These can potentially be used to find new peers in the network.
+/// > The total number of addresses known to the node may be higher.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GetNodeAddresses(pub Vec<NodeAddress>);
+
+/// An item from the list returned by the JSON-RPC method `getnodeaddresses`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct NodeAddress {
+    /// Timestamp in seconds since epoch (Jan 1 1970 GMT) when the node was last seen.
+    pub time: u64,
+    /// The services offered.
+    pub services: u64,
+    /// The address of the node.
+    pub address: String,
+    /// The port of the node.
+    pub port: u16,
+    /// The network (ipv4, ipv6, onion, i2p, cjdns) the node connected through.
+    pub network: String,
+}
+
 /// Result of JSON-RPC method `listbanned`.
 ///
 /// > listbanned
diff --git a/types/src/v23/mod.rs b/types/src/v23/mod.rs
@@ -294,10 +294,10 @@ pub use crate::{
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
-        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetNodeAddresses,
-        GetReceivedByLabel, ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError,
-        ListReceivedByLabel, ListReceivedByLabelError, ListUnspent, ListUnspentItem, ListWalletDir,
-        ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
+        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetReceivedByLabel,
+        ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError, ListReceivedByLabel,
+        ListReceivedByLabelError, ListUnspent, ListUnspentItem, ListWalletDir, ListWalletDirWallet,
+        UtxoUpdatePsbt,
     },
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances,
@@ -308,13 +308,13 @@ pub use crate::{
     },
     v20::{GenerateToDescriptor, GetTransactionDetail},
     v21::{
-        GenerateBlock, GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors,
-        ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UnloadWallet,
-        UpgradeWallet,
+        AddPeerAddress, GenerateBlock, GetIndexInfo, GetIndexInfoName, GetNetworkInfo,
+        ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
+        UnloadWallet, UpgradeWallet,
     },
     v22::{
         Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, GetMempoolInfo,
-        ListBanned, ListDescriptors, MempoolAcceptance, MempoolAcceptanceError, ScriptPubkey,
-        TestMempoolAccept, TestMempoolAcceptError, WalletDisplayAddress,
+        GetNodeAddresses, ListBanned, ListDescriptors, MempoolAcceptance, MempoolAcceptanceError,
+        NodeAddress, ScriptPubkey, TestMempoolAccept, TestMempoolAcceptError, WalletDisplayAddress,
     },
 };
diff --git a/types/src/v24/mod.rs b/types/src/v24/mod.rs
@@ -296,10 +296,9 @@ pub use crate::{
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
-        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetNodeAddresses,
-        GetReceivedByLabel, ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError,
-        ListReceivedByLabel, ListReceivedByLabelError, ListWalletDir, ListWalletDirWallet,
-        NodeAddress, UtxoUpdatePsbt,
+        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetReceivedByLabel,
+        ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError, ListReceivedByLabel,
+        ListReceivedByLabelError, ListWalletDir, ListWalletDirWallet, UtxoUpdatePsbt,
     },
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances,
@@ -310,14 +309,14 @@ pub use crate::{
     },
     v20::GenerateToDescriptor,
     v21::{
-        GenerateBlock, GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors,
-        ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UnloadWallet,
-        UpgradeWallet,
+        AddPeerAddress, GenerateBlock, GetIndexInfo, GetIndexInfoName, GetNetworkInfo,
+        ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
+        UnloadWallet, UpgradeWallet,
     },
     v22::{
-        Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, ListBanned,
-        ListDescriptors, MempoolAcceptance, MempoolAcceptanceError, ScriptPubkey,
-        TestMempoolAccept, TestMempoolAcceptError, WalletDisplayAddress,
+        Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, GetNodeAddresses,
+        ListBanned, ListDescriptors, MempoolAcceptance, MempoolAcceptanceError, NodeAddress,
+        ScriptPubkey, TestMempoolAccept, TestMempoolAcceptError, WalletDisplayAddress,
     },
     v23::{
         AddMultisigAddress, Bip9Info, Bip9Statistics, CreateMultisig, DecodeScript,
diff --git a/types/src/v25/mod.rs b/types/src/v25/mod.rs
@@ -292,10 +292,9 @@ pub use crate::{
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
-        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetNodeAddresses,
-        GetReceivedByLabel, ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError,
-        ListReceivedByLabel, ListReceivedByLabelError, ListWalletDir, ListWalletDirWallet,
-        NodeAddress, UtxoUpdatePsbt,
+        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetReceivedByLabel,
+        ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError, ListReceivedByLabel,
+        ListReceivedByLabelError, ListWalletDir, ListWalletDirWallet, UtxoUpdatePsbt,
     },
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances,
@@ -306,12 +305,12 @@ pub use crate::{
     },
     v20::GenerateToDescriptor,
     v21::{
-        GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
-        PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
+        AddPeerAddress, GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors,
+        ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
     v22::{
-        Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, ListBanned, ScriptPubkey,
-        WalletDisplayAddress,
+        Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, GetNodeAddresses,
+        ListBanned, NodeAddress, ScriptPubkey, WalletDisplayAddress,
     },
     v23::{
         AddMultisigAddress, Bip9Info, Bip9Statistics, CreateMultisig, DecodeScript,
diff --git a/types/src/v26/mod.rs b/types/src/v26/mod.rs
@@ -308,10 +308,9 @@ pub use crate::{
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
-        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetNodeAddresses,
-        GetReceivedByLabel, ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError,
-        ListReceivedByLabel, ListReceivedByLabelError, ListWalletDir, ListWalletDirWallet,
-        NodeAddress, UtxoUpdatePsbt,
+        AnalyzePsbtInputMissingError, DeriveAddresses, GetAddressInfoError, GetReceivedByLabel,
+        ImportMulti, ImportMultiEntry, JoinPsbts, JsonRpcError, ListReceivedByLabel,
+        ListReceivedByLabelError, ListWalletDir, ListWalletDirWallet, UtxoUpdatePsbt,
     },
     v19::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalancesMine,
@@ -321,12 +320,12 @@ pub use crate::{
     },
     v20::GenerateToDescriptor,
     v21::{
-        GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors, ImportDescriptorsResult,
-        PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
+        AddPeerAddress, GetIndexInfo, GetIndexInfoName, GetNetworkInfo, ImportDescriptors,
+        ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError, UpgradeWallet,
     },
     v22::{
-        Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, ListBanned, ScriptPubkey,
-        WalletDisplayAddress,
+        Banned, EnumerateSigners, GetAddressInfo, GetAddressInfoEmbedded, GetNodeAddresses,
+        ListBanned, NodeAddress, ScriptPubkey, WalletDisplayAddress,
     },
     v23::{
         AddMultisigAddress, Bip9Info, Bip9Statistics, CreateMultisig, DecodeScript,
diff --git a/types/src/v27/mod.rs b/types/src/v27/mod.rs
diff --git a/types/src/v27/network/mod.rs b/types/src/v27/network/mod.rs
diff --git a/types/src/v28/mod.rs b/types/src/v28/mod.rs
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs
