cryptorescuecore-node
v3.1.3
Published
Full node with extended capabilities using cryptorescuecore and CryptoRescue
Downloads
4
Readme
CryptoRescueCore Node
THANK YOU TO UNDER FOR MAKING THIS FORK POSSIBLE. MOST CREDIT GOES TO HIM AND THE BITCOIN DEVS UNDER
A CryptoRescue 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 CryptoRescue with additional indexing 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 cryptorescuecore-node
cryptorescuecore-node start
Note: For your convenience, we distribute cryptorescued binaries for x86_64 Linux and x86_64 Mac OS X. Upon npm install, the binaries for your platform will be downloaded. For more detailed installation instructions, or if you want to compile the project yourself, then please see the CryptoRescueCore branch of CryptoRescue with additional indexing.
Prerequisites
- GNU/Linux x86_32/x86_64, or OSX 64bit (for cryptorescued distributed binaries)
- Node.js v0.10, v0.12 or v4
- ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
- ~200GB of disk storage
- ~8GB of RAM
Configuration
CryptoRescueCore includes a Command Line Interface (CLI) for managing, configuring and interfacing with your CryptoRescueCore Node.
cryptorescuecore-node create -d <cryptorescue-data-dir> mynode
cd mynode
cryptorescuecore-node install <service>
cryptorescuecore-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 CryptoRescueCore:
Documentation
- Upgrade Notes
- Services
- CryptoRescued - Interface to CryptoRescue 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 underdarkskies, Inc. Copyright 2018 CryptoRescue
- bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)