StakeWise

1/**
2 * @title Pool
3 *
4 * @dev Pool contract accumulates deposits from the users, mints tokens and registers validators.
5 */
6contract Pool is IPool, OwnablePausableUpgradeable {
7    using SafeMathUpgradeable for uint256;
8​
9    // @dev Validator deposit amount.
10    uint256 public constant VALIDATOR_DEPOSIT = 32 ether;
11​
12    // @dev Total activated validators.
13    uint256 public override activatedValidators;
14​
15    // @dev Pool validator withdrawal credentials.
16    bytes32 public override withdrawalCredentials;
17​
18    // @dev Address of the ETH2 Deposit Contract (deployed by Ethereum).
19    IDepositContract public override validatorRegistration;
20​
21    // @dev Address of the StakedEthToken contract.
22    IStakedEthToken private stakedEthToken;
23​
24    // @dev Address of the Validators contract.
25    IValidators private validators;
26​
27    // @dev Address of the Oracles contract.
28    address private oracles;
29​
30    // @dev Maps senders to the validator index that it will be activated in.
31    mapping(address => mapping(uint256 => uint256)) public override activations;
32​
33    // @dev Total pending validators.
34    uint256 public override pendingValidators;
35​
36    / @dev Amount of deposited ETH that is not considered for the activation period.
37    uint256 public override minActivatingDeposit;
38​
39    / @dev Pending validators percent limit. If it's not exceeded tokens can be minted immediately.
40    uint256 public override pendingValidatorsLimit;
41​
42    /**
43     * @dev See {IPool-upgrade}.
44     * The `initialize` must be called before upgrading in previous implementation contract:
45     * https://github.com/stakewise/contracts/blob/v1.0.0/contracts/collectors/Pool.sol#L42
46     */
47    function upgrade(
48        address _oracles,
49        uint256 _activatedValidators,
50        uint256 _pendingValidators,
51        uint256 _minActivatingDeposit,
52        uint256 _pendingValidatorsLimit
53    )
54        external override onlyAdmin whenPaused
55    {
56        require(oracles == address(0), "Pool: already upgraded");
57        oracles = _oracles;
58​
59        pendingValidators = _pendingValidators;
60        activatedValidators = _activatedValidators;
61        emit ActivatedValidatorsUpdated(_activatedValidators, msg.sender);
62​
63        minActivatingDeposit = _minActivatingDeposit;
64        emit MinActivatingDepositUpdated(_minActivatingDeposit, msg.sender);
65​
66        pendingValidatorsLimit = _pendingValidatorsLimit;
67        emit PendingValidatorsLimitUpdated(_pendingValidatorsLimit, msg.sender);
68    }
69​
70    /**
71     * @dev See {IPool-setWithdrawalCredentials}.
72     */
73    function setWithdrawalCredentials(bytes32 _withdrawalCredentials) external override onlyAdmin {
74        withdrawalCredentials = _withdrawalCredentials;
75        emit WithdrawalCredentialsUpdated(_withdrawalCredentials);
76    }
77​
78    /**
79     * @dev See {IPool-setMinActivatingDeposit}.
80     */
81    function setMinActivatingDeposit(uint256 _minActivatingDeposit) external override onlyAdmin {
82        minActivatingDeposit = _minActivatingDeposit;
83        emit MinActivatingDepositUpdated(_minActivatingDeposit, msg.sender);
84    }
85​
86    /**
87     * @dev See {IPool-setPendingValidatorsLimit}.
88     */
89    function setPendingValidatorsLimit(uint256 _pendingValidatorsLimit) external override onlyAdmin {
90        require(_pendingValidatorsLimit < 10000, "Pool: invalid limit");
91        pendingValidatorsLimit = _pendingValidatorsLimit;
92        emit PendingValidatorsLimitUpdated(_pendingValidatorsLimit, msg.sender);
93    }
94​
95    /**
96     * @dev See {IPool-setActivatedValidators}.
97     */
98    function setActivatedValidators(uint256 newActivatedValidators) external override {
99        require(msg.sender == oracles || hasRole(DEFAULT_ADMIN_ROLE, msg.sender), "Pool: access denied");
100​
101        // subtract activated validators from pending validators
102        pendingValidators = pendingValidators.sub(newActivatedValidators.sub(activatedValidators));
103        activatedValidators = newActivatedValidators;
104        emit ActivatedValidatorsUpdated(newActivatedValidators, msg.sender);
105    }
106​
107    /**
108     * @dev See {IPool-addDeposit}.
109     */
110    function addDeposit() external payable override whenNotPaused {
111        require(msg.value > 0, "Pool: invalid deposit amount");
112​
113        // mint tokens for small deposits immediately
114        if (msg.value <= minActivatingDeposit) {
115            stakedEthToken.mint(msg.sender, msg.value);
116            return;
117        }
118​
119        // mint tokens if current pending validators limit is not exceed
120        uint256 _pendingValidators = pendingValidators.add((address(this).balance).div(VALIDATOR_DEPOSIT));
121        uint256 _activatedValidators = activatedValidators; // gas savings
122        uint256 validatorIndex = _activatedValidators.add(_pendingValidators);
123        if (validatorIndex.mul(1e4) <= _activatedValidators.mul(pendingValidatorsLimit.add(1e4))) {
124            stakedEthToken.mint(msg.sender, msg.value);
125        } else {
126            // lock deposit amount until validator activated
127            activations[msg.sender][validatorIndex] = activations[msg.sender][validatorIndex].add(msg.value);
128            emit ActivationScheduled(msg.sender, validatorIndex, msg.value);
129        }
130    }
131​
132    /**
133     * @dev See {IPool-canActivate}.
134     */
135    function canActivate(uint256 _validatorIndex) external view override returns (bool) {
136        return _validatorIndex.mul(1e4) <= activatedValidators.mul(pendingValidatorsLimit.add(1e4));
137    }
138​
139    /**
140     * @dev See {IPool-activate}.
141     */
142    function activate(address _account, uint256 _validatorIndex) external override whenNotPaused {
143        require(_validatorIndex.mul(1e4) <= activatedValidators.mul(pendingValidatorsLimit.add(1e4)), "Pool: validator is not active yet");
144​
145        uint256 amount = activations[_account][_validatorIndex];
146        require(amount > 0, "Pool: invalid validator index");
147​
148        delete activations[_account][_validatorIndex];
149        stakedEthToken.mint(_account, amount);
150        emit Activated(_account, _validatorIndex, amount, msg.sender);
151    }
152​
153    /**
154     * @dev See {IPool-activateMultiple}.
155     */
156    function activateMultiple(address _account, uint256[] calldata _validatorIndexes) external override whenNotPaused {
157        uint256 toMint;
158        uint256 _activatedValidators = activatedValidators;
159        for (uint256 i = 0; i < _validatorIndexes.length; i++) {
160            uint256 validatorIndex = _validatorIndexes[i];
161            require(validatorIndex.mul(1e4) <= _activatedValidators.mul(pendingValidatorsLimit.add(1e4)), "Pool: validator is not active yet");
162​
163            uint256 amount = activations[_account][validatorIndex];
164            toMint = toMint.add(amount);
165            delete activations[_account][validatorIndex];
166​
167            emit Activated(_account, validatorIndex, amount, msg.sender);
168        }
169        require(toMint > 0, "Pool: invalid validator index");
170        stakedEthToken.mint(_account, toMint);
171    }
172​
173    /**
174     * @dev See {IPool-registerValidator}.
175     */
176    function registerValidator(Validator calldata _validator) external override whenNotPaused {
177        require(validators.isOperator(msg.sender), "Pool: access denied");
178​
179        // register validator
180        validators.register(keccak256(abi.encodePacked(_validator.publicKey)));
181        emit ValidatorRegistered(_validator.publicKey, msg.sender);
182​
183        // update number of pending validators
184        pendingValidators = pendingValidators.add(1);
185​
186        validatorRegistration.deposit{value : VALIDATOR_DEPOSIT}(
187            _validator.publicKey,
188            abi.encodePacked(withdrawalCredentials),
189            _validator.signature,
190            _validator.depositDataRoot
191        );
192    }
193}

Solidity Contracts

JavaScript Tests