JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 30
  • Score
    100M100P100Q99332F
  • License MIT

Bitcoin Cash JavaScript Library

Package Exports

  • @chris.troutner/bch-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@chris.troutner/bch-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bch-js

Greenkeeper badge

Build Status

  • npm library

  • Install library: npm install @chris.troutner/bch-js

  • Instantiate in your code:

const BCHJS = require("@chris.troutner/bch-js")
const bchjs = new BCHJS(`http://decatur.hopto.org:12400/v3/`)

This is a fork of the BITBOX SDK maintained by Bitcoin.com. This library is intended to be paired with the bch-api REST API.

Quick links

Features

This library sets itself apart from BITBOX with the following features:

  • ECMAScript 2017 standard JavaScript used instead of TypeScript. Works natively with node.js v10 or higher.

  • slp-sdk features are integrated into this library too.

  • Semantic Release for continuous delivery using semantic versioning.

  • Greenkeeper automatic dependency management for automatically maintaining the latest, most secure dependencies.

  • IPFS uploads of all files and dependencies, to backup dependencies in case they are ever inaccessible from GitHub or npm.

Whereas BITBOX SDK has a big focus on integrating the latest features in the the ecosystem, this bch-js fork will remain relatively stable, integrating new features at a much slower pace.

Documentation:

Full documentation for this library can be found here:

Original documentation on BITBOX is available at:

bch-js uses APIDOC so that documentation and working code live in the same repository. To generate the documentation:

  • npm run docs
  • Open the generated docs/index.html file in a web browser.

Support

Have questions? Need help? Join our community support Telegram channel

IPFS Releases

I will periodically publish IPFS releases of this repository, including all dependencies in the node_modules folder. This ensures working copies of this repository can be retrieved in case there is any drift in dependency files, or if dependencies are pulled from npm or GitHub.

  • Initial fork on 5/9/2019:

    • without node_modules folder: QmQFHfbBQdEHfhtiRLbXtX1NcgnfL45hZb7TbQimTXAuzG (4 MB)
    • with node_modules folder: QmXq9Ds6Qdkg9xbRhcF8pay9KabA6QN2y7bx3wvSqiXifk (107 MB)

  • v1.0.0 - refactored to pure JavaScript:

    • without node_modules folder: QmNjFsiTZRMAUa9rZpXqZqivv9JLaNicwLSPHjyLB7PVDk (1 MB)
    • with node_modules folder: Qma9ScApwBtuL7dpdSk7jpBFTxbqRdiR921WjyP75SU7bT (100 MB)

License

MIT