bitcore-node-safe
v4.7.3
Published
Full node with extended capabilities using Bitcore and Safe Core
Downloads
77
Readme
Bitcore Node Safe
A Safe 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 Safe Core v0.12.1.x 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
npm install -g bitcore-node-safe
Prerequisites
- Safe Core (v0.12.1.x) with support for additional indexing (see above)
- Node.js v0.10, v0.12, v4 or v5
- ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
- ~20GB of disk storage
- ~1GB of RAM
Configuration
Bitcore includes a Command Line Interface (CLI) for managing, configuring and interfacing with your Bitcore Node.
bitcore-node-safe create -d <safe-data-dir> mynode
cd mynode
bitcore-node-safe install <service>
bitcore-node-safe install https://github.com/yourname/helloworld
bitcore-node-safe start
This will create a directory with configuration files for your node and install the necessary dependencies.
Please note that Safe Core v0.12.1.x will be downloaded automatically. Once completed the safed binary should be placed into the <safe-data-dir> folder specified during node creation.
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
- 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)