Merge pull request #156 from tcharding/05-11-client-types

client: Move types to version specific module

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

@@ -59,11 +59,7 @@ macro_rules! impl_client_v17__converttopsbt {
 macro_rules! impl_client_v17__createpsbt {
     () => {
         impl Client {
-            pub fn create_psbt(
-                &self,
-                inputs: &[$crate::client_sync::Input],
-                outputs: &[$crate::client_sync::Output],
-            ) -> Result<CreatePsbt> {
+            pub fn create_psbt(&self, inputs: &[Input], outputs: &[Output]) -> Result<CreatePsbt> {
                 self.call("createpsbt", &[into_json(inputs)?, into_json(outputs)?])
             }
         }
@@ -77,8 +73,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,10 +18,10 @@ 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},
 };
 
+// This publicly re-exports `Client`.
 crate::define_jsonrpc_minreq_client!("v18");
 crate::impl_client_check_expected_server_version!({ [180100] });
 

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");