JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 70
  • Score
    100M100P100Q82276F
  • License MIT

Start and stop geth from Node.js

Package Exports

  • geth

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (geth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

geth.js

Build Status Coverage Status npm version

A simple tool to start/stop geth from Node.js.

Usage

$ npm install geth

To use geth.js, simply require it:

var geth = require("geth");

Configure geth. It accepts the same flags as the geth command line client; here they 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 }.

geth.configure({
    networkid: "10101",
    port: 30303,
    rpcport: 8545,
    mine: null
});

geth is all configurated and ready-to-go.

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

The callback for start fires after geth has successfully started. Its 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 () {
    console.log("no more lively times :(");
});

Tests

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

$ npm test