davesag / erc884-reference-implementation

An Interface and Reference Implementation of the ERC-884 DGCL Token.

ERC884-reference-implementation

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

Branch	Status	Coverage
develop			Work in progress — updating for Truffle V5
master			Last stable release

Status

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

• See EIPS/eip-884 for the official spec.
• • See Tokenising Shares: Introducing ERC-884 for a more wordy overview.

Development

The smart contracts are implemented using Solidity 0.4.24.

Development Prerequisites

• NodeJS, version 10 (I use nvm to manage Node versions — brew install nvm.) note does not work with Node 12.
• truffle, which is a comprehensive framework for Ethereum development. npm install -g truffle — this should install Truffle v5.0.1 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.