Skip to content

Commit

Permalink
docs: update README to include section on electrum server
Browse files Browse the repository at this point in the history
  • Loading branch information
torkelrogstad committed Oct 30, 2024
1 parent 0ace3cf commit b2e3463
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,25 @@ $ buf curl --http2-prior-knowledge --protocol grpc \
}
```

# Regtest

By default, the enforcer runs against our custom signet. If you instead want to
run against a local regtest, you need to also run a local regtest Electrum
server.

This can be done by:

```bash
$ git clone https://github.com/romanz/electrs

# from within the cloned directory
# note that electrs does not like user + password auth!
# you'll have to used cookie-based authentication
$ cargo run --release -- --network regtest \
--daemon-dir $HOME/.bitcoin \
--log-filters INFO
```

# Logging

The application uses the `tracing` crate for logging. Logging is configured
Expand Down

0 comments on commit b2e3463

Please sign in to comment.