Btccore
Infrastructure to build Bitcoin and blockchain-based applications for the next generation of financial technology.
Note: If you're looking for the Btccore Library please see: https://github.com/owstack/btccore-lib
Attribution
This repository was created by copy forking bitcore 65d4166.
Getting Started
Before you begin you'll need to have Node.js v4 or v0.12 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 btccore
Spin up a full node and join the network:
npm install -g btccore
btccored
You can then view the OWS Explorer at the default location: http://localhost:3001/explorer
, and your configuration file will be found in your home directory at ~/.btccore
.
Create a transaction:
var btccore = require('btccore');
var transaction = new btccore.Transaction();
var transaction.from(unspent).to(address, amount);
transaction.sign(privateKey);
Applications
- Node - A full node with extended capabilities using Bitcoin Core
- Explorer API - A blockchain explorer HTTP API
- OWS Explorer - A blockchain explorer web user interface
- Wallet Service - A multisig HD service for wallets
- Wallet Client - A client for the wallet service
- CLI Wallet - A command-line based wallet client
- OWS Wallet - An easy-to-use, multiplatform, multisignature, secure bitcoin wallet
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
TBD - see original bitcore dcoumentation:
The complete docs are hosted here: btccore documentation. There's also a btccore API reference available generated from the JSDocs of the project, where you'll find low-level details on each btccore utility.
Security
We're using Btccore 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 [email protected].
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 btccore.js
and btccore.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/owstack/btccore/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).
To verify signatures, use the following PGP keys:
- @braydonf: https://pgp.mit.edu/pks/lookup?op=get&search=0x9BBF07CAC07A276D
D909 EFE6 70B5 F6CC 89A3 607A 9BBF 07CA C07A 276D
- @gabegattis: https://pgp.mit.edu/pks/lookup?op=get&search=0x441430987182732C
F3EA 8E28 29B4 EC93 88CB B0AA 4414 3098 7182 732C
- @kleetus: https://pgp.mit.edu/pks/lookup?op=get&search=0x33195D27EF6BDB7F
F8B0 891C C459 C197 65C2 5043 3319 5D27 EF6B DB7F
- @matiu: https://pgp.mit.edu/pks/lookup?op=get&search=0x9EDE6DE4DE531FAC
25CE ED88 A1B1 0CD1 12CD 4121 9EDE 6DE4 DE53 1FAC
License
Code released under the MIT license.
Copyright 2017 Open Wallet Stack. Btccore is a trademark maintained by Open Wallet Stack.