solidity-template

{{description}}

• develop —
• master —

Overview

This template was originally created to be used with create-project. However, github allows to use the template directly at repository creation time. This README should be overwritten according to the project's needs.

How to use this template

Using github

1. Select "create new repository" on SelfKeyFoundation github account.
2. Under "Repository template" select solidity-template
3. Continue project creation workflow as usual (see CONTRIBUTING.md)

By selecting the template from github, using create-project is not necessary, however, the following guidelines are kept for reference (possibly deprecating soon)...

Using create-project

1. Install create-project: npm install -g create-project
2. Create project on the main repo, fork and clone according to the contribution guidelines
3. In the directory outside the locally cloned project, execute create-project <project-name> SelfKeyFoundation/solidity-template
4. git add all the files included and make an initial commit
5. Overwrite this README on the new repository and start working on your project...

Development

Smart contracts are being implemented using Solidity 0.5.4.

Prerequisites

• NodeJS, version 9.5+ (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 the latest truffle version.

Initialization

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

We provide the following linting command for inspecting solidity contracts.

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

Contributing

Please see the contributing notes.