1- # bwt-daemon
1+ # libbwt-nodejs
22
33A nodejs library for programmatically managing the Bitcoin Wallet Tracker Electrum RPC and HTTP API servers
44using the [ ` libbwt ` C FFI interface] ( https://github.com/bwt-dev/libbwt ) .
@@ -8,21 +8,21 @@ using the [`libbwt` C FFI interface](https://github.com/bwt-dev/libbwt).
88### Install
99
1010```
11- $ npm install bwt-daemon
11+ $ npm install libbwt
1212```
1313
1414This will download the ` libbwt ` library for your platform.
1515The currently supported platforms are Linux, Mac, Windows and ARMv7/8.
1616
1717The hash of the downloaded library is verified against the
18- [ ` SHA256SUMS ` ] ( https://github.com/shesek/ bwt/ blob/master/contrib/nodejs-bwt-daemon /SHA256SUMS )
18+ [ ` SHA256SUMS ` ] ( https://github.com/bwt-dev/libbwt-nodejs/ blob/master/SHA256SUMS )
1919file that ships with the npm package.
2020
2121The library comes with the electrum and http servers by default.
22- If you're only interested in the Electrum server, you can install with ` BWT_VARIANT=electrum_only npm install bwt-daemon ` .
22+ If you're only interested in the Electrum server, you can install with ` BWT_VARIANT=electrum_only npm install libbwt ` .
2323This reduces the download size by ~ 1.6MB.
2424
25- > Note: ` bwt-daemon ` uses [ ` ffi-napi ` ] ( https://github.com/node-ffi-napi/node-ffi-napi ) , which requires
25+ > Note: ` libbwt-nodejs ` uses [ ` ffi-napi ` ] ( https://github.com/node-ffi-napi/node-ffi-napi ) , which requires
2626> a recent nodejs version. If you're running into errors during installation or segmentation faults,
2727> try updating to a newer version.
2828
@@ -32,7 +32,7 @@ Below is a minimally viable setup. If bitcoind is running locally on the default
3232and with cookie auth enabled (the default), this should Just Work™ \o/
3333
3434``` js
35- import BwtDaemon from ' bwt-daemon '
35+ import { BwtDaemon } from ' libbwt '
3636
3737const bwtd = await BwtDaemon ({
3838 xpubs: [ ' xpub66...' ],
@@ -82,7 +82,7 @@ console.log('bwt http server ready on', bwtd.http_url)
8282bwtd .shutdown ()
8383```
8484
85- See [ ` example.js ` ] ( https://github.com/shesek/ bwt/ blob/master/contrib/nodejs-bwt-daemon /example.js ) for an even more complete
85+ See [ ` example.js ` ] ( https://github.com/bwt-dev/libbwt-nodejs/ blob/master/example.js ) for an even more complete
8686example, including connecting to the HTTP API.
8787
8888The full list of options is available in the [ libbwt documentation] ( https://github.com/bwt-dev/libbwt#config-options ) .
0 commit comments