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.
๐ฆ 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
TODOS
- Investigate Hardhat Ledger support https://www.npmjs.com/package/@ethersproject/hardware-wallets
๐ License
Token Vesting Contracts is released under the Apache-2.0.