Utility Token Contracts

Utility token Contracts is a collection of smart contracts that enable developers to create utility token.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Project requires node and npm to be installed on dev machine.

Cloning

In case of fresh clone, use --recursive-submodules option while cloning:

git clone --recursive-submodules https://github.com/OpenST/utilitytoken-contracts.git

To update git submodules for already cloned repos, run:

git submodule update --init --recursive

Installing

Install npm packages, by running:

npm install

Compiling the contracts

The following npm script compiles updated contracts from the last call:

npm run compile

To compile all contracts, run:

npm run compile-all

Running the tests

Before running the tests run ganache-cli by:

npm run ganache

Run tests by calling:

npm run test

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Developer Guidelines

Learn about OpenST developer guidelines.

Authors

See also the list of contributors who participated in this project.