Merge #151: Move TemplateRequest and TemplateRules into their proper module

9ab4ed1 Move TemplateRequest and TemplateRules to appropriate module (GideonBature)

Pull request description:

  This pull request moves the `TemplateRequest` struct and `TemplateRules` enum, into their appropriate module to improve code organization and maintainability.

ACKs for top commit:
  tcharding:
    ACK 9ab4ed1

Tree-SHA512: c89fe05230f1e806e0e1ade6c5d323a30326edee6bd3ad34e5cded36b6a3b317d1393616b3843438b5f81600b019e637365bed7c3f27b8a9bf4523e6a3b274b3

Author: tcharding

client/src/client_sync/mod.rs

@@ -259,24 +259,3 @@ pub struct WalletCreateFundedPsbtInput {
     txid: Txid,
     vout: u32,
 }
-
-/// Arg for the `getblocktemplate` method.
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
-pub struct TemplateRequest {
-    /// A list of strings.
-    pub rules: Vec<TemplateRules>,
-}
-
-/// Client side supported softfork deployment.
-#[derive(Copy, Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
-#[serde(rename_all = "lowercase")]
-pub enum TemplateRules {
-    /// SegWit v0 supported.
-    Segwit,
-    /// Signet supported.
-    Signet,
-    /// CSV supported.
-    Csv,
-    /// Taproot supported.
-    Taproot,
-}

client/src/client_sync/v17/mining.rs

@@ -16,7 +16,7 @@ macro_rules! impl_client_v17__getblocktemplate {
         impl Client {
             pub fn get_block_template(
                 &self,
-                request: &$crate::client_sync::TemplateRequest,
+                request: &TemplateRequest,
             ) -> Result<GetBlockTemplate> {
                 self.call("getblocktemplate", &[into_json(request)?])
             }

client/src/client_sync/v17/mod.rs

@@ -151,3 +151,26 @@ impl fmt::Display for AddressType {
         fmt::Display::fmt(s, f)
     }
 }
+
+/// Arg for the `getblocktemplate` method.
+///
+/// For Core versions 0.17 through to v28. For Core v29 and onwards use `v29::TemplateRequest`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct TemplateRequest {
+    /// A list of strings.
+    pub rules: Vec<TemplateRules>,
+}
+
+/// Client side supported softfork deployment.
+#[derive(Copy, Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum TemplateRules {
+    /// SegWit v0 supported.
+    Segwit,
+    /// Signet supported.
+    Signet,
+    /// CSV supported.
+    Csv,
+    /// Taproot supported.
+    Taproot,
+}

client/src/client_sync/v18/mod.rs

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

client/src/client_sync/v19/mod.rs

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

client/src/client_sync/v20.rs

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

client/src/client_sync/v21/mod.rs

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

client/src/client_sync/v22/mod.rs

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

client/src/client_sync/v23/mod.rs

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

client/src/client_sync/v24.rs

@@ -14,7 +14,10 @@ use crate::client_sync::into_json;
 use crate::types::v24::*;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
-pub use crate::client_sync::{v23::AddressType, WalletCreateFundedPsbtInput};
+pub use crate::client_sync::{
+    v17::{TemplateRequest, TemplateRules},
+    v23::AddressType, WalletCreateFundedPsbtInput
+};
 
 crate::define_jsonrpc_minreq_client!("v24");
 crate::impl_client_check_expected_server_version!({ [240200] });