Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/carnesen-archive/bitcoin-regtest-service

A Node.js library for managing a "regtest"-mode `bitcoind` service
https://github.com/carnesen-archive/bitcoin-regtest-service

bitcoind carnesen nodejs regtest typescript

Last synced: about 9 hours ago
JSON representation

A Node.js library for managing a "regtest"-mode `bitcoind` service

Host: GitHub
URL: https://github.com/carnesen-archive/bitcoin-regtest-service
Owner: carnesen-archive
License: mit
Created: 2019-02-15T05:55:12.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2019-02-28T16:20:24.000Z (over 5 years ago)
Last Synced: 2024-04-29T02:45:57.434Z (7 months ago)
Topics: bitcoind, carnesen, nodejs, regtest, typescript
Language: TypeScript
Homepage:
Size: 63.5 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

README

        # @carnesen/bitcoin-regtest-service  [![npm version](https://badge.fury.io/js/%40carnesen%2Fbitcoin-regtest-service.svg)](https://badge.fury.io/js/%40carnesen%2Fbitcoin-regtest-service) [![Build Status](https://travis-ci.com/carnesen/bitcoin-regtest-service.svg?branch=master)](https://travis-ci.com/carnesen/bitcoin-regtest-service)

A Node.js library for managing a "regtest"-mode `bitcoind` service. The package includes runtime JavaScript files suitable for Node.js >=8 as well as the corresponding TypeScript type declarations.

## Usage

The `RegtestService` class combines features of [`@carnesen/bitcoin-config`](https://github.com/carnesen/bitcoin-config), [`@carnesen/bitcoin-software`](https://github.com/carnesen/bitcoin-software), and [`@carnesen/bitcoin-service`](https://github.com/carnesen/bitcoin-service) into a single easy-to-use object. The `start` method installs the software and writes a config file before spawning the service. A common use case is for unit testing:

```js

const { regtestService } = require('@carnesen/bitcoin-regtest-service');

describe('A unit test', () => {

  beforeAll(() => regtest.start(), 30000);

  // ^^ This method installs the software if it hasn't been already,

  // which can take upward of 30 seconds depending on bandwidth.

  afterAll(() => regtest.stop());

  it('does the right thing', () => {

    // Some test that uses the bitcoin regtest service ...

  })

})

```

## API

### `new RegtestService({datadir?}): instance`

Create a new instance of the `RegtestService` class.

#### `datadir`

Optional `string`. Absolute path of a directory for the service software and its data.

### `instance.start(): Promise`

Installs the software if it hasn't been already, writes a configuration file, and starts the `bitcoind` service.

### `instance.stop(): Promise`

Stops the service.

### `instance.restart(): Promise`

Restarts the service.

### `instance.isRunning(): Promise`

Returns a promise that resolves to `true` if the service is running or `false` if it is not.

### `instance.bitcoinHome`

`string` getter. Absolute path where the regtest service's software is installed.

### `instance.configFilePath`

`string` getter. Absolute path of the regtest service's configuration file.

### `instance.rpcHref`

`string` getter. "href" string of the service's remote procedure call (RPC) interface(e.g. `'http://rpcuser:rpcpassword@localhost:48332'`), suitable for parsing using the [WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api).

## More information

Check out [the tests directory](src/__tests__) for more examples of how to use this library. If you encounter any bugs or have any questions or feature requests, please don't hesitate to [file an issue](https://github.com/carnesen/bitcoin-regtest-service/issues/new) or [submit a pull request](https://github.com/carnesen/bitcoin-regtest-service/compare) on [this project's repository on GitHub](https://github.com/carnesen/bitcoin-regtest-service).

## Related

- [@carnesen/bitcoin-regtest-service-cli](https://github.com/carnesen/bitcoin-regtest-service-cli): A Node.js command-line interface for managing a regtest-mode `bitcoind` service

- [@carnesen/bitcoin-config](https://github.com/carnesen/bitcoin-config): A Node.js library for bitcoin server software configuration

- [@carnesen/bitcoin-service](https://github.com/carnesen/bitcoin-service): A Node.js library for managing the bitcoin service `bitcoind`

- [@carnesen/bitcoin-software](https://github.com/carnesen/bitcoin-software): A Node.js library for installing bitcoin server software

## License

MIT © [Chris Arnesen](https://www.carnesen.com)