forked from bitpay/bitcore
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Requirements:
- Trusted P2P Peer
- MongoDB Server >= v3.4
Checkout the repo
git clone git@github.com:bitpay/bitcore.git git checkout master npm install
1. Setup Bitcore config
Example bitcore.config.json{
"bitcoreNode": {
"chains": {
"BTC": {
"mainnet": {
"chainSource": "p2p",
"trustedPeers": [
{
"host": "127.0.0.1",
"port": 20008
}
],
"rpc": {
"host": "127.0.0.1",
"port": 20009,
"username": "username",
"password": "password"
}
},
"regtest": {
"chainSource": "p2p",
"trustedPeers": [
{
"host": "127.0.0.1",
"port": 20020
}
],
"rpc": {
"host": "127.0.0.1",
"port": 20021,
"username": "username",
"password": "password"
}
}
},
"BCH": {
"mainnet": {
"parentChain": "BTC",
"forkHeight": 478558,
"trustedPeers": [
{
"host": "127.0.0.1",
"port": 30008
}
],
"rpc": {
"host": "127.0.0.1",
"port": 30009,
"username": "username",
"password": "password"
}
},
"regtest": {
"chainSource": "p2p",
"trustedPeers": [
{
"host": "127.0.0.1",
"port": 30020
}
],
"rpc": {
"host": "127.0.0.1",
"port": 30021,
"username": "username",
"password": "password"
}
}
}
}
}
}
2. Setup Bitcoin Node
Example Bitcoin Mainnet Configwhitelist=127.0.0.1 txindex=0 listen=1 server=1 irc=1 upnp=1 # Make sure port & rpcport matches the # bitcore.config.json ports for BTC mainnet # if using Bitcoin Core v0.17+ prefix # [main] port=20008 rpcport=20009 rpcallowip=127.0.0.1 rpcuser=username rpcpassword=password
3. Run Bitcoin node
Example Starting a Bitcoin Node# Path to your bitcoin application and path to the config above /Applications/Bitcoin-Qt.app/Contents/MacOS/Bitcoin-Qt -datadir=/Users/username/blockchains/bitcoin-core/networks/mainnet/
4. Start Bitcore
npm run node
REST API parameters and example responses
Websockets API namespaces, event names, and parameters
Testing Bitcore-node in RegTest
Wallet Guide - Creating, Signing, Import Address
See CONTRIBUTING.md on the main bitcore repo for information about how to contribute.
Code released under the MIT license.
Copyright 2015-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.