3.1.15 • Published 6 years ago

raidencore-node v3.1.15

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

Raidencore Node

A Raidencash 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 Raidencash Core (raidencashd) 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.

Usages

As a standalone server

git clone https://github.com/dashevo/raidencore-node
cd raidencore-node
./bin/raidencore-node start

When running the start command, it will seek for a .raidencore folder with a raidencore-node.json conf file. If it doesn't exist, it will create it, with basic task to connect to raidencashd.

Some plugins are available :

  • Insight-API : `./bin/raidencore-node addservice @dashevo/insight-api
  • Insight-UI : ./bin/raidencore-node addservice @dashevo/insight-ui

You also might want to add these index to your raidencash.conf file :

-addressindex
-timestampindex
-spentindex

As a library

npm install raidencore-node
const raidencore = require('raidencore-node');
const config = require('./raidencore-node.json');

let node = raidencore.scaffold.start({ path: "", config: config });
node.on('ready', function() {
    //Raidencash core started
    raidencashd.on('tx', function(txData) {
        let tx = new raidencore.lib.Transaction(txData);
    });
});

Prerequisites

  • Raidencash Core (raidencashd) (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

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

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

This will create a directory with configuration files for your node and install the necessary dependencies.

Please note that Raidencash Core needs to be installed first.

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

Setting up dev environment (with Insight)

Prerequisite : Having a raidencashd node already runing raidencashd --daemon.

Raidencore-node : git clone https://github.com/dashevo/raidencore-node -b develop Insight-api (optional) : git clone https://github.com/dashevo/insight-api -b develop Insight-UI (optional) : git clone https://github.com/dashevo/insight-ui -b develop

Install them :

cd raidencore-node && npm install \
 && cd ../insight-ui && npm install \
 && cd ../insight-api && npm install && cd ..

Symbolic linking in parent folder :

npm link ../insight-api
npm link ../insight-ui

Start with ./bin/raidencore-node start to first generate a ~/.raidencore/raidencore-node.json file. Append this file with "@dashevo/insight-ui" and "@dashevo/insight-api" in the services array.

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)