An Interface and Reference Implementation of the ERC-884 DGCL Token.
Clone or download
davesag Merge pull request #35 from davesag/greenkeeper/lint-staged-8.0.0
Update lint-staged to the latest version 🚀
Latest commit f70f769 Oct 31, 2018

README.md

ERC884-reference-implementation

Greenkeeper badge

An Interface and Reference Implementation of the ERC-884 Delaware General Corporate Law compliant (DGCL) token.

  • developCircleCI codecov
  • masterCircleCI codecov

Status

An ERC-884 token is an ERC-20 compatible token that is compliant with Delaware General Corporate Law.

Development

The smart contracts are implemented using Solidity 0.4.24.

Development Prerequisites

  • NodeJS, version 10+ or better (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.1.14 or better. Check that with truffle version.

Initialisation

npm install

Testing

Standalone

npm test

or with code coverage

npm run test:cov

From within Truffle

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.

Linting

You can use the following linting options

  • npm run lint:sol — to lint the Solidity files, and
  • npm run lint:js — to lint the Javascript.

Contributing

Please see the contributing notes.