Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vgloic/rainbow-token-contracts
Rainbow Token smart contracts
https://github.com/vgloic/rainbow-token-contracts
ethereum smart-contracts
Last synced: about 1 month ago
JSON representation
Rainbow Token smart contracts
- Host: GitHub
- URL: https://github.com/vgloic/rainbow-token-contracts
- Owner: VGLoic
- Created: 2022-02-13T16:56:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-04T15:43:46.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T10:51:35.947Z (9 months ago)
- Topics: ethereum, smart-contracts
- Language: TypeScript
- Homepage:
- Size: 1.15 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rainbow Token Contracts
[](https://coveralls.io/github/VGLoic/rainbow-token-contracts?branch=main)
:warning: This application has been developed for educational purposes and should not be considered as a serious product in its current state :warning:
## Local Development
This repository is developped using [hardhat](https://hardhat.org/). One is free to directly use the available scripts from hardhat using `npx`, otherwise, a set of local script have been made in order to allow safe local development.
### Setup
#### Environment Variables
Proper environment variables are needed in order to run the various scripts
- `REPORT_GAS`: if truthy, the gas measurements of the tests will be translated in USD value. The `COINMARKET_CAP_API_KEY` environment variable will need to be set,
- `COINMARKET_CAP_API_KEY`: an API key for CoinMarket Cap in order to retrieve USD value of ETH,
- `ETHERSCAN_KEY`: an etherscan key used in order to verify the contracts on Etherscan,
#### Nvm
Use configured node and npm versions
```console
nvm use
```
Nvm installation instructions may be found [here](https://github.com/nvm-sh/nvm);
#### Dependencies
Install dependencies
```console
npm install
```
### Compile the smart contracts
```console
npm run compile
```
### Tests
Run all the tests
```console
npm run test
```
Obtain the test coverage
```console
npm run test:cover
```
### Solhint
Run a security and practices analysis by [solhint](https://github.com/protofire/solhint)
```console
npm run solhint
```