Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit e975c99

Browse files
committed
Convert the crate to a workspace
Mirror the crate structure in `rust-bitcoincore-rpc` by adding crates: - `client` - `json` - `integration_test` Exclude `integration_test` from the workspace because it should currently be used with specific versions (all features won't work until "26_0" is implemented).
1 parent a587f1c commit e975c99

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+627
-391
lines changed

Cargo.toml

Lines changed: 10 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,14 @@
1-
[package]
2-
name = "bitcoind-json-rpc"
3-
version = "0.1.0"
4-
authors = [
5-
"Steven Roose <[email protected]>",
6-
"Jean Pierre Dudey <[email protected]>",
7-
"Dawid Ciężarkiewicz <[email protected]>",
8-
"Tobin C. Harding <[email protected]>"
9-
]
10-
license = "CC0-1.0"
11-
description = "Support for the Bitcoin Core JSON-RPC API"
12-
keywords = ["bitcoin", "json-rpc"]
13-
edition = "2021"
1+
[workspace]
2+
members = ["client", "json"]
3+
exclude = ["integration_test"]
4+
resolver = "2"
145

15-
[features]
16-
default = []
17-
# Enable this feature to get JSON-RPC client code.
18-
client-sync = ["jsonrpc"]
6+
[patch.crates-io.bitcoind-json-rpc-client]
7+
path = "client"
198

20-
# These are only for controlling tests.
21-
"v26" = ["bitcoind/26_0"] # FIXME: The `json/16` module was written for 26.1
22-
"v25" = ["bitcoind/25_1"]
23-
"v24" = ["bitcoind/24_0_1"]
24-
"v23" = ["bitcoind/23_1"]
25-
"v22" = ["bitcoind/22_1"]
26-
"v21" = ["bitcoind/0_21_2"]
27-
"v20" = ["bitcoind/0_20_2"]
28-
"v19" = ["bitcoind/0_19_1"]
29-
"v18" = ["bitcoind/0_18_1"]
30-
"v17" = ["bitcoind/0_17_1"]
31-
32-
[dependencies]
33-
bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
34-
internals = { package = "bitcoin-internals", version = "0.3.0", default-features = false, features = ["std"] }
35-
log = "0.4"
36-
serde = { version = "1.0.103", default-features = false, features = [ "derive", "alloc" ] }
37-
serde_json = { version = "1.0.117" }
38-
39-
jsonrpc = { version = "0.18.0", features = ["minreq_http"], optional = true }
40-
41-
[dev-dependencies]
42-
rand = "0.8.5"
43-
env_logger = "0.9.0"
44-
# FIXME: How are we going to handle features (using features in this crate, ugh!)?
45-
bitcoind = { version = "0.36.0", features = ["22_1"] }
9+
[patch.crates-io.bitcoind-json-rpc-types]
10+
path = "json"
4611

4712
[patch.crates-io.bitcoind]
48-
path = "/home/tobin/build/github.com/tcharding/bitcoind/bitcoind-json-rpc"
49-
50-
[patch.crates-io.bitcoind-json-rpc]
51-
path = "."
13+
git = "https://github.com/tcharding/bitcoind"
14+
branch = "bitcoind-json-rpc"
File renamed without changes.

client/Cargo.toml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[package]
2+
name = "bitcoind-json-rpc-client"
3+
version = "0.1.0"
4+
authors = [
5+
"Steven Roose <[email protected]>",
6+
"Jean Pierre Dudey <[email protected]>",
7+
"Dawid Ciężarkiewicz <[email protected]>",
8+
"Tobin C. Harding <[email protected]>"
9+
]
10+
license = "CC0-1.0"
11+
description = "Bitcoin Core JSON-RPC client"
12+
keywords = ["bitcoin", "bitcoind", "json-rpc"]
13+
edition = "2021"
14+
15+
[features]
16+
default = []
17+
# Enable this feature to get a blocking JSON-RPC client.
18+
client-sync = ["jsonrpc"]
19+
20+
[dependencies]
21+
bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
22+
json = { package = "bitcoind-json-rpc-types", version = "0.1.0", default-features = false, features = [] }
23+
internals = { package = "bitcoin-internals", version = "0.3.0", default-features = false, features = ["std"] }
24+
log = "0.4"
25+
serde = { version = "1.0.103", default-features = false, features = [ "derive", "alloc" ] }
26+
serde_json = { version = "1.0.117" }
27+
28+
jsonrpc = { version = "0.18.0", features = ["minreq_http"], optional = true }
29+
30+
[dev-dependencies]
31+
rand = "0.8.5"
32+
env_logger = "0.9.0"
33+
# FIXME: How are we going to handle features (using features in this crate, ugh!)?
34+
bitcoind = { version = "0.36.0", features = ["22_1"] }
35+
36+
[patch.crates-io.bitcoind]
37+
path = "/home/tobin/build/github.com/tcharding/bitcoind/bitcoind-json-rpc"
38+
39+
[patch.crates-io.bitcoind-json-rpc]
40+
path = "."

client/LICENSE

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.
122+
File renamed without changes.

src/client_sync/mod.rs renamed to client/src/client_sync/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ macro_rules! impl_client_helpers {
134134
/// Gets the blockhash of the current chain tip.
135135
pub fn best_block_hash(&self) -> Result<bitcoin::BlockHash> {
136136
let json = self.get_blockchain_info()?;
137-
let concrete: $crate::model::GetBlockchainInfo = json.try_into().unwrap();
137+
let concrete: $crate::json::model::GetBlockchainInfo = json.try_into().unwrap();
138138
Ok(concrete.best_block_hash)
139139
}
140140

141141
/// Gets a block by blockhash.
142142
pub fn get_block(&self, hash: &bitcoin::BlockHash) -> Result<bitcoin::Block> {
143143
let json = self.get_block_verbosity_zero(hash)?;
144-
let concrete: $crate::model::GetBlockVerbosityZero = json.try_into()?;
144+
let concrete: $crate::json::model::GetBlockVerbosityZero = json.try_into()?;
145145
Ok(concrete.0)
146146
}
147147
}

src/client_sync/v17/blockchain.rs renamed to client/src/client_sync/v17/blockchain.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ macro_rules! impl_client_v17__getbestblockhash {
2929
/// Gets the blockhash of the current chain tip.
3030
pub fn best_block_hash(&self) -> Result<bitcoin::BlockHash> {
3131
let json = self.get_best_block_hash()?;
32-
let concrete: $crate::model::GetBestBlockHash = json.try_into().unwrap();
32+
let concrete: $crate::json::model::GetBestBlockHash = json.try_into().unwrap();
3333
Ok(concrete.0)
3434
}
3535

@@ -48,7 +48,7 @@ macro_rules! impl_client_v17__getblock {
4848
/// Gets a block by blockhash.
4949
pub fn get_block(&self, hash: &BlockHash) -> Result<Block> {
5050
let json = self.get_block_verbosity_zero(hash)?;
51-
let concrete: $crate::model::GetBlockVerbosityZero = json.try_into()?;
51+
let concrete: $crate::json::model::GetBlockVerbosityZero = json.try_into()?;
5252
Ok(concrete.0)
5353
}
5454

File renamed without changes.

0 commit comments

Comments
 (0)