btxcore

5.0.0-beta.44 • Public • Published

BTXCore

NPM Package Build Status

Infrastructure to build Bitcore BTX and blockchain-based applications for the next generation of financial technology.

Note: If you're looking for the BTXcore Library please see: https://github.com/limxtec/btxcore-lib

Getting Started

Before you begin you'll need to have Node.js v8 installed. There are several options for installation. One method is to use nvm to easily switch between different versions, or download directly from Node.js.

npm install -g btxcore

Spin up a full node and join the network:

npm install -g btxcore
btxcored

You can then view the Insight block explorer at the default location: http://localhost:3001/insight, and your configuration file will be found in your home directory at ~/.btxcore.

Create a transaction:

var btxcore = require('btxcore');
var transaction = new btxcore.Transaction();
var transaction.from(unspent).to(address, amount);
transaction.sign(privateKey);

Applications

Libraries

  • Lib - All of the core Bitcoin primatives including transactions, private key management and others
  • Payment Protocol - A protocol for communication between a merchant and customer
  • P2P - The peer-to-peer networking protocol
  • Mnemonic - Implements mnemonic code for generating deterministic keys
  • Channel - Micropayment channels for rapidly adjusting bitcoin transactions
  • Message - Bitcoin message verification and signing
  • ECIES - Uses ECIES symmetric key negotiation from public keys to encrypt arbitrarily long data streams.

Documentation

The complete docs are hosted here: bitcore documentation. There's also a bitcore API reference available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.

To get community assistance and ask for help with implementation questions, please use our community forums.

Security

We're using Bitcore BTX in production, as are many others, but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.

If you find a security issue, please email security@bitpay.com.

Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our CONTRIBUTING file.

This will generate files named btxcore.js and btxcore.min.js.

You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout a release commit (for example, https://github.com/bitpay/bitcore/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).

To verify signatures, use the following PGP keys:

License

Code released under the MIT license.

Copyright 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc. Copyright 2018 The Bitcore BTX Core Developers

Package Sidebar

Install

npm i btxcore

Weekly Downloads

0

Version

5.0.0-beta.44

License

MIT

Unpacked Size

158 kB

Total Files

28

Last publish

Collaborators

  • limxtec