erc20-token-vesting

Token Vesting Contracts

Overview

On-Chain vesting scheme enabled by smart contracts.

TokenVesting contract can release its token balance gradually like a typical vesting scheme, with a cliff and vesting period. The vesting schedules are optionally revocable by the owner.

Security audits

• Security audit from Hacken

This repository is compatible with both Forge and Hardhat. You can find the specific instructions for each tool below.

Forge

Installation

forge install

Compile

forge build

Testing

$ forge test

Hardhat

Installation

$ yarn

Compile

$ yarn compile

This task will compile all smart contracts in the contracts directory. ABI files will be automatically exported in build/abi directory.

Documentation

Documentation is auto-generated after each build in docs directory.

The generated output is a static website containing smart contract documentation.

Testing

$ yarn test

Code coverage

$ yarn coverage

The report will be printed in the console and a static website containing full report will be generated in coverage directory.

Code style

$ yarn prettier

‍ Verify & Publish contract source code

$ npx hardhat  verify --network mainnet $CONTRACT_ADDRESS $CONSTRUCTOR_ARGUMENTS

License

Token Vesting Contracts is released under the Apache-2.0.

Contributors

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare

Vaclav Pavlin

Brendan Baker

This project follows the all-contributors specification. Contributions of any kind welcome!