Skip to content

Commit 69461aa

Browse files
committed
Merge rust-bitcoin#37: Update readme
6268b6b Update readme (Edil Medeiros) Pull request description: Commit 6092f89 renamed the `bitcoind` directory to be `node` and the `BitcoinD` type to `Node`, but the examples in the readme did not reflect the changes. ACKs for top commit: tcharding: ACK 6268b6b Tree-SHA512: 311f42708a5a87136e77f5f01b03db5010ca9cd2ccb5ed0517986847037d320f0236a6ea1698f85d63df81ee49856eb9ac67c35dbf3e8badf5965edceb123de2
2 parents 7ff2e7f + 6268b6b commit 69461aa

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

node/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ for bitcoin core 25.1, starting a regtest node is as simple as that:
99
// the download feature is enabled whenever a specific version is enabled, for example `25_1` or `24_0_1`
1010
#[cfg(feature = "download")]
1111
{
12-
let bitcoind = bitcoind::BitcoinD::from_downloaded().unwrap();
12+
let bitcoind = node::Node::from_downloaded().unwrap();
1313
assert_eq!(0, bitcoind.client.get_blockchain_info().unwrap().blocks);
1414
}
1515
```
@@ -24,18 +24,18 @@ When you don't use the auto-download feature you have the following options:
2424

2525
```rust
2626
if let Ok(exe_path) = bitcoind::exe_path() {
27-
let bitcoind = bitcoind::BitcoinD::new(exe_path).unwrap();
27+
let bitcoind = node::Node::new(exe_path).unwrap();
2828
assert_eq!(0, bitcoind.client.get_blockchain_info().unwrap().blocks);
2929
}
3030
```
3131

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

3535
## Features
3636

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

0 commit comments

Comments
 (0)