\n\n\n## Table of Contents\n - [About The Project](#about-the-project)\n - [Better dApp Development](#better-dapp-development)\n - [Supported Services](#supported-services)\n - [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n - [Usage](#usage)\n - [JSON-RPC API Documentation](#json-rpc-api-documentation)\n - [Extending services](#extending-services)\n- [Contributing](#contributing)\n- [Resources](#resources)\n\n\n## About The Project\n\nService Runner is an opinionated JSON-RPC service manager, that provides daemonization, installation, and discovery for JSON-RPC based services.\n\nService 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.\n\n### Better dApp Development\n\nService 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:\n\n - Allows dApp developers to specify what services they'd like to use\n - Provides defaults for the services to run\n - Provides users with an easy installation path\n - Provides reliable discovery of pre-existing services run by the service runner\n - Provides OpenRPC interface to the Service Runner functionality, as well as the underlying services\n - Allows dApp developers the ability to retrieve reliable JSON-RPC connection information from the service\n - Provides typed interfaces to develop applications against\n\n### Supported Services\n\nCurrently it supports `core-geth` with the following environments:\n\n- `mainnet (ETC)`\n- `kotti`\n- `ethereum`\n- `goerli`\n- `rinkeby`\n\n## Getting Started\n\n### Prerequisites\n\n- node v12.10.0 or greater.\n- npm v6.10.3 or greater.\n\n### Installation\n\nInstall via npm package\n\n```bash\nnpm install -g @etclabscore/jade-service-runner\n```\n\nInstall the JavaScript client:\n\n```bash\nnpm install @etclabscore/jade-service-runner-client\n```\n\nThen require it into any module.\n\n```js\nconst { ServiceRunner } = require(\"@etclabscore/jade-service-runner-client\");\nconst ERPC = require(\"@etclabscore/ethereum-json-rpc\");\nconst serviceRunner = new ServiceRunner({ transport: { type: \"http\", port: 8002, host: \"localhost\" } });\nconst serviceName = \"core-geth\";\nconst successful = await serviceRunner.installService(serviceName, \"1.11.2\");\nif (successful === false) throw new Error(\"Service not installed\")\nconst serviceConfig = serviceRunner.start(serviceName, \"1.11.2\", \"kotti\");\nconst erpc = new ERPC(serviceConfig);\nerpc.getBalance(\"0x0DEADBEEF\");\n```\n\nTo run the jade-service-runner:\n\n```shell\njade-service-runner\n```\n\n## Usage\n\n### JSON-RPC API Documentation\n\nYou can view the API documentation [here](https://playground.open-rpc.org/?uiSchema[appBar][ui:title]=Jade%20Service%20Runner&uiSchema[appBar][ui:logoUrl]=https://github.com/etclabscore/jade-media-assets/raw/master/jade-logo-light/jade-logo-light%20(PNG)/48x48.png&uiSchema[appBar][ui:splitView]=false&uiSchema[appBar][ui:input]=false&uiSchema[methods][ui:title]=&schemaUrl=https://raw.githubusercontent.com/etclabscore/jade-service-runner/master/openrpc.json).\n\n### Extending services\n\nYou can extend jade-service-runner with your own configuration via the command line interface\n\n```bash\njade-service-runner -c extended-jade-service-runner-config.json\n```\n\n## Roadmap\n\nSee the [open issues](https://github.com/etclabscore/jade-service-runner/issues) for a list of proposed features (and known issues).\n\n## Contributing\n\nHow to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.\n\n## License\n\nApache License 2.0\n\n## Resources\n- [Jade.Builders](https://jade.builders/)\n- [Jade Specification](https://github.com/etclabscore/jade) \n","readmeFilename":"README.md","description":" Supported by [ETC Labs](https://www.etclabs.org/)","homepage":"https://github.com/etclabscore/jade-service-runner#readme","repository":{"type":"git","url":"git+https://github.com/etclabscore/jade-service-runner.git"},"bugs":{"url":"https://github.com/etclabscore/jade-service-runner/issues"}}
![\"CircleCI](\"https://img.shields.io/circleci/project/github/etclabscore/jade-service-runner/master.svg\")
\n ![](\"https://codecov.io/gh/etclabscore/jade-service-runner/branch/master/graph/badge.svg\"){kind=icon}
\n ![\"Chat](\"https://img.shields.io/badge/chat-on%20discord-7289da.svg\"){kind=icon}
\n ![\"npm\"](\"https://img.shields.io/npm/dt/@etclabscore/jade-service-runner.svg\")
\n ![\"GitHub](\"https://img.shields.io/github/release/etclabscore/jade-service-runner.svg\")
\n ![\"GitHub](\"https://img.shields.io/github/commits-since/etclabscore/jade-service-runner/latest.svg\")
\n ![](\"https://raw.githubusercontent.com/etclabscore/jade-media-assets/master/jade-logo-light/jade-logo-light%20(PNG)/256x256.png\"){kind=logo}
\n