sagarjethideveloper / Token-vesting

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Actions Status code style: prettier license npm version

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

๐Ÿ“„ License

Token Vesting Contracts is released under the Apache-2.0.

About

License:Apache License 2.0


Languages

Language:JavaScript 50.7%Language:Solidity 48.3%Language:Shell 0.9%