Skip to content

Commit 72df790

Browse files
committed
Remove outdated .env.example and update README for enforcer integration
1 parent 7dad0bf commit 72df790

3 files changed

Lines changed: 15 additions & 12 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ core.*
1515
/tmp/
1616
/.bitcoin-rs/
1717
/data/
18-
/.env
18+
.env
1919

2020
# Re-include project plan tracked in-repo (global ~/.gitignore drops PLAN.md).
2121
!PLAN.md

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,38 +36,41 @@ That starts a mainnet node storing state in `.bitcoin-rs` and serving JSON-RPC
3636
on `127.0.0.1:8332`. See [docs/getting-started.md](docs/getting-started.md) for
3737
backend selection, RPC authentication, and checking sync progress.
3838

39-
### Docker Compose
39+
### Enforcer integration
4040

41-
The enforcer integration Compose configuration builds the production `fjall` +
42-
`bitcoinkernel` profile, stores node and enforcer data under `data/`, exposes
41+
The Compose example under `tools/bip300301-enforcer` is specifically for
42+
running bitcoin-rs together with the BIP300/301 enforcer; it is not the general
43+
bitcoin-rs deployment path. It builds the production `fjall` + `bitcoinkernel`
44+
node profile, starts both services, stores their data under `data/`, exposes
4345
P2P, and binds RPC to the Docker host's loopback interface only. One
44-
`BITCOIN_RS_NETWORK` selects the matching bitcoin-rs and enforcer network; the
45-
`drynet4` selection derives its mainnet consensus rules, custom P2P magic, fixed
46-
peer, and disabled DNS seeding inside bitcoin-rs.
46+
`BITCOIN_RS_NETWORK` selects the matching network for both services. The
47+
`drynet4` selection derives its mainnet consensus rules, custom P2P magic,
48+
fixed peer, and disabled DNS seeding inside bitcoin-rs.
4749

48-
Set explicit RPC credentials in `.env`, then start the node:
50+
Set explicit RPC credentials in `.env`, then start bitcoin-rs and the enforcer:
4951

5052
```sh
53+
cd tools/bip300301-enforcer
5154
cp .env.example .env
5255
# Edit .env and set BITCOIN_RS_RPC_PASSWORD before starting the node.
5356

54-
docker compose --env-file .env -f tools/bip300301-enforcer/docker-compose.yaml up --build -d
55-
docker compose --env-file .env -f tools/bip300301-enforcer/docker-compose.yaml logs -f node
57+
docker compose up --build -d
58+
docker compose logs -f
5659
```
5760

5861
Check sync progress inside the container. This uses the credentials already
5962
provided by Compose and does not evaluate `.env` as shell code:
6063

6164
```sh
62-
docker compose --env-file .env -f tools/bip300301-enforcer/docker-compose.yaml exec node sh -c \
65+
docker compose exec node sh -c \
6366
'curl --user "$BITCOIN_RS_RPC_USER:$BITCOIN_RS_RPC_PASSWORD" \
6467
-H "content-type: application/json" \
6568
-d "{\"jsonrpc\":\"1.0\",\"id\":\"sync\",\"method\":\"getblockchaininfo\",\"params\":[]}" \
6669
http://127.0.0.1:8332/'
6770
```
6871

6972
Stop the process without deleting its chain data with
70-
`docker compose --env-file .env -f tools/bip300301-enforcer/docker-compose.yaml down`.
73+
`docker compose down`.
7174
Compose allows up to 5 minutes for the full clean checkpoint before forcing
7275
termination. Chain data remains under `data/` until it is explicitly removed.
7376

0 commit comments

Comments
 (0)