Skip to content

Latest commit

 

History

History
175 lines (119 loc) · 5.35 KB

README.md

File metadata and controls

175 lines (119 loc) · 5.35 KB
Raw

ethjs-contract-boilerplate


Features

  • Highly unopinionated
  • Complex configurable multi-environment contract deployment (ethdeploy)
  • Dual-language contract testing in Javascript (mocha) and Solidity (wafr)
  • Async/Await enabled JS testing
  • Configurable linting with eslint
  • Webpack enabled build and distribution flow
  • Local TestRPC driven testing environment

Install

git clone https://github.com/ethjs/ethjs-contract-boilerplate
cd ethjs-contract-boilerplate
npm install

Start

This will start a testrpc instance which is used for JS testing.

npm start

Test

npm test

Solidity or JS Testing

npm run test:contracts:solidity

npm run test:contracts:js

Deployment

Specify your account information in internals/accounts/index.js

Remember, do not publish/include your actual private keys in the repo.. require them from a source outside the repository

npm run deploy:mainnet
npm run deploy:rinkeby

npm run deploy:testrpc

Build

This will build the outputted contract data (address/abi/interface etc).

npm run build

About

This is a highly configurable boilerplate for constructing complex Ethereum smart-contract systems.

All environment and account configuration is included within the internals directory.

All contracts/interfaces and tests are included in the src/contracts directory.

All build/deployment data is outputed to src/contracts/lib directory.

Internals

Account Management (internals/accounts)

All account data is included in the accounts directory. This is where you can define your account private keys/addresses/balances.

This boierplate is configured to use the same account accross all environments.

Contract Deployment (internals/ethdeploy)

All deployment configuration is included in this directory.

Distribution (internals/webpack)

All webpack related configuration is in this directory.

Contributing

Please help better the ecosystem by submitting issues and pull requests to ethjs-contract-boilerplate. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.

Help out

There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:

  • Create, enhance, and debug ethjs rules (see our guide to "Working on rules").
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas for making ethjs better, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Create or contribute to ecosystem tools.
  • Spread the word!

Please consult our Code of Conduct docs before helping out.

We communicate via issues and pull requests.

Todo

The current TODO items are:

  • A clear command (clear all boilerplate contracts/tests)
  • Plop enabled contract instantiation
  • Account generation/wallet management

Important documents

Licence

This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.

The MIT License

Copyright (c) 2016 Nick Dodson. nickdodson.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.