README.md

Project Wyvern Ethereum Smart Contracts

Synopsis

Autonomously governed trustless digital item exchange.

These are the official Ethereum smart contracts for the Wyvern ERC20 token (WYV), the Wyvern Exchange, and the Wyvern DAO. For general information on the Wyvern project, please see the official website.

Development Information

Setup

Node >= v6.9.1 and Yarn required.

Before any development, install the required NPM dependencies:

yarn

Testing

Start Ethereum's testrpc tool to provide a Web3 interface (leave this running):

yarn testrpc

Compile the latest smart contracts:

yarn compile

Run the testsuite against the simulated network:

yarn test

Generating Documentation

Autogenerate documentation from Ethereum Natspec using Doxity:

yarn doc

Final output will be written to docs, which will be automatically published on push to GitHub Pages at docs.projectwyvern.com.

Contributing

Contributions welcome! Please use GitHub issues for suggestions/concerns - if you prefer to express your intentions in code, feel free to submit a pull request.