Skip to content

Commit

Permalink
[ecash-agora] Add integration test dev env instructions to README
Browse files Browse the repository at this point in the history
Summary: Pretty hard to figure this out if you don't know what's going on

Test Plan: Check out README

Reviewers: #bitcoin_abc, emack

Reviewed By: #bitcoin_abc, emack

Differential Revision: https://reviews.bitcoinabc.org/D16952
  • Loading branch information
BytesOfMan committed Oct 22, 2024
1 parent 1653ee0 commit 73cf689
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions modules/ecash-agora/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,27 @@ const acceptTx = txBuilder.sign(ecc);
await chronik.broadcastTx(acceptTx.ser());
```

## Development

### Running the integration tests locally

1. Build the node software from source with chronik and plugins enabled

```
mkdir build/
cd build/
cmake -GNinja .. -DBUILD_BITCOIN_CHRONIK=ON -DBUILD_BITCOIN_CHRONIK_PLUGINS=ON
ninja
```

2. You may need to [adjust](https://stackoverflow.com/questions/72409563/unsupported-hash-type-ripemd160-with-hashlib-in-python/72508879#72508879) your `openssl` settings

3. Specify the location of your built chronik-with-plugins node with the `BUILD_DIR` env variable, e.g.

Running from `bitcoin-abc/modules/ecash-agora` if your build dir is `bitcoin-abc/build/`:

`BUILD_DIR="${PWD}/../../build" npm run integration-tests`

## Changelog

- 0.1.0 - MVP [D16087](https://reviews.bitcoinabc.org/D16087) [D16111](https://reviews.bitcoinabc.org/D16111)
Expand Down

0 comments on commit 73cf689

Please sign in to comment.