client: Move types to version specific module

Currently we have a bit of confusion around types that are defined and
used by the various client version modules.

- Some currently don't change e.g., `Input`
- Some are due to change in v29 e.g., `TemplateRequest`
- Some change already e.g. `AddressVersion`

And to make matters worse, I did 'custom' re-exports in `node` which is
very confusing when one is reading code in `client`.

Put all `client` defined types in the version module they first appear
in and re-export them as we do for types from `types`. Then use the type
naked (without qualifying the path).

Author: tcharding

client/src/client_sync/mod.rs

@@ -16,14 +16,10 @@ pub mod v26;
 pub mod v27;
 pub mod v28;
 
-use std::collections::HashMap;
 use std::fs::File;
 use std::io::{BufRead, BufReader};
 use std::path::PathBuf;
 
-use bitcoin::{Address, Amount, Txid};
-use serde::{Deserialize, Serialize};
-
 pub use crate::client_sync::error::Error;
 
 /// Crate-specific Result type.
@@ -224,38 +220,3 @@ fn log_response(method: &str, resp: &Result<jsonrpc::Response>) {
         }
     }
 }
-
-/// Input used as parameter to `create_raw_transaction`.
-#[derive(Debug, Serialize)]
-pub struct Input {
-    /// The txid of the transaction that contains the UTXO.
-    pub txid: bitcoin::Txid,
-    /// The vout for the UTXO.
-    pub vout: u64,
-    /// Sequence number if needed.
-    pub sequence: Option<bitcoin::Sequence>,
-}
-
-/// Output used as parameter to `create_raw_transaction`.
-// Abuse `HashMap` so we can derive serialize to get the correct JSON object.
-#[derive(Debug, Serialize)]
-pub struct Output(
-    /// Map of address to value. Always only has a single item in it.
-    HashMap<String, f64>,
-);
-
-impl Output {
-    /// Creates a single output that serializes as Core expects.
-    pub fn new(addr: Address, value: Amount) -> Self {
-        let mut map = HashMap::new();
-        map.insert(addr.to_string(), value.to_btc());
-        Output(map)
-    }
-}
-
-/// An element in the `inputs` argument of method `walletcreatefundedpsbt`.
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
-pub struct WalletCreateFundedPsbtInput {
-    txid: Txid,
-    vout: u32,
-}

client/src/client_sync/v17/mod.rs

@@ -12,7 +12,7 @@ pub mod network;
 pub mod raw_transactions;
 pub mod wallet;
 
-use std::collections::BTreeMap;
+use std::collections::{BTreeMap, HashMap};
 use std::path::Path;
 
 use bitcoin::address::{Address, NetworkChecked};
@@ -22,9 +22,6 @@ use serde::{Deserialize, Serialize};
 use crate::client_sync::into_json;
 use crate::types::v17::*;
 
-#[rustfmt::skip]                // Keep public re-exports separate.
-pub use crate::client_sync::WalletCreateFundedPsbtInput;
-
 crate::define_jsonrpc_minreq_client!("v17");
 crate::impl_client_check_expected_server_version!({ [170200] });
 
@@ -174,3 +171,38 @@ pub enum TemplateRules {
     /// Taproot supported.
     Taproot,
 }
+
+/// Input used as parameter to `create_raw_transaction`.
+#[derive(Debug, Serialize)]
+pub struct Input {
+    /// The txid of the transaction that contains the UTXO.
+    pub txid: bitcoin::Txid,
+    /// The vout for the UTXO.
+    pub vout: u64,
+    /// Sequence number if needed.
+    pub sequence: Option<bitcoin::Sequence>,
+}
+
+/// Output used as parameter to `create_raw_transaction`.
+// Abuse `HashMap` so we can derive serialize to get the correct JSON object.
+#[derive(Debug, Serialize)]
+pub struct Output(
+    /// Map of address to value. Always only has a single item in it.
+    HashMap<String, f64>,
+);
+
+impl Output {
+    /// Creates a single output that serializes as Core expects.
+    pub fn new(addr: Address, value: Amount) -> Self {
+        let mut map = HashMap::new();
+        map.insert(addr.to_string(), value.to_btc());
+        Output(map)
+    }
+}
+
+/// An element in the `inputs` argument of method `walletcreatefundedpsbt`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct WalletCreateFundedPsbtInput {
+    txid: Txid,
+    vout: u32,
+}

client/src/client_sync/v17/raw_transactions.rs

@@ -61,8 +61,8 @@ macro_rules! impl_client_v17__createpsbt {
         impl Client {
             pub fn create_psbt(
                 &self,
-                inputs: &[$crate::client_sync::Input],
-                outputs: &[$crate::client_sync::Output],
+                inputs: &[Input],
+                outputs: &[Output],
             ) -> Result<CreatePsbt> {
                 self.call("createpsbt", &[into_json(inputs)?, into_json(outputs)?])
             }
@@ -77,8 +77,8 @@ macro_rules! impl_client_v17__createrawtransaction {
         impl Client {
             pub fn create_raw_transaction(
                 &self,
-                inputs: &[$crate::client_sync::Input],
-                outputs: &[$crate::client_sync::Output],
+                inputs: &[Input],
+                outputs: &[Output],
             ) -> Result<CreateRawTransaction> {
                 self.call("createrawtransaction", &[into_json(inputs)?, into_json(outputs)?])
             }

client/src/client_sync/v17/wallet.rs

@@ -446,7 +446,7 @@ macro_rules! impl_client_v17__walletcreatefundedpsbt {
         impl Client {
             pub fn wallet_create_funded_psbt(
                 &self,
-                inputs: Vec<$crate::client_sync::WalletCreateFundedPsbtInput>,
+                inputs: Vec<WalletCreateFundedPsbtInput>,
                 outputs: Vec<BTreeMap<Address, Amount>>,
             ) -> Result<WalletCreateFundedPsbt> {
                 self.call("walletcreatefundedpsbt", &[into_json(inputs)?, into_json(outputs)?])

client/src/client_sync/v18/mod.rs

@@ -18,8 +18,7 @@ use crate::types::v18::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, TemplateRequest, TemplateRules},
-    WalletCreateFundedPsbtInput
+    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v18");

client/src/client_sync/v19/mod.rs

@@ -18,8 +18,7 @@ use crate::types::v19::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, TemplateRequest, TemplateRules},
-    WalletCreateFundedPsbtInput
+    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v19");

client/src/client_sync/v20.rs

@@ -15,8 +15,7 @@ use crate::types::v20::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, TemplateRequest, TemplateRules},
-    WalletCreateFundedPsbtInput
+    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v20");

client/src/client_sync/v21/mod.rs

@@ -17,8 +17,7 @@ use crate::types::v21::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, TemplateRequest, TemplateRules},
-    WalletCreateFundedPsbtInput
+    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v21");

client/src/client_sync/v22/mod.rs

@@ -18,8 +18,7 @@ use crate::types::v22::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{AddressType, TemplateRequest, TemplateRules},
-    WalletCreateFundedPsbtInput
+    v17::{AddressType, Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v22");

client/src/client_sync/v23/mod.rs

@@ -19,8 +19,7 @@ use crate::types::v23::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{TemplateRequest, TemplateRules},
-    WalletCreateFundedPsbtInput
+    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
 };
 
 crate::define_jsonrpc_minreq_client!("v23");

client/src/client_sync/v24.rs

@@ -15,8 +15,8 @@ use crate::types::v24::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{TemplateRequest, TemplateRules},
-    v23::AddressType, WalletCreateFundedPsbtInput
+    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v23::AddressType,
 };
 
 crate::define_jsonrpc_minreq_client!("v24");

client/src/client_sync/v25.rs

@@ -15,8 +15,8 @@ use crate::types::v25::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{TemplateRequest, TemplateRules},
-    v23::AddressType, WalletCreateFundedPsbtInput
+    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v23::AddressType,
 };
 
 crate::define_jsonrpc_minreq_client!("v25");

client/src/client_sync/v26/mod.rs

@@ -19,9 +19,8 @@ use crate::types::v26::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{TemplateRequest, TemplateRules},
+    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
-    WalletCreateFundedPsbtInput
 };
 
 crate::define_jsonrpc_minreq_client!("v26");

client/src/client_sync/v27.rs

@@ -15,8 +15,8 @@ use crate::types::v27::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{TemplateRequest, TemplateRules},
-    v23::AddressType, WalletCreateFundedPsbtInput
+    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
+    v23::AddressType,
 };
 
 crate::define_jsonrpc_minreq_client!("v27");

client/src/client_sync/v28/mod.rs

@@ -17,9 +17,8 @@ use crate::types::v28::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
 pub use crate::client_sync::{
-    v17::{TemplateRequest, TemplateRules},
+    v17::{Input, Output, TemplateRequest, TemplateRules, WalletCreateFundedPsbtInput},
     v23::AddressType,
-    WalletCreateFundedPsbtInput
 };
 
 crate::define_jsonrpc_minreq_client!("v28");

integration_test/tests/mining.rs

@@ -6,7 +6,6 @@
 
 use bitcoin::SignedAmount;
 use integration_test::{Node, NodeExt as _, Wallet};
-use node::{TemplateRequest, TemplateRules};
 use node::vtype::*;             // All the version specific types.
 use node::mtype;
 

integration_test/tests/raw_transactions.rs

@@ -9,7 +9,6 @@ use bitcoin::hex::FromHex as _;
 use bitcoin::opcodes::all::*;
 use bitcoin::{absolute, transaction, consensus,  script, Amount, TxOut, Transaction, ScriptBuf};
 use integration_test::{Node, NodeExt as _, Wallet};
-use node::client::client_sync::{Input, Output};
 use node::vtype::*;             // All the version specific types.
 use node::mtype;
 

integration_test/tests/wallet.rs

@@ -8,7 +8,6 @@
 use bitcoin::address::{Address, NetworkChecked};
 use bitcoin::Amount;
 use integration_test::{Node, NodeExt as _, Wallet};
-use node::AddressType;
 use node::vtype::*;             // All the version specific types.
 use node::mtype;
 

node/src/client_versions.rs

@@ -7,52 +7,52 @@
 #![allow(unused_imports)] // Not all users need the json types.
 
 #[cfg(feature = "28_0")]
-pub use corepc_client::{client_sync::v28::{Client, AddressType, TemplateRequest, TemplateRules}, types::v28 as vtype};
+pub use corepc_client::{client_sync::v28::{Client}, types::v28 as vtype};
 
 #[cfg(all(feature = "27_2", not(feature = "28_0")))]
-pub use corepc_client::{client_sync::v27::{Client, AddressType, TemplateRequest, TemplateRules}, types::v27 as vtype};
+pub use corepc_client::{client_sync::v27::{Client}, types::v27 as vtype};
 
 #[cfg(all(feature = "27_1", not(feature = "27_2")))]
-pub use corepc_client::{client_sync::v27::{Client, AddressType, TemplateRequest, TemplateRules}, types::v27 as vtype};
+pub use corepc_client::{client_sync::v27::{Client}, types::v27 as vtype};
 
 #[cfg(all(feature = "27_0", not(feature = "27_1")))]
-pub use corepc_client::{client_sync::v27::{Client, AddressType, TemplateRequest, TemplateRules}, types::v27 as vtype};
+pub use corepc_client::{client_sync::v27::{Client}, types::v27 as vtype};
 
 #[cfg(all(feature = "26_2", not(feature = "27_0")))]
-pub use corepc_client::{client_sync::v26::{Client, AddressType, TemplateRequest, TemplateRules}, types::v26 as vtype};
+pub use corepc_client::{client_sync::v26::{Client}, types::v26 as vtype};
 
 #[cfg(all(feature = "26_1", not(feature = "26_2")))]
-pub use corepc_client::{client_sync::v26::{Client, AddressType, TemplateRequest, TemplateRules}, types::v26 as vtype};
+pub use corepc_client::{client_sync::v26::{Client}, types::v26 as vtype};
 
 #[cfg(all(feature = "26_0", not(feature = "26_1")))]
-pub use corepc_client::{client_sync::v26::{Client, AddressType, TemplateRequest, TemplateRules}, types::v26 as vtype};
+pub use corepc_client::{client_sync::v26::{Client}, types::v26 as vtype};
 
 #[cfg(all(feature = "25_2", not(feature = "26_0")))]
-pub use corepc_client::{client_sync::v25::{Client, AddressType, TemplateRequest, TemplateRules}, types::v25 as vtype};
+pub use corepc_client::{client_sync::v25::{Client}, types::v25 as vtype};
 
 #[cfg(all(feature = "24_2", not(feature = "25_2")))]
-pub use corepc_client::{client_sync::v24::{Client, AddressType, TemplateRequest, TemplateRules}, types::v24 as vtype};
+pub use corepc_client::{client_sync::v24::{Client}, types::v24 as vtype};
 
 #[cfg(all(feature = "23_2", not(feature = "24_2")))]
-pub use corepc_client::{client_sync::v23::{Client, AddressType, TemplateRequest, TemplateRules}, types::v23 as vtype};
+pub use corepc_client::{client_sync::v23::{Client}, types::v23 as vtype};
 
 #[cfg(all(feature = "22_1", not(feature = "23_2")))]
-pub use corepc_client::{client_sync::v22::{Client, AddressType, TemplateRequest, TemplateRules}, types::v22 as vtype};
+pub use corepc_client::{client_sync::v22::{Client}, types::v22 as vtype};
 
 #[cfg(all(feature = "0_21_2", not(feature = "22_1")))]
-pub use corepc_client::{client_sync::v21::{Client, AddressType, TemplateRequest, TemplateRules}, types::v21 as vtype};
+pub use corepc_client::{client_sync::v21::{Client}, types::v21 as vtype};
 
 #[cfg(all(feature = "0_20_2", not(feature = "0_21_2")))]
-pub use corepc_client::{client_sync::v20::{Client, AddressType, TemplateRequest, TemplateRules}, types::v20 as vtype};
+pub use corepc_client::{client_sync::v20::{Client}, types::v20 as vtype};
 
 #[cfg(all(feature = "0_19_1", not(feature = "0_20_2")))]
-pub use corepc_client::{client_sync::v19::{Client, AddressType, TemplateRequest, TemplateRules}, types::v19 as vtype};
+pub use corepc_client::{client_sync::v19::{Client}, types::v19 as vtype};
 
 #[cfg(all(feature = "0_18_1", not(feature = "0_19_1")))]
-pub use corepc_client::{client_sync::v18::{Client, AddressType, TemplateRequest, TemplateRules}, types::v18 as vtype};
+pub use corepc_client::{client_sync::v18::{Client}, types::v18 as vtype};
 
 #[cfg(all(feature = "0_17_2", not(feature = "0_18_1")))]
-pub use corepc_client::{client_sync::v17::{Client, AddressType, TemplateRequest, TemplateRules}, types::v17 as vtype};
+pub use corepc_client::{client_sync::v17::{Client}, types::v17 as vtype};
 
 /// This is meaningless but we need it otherwise we can't get far enough into
 /// the build process to trigger the `compile_error!` in `./versions.rs`.
@@ -74,4 +74,4 @@ pub use corepc_client::{client_sync::v17::{Client, AddressType, TemplateRequest,
     not(feature = "0_18_1"),
     not(feature = "0_17_2"),
 ))]
-pub use corepc_client::{client_sync::v28::{Client, AddressType, TemplateRequest, TemplateRules}, types::v28 as vtype};
+pub use corepc_client::{client_sync::v28::{Client}, types::v28 as vtype};

node/src/lib.rs

@@ -24,7 +24,7 @@ pub use {anyhow, serde_json, tempfile, which};
 #[doc(inline)]
 pub use self::{
     // Re-export `vtype` - the version specific types.
-    client_versions::{vtype, Client, AddressType, TemplateRequest, TemplateRules},
+    client_versions::{vtype, Client},
     // Re-export the version string e.g., "28.0".
     versions::VERSION,
     // Re-export the model types as `mtype` to differentiate it from `vtype`.