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

geth

v0.4.0

Published

Start and stop geth from Node.js

Downloads

498

Readme

geth.js

Build Status Coverage Status npm version

Start and stop geth from Node.js.

Usage

$ npm install geth

To use geth.js, simply require it:

var geth = require("geth");

Starting and stopping geth

geth's start method accepts a configuration object, which uses the same flags as the geth command line client. (Here, the flags are organized into an object.) Flags that are not accompanied by a value on the command line (for example, --mine) should be passed in as { flag: null }.

var options = {
    networkid: "10101",
    port: 30303,
    rpcport: 8545,
    mine: null
};

geth.start(options, function (err, proc) {
    if (err) return console.error(err);
    // get your geth on!
});

The callback's parameter proc is the child process, which is also attached to the geth object (geth.proc) for your convenience.

When you and geth have had enough lively times, stop kills the underlying geth process:

geth.stop(function () {
    // no more lively times :( 
});

Listeners

The callback for start fires after geth has successfully started. Specifically, it looks for "IPC service started" in geth's stderr. If you want to change the start callback trigger to something else, this can be done by replacing geth's default listeners. geth.start accepts an optional second parameter which should specify the listeners to overwrite, for example:

{
    stdout: function (data) {
        process.stdout.write("I got a message!! " + data.toString());
    },
    stderr: function (data) {
        if (data.toString().indexOf("Protocol Versions") > -1) {
            geth.trigger(null, geth.proc);
        }
    },
    close: function (code) {
        console.log("It's game over, man!  Game over!");
    }
}

In the above code, geth.trigger is the callback passed to geth.start. (This callback is stored so that the startup trigger can be changed if needed.) These three listeners (stdout, stderr, and close) are the only listeners which can be specified in this parameter, since only these three are set by default in geth.start.

If you want to swap out or add other listeners (after the initial startup), you can use the geth.listen convenience method:

geth.listen("stdout", "data", function (data) { process.stdout.write(data); });

This example (re-)sets the "data" listener on stdout by setting geth.proc.stdout._events.data = function (data) { process.stdout.write(data); }.

Tests

geth.js's tests use ethrpc to send some basic requests to geth.

$ npm test