sparkscore Node

A sparks 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 sparks Core (sparksd) 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/sparkspay/sparkscore-node
cd sparkscore-node
./bin/sparkscore-node start

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

Some plugins are available :

• insight-api-sparks : `./bin/sparkscore-node addservice insight-api-sparks
• insight-ui-sparks : ./bin/sparkscore-node addservice insight-ui-sparks

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

-addressindex
-timestampindex
-spentindex

As a library

npm install sparkscore-node

const sparkscore = require('sparkscore-node');
const config = require('./sparkscore-node.json');

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

Prerequisites

• sparks Core (sparksd) (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

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

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

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

Please note that sparks 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:

• Insight API
• Insight UI
• Bitcore Wallet Service

Documentation

• Upgrade Notes
• Services
  • sparksd - Interface to sparks 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.

Setting up dev environment (with Insight)

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

sparkscore-node : git clone https://github.com/sparkspay/sparkscore-node -b develop insight-api-sparks (optional) : git clone https://github.com/sparkspay/insight-api-sparks -b develop insight-ui-sparks (optional) : git clone https://github.com/sparkspay/insight-ui-sparks -b develop

Install them :

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

Symbolic linking in parent folder :

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

Start with ./bin/sparkscore-node start to first generate a ~/.sparkscore/sparkscore-node.json file. Append this file with "insight-ui-sparks" and "insight-api-sparks" 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)