Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 3.19 KB

README.md

File metadata and controls

70 lines (49 loc) · 3.19 KB
Raw

Bitcore Node Zcoin

A Zcoin 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 Zcoin 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.

Prerequisites

  • Zcoin Core (v0.13.6.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

Quick Start

A simple installation script is implemented in scripts/install-insight.sh. It was tested on Ubuntu 16.04 with NodeJS v6.14.4 and the bundled npm 3.10.10. Here is a simple invocation example:

git clone [email protected]:zcoinofficial/bitcore-node-zcoin.git
bitcore-node-zcoin/scripts/install-insight.sh insight
# Please modify your insight/bitcore-node-zcoin.json config before starting
cd insight
node_modules/bitcore-node-zcoin/bin/bitcore-node-zcoin start

Configuration

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

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

Please note that Zcoin Core v0.13.6.x will be downloaded automatically. Once completed the zcoind binary should be placed into the <zcoin-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
    • 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.

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-2018 Bitcoin Core Developers (MIT License)
  • zcoin: Copyright (c) 2016-2018 Zcoin Core Developers (MIT License)