https://github.com/joincolony/colonytoken
Colony Token and Vesting contracts
https://github.com/joincolony/colonytoken
blockchain ethereum smart-contracts solidity token
Last synced: 11 months ago
JSON representation
Colony Token and Vesting contracts
- Host: GitHub
- URL: https://github.com/joincolony/colonytoken
- Owner: JoinColony
- License: gpl-3.0
- Created: 2018-04-11T13:28:06.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T17:07:08.000Z (over 3 years ago)
- Last Synced: 2024-05-02T00:21:48.433Z (about 2 years ago)
- Topics: blockchain, ethereum, smart-contracts, solidity, token
- Language: JavaScript
- Homepage: https://colony.io/
- Size: 8.38 MB
- Stars: 4
- Watchers: 16
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Colony Token and Vesting contracts
## About
This is the repository for the Colony token (CLNY) and Token Vesting contracts.
The contracts contained in this repo have been released under a GPL-3.0 license.
It should go without saying, but the code contained herein is designed to handle potentially large amounts of Ether, and as such should be deployed at your own risk and sole responsibility.
If you've found a bug, please reach out to us here on github or by [email](mailto:hello@colony.io).
## Install
```
git clone https://github.com/JoinColony/colonyToken.git
cd colonyToken
npm ci
git submodule update --remote --init
npm run provision:multisig:contract
```
## Contracts
[Token.sol](./contracts/Token.sol)
CLNY Token contract based on an ERC20 token with `mint` and `burn` functionality. The Token is based on the `DSToken` implementation from [Dappsys library](https://github.com/dapphub/dappsys). Additionally implements a one-way unlock switch to open the token to transfers to all token holders. When deployed initially, token transfers will only be allowed for the Colony MultiSig and Vesting contracts, see `TokenAuthority` contract for details.
[TokenAuthority.sol](./contracts/TokenAuthority.sol)
Acts as the Token Authority while CLNY Token is locked for token transfers. Implements `DSAuthority` to allow Colony MultiSig, Vesting and other necessary contracts to be able to transfer tokens for the purposes of pre-allocating tokens and token grants as well as the general functioning of the Colony Network. This is an immutable set of permissions which can be reviewed in the contract itself.
[VestingSimple.sol](./contracts/VestingSimple.sol)
Stores and manages the CLNY Token grants via the following functions:
Secured to contract owner only:
* `setGrant` - Adds a new token grant for a given user. Only one grant per user is allowed. The grant may be increased or decreased after the fact, but not less than any amount already claimed. Grants may also be added after activation, with vesting calculated from the time of activation.
* `setGrants` - Call `setGrant` on an array of addresses and values. A convenience function.
* `activate` - Allows users to begin claiming token grants, with vesting calculated from the timestamp of the activating transaction.
* `withdraw` - Withdraw any excess tokens from the contract and return them to the contract owner.
Public functions:
* `claimGrant` - Allows a grant recipient to claim their vested tokens. Errors if no tokens have vested. Note that it is advised recipients check they are entitled to claim via `getClaimable` before calling this.
* `getClaimable` - Calculates the amount of tokens currently claimable by a user.
## Testing
To run all tests:
```
npm run test:contracts
```
To run tests with code coverage using [solidity-coverage](https://github.com/sc-forks/solidity-coverage):
```
npm run test:contracts:coverage
```
To lint contracts using [Solium](https://github.com/duaraghav8/Solium)
```
npm run lint:contracts
```
## Deployment
We use a hosted Ethereum node cluster - [Infura](https://infura.io) for deployment to main and test networks.
Flattened contracts are in source control under `flattened` folder and can be generated via `npm run flatten:contracts` which uses [/solidity-steamroller](https://github.com/JoinColony/solidity-steamroller)