README
@rei-network/contracts
REI-Network genesis contracts
Config
Global config contract, deployed at0x0000000000000000000000000000000000001000
StakeManager
Stake manager contract, deployed at0x0000000000000000000000000000000000001001
UnstakePool
A smart contract that keeps unstake amount, deployed at0x0000000000000000000000000000000000001003
ValidatorRewardPool
A smart contract that keeps validator reward for validator, deployed at0x0000000000000000000000000000000000001004
CommmissionShare
A smart contract that keeps commission reward for all staking user, dynamically deployed for each validator
Install
npm install @rei-network/contracts
Usage
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity ^0.6.0;
import "@openzeppelin/contracts/token/ERC20/ERC20Burnable.sol";
import "@openzeppelin/contracts/math/SafeMath.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@rei-network/contracts/src/interfaces/IStakeManager.sol";
import "@rei-network/contracts/src/interfaces/ICommissionShare.sol";
// candy token for stake user
// after deployment, the `transferOwnership` method should be called
// to transfer ownership to the `LockedStake` contract
contract Candy is ERC20Burnable, Ownable {
constructor() public ERC20("Candy", "CD") {}
function mint(address to, uint256 amount) external onlyOwner {
_mint(to, amount);
}
}
/**
* A locked staking smart contract,
* user stake for validator can get candy reward,
* but only can start unstake after `lockTime`
*/
contract LockedStake {
using SafeMath for uint256;
// lock the shares until 4 weeks later
uint256 public lockTime = 4 weeks;
address public validator;
Candy public candy;
IStakeManager public sm;
mapping(uint256 => uint256) public stakeTimestampOf;
mapping(uint256 => uint256) public stakeSharesOf;
mapping(uint256 => address) public stakeOwnerOf;
// auto-increment id for each stack
uint256 private autoIncrement = 0;
event Stake(
address indexed staker,
uint256 indexed id,
uint256 amount,
uint256 shares
);
event Unstake(uint256 indexed unstakeId);
constructor(address _validator, Candy _candy) public {
validator = _validator;
candy = _candy;
sm = IStakeManager(0x0000000000000000000000000000000000001001);
}
function stake() external payable returns (uint256 id) {
id = autoIncrement;
autoIncrement = id.add(1);
uint256 shares = sm.stake{ value: msg.value }(validator, address(this));
stakeTimestampOf[id] = block.timestamp;
stakeSharesOf[id] = shares;
stakeOwnerOf[id] = msg.sender;
candy.mint(msg.sender, shares);
emit Stake(msg.sender, id, msg.value, shares);
}
function unstake(uint256 id, address payable to)
external
returns (uint256 unstakeId)
{
uint256 timestamp = stakeTimestampOf[id];
require(
timestamp != 0 && timestamp.add(lockTime) >= block.timestamp,
"LockedStake: invalid id or timestamp"
);
require(stakeOwnerOf[id] == msg.sender, "LockedStake: invalid stake owner");
uint256 _shares = stakeSharesOf[id];
// we should approve the shares to stake manager before starting unstake
ICommissionShare(sm.validators(validator).commissionShare).approve(
address(sm),
_shares
);
// stake manager will burn the shares and return the REI after `config.unstakeDelay`
unstakeId = sm.startUnstake(validator, to, _shares);
delete stakeTimestampOf[id];
delete stakeSharesOf[id];
delete stakeOwnerOf[id];
emit Unstake(unstakeId);
}
}
Hardhat tasks
AVAILABLE TASKS:
abr Assign block reward
accounts List accounts
afb Call onAfterBlock callback
approve Approve commission share
balance Get balance
check Check whatever you need
clean Clears the cache and deletes all artifacts
compile Compiles the entire project, building all artifacts
console Opens a hardhat console
deploy Deploy contracts
du Do unstake
etherscan-verify submit contract source code to etherscan
export export contract deployment of the specified network into one file
export-artifacts
flatten Flattens and prints contracts and their dependencies
gb Get REI balance
help Prints this message
lscfgaddr List config addresses
node Starts a JSON-RPC server on top of Hardhat EVM
run Runs a user-defined script after compiling the project
scr Set commission rate
sourcify submit contract source code to sourcify (https://sourcify.dev)
stake Stake for validator
su Start unstake
test Runs mocha tests
transfer Transfer value to target address
typechain Generate Typechain typings for compiled contracts
verify Verifies contract on Etherscan
vp Visit validator voting power by address
vu Visit unstake info by id
vva Visit validator information by address
vvi Visit validator information by index
Any detailed options of the task can be obtained like this:
npx hardhat stake --help
Hardhat tasks usage
Stake
npx hardhat --networkd rei-testnet stake --address 0x0000000000000000000000000000000000001001 --validator 0x...123 --value 100 --ether
stake 100 REI for 0x...123 on rei-testnet
Start unstake
npx hardhat --networkd rei-testnet sunstake --address 0x0000000000000000000000000000000000001001 --validator 0x...123 --shares 100 --ether
start unstake 100 CommissionShares for 0x...123 on rei-testnet
Unstake
npx hardhat --networkd rei-testnet unstake --address 0x0000000000000000000000000000000000001001 --id 0
unstake for id 0