openwrld / bitcore-crown

A full stack for bitcoin and blockchain-based applications

bitcore-crown

This package is under development. It may be unstable, or not work as expected.

All commands in this document must be executed as a standard user. Do not execute them as root.

Prerequisites

Make sure you're on Ubuntu 16.04.

Basically, you need to have ZeroMQ and tools, nvm, Node.js and npm on your server. Here's how to install them:

ZeroMQ and Tools

sudo apt-get update
sudo apt-get install libzmq3-dev build-essential

Also make sure the commands python and curl are installed.

nvm, Node.js and npm

Install nvm. Click here to learn how to install nvm.

Use nvm command to install Node.js v4 and the latest npm:

nvm install 4
nvm install-latest-npm

Installation

npm install bitcore-crown -g --legacy-bundling

Note: Do not use sudo. To get rid of sudo, Node.js and npm must be installed via nvm.

Usage

bitcored-crown

It will start a Crown node and Insight service. The blockchain data will be downloaded to ~/.bitcore-crown. Insight can be visited via "http://localhost:3001/insight/".

Configurations can be changed in ~/.bitcore-crown/bitcore-node-crown.json. But don't modify the servicesConfig.bitcoind.spawn.exec property. Unlike the original Bitcore, modifying the binary file path will have no effect, as it will be automatically adjusted on every start if needed. This is by design to avoid conflicts between the testing environment and production environment. In the future this may be changed.

If you want the root path "/" rather than the default "/insight" to hold the Insight website, and "/api" rather than the default "/insight-api-crown" to hold the Insight API website, add 2 fields to servicesConfig in the config file:

{
  ...
  ...
  "servicesConfig": {
    ...
    ...
    "insight-ui-crown": {
      "routePrefix": "",
      "apiPrefix": "api"
    },
    "insight-api-crown": {
      "routePrefix": "api"
    }
  }
}

If you think the data is broken, the last way is to delete ~/.bitcore-crown and start the program to redownload the data.

There's another command bitcore-crown-adv for advanced operations. This maps to the bitcore command in the original Bitcore. The original Bitcore manual is here. We added the -adv suffix to avoid confusion with bitcored-crown.

Contributing

See CONTRIBUTING.md file.

License

See LICENSE file.