Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AbdelStark/token-vesting-contracts
ERC20 token vesting smart contracts 💰⏳
https://github.com/AbdelStark/token-vesting-contracts
erc20 ethereum forge foundry smart-contracts solidity solmate vesting
Last synced: 13 days ago
JSON representation
ERC20 token vesting smart contracts 💰⏳
- Host: GitHub
- URL: https://github.com/AbdelStark/token-vesting-contracts
- Owner: AbdelStark
- License: apache-2.0
- Created: 2021-05-25T11:24:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T18:14:19.000Z (5 months ago)
- Last Synced: 2024-10-31T07:05:59.886Z (16 days ago)
- Topics: erc20, ethereum, forge, foundry, smart-contracts, solidity, solmate, vesting
- Language: JavaScript
- Homepage:
- Size: 2.17 MB
- Stars: 192
- Watchers: 5
- Forks: 136
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Audit: audits/hacken_audit_report.pdf
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/abdelhamidbakhta/token-vesting-contracts/actions/workflows/test.yml)
[](https://github.com/prettier/prettier)
[](https://opensource.org/licenses/Apache-2.0)
[](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.
Forge needs to be ran (install and build) before Hardhat is used in order to load dependency contracts.
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
Note: make sure to have ran forge build and compile before you run tests.
```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
💻
Vaclav Pavlin
💻
Brendan Baker
💻
Oren Gampel
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!