# @gohelpfund/helpcore-node

> Full node with extended capabilities using Helpcore and Help Core (helpd)

Latest version **5.3.3** (published 2019-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gohelpfund/helpcore-node
pnpm add @gohelpfund/helpcore-node
yarn add @gohelpfund/helpcore-node
bun add @gohelpfund/helpcore-node
```

Provides the command `helpcore-node`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.3.3 |
| Published | 2019-08-03 |
| First published | 2019-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 39.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | GoHelpFund |
| Maintainers | npm-gohelpfund |

## Links

- npm: https://www.npmjs.com/package/@gohelpfund/helpcore-node
- Repository: https://github.com/gohelpfund/helpcore-node
- Issues: https://github.com/gohelpfund/helpcore-node/issues
- npm.io page: https://npm.io/package/@gohelpfund/helpcore-node

## Dependencies (18)

- [async](https://npm.io/package/async.md) ^2.6.1
- [errno](https://npm.io/package/errno.md) ^0.1.7
- [colors](https://npm.io/package/colors.md) ^1.3.3
- [mkdirp](https://npm.io/package/mkdirp.md) 0.5.1
- [semver](https://npm.io/package/semver.md) ^5.6.0
- [zeromq](https://npm.io/package/zeromq.md) ^5.1.0
- [express](https://npm.io/package/express.md) ^4.16.4
- [liftoff](https://npm.io/package/liftoff.md) ^2.5.0
- [commander](https://npm.io/package/commander.md) ^2.19.0
- [lru-cache](https://npm.io/package/lru-cache.md) ^4.0.1
- [socket.io](https://npm.io/package/socket.io.md) ^2.2.0
- [bufferutil](https://npm.io/package/bufferutil.md) ~4.0.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.3
- [utf-8-validate](https://npm.io/package/utf-8-validate.md) ~5.0.2
- [path-is-absolute](https://npm.io/package/path-is-absolute.md) ^1.0.0
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^2.2.0
- [@gohelpfund/helpd-rpc](https://npm.io/package/@gohelpfund/helpd-rpc.md) ^1.2.1
- [@gohelpfund/helpcore-lib](https://npm.io/package/@gohelpfund/helpcore-lib.md) ^0.16.9

## Recent versions

- 5.3.3 (latest) — 2019-08-03
- 5.3.1 — 2019-08-03
- 5.2.4 — 2019-08-03
- 5.2.3 — 2019-08-02
- 5.2.2 — 2019-08-02
- 5.2.1 — 2019-07-16
- 5.2.0 — 2019-07-16
- 5.1.2 — 2019-03-19
- 5.1.1 — 2019-03-10
- 5.1.0 — 2019-03-06
- 4.0.4 — 2019-03-06
- 4.0.3 — 2019-03-06
- 4.0.2 — 2019-03-06
- 4.0.1 — 2019-03-06
- 4.0.0 — 2019-03-05

## README

Helpcore Node
============

A Help 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 [Help Core (helpd) v0.13.0](https://github.com/helppay/help/tree/v0.13.0.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

```bash
git clone https://github.com/gohelpfund/helpcore-node
cd helpcore-node
npm install
./bin/helpcore-node start
```

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

Some plugins are available :

- Insight-API : `./bin/helpcore-node addservice @gohelpfund/insight-api`
- Insight-UI : `./bin/helpcore-node addservice @gohelpfund/insight-ui`

You also might want to add these index to your help.conf file :
```
-addressindex
-timestampindex
-spentindex
```

### As a library

```bash
npm install @gohelpfund/helpcore-node
```

```javascript
const helpcore = require('@gohelpfund/helpcore-node');
const config = require('./helpcore-node.json');

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

## Prerequisites

- Help Core (helpd) (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

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

```bash
helpcore-node create -d <help-data-dir> mynode
cd mynode
helpcore-node install <service>
helpcore-node install https://github.com/yourname/helloworld
helpcore-node start
```

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

Please note that [Help Core](https://github.com/helppay/help/tree/master) needs to be installed first.

For more information about (and developing) services, please see the [Service Documentation](docs/services.md).

## Add-on Services

There are several add-on services available to extend the functionality of Bitcore:

- [Insight API](https://github.com/gohelpfund/insight-api/tree/master)
- [Insight UI](https://github.com/gohelpfund/insight-ui/tree/master)
- [Bitcore Wallet Service](https://github.com/gohelpfund/helpcore-wallet-service/tree/master)

## Documentation

- [Upgrade Notes](docs/upgrade.md)
- [Services](docs/services.md)
  - [Helpd](docs/services/helpd.md) - Interface to Help Core
  - [Web](docs/services/web.md) - Creates an express application over which services can expose their web/API content
- [Development Environment](docs/development.md) - Guide for setting up a development environment
- [Node](docs/node.md) - Details on the node constructor
- [Bus](docs/bus.md) - Overview of the event bus constructor
- [Release Process](docs/release.md) - Information about verifying a release and the release process.


## Setting up dev environment (with Insight)

Prerequisite : Having a helpd node already runing `helpd --daemon`.

Helpcore-node : `git clone https://github.com/gohelpfund/helpcore-node -b develop`
Insight-api (optional) : `git clone https://github.com/gohelpfund/insight-api -b develop`
Insight-UI (optional) : `git clone https://github.com/gohelpfund/insight-ui -b develop`

Install them :
```
cd helpcore-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/helpcore-node start` to first generate a ~/.helpcore/helpcore-node.json file.
Append this file with `"@gohelpfund/insight-ui"` and `"@gohelpfund/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](https://github.com/gohelpfund/helpcore/blob/master/CONTRIBUTING.md) file.

## License

Code released under [the MIT license](https://github.com/gohelpfund/helpcore-node/blob/master/LICENSE).

Copyright 2016-2018 Help Core Group, Inc.

- bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)

---
_Source: https://npm.io/package/@gohelpfund/helpcore-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._