@nichemandao/consul

Consul

Consul provides functionality for Arbitrator and Arbitrable Ethereum smart contracts as defined in ERC 836 and ERC 1836.

Documentation

See full documentation at https://consul.readthedocs.io/en/latest/index.html

Installation

npm install @nichemandao/consul

Basic Usage

var Consul = require('@nichemandao/consul');

var consul = new Consul('wss://some.local-or-remote.node:8546');

> consul.arbitrator
> consul.arbitrable
> consul.utils
> consul.version

Test

yarn ganache
yarn test

Build

yarn run build

Update Docs

The documentation is based on Sphinx. Install Sphinx with your global python or in a virtualenv

pip install sphinx

1. Update .rst files in /docs

2. Run to generate new docs bundle

cd docs && make html

3. View changes

open ./docs/_build/html/index.html

4. Push changes