https://github.com/dimensiondev/stake_mask
https://github.com/dimensiondev/stake_mask
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dimensiondev/stake_mask
- Owner: DimensionDev
- License: mit
- Created: 2024-03-15T05:03:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T03:34:28.000Z (over 1 year ago)
- Last Synced: 2025-02-15T12:52:42.145Z (12 months ago)
- Language: Solidity
- Size: 1.12 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stake Mask
### Introduction
This project is about staking MASK tokens to earn ecosystem token rewards. It consists of two main contracts:
`StakeManager.sol`, manages the staking of MASK tokens.
`Reward.sol`, distributes ecosystem token rewards.
## Getting Started
### Deployed Contract Address
| Chain | StakeManager | Reward |
| ------- | ----------------------------- | ------------------------------ |
| mainnet | [`0x089f9e40`][stake-mainnet] | [`0xb55f6363`][reward-mainnet] |
[stake-mainnet]: https://etherscan.io/address/0x089f9e409e2ae5837def520ce6bfb2fa03ce5128
[reward-mainnet]: https://etherscan.io/address/0xb55f6363e8033641ada71afadabd667d071bc9b1
### Build / Compile
Build / Compile the contracts:
```sh
$ forge build
```
### Clean
Delete the build artifacts and cache directories:
```sh
$ forge clean
```
### Coverage
Get a test coverage report:
```sh
$ forge coverage
```
### Generate typechain (by hardhat)
Generate typechain (by hardhat):
```sh
$ npx hardhat compile
```
### Deploy
Deploy:
```sh
$ npx hardhat --network deploy
```
### Format
Format the contracts:
```sh
$ forge fmt
```
### Gas Usage
Get a gas report:
```sh
$ forge test --gas-report
```
### Test
Run the tests:
```sh
$ forge test
```
Run the tests with detailed report:
```sh
$ forge test -vvvv
```
### Verify
Verify contracts:
```sh
$ ETHERSCAN_API_KEY= forge verify-contract --watch --compiler-version "v0.8.23" \
[--verifier-url http://localhost:5000] \
--constructor-args $(cast abi-encode "constructor(string)" "string") \
Some-contract
```