https://github.com/kleros/archon
Provides functionality for Arbitrator and Arbitrable Ethereum smart contracts as defined in ERC 792 and ERC 1497.
https://github.com/kleros/archon
arbitration blockchain developer-tools ethereum middleware sdk
Last synced: 11 months ago
JSON representation
Provides functionality for Arbitrator and Arbitrable Ethereum smart contracts as defined in ERC 792 and ERC 1497.
- Host: GitHub
- URL: https://github.com/kleros/archon
- Owner: kleros
- Created: 2018-09-14T17:43:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T18:32:23.000Z (over 1 year ago)
- Last Synced: 2025-05-24T17:46:30.527Z (about 1 year ago)
- Topics: arbitration, blockchain, developer-tools, ethereum, middleware, sdk
- Language: JavaScript
- Homepage:
- Size: 6.74 MB
- Stars: 13
- Watchers: 11
- Forks: 7
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Archon
> Archon provides functionality for Arbitrator and Arbitrable Ethereum smart contracts as defined in ERC 792 and ERC 1497.
## Documentation
See full documentation at https://archon.readthedocs.io/en/latest/index.html
## Installation
```
npm install @kleros/archon
```
## Basic Usage
```
var Archon = require('@kleros/archon');
var archon = new Archon('wss://some.local-or-remote.node:8546');
> archon.arbitrator
> archon.arbitrable
> archon.utils
> archon.version
```
## Test
```sh
yarn ganache
yarn test
```
## Build
```sh
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