Package Exports

@nichemandao/consul
@nichemandao/consul/dist/index.js

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 (@nichemandao/consul) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

Update .rst files in /docs
Run to generate new docs bundle

cd docs && make html

View changes

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

Push changes