npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stashcore/stashcore-node

v5.1.4

Published

Full node with extended capabilities using Stashcore and Stash Core (stashd)

Downloads

11

Readme

Stashcore Node

A Stash 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 Stash Core (stashd) 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/stashpayio/stashcore-node
cd stashcore-node
npm install
./bin/stashcore-node start

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

Some plugins are available :

  • Insight-API : ./bin/stashcore-node addservice @stashcore/insight-api
  • Insight-UI : ./bin/stashcore-node addservice @stashcore/insight-ui

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

-addressindex
-timestampindex
-spentindex

As a library

npm install @stashcore/stashcore-node
const stashcore = require('@stashcore/stashcore-node');
const config = require('./stashcore-node.json');

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

Prerequisites

  • Stash Core (stashd) (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

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

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

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

Please note that Stash 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
    • Stashd - Interface to Stash 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 stashd node already runing stashd --daemon.

Stashcore-node : git clone https://github.com/stashpayio/stashcore-node -b develop Insight-api (optional) : git clone https://github.com/stashpayio/insight-api -b develop Insight-UI (optional) : git clone https://github.com/stashpayio/insight-ui -b develop

Install them :

cd stashcore-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/stashcore-node start to first generate a ~/.stashcore/stashcore-node.json file. Append this file with "@stashcore/insight-ui" and "@stashcore/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 Stash Core Group, Inc.

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