A lightning fast decentralised exchange protocol.
Clone or download

README.md

THORChain

CircleCI Maintainability

THORChain is a lightning fast decentralised exchange protocol with cross-chain bridges and support for a layer 2 payment network. Read the whitepaper here: THORChain Whitepaper

This project is based on work done for the Cosmos Project by the Cosmos/Tendermint team.

Codeclimate: https://codeclimate.com/github/thorchain/THORChain

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them:

Installing

A step by step series of examples that tell you how to get a development env running

Thorchain can be installed to $GOPATH/src/github.com/thorchain/THORChain like a normal Go program:

go get github.com/thorchain/THORChain

Then install dependencies:

cd $GOPATH/src/github.com/thorchain/THORChain
dep ensure -update github.com/brejski/hid
make get_tools
make get_vendor_deps
make install

(dep ensure above is a workaround until https://github.com/cosmos/cosmos-sdk/issues/2253 is fixed.)

Verify that everything worked by running:

thorchaind version

and:

thorchaincli version

Running the tests

make test

Break down into end to end tests

make test_cli

And coding style tests

make test_lint

Deployment

make build-linux

Built With

Contributing

Please read CONTRIBUTING.md for details on code standards and the process for submitting pull requests to the project.

Versioning

Update version/version.go before building.

Authors

thorchaindevs Initial Commit thorchainadmin

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Thanks to the Interchain Foundation (ICF) for Cosmos SDK and Tendermint, Inc for Tendermint.