README
POSQcore Node
A POSQ 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 POSQ Core (posqd) v0.13.0 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/posqevo/posqcore-node
cd posqcore-node
npm install
./bin/posqcore-node start
When running the start command, it will seek for a .posqcore folder with a posqcore-node.json conf file. If it doesn't exist, it will create it, with basic task to connect to posqd.
Some plugins are available :
- Insight-API :
./bin/posqcore-node addservice @posqevo/insight-api
- Insight-UI :
./bin/posqcore-node addservice @posqevo/insight-ui
You also might want to add these index to your posq.conf file :
-addressindex
-timestampindex
-spentindex
As a library
npm install @posqevo/posqcore-node
const posqcore = require('@posqevo/posqcore-node');
const config = require('./posqcore-node.json');
let node = posqcore.scaffold.start({ path: "", config: config });
node.on('ready', function() {
//POSQ core started
posqd.on('tx', function(txData) {
let tx = new posqcore.lib.Transaction(txData);
});
});
Prerequisites
- POSQ Core (posqd) (v0.13.0) with support for additional indexing (see above)
- Node.js v8+
- ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
- ~20GB of disk storage
- ~1GB of RAM
Configuration
POSQcore includes a Command Line Interface (CLI) for managing, configuring and interfacing with your POSQcore Node.
posqcore-node create -d <posq-data-dir> mynode
cd mynode
posqcore-node install <service>
posqcore-node install https://github.com/yourname/helloworld
posqcore-node start
This will create a directory with configuration files for your node and install the necessary dependencies.
Please note that POSQ 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
- 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.
Setting up dev environment (with Insight)
Prerequisite : Having a posqd node already runing posqd --daemon
.
POSQcore-node : git clone https://github.com/posqevo/posqcore-node -b develop
Insight-api (optional) : git clone https://github.com/posqevo/insight-api -b develop
Insight-UI (optional) : git clone https://github.com/posqevo/insight-ui -b develop
Install them :
cd posqcore-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/posqcore-node start
to first generate a ~/.posqcore/posqcore-node.json file.
Append this file with "@posqevo/insight-ui"
and "@posqevo/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 2016-2018 POSQ Core Group, Inc.
- bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)