Skip to content

Commit cfb740d

Browse files
committed
Merge #574: docs: fix stale corepc-node references
7a7bca2 docs: replace stale corepc-node references with bitcoind (satsfy (Renato Britto)) Pull request description: Follow up from #573 (comment) Continues `corepc-node` to `bitcoind` rename. This updates stale documentation references that were missed in earlier changes. It fixes the top level crate listing, the `bitcoind` crate README examples and text, the `bitcoind/contrib/extra_tests.sh` comments, and the `integration_test` README. ACKs for top commit: jamillambert: ACK 7a7bca2 tcharding: ACK 7a7bca2 Tree-SHA512: dc42bfad91c32a16e0173aca8b9727a892bceee6dd2a9a14f98dd99bec1956a7de76b6e76c9e412f4f2723eb9a705696f4564c5844acfa8dd768ab5b85fab797
2 parents 1fd697f + 7a7bca2 commit cfb740d

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

.github/workflows/pr-labeler.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
);
2828
2929
const filePathsToLabels = {
30-
'node/': 'C-node',
30+
'bitcoind/': 'C-bitcoind',
3131
'client/': 'C-client',
3232
'integration_test/': 'C-integration-test',
3333
'jsonrpc/': 'C-jsonrpc',

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ integration testing.
2727
- `bitreq/`: [`bitreq`](https://crates.io/crates/bitreq): Simple, minimal-dependency HTTP client, with optional features for proxies, async, and https.
2828
- `client/`: [`corepc-client`](https://crates.io/crates/corepc-client): A blocking JSON-RPC client used to test `corepc-types`.
2929
- `contrib/`: Contains scripts including one to run local regtest `bitcoind` nodes using versions specified in the config file. A template config file and bitcoind aliases are in the subdirectory `templates/`
30-
- `integration_test/`: Integration tests that use `corepc-client` and `corepc-node` to test `corepc-types`.
30+
- `integration_test/`: Integration tests that use `corepc-client` and `bitcoind` to test `corepc-types`.
3131
- `jsonrpc/`: [`jsonrpc`](https://crates.io/crates/jsonrpc): Rudimentary support for sending JSONRPC 2.0 requests and receiving responses.
32-
- `node/`: [`corepc-node`](https://crates.io/crates/corepc-node): Runs `bitcoind` regtest nodes.
32+
- `bitcoind/`: [`bitcoind`](https://crates.io/crates/bitcoind): Runs `bitcoind` regtest nodes.
3333
- `types/`: [`corepc-types`](https://crates.io/crates/corepc-types): Rust types returned by the JSON-RPC API of Bitcoin Core.
3434
- `verify/`: Provides a tool to help verify the rest of the repository.
3535

bitcoind/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ When the auto-download feature is enabled, starting a regtest node is as simple
88
// the download feature must be enabled with a specific version, for example `25_1` or `24_0_1`
99
#[cfg(feature = "download")]
1010
{
11-
let node = corepc_node::Node::from_downloaded().unwrap();
11+
let node = bitcoind::BitcoinD::from_downloaded().unwrap();
1212
assert_eq!(0, node.client.get_blockchain_info().unwrap().blocks);
1313
}
1414
```
@@ -22,19 +22,19 @@ When you don't use the auto-download feature you have the following options:
2222
* provide the `bitcoind` executable via the `BITCOIND_EXE` env var
2323

2424
```rust
25-
if let Ok(exe_path) = corepc_node::exe_path() {
26-
let node = corepc_node::BitcoinD::new(exe_path).unwrap();
25+
if let Ok(exe_path) = bitcoind::exe_path() {
26+
let node = bitcoind::BitcoinD::new(exe_path).unwrap();
2727
assert_eq!(0, node.client.get_blockchain_info().unwrap().blocks);
2828
}
2929
```
3030

3131
Startup options could be configured via the [`Conf`] struct using [`BitcoinD::with_conf`] or
32-
`Node::from_downloaded_with_conf`
32+
`BitcoinD::from_downloaded_with_conf`
3333

3434
## Features
3535

3636
* Waits until bitcoind daemon becomes ready to accept RPC commands
37-
* `node` uses a temporary directory as datadir. You can specify the root of your temp
37+
* `bitcoind` uses a temporary directory as datadir. You can specify the root of your temp
3838
directories so that you have the node's datadir in a RAM disk (eg `/dev/shm`)
3939
* Free ports are requested from the OS. Since you can't reserve the given port, a low probability
4040
race condition is still possible, for this reason the process attempts spawning 3 times with

integration_test/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Integration testing
22

33
This crate is used to run tests against all the supported versions of
4-
Core. It runs Core by using `corepc-node` with the `download` feature
5-
enabled. However `node` allows setting the environment variable
4+
Core. It runs Core by using `bitcoind` with the `download` feature
5+
enabled. However `bitcoind` allows setting the environment variable
66
`BITCOIND_EXE` to override downloading the Core executable. E.g.
77

88
`BITCOIND_EXE=/opt/bitcoin-28.0/bin/bitcoind cargo test --features=28_0`

0 commit comments

Comments
 (0)