npmpackage.info

Gathering detailed insights and metrics for pocket-node

Other packages similar to pocket-node

node-pocket-safe

0.5.0

Pocket-Safe is a decentralized system for secure offline blockchain management, enabling local transactions via Bluetooth, Wi-Fi, NFC, or QR Codes. A fiscal agent ensures integrity through digital signatures, offering scalable and reliable solutions.

node-pocket

0.9.5

API bindings for getpocket.com

node-pocket-api

0.2.8

node lib for [Pocket API](http://getpocket.com/developer/docs/overview)

pocket-api

1.0.2

Node module for Pocket API

Gathering detailed insights and metrics for pocket-node

pocket-node - 0.0.12 | npmpackage.info

pocket-node

A REST API web app to connect to any blockchain with a plugin system.

0.0.12

MIT

JavaScript

64.43 kB

2.4

Installations

npm install pocket-node

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=9.9.0

Node Version

10.3.0

NPM Version

6.4.1 Pull Requests

Open

1

Total

36

Closed

1

Merged

34

Issues

Open

0

Total

25

Closed

25

Releases

Unable to fetch releases

Languages

JavaScript

Shell

Dockerfile

JavaScript (87.38%)

Shell (8.12%)

Dockerfile (4.5%)

Developer

pokt-network

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

11 Stars

158 Commits

5 Forks

3 Watchers

2 Branches

7 Contributors

Updated on Jan 28, 2023

Maintainers

View All 7 Contributors

Package Meta Information

Latest Version

0.0.12

Package Id

pocket-node@0.0.12

Unpacked Size

64.43 kB

Size

15.79 kB

File Count

NPM Version

6.4.1

Node Version

10.3.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@koa/cors app-root-path commander fs-extra jsonfile-updater koa koa-body koa-router koa-websocket npm-programmatic winston winston-daily-rotate-file

Dev Dependencies

mocha supertest

pocket-node

A Pocket Network client for Pocket Nodes, which are the actors within the Pocket Network that execute the Relays.

For more about the Pocket Network please visit our website

Installation

You can install using npm:

npm install -g pocket-node

Running the server

To start the server, just run:

pocket-node start -p [port number] -h -w

The -h and -w flags are to enable the HTTP and WebSocket endpoints respectively. Before you can start relaying transactions, read below on how to install the different plugins which will allow your Node to connect to the different blockchains (ETH, BTC, LTC, etc.).

Using Docker

The .env file is an example set of environment variables that docker-compose will use by default when bringing up the container.

The pocket-node image will be built and container may be started simply by running:

docker-compose up -d

If you are iterating on the codebase and changing things, this is the best way to ensure your changes are included in the resultant docker image and spawned container:

docker-compose build pocket-node && docker-compose up -d --force-recreate pocket-node

If you want to run the geth integration with pocket just do:

1cd integrations/geth
2docker-compose build && docker-compose up

What is a Pocket Node Plugin?

The Pocket Node Plugin System allows the Pocket Node app to support any decentralized network as a Relay Node in the Pocket Network.

Each plugin can be created independently and supported individually as a NPM package, and each node can pick and choose whichever plugins they wanna use to support on their network.

For example, if you wanted to add Ethereum support for your node, you can use our Pocket Node Ethereum Plugin

Installing a Pocket Node Plugin

To install a plugin from NPM just run the following command:

pocket-node install <npm package name>

As simple as that and your Pocket Node will support the network described by this plugin.

Note: Please note that if you install multiple plugins for the same network, only the latest one you installed will be used, the older ones will be uninstalled.

Listing your Pocket Node Plugins

To see which plugins you have installed just run the following command:

pocket-node list

Configuring your Pocket Node Plugins

Each Plugin requires a configuration file which is a JSON object with all the pre-determined configurations. Please refer to each Plugin's documentation to see how you can configure your Plugin using the following command:

pocket-node configure <network token ID (ETH, BTC, etc.)> /path/to/configuration.json

Removing a Pocket Node Plugin

To remove a specific plugin just run the following command:

pocket-node remove -n <network token ID (ETH, BTC, etc.)>

You can also remove all installed plugins with the following command:

pocket-node remove -a

Notes:

In case you have multiple plugins with the same network, all will be removed.
If you remove a plugin, your configuration for that plugin will be removed as well, as such you will have to reconfigure the plugin if you decide to re-install it.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.4

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More