Skip to content

README.md

Latest commit

 

History

History
63 lines (35 loc) · 1.69 KB

README.md

File metadata and controls

63 lines (35 loc) · 1.69 KB

PoB-contracts

Smart contracts implementing Proof of Burn consensus

  • develop — CircleCI [codecov badge]
  • master — CircleCI [codecov badge]

Overview

to be filled

Requirements

to be filled

Development

The smart contracts are being implemented in Solidity 0.4.23.

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.8 or better. Check that with truffle version.
  • Access to the C4Coin Jira

Initialisation

npm install

Testing

Standalone

npm test

or with code coverage (not enabled yet as there are no real tests)

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

We provide the following linting options

  • npm run lint:sol — to lint the Solidity files, (although this is currently not working)
  • npm run lint:js — to lint the Javascript.

Contributing

Please see the contributing notes.