Merge #194: Implement addnode method and test

91d2ac1 Implement addnode method and test (GideonBature)

Pull request description:

  Going by the conversations with tcharding for PR [#116 ](#116) on implementing one method at a time for easier review: This is first method under network section, addnode which is a specific type that returns a (json null). Once this is approved, I’ll proceed with the next one.

ACKs for top commit:
  tcharding:
    ACK 91d2ac1

Tree-SHA512: 05e4f71e335a514336a96f91a06aa51049fea46780568a3e63aae4927996bacecf66cca08ffba062dd7bdb96ac360d5c40702e48843fe8a04660bcc139bc2f69

Author: tcharding

client/src/client_sync/v17/mod.rs

@@ -71,6 +71,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();
@@ -214,3 +215,12 @@ pub struct WalletCreateFundedPsbtInput {
     txid: Txid,
     vout: u32,
 }
+
+/// Args for the `addnode` method
+#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum AddNodeCommand {
+    Add,
+    Remove,
+    OneTry,
+}

client/src/client_sync/v17/network.rs

@@ -9,6 +9,22 @@
 //!
 //! See, or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
 
+/// Implements Bitcoin Core JSON-RPC API method `addnode`
+#[macro_export]
+macro_rules! impl_client_v17__addnode {
+    () => {
+        impl Client {
+            pub fn add_node(&self, node: &str, command: AddNodeCommand) -> Result<()> {
+                match self.call("addnode", &[into_json(node)?, into_json(command)?]) {
+                    Ok(serde_json::Value::Null) => Ok(()),
+                    Ok(res) => Err(Error::Returned(res.to_string())),
+                    Err(err) => Err(err.into()),
+                }
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `getaddednodeinfo`
 #[macro_export]
 macro_rules! impl_client_v17__getaddednodeinfo {

client/src/client_sync/v18/mod.rs

@@ -19,7 +19,10 @@ use crate::types::v18::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddNodeCommand, AddressType, Input, Output, TemplateRequest, TemplateRules,
+        WalletCreateFundedPsbtInput
+    },
 };
 
 // This publicly re-exports `Client`.
@@ -72,6 +75,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v19/mod.rs

@@ -18,7 +18,10 @@ use crate::types::v19::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddNodeCommand, AddressType, Input, Output, TemplateRequest, TemplateRules,
+        WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v19");
@@ -70,6 +73,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v20.rs

@@ -15,7 +15,7 @@ use crate::types::v20::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddressType, AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v20");
@@ -67,6 +67,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v21/mod.rs

@@ -17,7 +17,10 @@ use crate::types::v21::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddNodeCommand, AddressType, Input, Output, TemplateRequest, TemplateRules,
+        WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v21");
@@ -69,6 +72,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v22/mod.rs

@@ -17,7 +17,10 @@ use crate::types::v22::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{
+        AddNodeCommand, AddressType, Input, Output, TemplateRequest, TemplateRules,
+        WalletCreateFundedPsbtInput
+    },
 };
 
 crate::define_jsonrpc_minreq_client!("v22");
@@ -69,6 +72,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v23/mod.rs

@@ -19,7 +19,7 @@ use crate::types::v23::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v23");
@@ -71,6 +71,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v24.rs

@@ -15,7 +15,7 @@ use crate::types::v24::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
 };
 
@@ -68,6 +68,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v25.rs

@@ -15,7 +15,7 @@ use crate::types::v25::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
 };
 
@@ -68,6 +68,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v26/mod.rs

@@ -19,7 +19,7 @@ use crate::types::v26::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
 };
 
@@ -73,6 +73,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v27.rs

@@ -15,7 +15,7 @@ use crate::types::v27::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
 };
 
@@ -69,6 +69,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v28/mod.rs

@@ -17,7 +17,7 @@ use crate::types::v28::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
 };
 
@@ -71,6 +71,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

client/src/client_sync/v29/mod.rs

@@ -19,7 +19,7 @@ use crate::types::v29::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{Input, Output, WalletCreateFundedPsbtInput},
+    v17::{AddNodeCommand, Input, Output, WalletCreateFundedPsbtInput},
     v23::AddressType,
 };
 
@@ -74,6 +74,7 @@ crate::impl_client_v17__prioritisetransaction!();
 crate::impl_client_v17__submitblock!();
 
 // == Network ==
+crate::impl_client_v17__addnode!();
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();
 crate::impl_client_v17__getnetworkinfo!();

integration_test/tests/network.rs

@@ -6,7 +6,38 @@
 
 use integration_test::{Node, NodeExt as _, Wallet};
 use node::vtype::*;             // All the version specific types.
-use node::mtype;
+use node::{AddNodeCommand, mtype};
+
+#[test]
+fn network__add_node() {
+    let dummy_peer = "192.0.2.1:8333";
+
+    #[cfg(not(any(
+        feature = "v26",
+        feature = "v27",
+        feature = "v28",
+        feature = "v29",
+    )))]
+    {
+        let node = Node::with_wallet(Wallet::None, &[]);
+        node.client.add_node(dummy_peer, AddNodeCommand::OneTry).expect("addnode onetry");
+        node.client.add_node(dummy_peer, AddNodeCommand::Add).expect("addnode add");
+        node.client.add_node(dummy_peer, AddNodeCommand::Remove).expect("addnode remove");
+    }
+
+    #[cfg(any(
+        feature = "v26",
+        feature = "v27",
+        feature = "v28",
+        feature = "v29",
+    ))]
+    {
+        let node = Node::with_wallet(Wallet::None, &["-v2transport"]);
+        node.client.add_node(dummy_peer, AddNodeCommand::OneTry).expect("addnode onetry");
+        node.client.add_node(dummy_peer, AddNodeCommand::Add).expect("addnode add");
+        node.client.add_node(dummy_peer, AddNodeCommand::Remove).expect("addnode remove");
+    }
+}
 
 #[test]
 fn network__get_added_node_info() {