Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carnesen-archive/bitcoind
A Node.js library for managing the bitcoin server process `bitcoind`
https://github.com/carnesen-archive/bitcoind
bitcoin bitcoin-cash bitcoin-core bitcoind nodejs typescript
Last synced: about 2 months ago
JSON representation
A Node.js library for managing the bitcoin server process `bitcoind`
- Host: GitHub
- URL: https://github.com/carnesen-archive/bitcoind
- Owner: carnesen-archive
- License: mit
- Created: 2019-01-30T18:06:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-07T22:53:26.000Z (almost 6 years ago)
- Last Synced: 2024-10-31T18:29:00.255Z (2 months ago)
- Topics: bitcoin, bitcoin-cash, bitcoin-core, bitcoind, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# @carnesen/bitcoind [](https://travis-ci.com/carnesen/bitcoind)
A Node.js library for managing the bitcoin server process `bitcoind`
## Install
```
$ npm install @carnesen/bitcoind
```
The package includes runtime JavaScript files suitable for Node.js >=8 as well as the corresponding TypeScript type declarations.
## Usage
Here is a little TypeScript Node.js script that spawns `bitcoind`:
```ts
// example.ts
import { spawn } from '@carnesen/bitcoind';
const bitcoinHome = '/usr/local/bitcoin-0.17.1';
(async () => {
try {
await spawn({ bitcoinHome });
process.exit(0);
} catch (ex) {
console.log(ex);
process.exit(1);
}
})()
```
Running this script looks like:
```
$ ts-node example.ts
2019-01-24T03:57:07Z Bitcoin Core version v0.17.1 (release build)
2019-01-24T03:57:07Z InitParameterInteraction: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1
2019-01-24T03:57:07Z Validating signatures for all blocks.
...
```
The `bitcoind` child process inherits the Node.js parent's stdout, stdin, and stderr. So in non-daemon mode when `bitcoind` logs to the terminal, so does the parent.
## API
### spawn({bitcoinHome, configFilePath}): Promise\
Reads a bitcoin configuration file and spawns `bitcoind` as a child process
#### bitcoinHome?
`string`. If not provided, `bitcoind` must be on your `PATH`. If provided, absolute path of a directory where the bitcoin server software is installed. By convention, `bitcoind` must be located at `` `${bitcoinHome}/bin/bitcoind` ``.
#### configFilePath?
`string`. Defaults to the platform-dependent location where the bitcoin server software looks for its configuration file, e.g. `'~/.bitcoin/bitcoin.conf'` on Linux. Before spawning `bitcoind`, `spawnBitcoin` reads the configuration file and modifies its behavior slightly based on what it finds. If the configuration does not specify `daemon` as `true`, the `spawnBitcoin` kills the child `bitcoind` process if the parent Node.js process exits. Also if `daemon` is not set to `true` (1), `bitcoind` exiting is always considered an error even if it exits with status code 0 (success).
#### Promise\
Represents the running `bitcoind` child. If there is an error spawning the child or if the child exits for any reason, the promise rejects. The only exception to that rule is if `daemon` is set to `true` and the child's exit status is 0 (success). In that case the promise resolves.
## More information
This library has a number of unit tests with >95% coverage. Check out [the tests directory](src/__tests__) for more examples of how it works. If you encounter any bugs or have any questions or feature requests, please don't hesitate to file an issue or submit a pull request on this project's repository on GitHub.
## Related
- [@carnesen/bitcoind-cli](https://github.com/carnesen/bitcoind-cli): A Node.js CLI and library for managing the bitcoin server process `bitcoind`
- [@carnesen/bitcoin-config](https://github.com/carnesen/bitcoin-config): A Node.js library for bitcoin server software configuration