Implement dynamic balanceOf and totalSupply in stETH (Aragon-way) #28

ongrid · 2020-09-28T16:58:25Z

Keeping the Aragon approach, implement dynamic outputs of balanceOf and totalSupply and related functions as specified in stETH token specification.

* link DePool and stETH * implement basic getters * minimal tests

* Add DePool mock with initializer * Add shares and totalShares vars to stETH * Add shares-related getter * Link math to totalControlledEthers of DePool * Fix minimal tests

* Add tests for share-related getters (w. 0 shares) * Mock DePool's totalControlledEther method

Issues: #3 and #28 * Remove mint * Add processSubmission Todo: * Expose share getters via Mock * Mock dePool contract * share and balances unit-tests (on Mocks)

Issues: #3 and #28 * Remove mint * Add processSubmission

* Split tests for zero- and non-zero supply Issues: #3 and #28 ToDo: * mint via processSubmission * Mock token to expose totalShares * Check effects on totalShares * Double-check math

* Split tests for zero- and non-zero supply Issues: #3 and #28

Issues: #3 and #28

Since stETH implements dynamic balances behavior we rename the corresponding state variables. Note: Still keeping traditional behavior - storing individual balances. Related issies: #3 #28

Since stETH implements dynamic balances behavior, rename the conventional state variables and use _shares and _totalShares instead. Note: Still keeping traditional behavior - storing individual balances in newly-named vars -> subject to change. Related issies: #3 #28

* Remove mint and burn interfaces * Comment out DePool mint ext calls (user and treasury) * Remove conventional mint and burn (not relevant) * Remove processSubmission (will use mintShares..) * Fix getPooledEthByShares * Update tests (still broken) ToDo: * ISTETH: add mint- and burn-related interfaces * Move share calculation to StETH token * Fix tests

* Get totalSupply from dePool.totalControlledEthers * Return balanceOf in PooledEth * Share calculation in mint * Share calculation in burn (WIP, broken) * Set totalControlledEther in unittests

* Change transfer math to share-based * Additional checks in _transfer

Since mint logic changed to share-based, there is no need to preserve OZ's approach of logic/interface separation. * Remove internal _mint function * Move _mint's logic inside mint * Update docstrings

Replaced by mint(...) function that has more conventional name

* Add DePool mock with initializer * Add shares and totalShares vars to stETH * Add shares-related getter * Link math to totalControlledEthers of DePool * Fix minimal tests

* Add tests for share-related getters (w. 0 shares) * Mock DePool's totalControlledEther method

Issues: #3 and #28 * Remove mint * Add processSubmission

* Split tests for zero- and non-zero supply Issues: #3 and #28

* Switch to minting calculator located inside the token * Rename _rewards to _totalRewards in distributeRewards func * Add getRewardBase() public getter ToDos: * Fix getSPs().distributeRewards reverts * zero feeBasePoint breaks mint (DePool.sol:535)

* Switch to minting calculator located inside the token * Rename _rewards to _totalRewards in distributeRewards func * Add getRewardBase() public getter * balanceOf calls getPooledEthByHolder for clarity * simplify share calculation in mint function Broken: StakingProvidersRegistry.sol:312 reverts in integration tests with stETH