Skip to content

Commit 5800e47

Browse files
committed
docs: Update README
1 parent 3b8ea11 commit 5800e47

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
🔸 Developer-friendly, modern HTTP REST API<br>
1414
🔸 Real-time updates with Server-Sent-Events or Web Hooks
1515

16-
> ⚠️ This is early alpha software that is likely to be buggy. Use with care.
16+
> ⚠️ This is early alpha software that is likely to be buggy. Use with care, preferably on testnet/regtest.
1717
1818
- [Intro](#intro)
1919
- [Server setup](#server-setup)
@@ -125,7 +125,7 @@ your `--bitcoind-url` (defaults to `http://127.0.0.1:<default-rpc-port>`),
125125

126126
You can set multiple `--xpub`s to track. This also supports ypubs and zpubs.
127127

128-
Be default, the Electrum server will be bound on port `50001`/`60001`/`60401` (according to the network)
128+
By default, the Electrum server will be bound on port `50001`/`60001`/`60401` (according to the network)
129129
and the HTTP server will be bound on port `3060`. This can be controlled with `--electrum-rpc-addr`
130130
and `--http-server-addr`.
131131

@@ -167,7 +167,7 @@ By default, bwt will query bitcoind for new blocks/transactions every 5 seconds.
167167
This can be adjusted with `--poll-interval <seconds>`.
168168

169169
To get *real* real-time updates, you may configure your bitcoind node to send a `POST /sync` request to the bwt
170-
http server whenever a new block or a wallet transaction is found, using the `walletnotify` and `blocknotify` options.
170+
http server whenever a new block or wallet transaction is found, using the `walletnotify` and `blocknotify` options.
171171

172172
Example bitcoind configuration:
173173
```
@@ -230,8 +230,9 @@ The plugin is currently available for Linux and Windows.
230230
Note that it is not possible to install external plugins with the Electrum AppImage or standalone Windows executable.
231231
You will need to [run from tar.gz](https://github.com/spesmilo/electrum/#running-from-targz) on Linux, use the Windows installer, or [run from source](https://github.com/spesmilo/electrum/#development-version-git-clone).
232232

233-
![Screenshot of bwt integrated into Electrum](doc/electrum-plugin.png)
233+
To build the plugin from source, first build the binary as [described here](#from-source), copy it into the `contrib/electrum-plugin` directory, then place that directory under `electrum/plugins`, *but renamed to `bwt`* (Electrum won't recognize it otherwise).
234234

235+
![Screenshot of bwt integrated into Electrum](doc/electrum-plugin.png)
235236

236237
## HTTP API
237238

@@ -257,7 +258,7 @@ $ curl localhost:3060/hd
257258
258259
{
259260
"9f0d3265": {
260-
"master": "tpubDAfKzTwp5MBqcSM3PUqkGjftNDSgKYtKQNoT6CosG7oGDAKpQWgGmB7t2VBt5a9z2k1u7F7FZnMzDtDmdnUwRcdiVakHXt4n7uXCd8LFJzz",
261+
"xpub": "tpubDAfKzTwp5MBqcSM3PUqkGjftNDSgKYtKQNoT6CosG7oGDAKpQWgGmB7t2VBt5a9z2k1u7F7FZnMzDtDmdnUwRcdiVakHXt4n7uXCd8LFJzz",
261262
"origin": "3f37f4f0/0",
262263
"network": "regtest",
263264
...
@@ -1048,7 +1049,7 @@ data:{"category":"ChainTip","params":[130,"57d17db78d5017c89e86e863a7397c02027f0
10481049
# Disconnected again, this time while a reorg happened
10491050
$ curl localhost:3060/stream?synced-tip=130:57d17db78d5017c89e86e863a7397c02027f09327222feb72cdfe8372644c589
10501051
< HTTP/1.1 410 Gone
1051-
Reorg detected at height 130
1052+
Reorg detected at height 130 (previous=57d17db78d5017c89e86e863a7397c02027f09327222feb72cdfe8372644c589 current=43b482862ba3fc883187f534be1971186b11c534494129397e8a2b4faf4bf2f4)
10521053
10531054
# Re-sync events from height 110 (N=20 blocks before the reported reorg)
10541055
$ curl localhost:3060/stream?synced-tip=110

0 commit comments

Comments
 (0)