Merge pull request #2 from tcharding/06-02-integration-tests

Convert the crate to a workspace

Cargo.toml

@@ -1,51 +1,14 @@
-[package]
-name = "bitcoind-json-rpc"
-version = "0.1.0"
-authors = [
-    "Steven Roose <[email protected]>",
-    "Jean Pierre Dudey <[email protected]>",
-    "Dawid Ciężarkiewicz <[email protected]>",
-    "Tobin C. Harding <[email protected]>"
-]
-license = "CC0-1.0"
-description = "Support for the Bitcoin Core JSON-RPC API"
-keywords = ["bitcoin", "json-rpc"]
-edition = "2021"
+[workspace]
+members = ["client", "json"]
+exclude = ["integration_test"]
+resolver = "2"
 
-[features]
-default = []
-# Enable this feature to get JSON-RPC client code.
-client-sync = ["jsonrpc"]
+[patch.crates-io.bitcoind-json-rpc-client]
+path = "client"
 
-# These are only for controlling tests.
-"v26" = ["bitcoind/26_0"]       # FIXME: The `json/16` module was written for 26.1
-"v25" = ["bitcoind/25_1"]
-"v24" = ["bitcoind/24_0_1"]
-"v23" = ["bitcoind/23_1"]
-"v22" = ["bitcoind/22_1"]
-"v21" = ["bitcoind/0_21_2"]
-"v20" = ["bitcoind/0_20_2"]
-"v19" = ["bitcoind/0_19_1"]
-"v18" = ["bitcoind/0_18_1"]
-"v17" = ["bitcoind/0_17_1"]
-
-[dependencies]
-bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
-internals = { package = "bitcoin-internals", version = "0.3.0", default-features = false,  features = ["std"] }
-log = "0.4"
-serde = { version = "1.0.103", default-features = false, features = [ "derive", "alloc" ] }
-serde_json = { version = "1.0.117" }
-
-jsonrpc = { version = "0.18.0", features = ["minreq_http"], optional = true }
-
-[dev-dependencies]
-rand = "0.8.5"
-env_logger = "0.9.0"
-# FIXME: How are we going to handle features (using features in this crate, ugh!)?
-bitcoind = { version = "0.36.0", features = ["22_1"] }
+[patch.crates-io.bitcoind-json-rpc-types]
+path = "json"
 
 [patch.crates-io.bitcoind]
-path = "/home/tobin/build/github.com/tcharding/bitcoind/bitcoind-json-rpc"
-
-[patch.crates-io.bitcoind-json-rpc]
-path = "."
+git = "https://github.com/tcharding/bitcoind"
+branch = "bitcoind-json-rpc"

client/Cargo.toml

@@ -0,0 +1,40 @@
+[package]
+name = "bitcoind-json-rpc-client"
+version = "0.1.0"
+authors = [
+    "Steven Roose <[email protected]>",
+    "Jean Pierre Dudey <[email protected]>",
+    "Dawid Ciężarkiewicz <[email protected]>",
+    "Tobin C. Harding <[email protected]>"
+]
+license = "CC0-1.0"
+description = "Bitcoin Core JSON-RPC client"
+keywords = ["bitcoin", "bitcoind", "json-rpc"]
+edition = "2021"
+
+[features]
+default = []
+# Enable this feature to get a blocking JSON-RPC client.
+client-sync = ["jsonrpc"]
+
+[dependencies]
+bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
+json = { package = "bitcoind-json-rpc-types", version = "0.1.0", default-features = false, features = [] }
+internals = { package = "bitcoin-internals", version = "0.3.0", default-features = false,  features = ["std"] }
+log = "0.4"
+serde = { version = "1.0.103", default-features = false, features = [ "derive", "alloc" ] }
+serde_json = { version = "1.0.117" }
+
+jsonrpc = { version = "0.18.0", features = ["minreq_http"], optional = true }
+
+[dev-dependencies]
+rand = "0.8.5"
+env_logger = "0.9.0"
+# FIXME: How are we going to handle features (using features in this crate, ugh!)?
+bitcoind = { version = "0.36.0", features = ["22_1"] }
+
+[patch.crates-io.bitcoind]
+path = "/home/tobin/build/github.com/tcharding/bitcoind/bitcoind-json-rpc"
+
+[patch.crates-io.bitcoind-json-rpc]
+path = "."

client/LICENSE

@@ -0,0 +1,122 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
+

src/client_sync/mod.rs → client/src/client_sync/mod.rs

@@ -134,14 +134,14 @@ macro_rules! impl_client_helpers {
             /// Gets the blockhash of the current chain tip.
             pub fn best_block_hash(&self) -> Result<bitcoin::BlockHash> {
                 let json = self.get_blockchain_info()?;
-                let concrete: $crate::model::GetBlockchainInfo = json.try_into().unwrap();
+                let concrete: $crate::json::model::GetBlockchainInfo = json.try_into().unwrap();
                 Ok(concrete.best_block_hash)
             }
 
             /// Gets a block by blockhash.
             pub fn get_block(&self, hash: &bitcoin::BlockHash) -> Result<bitcoin::Block> {
                 let json = self.get_block_verbosity_zero(hash)?;
-                let concrete: $crate::model::GetBlockVerbosityZero = json.try_into()?;
+                let concrete: $crate::json::model::GetBlockVerbosityZero = json.try_into()?;
                 Ok(concrete.0)
             }
         }

src/client_sync/v17/blockchain.rs → client/src/client_sync/v17/blockchain.rs

@@ -29,7 +29,7 @@ macro_rules! impl_client_v17__getbestblockhash {
             /// Gets the blockhash of the current chain tip.
             pub fn best_block_hash(&self) -> Result<bitcoin::BlockHash> {
                 let json = self.get_best_block_hash()?;
-                let concrete: $crate::model::GetBestBlockHash = json.try_into().unwrap();
+                let concrete: $crate::json::model::GetBestBlockHash = json.try_into().unwrap();
                 Ok(concrete.0)
             }
 
@@ -48,7 +48,7 @@ macro_rules! impl_client_v17__getblock {
             /// Gets a block by blockhash.
             pub fn get_block(&self, hash: &BlockHash) -> Result<Block> {
                 let json = self.get_block_verbosity_zero(hash)?;
-                let concrete: $crate::model::GetBlockVerbosityZero = json.try_into()?;
+                let concrete: $crate::json::model::GetBlockVerbosityZero = json.try_into()?;
                 Ok(concrete.0)
             }
 

src/client_sync/v18/mod.rs → client/src/client_sync/v18/mod.rs

@@ -14,7 +14,6 @@ use crate::json::v18::*;
 const EXPECTED_SERVER_VERSION: usize = 180100;
 
 crate::define_jsonrpc_minreq_client!();
-//crate::impl_client_helpers!();
 
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();

client/src/lib.rs

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Support for connecting to Bitcoin Core via JSON-RPC.
+
+/// Re-export the `rust-bitcoin` crate.
+pub extern crate bitcoin;
+
+/// Re-export the `rust-bitcoin-json-rpc-tyes` crate.
+pub extern crate json;
+
+#[cfg(feature = "client-sync")]
+#[macro_use]
+pub mod client_sync;

integration_test/Cargo.toml

@@ -0,0 +1,49 @@
+[package]
+name = "integration-test"
+version = "0.1.0"
+authors = ["Tobin C. Harding <[email protected]>"]
+license = "CC0-1.0"
+description = "Integration tests for bitcoind-json-rpc-client/types"
+edition = "2021"
+
+[features]
+"26_0" =["v26", "bitcoind/26_0"]
+"25_1" = ["v25", "bitcoind/25_1"]
+"25_0" = ["v25", "bitcoind/25_0"]
+"24_0_1" = ["v24", "bitcoind/24_0_1"]
+"23_1" = ["v23", "bitcoind/23_1"]
+"22_1" = ["v22", "bitcoind/22_1"]
+"0_21_2" = ["v21", "bitcoind/0_21_2"]
+"0_20_2" = ["v20", "bitcoind/0_20_2"]
+"0_19_1" = ["v19", "bitcoind/0_19_1"]
+"0_18_1" = ["v18", "bitcoind/0_18_1"]
+"0_17_1" = ["v17", "bitcoind/0_17_1"]
+
+"v26" = []
+"v25" = []
+"v24" = []
+"v23" = []
+"v22" = []
+"v21" = []
+"v20" = []
+"v19" = []
+"v18" = []
+"v17" = []
+
+[dependencies]
+bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
+client = { package = "bitcoind-json-rpc-client", version = "0.1.0", default-features = false, features = ["client-sync"] }
+bitcoind = { version = "0.36.0", default-features = false, features = [] }
+rand = "0.8.5"
+env_logger = "0.9.0"
+
+[dev-dependencies]
+
+[patch.crates-io.bitcoind-json-rpc-client]
+path = "../client"
+
+[patch.crates-io.bitcoind-json-rpc-types]
+path = "../json"
+
+[patch.crates-io.bitcoind]
+path = "/home/tobin/build/github.com/tcharding/bitcoind/bitcoind-json-rpc"

integration_test/src/lib.rs

@@ -0,0 +1,40 @@
+//! Provides a macro that implements the tests.
+
+pub mod v17;
+pub mod v22;
+
+/// Requires `RPC_PORT` to be in scope.
+use bitcoind::BitcoinD;
+
+/// Initialize a logger (configure with `RUST_LOG=trace cargo test`).
+#[allow(dead_code)] // Not all tests use this function.
+pub fn init_logger() { let _ = env_logger::try_init(); }
+
+/// Returns a handle to a `bitcoind` instance with "default" wallet loaded.
+#[allow(dead_code)] // Not all tests use this function.
+pub fn bitcoind_with_default_wallet() -> BitcoinD {
+    let exe = bitcoind::exe_path().expect("failed to get bitcoind executable");
+
+    let conf = bitcoind::Conf::default();
+    BitcoinD::with_conf(exe, &conf).expect("failed to create BitcoinD")
+}
+
+/// Returns a handle to a `bitcoind` instance without any wallets.
+#[allow(dead_code)] // Not all tests use this function.
+pub fn bitcoind_with_wallet(wallet: String) -> BitcoinD {
+    let exe = bitcoind::exe_path().expect("failed to get bitcoind executable");
+
+    let mut conf = bitcoind::Conf::default();
+    conf.wallet = Some(wallet);
+    BitcoinD::with_conf(exe, &conf).expect("failed to create BitcoinD")
+}
+
+/// Returns a handle to a `bitcoind` instance without any wallet loaded.
+#[allow(dead_code)] // Not all tests use this function.
+pub fn bitcoind_no_wallet() -> BitcoinD {
+    let exe = bitcoind::exe_path().expect("failed to get bitcoind executable");
+
+    let mut conf = bitcoind::Conf::default();
+    conf.wallet = None;
+    BitcoinD::with_conf(exe, &conf).expect("failed to create BitcoinD")
+}