Starton - Smart Contracts

This repository has all the templates provided by Starton that you can access and deploy using the official API.

Requirements

You will need :

• NodeJS (we recommend the use of nvm)
• Yarn

Installation

To install the project, first clone the repository and go inside project directory, then :

• With yarn :

  $ yarn install

Tests

You can find all the tests in the test directory

You can run them using:

yarn test

If you wants to get the coverage use:

yarn coverage

When you're going to run the tests you will get all the informations about gas comsuption of every functions inside the contracts

Documentation

A script is available to generate the documentation of the contracts

yarn doc FILENAME

This script will take all the informations as input from the doc.ts file and fill the abi, bytecode and compilation details. PS: You need to specify the contractName in the compilation details for it to works

Audits and Security

You can find the audit of the contracts by Pessimistic: Report

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to Starton's Code of Conduct.

License

Apache License 2.0

Authors

• Starton [email protected]
• Matéo Viel [email protected]