Skip to content

Commit

Permalink
Merge #37: Update readme
Browse files Browse the repository at this point in the history
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
  • Loading branch information
tcharding committed Dec 19, 2024
2 parents 7ff2e7f + 6268b6b commit 69461aa
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ for bitcoin core 25.1, starting a regtest node is as simple as that:
// the download feature is enabled whenever a specific version is enabled, for example `25_1` or `24_0_1`
#[cfg(feature = "download")]
{
let bitcoind = bitcoind::BitcoinD::from_downloaded().unwrap();
let bitcoind = node::Node::from_downloaded().unwrap();
assert_eq!(0, bitcoind.client.get_blockchain_info().unwrap().blocks);
}
```
Expand All @@ -24,18 +24,18 @@ When you don't use the auto-download feature you have the following options:

```rust
if let Ok(exe_path) = bitcoind::exe_path() {
let bitcoind = bitcoind::BitcoinD::new(exe_path).unwrap();
let bitcoind = node::Node::new(exe_path).unwrap();
assert_eq!(0, bitcoind.client.get_blockchain_info().unwrap().blocks);
}
```

Startup options could be configured via the [`Conf`] struct using [`BitcoinD::with_conf`] or
[`BitcoinD::from_downloaded_with_conf`]
Startup options could be configured via the [`Conf`] struct using [`Node::with_conf`] or
[`Node::from_downloaded_with_conf`]

## Features

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

0 comments on commit 69461aa

Please sign in to comment.