README.md

Bitcore Node Flux

A Flux full node for building applications and services with Node.js. A node is extensible and can be configured to run additional services. Additional services can be enabled to make a node more useful such as exposing new APIs, running a block explorer and wallet service.

Explorer Guide

Latest Flux insight explorer = Flux daaemon with bitcore-node with insight-api and insight-ui

wget -qO- https://raw.githubusercontent.com/runonflux/bitcore-node/master/installExplorer.sh | bash

Install

npm install -g @runonflux/bitcore-node
bitcore-node start

Prerequisites

• GNU/Linux x86_32/x86_64, or OSX 64bit (for fluxd distributed binaries)
• Node.js 24 LTS or newer
• ~30GB of disk storage
• ~2GB of RAM

Configuration

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

bitcore-node create -d <bitcoin-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:

• Insight API
• Insight UI

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.

License

Code released under the MIT license.

Copyright 2013-2015 BitPay, Inc.

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