An ERC20
token used to fuel a wide range of KYC related dapps
- See selfkey.io for more details.
The smart contracts are being implemented in Solidity 0.4.19
.
- NodeJS, version 9+ (I use
nvm
to manage Node versions —brew install nvm
.) - truffle, which is a comprehensive framework for Ethereum development.
npm install -g truffle
— this should install Truffle v4.0.6 or better. Check that withtruffle version
. - Access to the KYC_Chain Jira
- Docker (don't
brew install docker
as it's nowhere near as relaible. Use the official Docker For Mac installer.) - ethereum-docker — run geth and any monitoring tools within docker using
docker-compose up -d
npm install
Run the truffle
development environment
truffle develop
then from the prompt you can run
compile
migrate
test
as well as other truffle commands. See truffleframework.com for more.
Run
npm test
To generate code coverage reports run
npm run test:cov
Note Generating code coverage reports takes a bit longer to run than just running the tests.
We provide the following linting options
npm run lint:sol
— to lint the solidity files, andnpm run lint:js
— to lint the javascript.
You'll need an address on the Ropsten blockchain with some ETH in it.
Use MetaMask to create a wallet and use faucet.metamask.io to get some ETH for it.
You will need to supply a file called wallet.json
in the root of the project.
{
"name": "my awesome wallet",
"mnemonic": "the sequence of twelve words you used to keep your wallet secure"
}
Then run
npm run deploy:ropsten
Contributions are welcomed. Please see the contributing notes