Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 3.33 KB

README.md

File metadata and controls

100 lines (70 loc) · 3.33 KB
Raw

Bitcore Node

A Navcoin full node for building applications and services with Node.js. A node is extensible and can be configured to run additional services. At the minimum a node has an interface to Navcoin full node for more advanced address queries. Additional services can be enabled to make a node more useful such as exposing new APIs, running a block explorer and wallet service.

Install

su
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs
npm install n
n 6
sudo apt install libzmq3-dev
npm install --unsafe-perm -g git://github.com/Encrypt-S/bitcore-node.git
exit
bitcore-node create mynode
cd mynode
bitcore-node start

Note: For your convenience, we automate the download and compilation of the navcoind daemon. Upon npm install, the sources will be downloaded and built.

Installing modules

cd mynode
bitcore-node install insight-api
bitcore-node install bitcore-wallet-service

Prerequisites

  • GNU/Linux x86_32/x86_64, or OSX 64bit
  • Node.js v6
  • ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
  • ~200GB of disk storage
  • ~8GB of RAM

Installing libzmq3-dev on Debian

Add the following line to /etc/apt/sources.list

deb http://http.us.debian.org/debian testing main contrib non-free

Then apt-get install libzmq3-dev.

MongoDB

If MongoDB fails to connect when running bitcore-node start try installing it with apt:

sudo apt install mongodb-server

Configuration

Bitcore includes a Command Line Interface (CLI) for managing, configuring and interfacing with your Bitcore Node.

bitcore-node create -d <navcoin-data-dir> mynode
cd mynode
bitcore-node install <service>
bitcore-node install https://github.com/yourname/helloworld

This will create a directory with configuration files for your node and install the necessary dependencies. For more information about (and developing) services, please see the Service Documentation.

Add-on Services

There are several add-on services available to extend the functionality of Bitcore:

Documentation

  • Upgrade Notes
  • Services
    • Bitcoind - Interface to Bitcoin Core
    • Web - Creates an express application over which services can expose their web/API content
  • Development Environment - Guide for setting up a development environment
  • Node - Details on the node constructor
  • Bus - Overview of the event bus constructor
  • Release Process - Information about verifying a release and the release process.

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.

License

Code released under the MIT license.

Copyright 2013-2015 BitPay, Inc.

  • bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)