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!