Add model for getnodeaddresses

GetNodeAddresses returns an Address.  Create a bitcoin::Address model
for it and modify the test to use it.

Implement for v18 to v21. In v22 the return changes, label v22 to v28 as
TODO.

Author: jamillambert

integration_test/tests/network.rs

@@ -37,10 +37,11 @@ fn network__get_network_info__modelled() {
 fn network__get_node_addresses() {
     let node = Node::with_wallet(Wallet::None, &[]);
     let json: GetNodeAddresses = node.client.get_node_addresses().expect("getnodeaddresses");
-    assert!(json.0.len() <= 2500);
-    if let Some(addr) = json.0.first() {
+    let res: Result<mtype::GetNodeAddresses, _> = json.into_model();
+    let model = res.expect("GetNodeAddresses into model");
+    assert!(model.0.len() <= 2500);
+    if let Some(addr) = model.0.first() {
         assert!(addr.port > 0);
-        assert!(!addr.address.is_empty());
         assert!(addr.time > 1231006505);
     }
 }

types/src/model/mod.rs

@@ -34,7 +34,9 @@ pub use self::{
         BlockTemplateTransaction, GetBlockTemplate, GetPrioritisedTransactions,
         PrioritisedTransaction,
     },
-    network::{GetNetworkInfo, GetNetworkInfoAddress, GetNetworkInfoNetwork},
+    network::{
+        GetNetworkInfo, GetNetworkInfoAddress, GetNetworkInfoNetwork, GetNodeAddresses, NodeAddress,
+    },
     raw_transactions::{
         AnalyzePsbt, AnalyzePsbtInput, AnalyzePsbtInputMissing, CombinePsbt, CombineRawTransaction,
         ConvertToPsbt, CreatePsbt, CreateRawTransaction, DecodePsbt, DecodeRawTransaction,

types/src/model/network.rs

@@ -5,7 +5,8 @@
 //! These structs model the types returned by the JSON-RPC API but have concrete types
 //! and are not specific to a specific version of Bitcoin Core.
 
-use bitcoin::FeeRate;
+use bitcoin::address::NetworkUnchecked;
+use bitcoin::{Address, FeeRate};
 use serde::{Deserialize, Serialize};
 
 /// Models the result of JSON-RPC method `getnetworkinfo`.
@@ -64,3 +65,24 @@ pub struct GetNetworkInfoAddress {
     /// Relative score.
     pub score: u32,
 }
+
+/// Result of JSON-RPC method `getnodeaddresses`.
+///
+/// > getnodeaddresses ( count )
+/// >
+/// > Return known addresses which can potentially be used to find new nodes in the network.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetNodeAddresses(pub Vec<NodeAddress>);
+
+/// An item from the list returned by the JSON-RPC method `getnodeaddresses`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+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: Address<NetworkUnchecked>,
+    /// The port of the node.
+    pub port: u16,
+}

types/src/v18/mod.rs

@@ -103,7 +103,7 @@
 //! | getconnectioncount                 | returns numeric |                                        |
 //! | getnettotals                       | version         |                                        |
 //! | getnetworkinfo                     | version + model |                                        |
-//! | getnodeaddresses                   | version         |                                        |
+//! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
 //! | listbanned                         | returns string  |                                        |
 //! | ping                               | returns nothing |                                        |

types/src/v18/network/into.rs

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use bitcoin::address::NetworkUnchecked;
+use bitcoin::{address, Address};
+
+use super::{GetNodeAddresses, NodeAddress};
+use crate::model;
+
+impl GetNodeAddresses {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetNodeAddresses, address::ParseError> {
+        let nodes = self.0.into_iter().map(|n| n.into_model()).collect::<Result<_, _>>()?;
+        Ok(model::GetNodeAddresses(nodes))
+    }
+}
+
+impl NodeAddress {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::NodeAddress, address::ParseError> {
+        let address = self.address.parse::<Address<NetworkUnchecked>>()?;
+        Ok(model::NodeAddress {
+            time: self.time,
+            services: self.services,
+            address,
+            port: self.port,
+        })
+    }
+}

types/src/v18/network/mod.rs

@@ -4,6 +4,8 @@
 //!
 //! Types for methods found under the `== Network ==` section of the API docs.
 
+mod into;
+
 use serde::{Deserialize, Serialize};
 
 /// Result of JSON-RPC method `getnodeaddresses`.

types/src/v19/mod.rs

@@ -103,7 +103,7 @@
 //! | getconnectioncount                 | returns numeric |                                        |
 //! | getnettotals                       | version         |                                        |
 //! | getnetworkinfo                     | version + model |                                        |
-//! | getnodeaddresses                   | version         |                                        |
+//! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
 //! | listbanned                         | returns string  |                                        |
 //! | ping                               | returns nothing |                                        |

types/src/v20/mod.rs

@@ -104,7 +104,7 @@
 //! | getconnectioncount                 | returns numeric |                                        |
 //! | getnettotals                       | version         |                                        |
 //! | getnetworkinfo                     | version + model |                                        |
-//! | getnodeaddresses                   | version         |                                        |
+//! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
 //! | listbanned                         | returns string  |                                        |
 //! | ping                               | returns nothing |                                        |

types/src/v21/mod.rs

@@ -105,7 +105,7 @@
 //! | getconnectioncount                 | returns numeric |                                        |
 //! | getnettotals                       | version         |                                        |
 //! | getnetworkinfo                     | version + model |                                        |
-//! | getnodeaddresses                   | version         |                                        |
+//! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
 //! | listbanned                         | returns string  |                                        |
 //! | ping                               | returns nothing |                                        |

types/src/v22/mod.rs

@@ -105,7 +105,7 @@
 //! | getconnectioncount                 | returns numeric |                                        |
 //! | getnettotals                       | version         |                                        |
 //! | getnetworkinfo                     | version + model |                                        |
-//! | getnodeaddresses                   | version         |                                        |
+//! | getnodeaddresses                   | version + model | TODO                                   |
 //! | getpeerinfo                        | version         |                                        |
 //! | listbanned                         | returns string  |                                        |
 //! | ping                               | returns nothing |                                        |