@bitaccess/bitcoin-core

Forked from ruimarinho/bitcoin-core

See CHANGELOG.md

Install

Install the package via yarn:

yarn add @bitaccess/bitcoin-core

or via npm:

Install the package via npm:

npm install @bitaccess/bitcoin-core --save

Usage

Client(...args)

Arguments

See here for original arguments.

15. (NEW) [proxy] (string|Object): connect via proxy URL or expanded config (Object).
16. (NEW) [proxy.url] (string): Proxy URL.
17. (NEW) [proxy.username] (string): Authenticated proxy user name.
18. (NEW) [proxy.password] (string): Authenticated proxy password.

Examples

(NEW) Connecting to an SSL/TLS server via HTTPS proxy without strict checking enabled

const Client = require('bitcoin-core');
const client = new Client({
  host: 'bitcoindrpcssl.example.com',
  port: 443,
  proxy: 'https://username:[email protected]',
  ssl: {
    enabled: true,
    strict: false
  }
});

Tests

To test using a local installation of node.js but with dependencies (e.g. bitcoind) running inside Docker:

npm run test:docker

To test using Docker exclusively (similarly to what is done in Travis CI):

npm run test:ci

Release

npm version [<newversion> | major | minor | patch] -m "Release %s"

License

MIT