Skip to content

Commit

Permalink
Merge pull request #231 from rustaceanrob/readme-12-4
Browse files Browse the repository at this point in the history
Update `README` and remove scripts
  • Loading branch information
rustaceanrob authored Dec 4, 2024
2 parents a3f8b87 + a912824 commit 70445a7
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 71 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ let mut addresses = HashSet::new();
addresses.insert(address);
let builder = NodeBuilder::new(bitcoin::Network::Signet);
// Add node preferences and build the node/client
let (mut node, mut client) = builder
let (node, client) = builder
// Add the peers
.add_peers(vec![TrustedPeer::from_ip(peer_1), TrustedPeer::from_ip(peer_1)])
// The Bitcoin scripts to monitor
Expand Down Expand Up @@ -76,7 +76,7 @@ While connections over the Tor protocol are supported by the feature `tor`, the

The preferred workflow is by using `just`. If you do not have `just` installed, check out the [installation page](https://just.systems/man/en/chapter_4.html).

To run the unit tests:
To run the unit tests and doc tests:

```
just test
Expand All @@ -88,18 +88,22 @@ To sync with a live Signet node:
just sync
```

And to run scenarios against your `bitcoind` instance:
And to run scenarios against your `bitcoind` instance, set a `BITCOIND_EXE` environment variable to the path to `bitcoind`:

```
just integrate
export BITCOIND_EXE = "/usr/path/to/bitcoind/"
```

The default path to the `.bitcoin` directory is for Linux. To set this path to another operating system or location:
You may want to add this to your bash or zsh profile.

To run the `bitcoind` tests:

```
just bitcoindir=/path/to/bitcoin/folder/ integrate
just integrate
```

If you do not have `bitcoind` installed, you may simply run `just integrate` and it will be installed for you in the `build` folder.

## Project Layout

`chain`: Contains all logic for syncing block headers, filter headers, filters, parsing blocks. Also contains preset checkpoints for Signet, Regtest, and Bitcoin networks. Notable files: `chain.rs`
Expand Down
54 changes: 0 additions & 54 deletions scripts/integration.sh

This file was deleted.

1 change: 0 additions & 1 deletion scripts/kill.sh

This file was deleted.

9 changes: 0 additions & 9 deletions scripts/mine.sh

This file was deleted.

1 change: 0 additions & 1 deletion scripts/regtest.sh

This file was deleted.

0 comments on commit 70445a7

Please sign in to comment.