# erc20-token-vesting > ERC20 token vesting smart contracts ๐Ÿ’ฐโณ Latest version **1.0.1** (published 2023-03-14) ยท Apache-2.0 license ยท 0 weekly downloads ## Install ```sh npm install erc20-token-vesting pnpm add erc20-token-vesting yarn add erc20-token-vesting bun add erc20-token-vesting ``` ## Health **Score 15/100 (F)** โ€” status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2023-03-14 | | First published | 2023-03-14 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 10 | | Unpacked size | 64 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 203 | | Author | Abdelhamid Bakhta | | Maintainers | abdelhamid-bakhta | | Keywords | ERC20, Ethereum, Solidity, Smart+Contracts, Blockchain | ## Links - npm: https://www.npmjs.com/package/erc20-token-vesting - Repository: https://github.com/abdelhamidbakhta/token-vesting-contracts - Homepage: https://github.com/abdelhamidbakhta/token-vesting-contracts#readme - Issues: https://github.com/abdelhamidbakhta/token-vesting-contracts/issues - npm.io page: https://npm.io/package/erc20-token-vesting ## Dependencies (10) - [solc](https://npm.io/package/solc.md) npm:solc@^0.8.4 - [web3](https://npm.io/package/web3.md) ^1.3.6 - [surya](https://npm.io/package/surya.md) ^0.4.2 - [truffle](https://npm.io/package/truffle.md) ^5.3.7 - [prettier](https://npm.io/package/prettier.md) ^2.3.0 - [solidity-docgen](https://npm.io/package/solidity-docgen.md) ^0.5.13 - [solidity-coverage](https://npm.io/package/solidity-coverage.md) ^0.7.16 - [truffle-flattener](https://npm.io/package/truffle-flattener.md) ^1.5.0 - [truffle-assertions](https://npm.io/package/truffle-assertions.md) ^0.9.2 - [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) ^4.1.0 ## Alternatives - [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) โ€” 3.7M weekly downloads - [solid-js](https://npm.io/package/solid-js.md) โ€” 2.7M weekly downloads - [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) โ€” 2.5M weekly downloads - [nanoassert](https://npm.io/package/nanoassert.md) โ€” 780.8K weekly downloads - [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) โ€” 529.5K weekly downloads ## Recent versions - 1.0.1 (latest) โ€” 2023-03-14 - 1.0.0 โ€” 2023-03-14 ## README [![Actions Status](https://github.com/abdelhamidbakhta/token-vesting-contracts/workflows/test/badge.svg)](https://github.com/abdelhamidbakhta/token-vesting-contracts/actions/workflows/test.yml) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![npm version](https://badge.fury.io/js/erc20-token-vesting.svg)](https://badge.fury.io/js/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](https://github.com/abdelhamidbakhta/token-vesting-contracts/blob/main/audits/hacken_audit_report.pdf) from [Hacken](https://hacken.io) This repository is compatible with both Forge and Hardhat. You can find the specific instructions for each tool below. ### Forge #### ๐Ÿ“ฆ Installation ```console forge install ``` #### โ›๏ธ Compile ```console forge build ``` #### ๐ŸŒก๏ธ Testing ```console $ forge test ``` ### Hardhat #### ๐Ÿ“ฆ Installation ```console $ yarn ``` #### โ›๏ธ Compile ```console $ 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 ```console $ yarn test ``` #### ๐Ÿ“Š Code coverage ```console $ 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 ```console $ yarn prettier ``` #### ๐Ÿฑโ€๐Ÿ’ป Verify & Publish contract source code ```console $ npx hardhat verify --network mainnet $CONTRACT_ADDRESS $CONSTRUCTOR_ARGUMENTS ``` ## ๐Ÿ“„ License **Token Vesting Contracts** is released under the [Apache-2.0](LICENSE). ## Contributors โœจ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Abdel @ StarkWare
Abdel @ StarkWare
๐Ÿ’ป		 Vaclav Pavlin
Vaclav Pavlin
๐Ÿ’ป		 Brendan Baker
Brendan Baker
๐Ÿ’ป
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! --- _Source: https://npm.io/package/erc20-token-vesting ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._