README.md

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. Optionally revocable by the owner.

🎭🧑‍💻 Security audits

• Security audit from Hacken

📦 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.