This repository holds a set of solidity contracts that make up our XCHNG Token.
Future contracts can be added to take advantage of existing implementations and tests.
Truffle is a development environment, testing framework and asset pipeline for Ethereum.
A truffle.js and truffle-config.js will be created. You can set additional configurations for your truffle environment there.
Ganache is a private blockchain for ethereum development. It allows you to easily deploy,tests, and debug contracts/applications.
Install ganache by downloading the appropriate version for your OS
or
Install the ganache-cli through npm using npm install -g ganache-cli
Metamask is an easy to use browser extension. You can set up a private network by following this setup guide
Dependencies are managed with yarn. If you do not already have yarn install you can run npm install -G yarn.
To install the project dependencies run yarn install from the project root dir.
To compile the solidity contracts run truffle compile from the project root dir.
The compiled artifacts will be placed under prject_root_dir/build/contracts/
Note : Truffle expects contracts to be located at project_root_dir/contracts
To deploy/migrate contracts to a local ganache instance run truffle migrate --network ganache from the project root dir.
Our tests are written using mocha and chai and assume you are using truffle to launch the tests.
To test our smart contracts run truffle test from the project root dir.
To execute a single test file run : truffle test ./path/to/test/file.js
Note : Truffle expects contract tests to be located at project_root_dir/test
We are using solidity-coverage to view our test coverage.
To generate the report run ./node_modules/.bin/solidity-coverage from the project root dir.