Skip to content
Branch: master
Clone or download
semantic-release-bot chore(release): 1.1.2 [skip ci]
## [1.1.2](1.1.1...1.1.2) (2019-06-29)

### Bug Fixes

* **circleci:** use newer python image ([c54632a](c54632a))
Latest commit 38b5b76 Jun 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci fix(circleci): use newer python image Jun 29, 2019
.ebextensions fix: setup for deploy Jun 29, 2019
.elasticbeanstalk fix: setup for deploy Jun 29, 2019
.github/ISSUE_TEMPLATE feat: add issue templates Feb 21, 2019
examples fix: build directory issues Jun 1, 2019
fixtures feat: add health check support to service runnner Jun 13, 2019
src fix: setup for deploy Jun 29, 2019
.ebignore fix: setup for deploy Jun 29, 2019
.gitignore fix: build directory issues Jun 1, 2019
.npmrc fix: setup for deploy Jun 29, 2019
.releaserc fix: release rc missing npm Jun 1, 2019
BUILDING.md fix(building): remove unneeded definitions Apr 18, 2019
CHANGELOG.md chore(release): 1.1.2 [skip ci] Jun 29, 2019
CONTRIBUTING.md feature: build target file names + release order Feb 4, 2019
CONVENTIONAL_COMMITS.md Minor language/grammar fixes and tweaks Feb 1, 2019
Jenkinsfile fix: merge conflict resolutions Jun 1, 2019
LICENSE.md
README.md fix(README): provides typo Jun 10, 2019
RELEASING.md feat: update release to be more specific Apr 3, 2019
TESTING.md fix: indenting Feb 21, 2019
VERSIONING.md feature: build target file names + release order Feb 4, 2019
client.ts chore: fix lint errors Jun 13, 2019
jest.config.js fix: merge conflict resolutions Jun 1, 2019
openrpc.json fix(circleci): use newer python image Jun 29, 2019
package-lock.json chore(release): 1.1.1 [skip ci] Jun 29, 2019
package.json chore(release): 1.1.1 [skip ci] Jun 29, 2019
tsconfig.json fix: merge conflict resolutions Jun 1, 2019
tsfmt.json fix: merge conflict resolutions Jun 1, 2019
tslint.json fix: commandline argument passing Jun 4, 2019

README.md

Jade Service Runner - A JSON-RPC Service Manager

CircleCI branch Dependabot status Chat on Discord npm GitHub release GitHub commits since latest release

Service Runner is an opinionated JSON-RPC service manager, that provides daemonization, installation, and discovery for JSON-RPC based services.

Service Runner helps developers gain access to a user's locally run services. It provides users with a management and installation tool, that allows developers to discover services and reliably request access to those services.

Better dApp Development

Service Runner improves the dApp development cycle, by reducing the number of steps required for running services that are local to the user, in addition to associated with relying on locally running JSON-RPC services. To do this effectively, Jade Service Runner supports the following:

  • Allows dApp developers to specify what services they'd like to use
  • Provides defaults for the services to run
  • Provides users with an easy installation path
  • Provides reliable discovery of pre-existing services run by the service runner
  • Provides OpenRPC interface to the Service Runnner functionality, as well as the underlying services
  • Allows dApp developers the ability to retrieve reliable JSON-RPC connection information from the service
  • Provides typed interfaces to develop applications against

Getting Started


Install jade-service-runner using npm

npm install -g @etclabscore/jade-service-runner

It also has a javascript client:

npm install @etclabscore/jade-service-runner-client

Then require it into any module.

const { ServiceRunner } = require('@etclabscore/jade-service-runner-client');
const ERPC = require('@etclabscore/ethereum-json-rpc');
const serviceRunner = new ServiceRunner({ transport: { type: "http", port: 8002, host: "localhost" } });
const serviceName = 'multi-geth';
const successful = await serviceRunner.installService(serviceName);
if (successful === false) throw new Error('Service not installed')
const serviceConfig = serviceRunner.start(serviceName, 'kotti');
const erpc = new ERPC(serviceConfig);
erpc.getBalance("0x0DEADBEEF");

to run the service runner:

jade-service-runner

Supported Services

Currently it supports multi-geth with the following environments:

  • mainnet (ETC)
  • kotti
  • ethereum
  • goerli
  • rinkeby

Extending services

You can extend jade-service-runner with your own configuration via the command line interface

jade-service-runner -c extended-jade-service-runner-config.json

JSON-RPC API Documentation

You can view the API documentation here.

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

You can’t perform that action at this time.