README
MARKET Protocol has been created to provide a secure, flexible, open source foundation for decentralized trading on the Ethereum blockchain. We provide the pieces necessary to create a decentralized exchange, including the requisite clearing and collateral pool infrastructure, enabling third parties to build applications for trading. Take a look at our FAQ or docs for a little more explanation.
Join our Discord Community to interact with members of our dev staff and other contributors.
Getting Started
A Makefile is provided for easy setup of the environment.
Some pre-requisites are required in order to utilize the Makefile.
$ git clone https://github.com/MARKETProtocol/MARKETProtocol.git # clone this repository
$ git clone https://github.com/MARKETProtocol/ethereum-bridge.git # and the needed oraclize.it bridge (for local test rpc)
From here you will be able to use make commands assuming npm is already installed.
Assuming you have npm already, Install truffle
$ make install_truffle
Clone this repository and use npm to install needed dependencies
$ git clone https://github.com/MARKETProtocol/MARKETProtocol.git
$ cd MARKETProtocol
$ make install_deps
If you get an error on the node-gyp rebuild line during make install_deps, node-gyp doesn't support Python v3.x.x; v2.7 is recommended. There are several solutions based upon your platform.
The easiest solution? Use make install_deps_python2.7 to use Python 2.7, see stack overflow or the npm node-gyp project for details.
Tests
To run the tests locally via truffle you must have oraclize's bridge running. Information on installation can be found here
Start truffle and its development blockchain with
$ make start_console
and then start the ethereum bridge (in a separate console) to run connected to the development blockchain you just started. (in this example account 9 is used)
$ make start_bridge
Once the bridge has fully initialized, you should be able to run the example migrations as well as the accompanying tests inside the truffle console
truffle(develop)> migrate --reset
truffle(develop)> test
If this fails due to a revert , please be sure the bridge is listening prior to attempting the migration.
Running tests with coverage enabled
The most convenient way to run tests with coverage enabled is to run them with help of Docker orchestration. This ensures, that the coverage results will match the ones on Travis CI.
Prerequisites
Docker and docker-compose
Instructions on how to install both applications are available at docker and docker-compose websites. When the applications are installed please make sure that the current user is added to 'docker' group.
Environment variables
Docker images use four environment variables that point to host and port on test and coverage Ethereum networks, please export them to your shell environment:
TRUFFLE_DEVELOP_HOST=truffle TRUFFLE_DEVELOP_PORT=9545 TRUFFLE_COVERAGE_HOST=truffle-coverage TRUFFLE_COVERAGE_PORT=8555
Running tests
Start containers
docker-compose up
The first run will take a while since images will be pulled from Docker registry. After that images are cached and the start will be much faster. Please wait until Oraclize connector initializes and open a second console. Make sure that all four environment variables are available in the second shell.
Install dependencies
docker-compose exec truffle-coverage npm install
Start tests
docker-compose exec truffle-coverage env CONTINUOUS_INTEGRATION=true scripts/coverage_run.sh
Solium
To run solium on the solidity smart contracts
ensure you have solium installed with solium -V if not install
$ npm install -g solium
and then
$ solium --dir ./
Contributing
Want to hack on MARKET Protocol? Awesome!
MARKET Protocol is an Open Source project and we welcome contributions of all sorts. There are many ways to help, from reporting issues, contributing code, and helping us improve our community.
Ready to jump in? Check docs.marketprotocol.io/#contributing.
Questions?
Join our Discord Community to get in touch with our dev staff and other contributors.