Giter Club home page Giter Club logo

token-vesting-contracts's Introduction

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. The vesting schedules are optionally revocable by the owner.

๐ŸŽญ๐Ÿง‘โ€๐Ÿ’ป Security audits

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

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

Note: make sure to have ran forge build and compile before you run tests.

$ 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
Abdel @ StarkWare

๐Ÿ’ป
Vaclav Pavlin
Vaclav Pavlin

๐Ÿ’ป
Brendan Baker
Brendan Baker

๐Ÿ’ป
Oren Gampel
Oren Gampel

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

token-vesting-contracts's People

Contributors

abdelstark avatar dependabot[bot] avatar themightyyak1 avatar owlen avatar vpavlin avatar joelamouche avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.