From 3cc84a904a999d4ad063475e87a8a3def28547b9 Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 01:46:39 +1000 Subject: [PATCH 01/13] fixed an insurance amount (ZERO'd) bug --- contracts/pools/erc20.sol | 1 + contracts/pools/eth.sol | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index 6b1c0a1..51968a2 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -90,6 +90,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { insuranceAmt = sub(insuranceAmt, difTkn); _currentRate = _previousRate; } else { + insuranceAmt = 0; tokenBalance = add(_totalToken, insuranceAmt); _currentRate = wdiv(totalSupply(), tokenBalance); } diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index 35fbd53..a37685d 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -80,13 +80,14 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { uint _totalToken = RateInterface(registry.poolLogic(address(this))).getTotalToken(); _totalToken = sub(_totalToken, insuranceAmt); uint _currentRate = wdiv(totalSupply(), _totalToken); - require(_currentRate != 0, "currentRate-is-0"); + require(_currentRate != 0, "current-rate-is-zero"); if (_currentRate > _previousRate) { - uint difTkn = sub(tokenBalance, _totalToken); - if (difTkn < insuranceAmt) { - insuranceAmt = sub(insuranceAmt, difTkn); + uint _difTkn = sub(tokenBalance, _totalToken); + if (_difTkn < insuranceAmt) { + insuranceAmt = sub(insuranceAmt, _difTkn); _currentRate = _previousRate; } else { + insuranceAmt = 0; tokenBalance = add(_totalToken, insuranceAmt); _currentRate = wdiv(totalSupply(), tokenBalance); } From 07c2b67b63cbb0446540c2e806991b7e47767b41 Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 01:47:40 +1000 Subject: [PATCH 02/13] created common getter for current rate --- contracts/pools/eth.sol | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index a37685d..80e3766 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -75,11 +75,19 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { emit LogDeploy(token, amount); } + /** + * @dev get pool token rate + * @param tokenAmt total token amount + */ + function getCurrentRate(uint tokenAmt) public { + return wdiv(totalSupply(), tokenAmt); + } + function setExchangeRate() public isChief { uint _previousRate = exchangeRate; uint _totalToken = RateInterface(registry.poolLogic(address(this))).getTotalToken(); _totalToken = sub(_totalToken, insuranceAmt); - uint _currentRate = wdiv(totalSupply(), _totalToken); + uint _currentRate = getCurrentRate(_totalToken); require(_currentRate != 0, "current-rate-is-zero"); if (_currentRate > _previousRate) { uint _difTkn = sub(tokenBalance, _totalToken); @@ -89,13 +97,13 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { } else { insuranceAmt = 0; tokenBalance = add(_totalToken, insuranceAmt); - _currentRate = wdiv(totalSupply(), tokenBalance); + _currentRate = getCurrentRate(tokenBalance); } } else { uint insureFeeAmt = wmul(sub(_totalToken, tokenBalance), registry.insureFee(address(this))); insuranceAmt = add(insuranceAmt, insureFeeAmt); tokenBalance = sub(_totalToken, insureFeeAmt); - _currentRate = wdiv(totalSupply(), tokenBalance); + _currentRate = getCurrentRate(tokenBalance); } exchangeRate = _currentRate; emit LogExchangeRate(exchangeRate, tokenBalance, insuranceAmt); From 6a6a7f51e5ccf7124065970c58baeab82fc14842 Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 01:52:16 +1000 Subject: [PATCH 03/13] similar changes to previous to erc20 as well --- contracts/pools/erc20.sol | 20 ++++++++++++++------ contracts/pools/eth.sol | 2 +- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index 51968a2..ac7fa04 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -78,27 +78,35 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { emit LogDeploy(token, amount); } + /** + * @dev get pool token rate + * @param tokenAmt total token amount + */ + function getCurrentRate(uint tokenAmt) public returns (uint) { + return wdiv(totalSupply(), tokenAmt); + } + function setExchangeRate() public isChief { uint _previousRate = exchangeRate; uint _totalToken = RateInterface(registry.poolLogic(address(this))).getTotalToken(); _totalToken = sub(_totalToken, insuranceAmt); - uint _currentRate = wdiv(totalSupply(), _totalToken); + uint _currentRate = getCurrentRate(_totalToken); require(_currentRate != 0, "currentRate-is-0"); if (_currentRate > _previousRate) { - uint difTkn = sub(tokenBalance, _totalToken); - if (difTkn < insuranceAmt) { - insuranceAmt = sub(insuranceAmt, difTkn); + uint _difTkn = sub(tokenBalance, _totalToken); + if (_difTkn < insuranceAmt) { + insuranceAmt = sub(insuranceAmt, _difTkn); _currentRate = _previousRate; } else { insuranceAmt = 0; tokenBalance = add(_totalToken, insuranceAmt); - _currentRate = wdiv(totalSupply(), tokenBalance); + _currentRate = getCurrentRate(tokenBalance); } } else { uint insureFeeAmt = wmul(sub(_totalToken, tokenBalance), registry.insureFee(address(this))); insuranceAmt = add(insuranceAmt, insureFeeAmt); tokenBalance = sub(_totalToken, insureFeeAmt); - _currentRate = wdiv(totalSupply(), tokenBalance); + _currentRate = getCurrentRate(tokenBalance); } exchangeRate = _currentRate; emit LogExchangeRate(exchangeRate, tokenBalance, insuranceAmt); diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index 80e3766..0101063 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -79,7 +79,7 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { * @dev get pool token rate * @param tokenAmt total token amount */ - function getCurrentRate(uint tokenAmt) public { + function getCurrentRate(uint tokenAmt) public returns (uint) { return wdiv(totalSupply(), tokenAmt); } From 11410e0d5e59729c85748bddab650dd925433d3e Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 02:33:07 +1000 Subject: [PATCH 04/13] setExchangeRate() diagnosis completed --- contracts/pools/erc20.sol | 29 ++++++++++++++++------------- contracts/pools/eth.sol | 21 ++++++++++++--------- 2 files changed, 28 insertions(+), 22 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index ac7fa04..d68b356 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -79,30 +79,33 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { } /** - * @dev get pool token rate - * @param tokenAmt total token amount - */ - function getCurrentRate(uint tokenAmt) public returns (uint) { - return wdiv(totalSupply(), tokenAmt); - } + * @dev get pool token rate + * @param tokenAmt total token amount + */ + function getCurrentRate(uint tokenAmt) public returns (uint) { + return wdiv(totalSupply(), tokenAmt); + } + /** + * @dev sets exchange rates + */ function setExchangeRate() public isChief { uint _previousRate = exchangeRate; uint _totalToken = RateInterface(registry.poolLogic(address(this))).getTotalToken(); _totalToken = sub(_totalToken, insuranceAmt); uint _currentRate = getCurrentRate(_totalToken); - require(_currentRate != 0, "currentRate-is-0"); - if (_currentRate > _previousRate) { - uint _difTkn = sub(tokenBalance, _totalToken); - if (_difTkn < insuranceAmt) { - insuranceAmt = sub(insuranceAmt, _difTkn); + require(_currentRate != 0, "current-rate-is-zero"); + if (_currentRate > _previousRate) { // loss => deduct partially/fully from insurance amount + uint _loss = sub(tokenBalance, _totalToken); + if (_loss <= insuranceAmt) { + insuranceAmt = sub(insuranceAmt, _loss); _currentRate = _previousRate; } else { - insuranceAmt = 0; tokenBalance = add(_totalToken, insuranceAmt); + insuranceAmt = 0; _currentRate = getCurrentRate(tokenBalance); } - } else { + } else { // profit => add to insurance amount uint insureFeeAmt = wmul(sub(_totalToken, tokenBalance), registry.insureFee(address(this))); insuranceAmt = add(insuranceAmt, insureFeeAmt); tokenBalance = sub(_totalToken, insureFeeAmt); diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index 0101063..3e0bea7 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -76,30 +76,33 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { } /** - * @dev get pool token rate - * @param tokenAmt total token amount - */ + * @dev get pool token rate + * @param tokenAmt total token amount + */ function getCurrentRate(uint tokenAmt) public returns (uint) { return wdiv(totalSupply(), tokenAmt); } + /** + * @dev sets exchange rates + */ function setExchangeRate() public isChief { uint _previousRate = exchangeRate; uint _totalToken = RateInterface(registry.poolLogic(address(this))).getTotalToken(); _totalToken = sub(_totalToken, insuranceAmt); uint _currentRate = getCurrentRate(_totalToken); require(_currentRate != 0, "current-rate-is-zero"); - if (_currentRate > _previousRate) { - uint _difTkn = sub(tokenBalance, _totalToken); - if (_difTkn < insuranceAmt) { - insuranceAmt = sub(insuranceAmt, _difTkn); + if (_currentRate > _previousRate) { // loss => deduct partially/fully from insurance amount + uint _loss = sub(tokenBalance, _totalToken); + if (_loss <= insuranceAmt) { + insuranceAmt = sub(insuranceAmt, _loss); _currentRate = _previousRate; } else { - insuranceAmt = 0; tokenBalance = add(_totalToken, insuranceAmt); + insuranceAmt = 0; _currentRate = getCurrentRate(tokenBalance); } - } else { + } else { // profit => add to insurance amount uint insureFeeAmt = wmul(sub(_totalToken, tokenBalance), registry.insureFee(address(this))); insuranceAmt = add(insuranceAmt, insureFeeAmt); tokenBalance = sub(_totalToken, insureFeeAmt); From dac3be57fea025a4f0c1e823ef1962f01fd1270e Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 03:08:40 +1000 Subject: [PATCH 05/13] fixed deposit bug --- contracts/pools/erc20.sol | 15 ++++++++------- contracts/pools/eth.sol | 17 +++++++++-------- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index d68b356..a5144a8 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -35,7 +35,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { event LogDeploy(address token, uint amount); event LogExchangeRate(uint exchangeRate, uint tokenBalance, uint insuranceAmt); - event LogSettle(uint settleTime); + event LogSettle(uint settleBlock); event LogDeposit(uint depositAmt, uint poolMintAmt); event LogWithdraw(uint withdrawAmt, uint poolBurnAmt, uint feeAmt); event LogAddInsurance(uint amount); @@ -68,11 +68,11 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { function deploy(address _dsa, address token, uint amount) public isChief { require(registry.isDsa(address(this), _dsa), "not-autheticated-dsa"); require(AccountInterface(_dsa).isAuth(address(this)), "token-pool-not-auth"); - if (token == address(0)) { + if (token == address(0)) { // pool base token baseToken.safeTransfer(_dsa, amount); - } else if (token == 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE){ + } else if (token == 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE){ // non-pool ethereum payable(_dsa).transfer(amount); - } else { + } else { // non-pool other tokens IERC20(token).safeTransfer(_dsa, amount); } emit LogDeploy(token, amount); @@ -122,13 +122,12 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { dsaWallet.cast(_targets, _datas, _origin); } require(dsaWallet.isAuth(address(this)), "token-pool-not-auth"); - setExchangeRate(); - emit LogSettle(block.timestamp); + emit LogSettle(block.number); } function deposit(uint tknAmt) external whenNotPaused payable returns(uint) { - uint _newTokenBal = add(tokenBalance, tknAmt); + tokenBalance = add(tokenBalance, tknAmt); baseToken.safeTransferFrom(msg.sender, address(this), tknAmt); uint _mintAmt = wmul(tknAmt, exchangeRate); @@ -152,6 +151,8 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { _tknAmt = tknAmt; } + tokenBalance = sub(tokenBalance, _tknAmt); + _burn(msg.sender, _burnAmt); uint _withdrawalFee = registry.withdrawalFee(address(this)); diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index 3e0bea7..c27b02b 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -35,7 +35,7 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { event LogDeploy(address indexed token, uint amount); event LogExchangeRate(uint exchangeRate, uint tokenBalance, uint insuranceAmt); - event LogSettle(uint settleTime); + event LogSettle(uint settleBlock); event LogDeposit(uint depositAmt, uint poolMintAmt); event LogWithdraw(uint withdrawAmt, uint poolBurnAmt, uint feeAmt); event LogAddInsurance(uint amount); @@ -66,10 +66,10 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { function deploy(address _dsa, address token, uint amount) external isChief { require(registry.isDsa(address(this), _dsa), "not-autheticated-dsa"); - require(AccountInterface(_dsa).isAuth(address(this)), "token-pool-not-auth"); - if (token == address(0)) { + require(AccountInterface(_dsa).isAuth(address(this)), "token-pool-not-auth"); + if (token == address(0)) { // pool base ETH payable(_dsa).transfer(amount); - } else { + } else { // non-pool other tokens IERC20(token).safeTransfer(_dsa, amount); } emit LogDeploy(token, amount); @@ -118,15 +118,14 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { if (_targets.length > 0 && _datas.length > 0) { dsaWallet.cast(_targets, _datas, _origin); } - require(dsaWallet.isAuth(address(this)), "token-pool-not-auth"); + require(dsaWallet.isAuth(address(this)), "token-pool-not-auth"); setExchangeRate(); - - emit LogSettle(block.timestamp); + emit LogSettle(block.number); } function deposit(uint tknAmt) public whenNotPaused payable returns(uint) { require(tknAmt == msg.value, "unmatched-amount"); - uint _newTokenBal = add(tokenBalance, msg.value); + tokenBalance = add(tokenBalance, tknAmt); uint _mintAmt = wmul(msg.value, exchangeRate); _mint(msg.sender, _mintAmt); @@ -149,6 +148,8 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { _tknAmt = tknAmt; } + tokenBalance = sub(tokenBalance, _tknAmt); + _burn(msg.sender, _burnAmt); uint _withdrawalFee = registry.withdrawalFee(address(this)); From 86701e67bc7621a25e0b07db188e574e2b606c20 Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 03:35:51 +1000 Subject: [PATCH 06/13] simplified withdrawInsurance() method --- contracts/pools/erc20.sol | 16 ++++++---------- contracts/pools/eth.sol | 20 ++++++++------------ 2 files changed, 14 insertions(+), 22 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index a5144a8..ff10920 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -126,11 +126,12 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { emit LogSettle(block.number); } - function deposit(uint tknAmt) external whenNotPaused payable returns(uint) { + function deposit(uint tknAmt) external whenNotPaused payable returns (uint _mintAmt) { + require(msg.value == 0, "non-eth-pool"); tokenBalance = add(tokenBalance, tknAmt); baseToken.safeTransferFrom(msg.sender, address(this), tknAmt); - uint _mintAmt = wmul(tknAmt, exchangeRate); + _mintAmt = wmul(tknAmt, exchangeRate); _mint(msg.sender, _mintAmt); emit LogDeposit(tknAmt, _mintAmt); @@ -176,14 +177,9 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { function withdrawInsurance(uint tknAmt) external { require(msg.sender == instaIndex.master(), "not-master"); - require(tknAmt <= insuranceAmt || tknAmt == uint(-1), "not-enough-insurance"); - if (tknAmt == uint(-1)) { - baseToken.safeTransfer(msg.sender, insuranceAmt); - insuranceAmt = 0; - } else { - baseToken.safeTransfer(msg.sender, tknAmt); - insuranceAmt = sub(insuranceAmt, tknAmt); - } + require(tknAmt <= insuranceAmt, "not-enough-insurance"); + baseToken.safeTransfer(msg.sender, tknAmt); + insuranceAmt = sub(insuranceAmt, tknAmt); emit LogAddInsurance(tknAmt); } diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index c27b02b..efe675e 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -39,6 +39,7 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { event LogDeposit(uint depositAmt, uint poolMintAmt); event LogWithdraw(uint withdrawAmt, uint poolBurnAmt, uint feeAmt); event LogAddInsurance(uint amount); + event LogWithdrawInsurance(uint amount); event LogPausePool(bool); RegistryInterface public immutable registry; // Pool Registry @@ -123,11 +124,11 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { emit LogSettle(block.number); } - function deposit(uint tknAmt) public whenNotPaused payable returns(uint) { + function deposit(uint tknAmt) public whenNotPaused payable returns (uint _mintAmt) { require(tknAmt == msg.value, "unmatched-amount"); tokenBalance = add(tokenBalance, tknAmt); - uint _mintAmt = wmul(msg.value, exchangeRate); + _mintAmt = wmul(msg.value, exchangeRate); _mint(msg.sender, _mintAmt); emit LogDeposit(tknAmt, _mintAmt); @@ -167,21 +168,16 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { function addInsurance(uint tknAmt) external payable { require(tknAmt == msg.value, "unmatched-amount"); - insuranceAmt += tknAmt; + insuranceAmt = add(insuranceAmt, tknAmt); emit LogAddInsurance(tknAmt); } function withdrawInsurance(uint tknAmt) external { require(msg.sender == instaIndex.master(), "not-master"); - require(tknAmt <= insuranceAmt || tknAmt == uint(-1), "not-enough-insurance"); - if (tknAmt == uint(-1)) { - msg.sender.transfer(insuranceAmt); - insuranceAmt = 0; - } else { - msg.sender.transfer(tknAmt); - insuranceAmt = sub(insuranceAmt, tknAmt); - } - emit LogAddInsurance(tknAmt); + require(tknAmt <= insuranceAmt, "not-enough-insurance"); + msg.sender.transfer(tknAmt); + insuranceAmt = sub(insuranceAmt, tknAmt); + emit LogWithdrawInsurance(tknAmt); } function shutdown() external { From 99938ad737cc7c87ee84e855fbde0033790939e6 Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Mon, 31 Aug 2020 03:38:58 +1000 Subject: [PATCH 07/13] fixed event emit on erc20 --- contracts/pools/erc20.sol | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index ff10920..8080970 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -39,6 +39,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { event LogDeposit(uint depositAmt, uint poolMintAmt); event LogWithdraw(uint withdrawAmt, uint poolBurnAmt, uint feeAmt); event LogAddInsurance(uint amount); + event LogWithdrawInsurance(uint amount); event LogPausePool(bool); IERC20 public immutable baseToken; // Base token. Eg:- DAI, USDC, etc. @@ -180,7 +181,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { require(tknAmt <= insuranceAmt, "not-enough-insurance"); baseToken.safeTransfer(msg.sender, tknAmt); insuranceAmt = sub(insuranceAmt, tknAmt); - emit LogAddInsurance(tknAmt); + emit LogWithdrawInsurance(tknAmt); } function shutdown() external { From 1c2bd398f1d2b3dc9b95d137fe2db42289848d7d Mon Sep 17 00:00:00 2001 From: Thrilok Kumar Date: Sun, 30 Aug 2020 23:40:32 +0530 Subject: [PATCH 08/13] Minor edits; Added `dsa` address in `LogDeploy` --- contracts/pools/erc20.sol | 8 ++++---- contracts/pools/eth.sol | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index 8080970..3d2619b 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -33,7 +33,7 @@ interface RateInterface { contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { using SafeERC20 for IERC20; - event LogDeploy(address token, uint amount); + event LogDeploy(address indexed dsa, address token, uint amount); event LogExchangeRate(uint exchangeRate, uint tokenBalance, uint insuranceAmt); event LogSettle(uint settleBlock); event LogDeposit(uint depositAmt, uint poolMintAmt); @@ -46,7 +46,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { RegistryInterface public immutable registry; // Pool Registry IndexInterface public constant instaIndex = IndexInterface(0x2971AdFa57b20E5a416aE5a708A8655A9c74f723); // Main Index - uint private tokenBalance; // total token balance since last rebalancing + uint private tokenBalance; // total token balance uint public exchangeRate; // initial 1 token = 1 uint public insuranceAmt; // insurance amount to keep pool safe @@ -76,14 +76,14 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { } else { // non-pool other tokens IERC20(token).safeTransfer(_dsa, amount); } - emit LogDeploy(token, amount); + emit LogDeploy(_dsa, token, amount); } /** * @dev get pool token rate * @param tokenAmt total token amount */ - function getCurrentRate(uint tokenAmt) public returns (uint) { + function getCurrentRate(uint tokenAmt) public view returns (uint) { return wdiv(totalSupply(), tokenAmt); } diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index efe675e..8b342b3 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -33,7 +33,7 @@ interface RateInterface { contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { using SafeERC20 for IERC20; - event LogDeploy(address indexed token, uint amount); + event LogDeploy(address indexed dsa, address indexed token, uint amount); event LogExchangeRate(uint exchangeRate, uint tokenBalance, uint insuranceAmt); event LogSettle(uint settleBlock); event LogDeposit(uint depositAmt, uint poolMintAmt); @@ -73,14 +73,14 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { } else { // non-pool other tokens IERC20(token).safeTransfer(_dsa, amount); } - emit LogDeploy(token, amount); + emit LogDeploy(_dsa, token, amount); } /** * @dev get pool token rate * @param tokenAmt total token amount */ - function getCurrentRate(uint tokenAmt) public returns (uint) { + function getCurrentRate(uint tokenAmt) public view returns (uint) { return wdiv(totalSupply(), tokenAmt); } From 2da1029857b1b062564e9ae3bdfc40b5b3e0152c Mon Sep 17 00:00:00 2001 From: Thrilok Kumar Date: Mon, 31 Aug 2020 00:16:03 +0530 Subject: [PATCH 09/13] Added comments; Added `user` address in deposit and withdraw --- contracts/pools/erc20.sol | 45 ++++++++++++++++++++++++++++++--- contracts/pools/eth.sol | 52 +++++++++++++++++++++++++++++++++------ 2 files changed, 85 insertions(+), 12 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index 3d2619b..947d52e 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -36,8 +36,8 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { event LogDeploy(address indexed dsa, address token, uint amount); event LogExchangeRate(uint exchangeRate, uint tokenBalance, uint insuranceAmt); event LogSettle(uint settleBlock); - event LogDeposit(uint depositAmt, uint poolMintAmt); - event LogWithdraw(uint withdrawAmt, uint poolBurnAmt, uint feeAmt); + event LogDeposit(address indexed user, uint depositAmt, uint poolMintAmt); + event LogWithdraw(address indexed user, uint withdrawAmt, uint poolBurnAmt, uint feeAmt); event LogAddInsurance(uint amount); event LogWithdrawInsurance(uint amount); event LogPausePool(bool); @@ -66,6 +66,12 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { _; } + /** + * @dev Deploy assets to DSA. + * @param _dsa DSA address + * @param token token address + * @param amount token amount + */ function deploy(address _dsa, address token, uint amount) public isChief { require(registry.isDsa(address(this), _dsa), "not-autheticated-dsa"); require(AccountInterface(_dsa).isAuth(address(this)), "token-pool-not-auth"); @@ -116,6 +122,13 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { emit LogExchangeRate(exchangeRate, tokenBalance, insuranceAmt); } + /** + * @dev Settle the assets on dsa and update exchange rate + * @param _dsa DSA address + * @param _targets array of connector's address + * @param _datas array of connector's function calldata + * @param _origin origin address + */ function settle(address _dsa, address[] calldata _targets, bytes[] calldata _datas, address _origin) external isChief { require(registry.isDsa(address(this), _dsa), "not-autheticated-dsa"); AccountInterface dsaWallet = AccountInterface(_dsa); @@ -127,6 +140,11 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { emit LogSettle(block.number); } + /** + * @dev Deposit token. + * @param tknAmt token amount + * @return _mintAmt amount of wrap token minted + */ function deposit(uint tknAmt) external whenNotPaused payable returns (uint _mintAmt) { require(msg.value == 0, "non-eth-pool"); tokenBalance = add(tokenBalance, tknAmt); @@ -135,9 +153,15 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { _mintAmt = wmul(tknAmt, exchangeRate); _mint(msg.sender, _mintAmt); - emit LogDeposit(tknAmt, _mintAmt); + emit LogDeposit(msg.sender, tknAmt, _mintAmt); } + /** + * @dev Withdraw tokens. + * @param tknAmt token amount + * @param to withdraw tokens to address + * @return _tknAmt amount of token withdrawn + */ function withdraw(uint tknAmt, address to) external nonReentrant whenNotPaused returns (uint _tknAmt) { uint poolBal = baseToken.balanceOf(address(this)); require(tknAmt <= poolBal, "not-enough-liquidity-available"); @@ -167,15 +191,24 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { baseToken.safeTransfer(to, _tknAmt); - emit LogWithdraw(tknAmt, _burnAmt, _feeAmt); + emit LogWithdraw(msg.sender, tknAmt, _burnAmt, _feeAmt); } + /** + * @dev Add Insurance to the pool. + * @param tknAmt insurance token amount to add + */ function addInsurance(uint tknAmt) external { baseToken.safeTransferFrom(msg.sender, address(this), tknAmt); insuranceAmt = add(insuranceAmt, tknAmt); emit LogAddInsurance(tknAmt); } + /** + * @dev Withdraw Insurance from the pool. + * @notice only master can call this function. + * @param tknAmt insurance token amount to remove + */ function withdrawInsurance(uint tknAmt) external { require(msg.sender == instaIndex.master(), "not-master"); require(tknAmt <= insuranceAmt, "not-enough-insurance"); @@ -184,6 +217,10 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { emit LogWithdrawInsurance(tknAmt); } + /** + * @dev Shut the pool. + * @notice only master can call this function. + */ function shutdown() external { require(msg.sender == instaIndex.master(), "not-master"); paused() ? _unpause() : _pause(); diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index 8b342b3..27bffc5 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -36,8 +36,8 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { event LogDeploy(address indexed dsa, address indexed token, uint amount); event LogExchangeRate(uint exchangeRate, uint tokenBalance, uint insuranceAmt); event LogSettle(uint settleBlock); - event LogDeposit(uint depositAmt, uint poolMintAmt); - event LogWithdraw(uint withdrawAmt, uint poolBurnAmt, uint feeAmt); + event LogDeposit(address indexed user, uint depositAmt, uint poolMintAmt); + event LogWithdraw(address indexed user, uint withdrawAmt, uint poolBurnAmt, uint feeAmt); event LogAddInsurance(uint amount); event LogWithdrawInsurance(uint amount); event LogPausePool(bool); @@ -46,7 +46,7 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { IndexInterface public constant instaIndex = IndexInterface(0x2971AdFa57b20E5a416aE5a708A8655A9c74f723); IERC20 public immutable baseToken; // Base token. - uint private tokenBalance; // total token balance since last rebalancing + uint private tokenBalance; // total token balance uint public exchangeRate = 10 ** 18; // initial 1 token = 1 uint public insuranceAmt; // insurance amount to keep pool safe @@ -65,6 +65,12 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { _; } + /** + * @dev Deploy assets to DSA. + * @param _dsa DSA address + * @param token token address + * @param amount token amount + */ function deploy(address _dsa, address token, uint amount) external isChief { require(registry.isDsa(address(this), _dsa), "not-autheticated-dsa"); require(AccountInterface(_dsa).isAuth(address(this)), "token-pool-not-auth"); @@ -79,14 +85,14 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { /** * @dev get pool token rate * @param tokenAmt total token amount - */ + */ function getCurrentRate(uint tokenAmt) public view returns (uint) { return wdiv(totalSupply(), tokenAmt); } /** * @dev sets exchange rates - */ + */ function setExchangeRate() public isChief { uint _previousRate = exchangeRate; uint _totalToken = RateInterface(registry.poolLogic(address(this))).getTotalToken(); @@ -113,6 +119,13 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { emit LogExchangeRate(exchangeRate, tokenBalance, insuranceAmt); } + /** + * @dev Settle the assets on dsa and update exchange rate + * @param _dsa DSA address + * @param _targets array of connector's address + * @param _datas array of connector's function calldata + * @param _origin origin address + */ function settle(address _dsa, address[] calldata _targets, bytes[] calldata _datas, address _origin) external isChief { require(registry.isDsa(address(this), _dsa), "not-autheticated-dsa"); AccountInterface dsaWallet = AccountInterface(_dsa); @@ -124,6 +137,11 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { emit LogSettle(block.number); } + /** + * @dev Deposit token. + * @param tknAmt token amount + * @return _mintAmt amount of wrap token minted + */ function deposit(uint tknAmt) public whenNotPaused payable returns (uint _mintAmt) { require(tknAmt == msg.value, "unmatched-amount"); tokenBalance = add(tokenBalance, tknAmt); @@ -131,9 +149,15 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { _mintAmt = wmul(msg.value, exchangeRate); _mint(msg.sender, _mintAmt); - emit LogDeposit(tknAmt, _mintAmt); + emit LogDeposit(msg.sender, tknAmt, _mintAmt); } + /** + * @dev Withdraw tokens. + * @param tknAmt token amount + * @param to withdraw tokens to address + * @return _tknAmt amount of token withdrawn + */ function withdraw(uint tknAmt, address to) external nonReentrant whenNotPaused returns (uint _tknAmt) { uint poolBal = address(this).balance; require(tknAmt <= poolBal, "not-enough-liquidity-available"); @@ -163,15 +187,24 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { payable(to).transfer(_tknAmt); - emit LogWithdraw(tknAmt, _burnAmt, _feeAmt); + emit LogWithdraw(msg.sender, tknAmt, _burnAmt, _feeAmt); } + /** + * @dev Add Insurance to the pool. + * @param tknAmt insurance token amount to add + */ function addInsurance(uint tknAmt) external payable { require(tknAmt == msg.value, "unmatched-amount"); insuranceAmt = add(insuranceAmt, tknAmt); emit LogAddInsurance(tknAmt); } + /** + * @dev Withdraw Insurance from the pool. + * @notice only master can call this function. + * @param tknAmt insurance token amount to remove + */ function withdrawInsurance(uint tknAmt) external { require(msg.sender == instaIndex.master(), "not-master"); require(tknAmt <= insuranceAmt, "not-enough-insurance"); @@ -180,11 +213,14 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { emit LogWithdrawInsurance(tknAmt); } + /** + * @dev Shut the pool. + * @notice only master can call this function. + */ function shutdown() external { require(msg.sender == instaIndex.master(), "not-master"); paused() ? _unpause() : _pause(); } receive() external payable {} - } From 8bcec5c0ac10bbe74c5550b31418fa0b0c5c23eb Mon Sep 17 00:00:00 2001 From: Thrilok Kumar Date: Mon, 31 Aug 2020 00:42:23 +0530 Subject: [PATCH 10/13] Added comments in registry.sol --- contracts/registry.sol | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/contracts/registry.sol b/contracts/registry.sol index 94fb1b3..eead9fc 100644 --- a/contracts/registry.sol +++ b/contracts/registry.sol @@ -127,6 +127,11 @@ contract Registry { emit LogUpdatePool(_pool, isPool[_pool]); } + /** + * @dev update pool rate logic + * @param _pool pool address + * @param _newLogic new rate logic address + */ function updatePoolLogic(address _pool, address _newLogic) external isMaster { require(isPool[_pool], "not-pool"); require(_newLogic != address(0), "invalid-address"); @@ -135,6 +140,11 @@ contract Registry { emit LogUpdatePoolLogic(_pool, _newLogic); } + /** + * @dev update pool insure fee + * @param _pool pool address + * @param _newFee new fee amount + */ function updateInsureFee(address _pool, uint _newFee) external isMaster { require(isPool[_pool], "not-pool"); require(_newFee < 10 ** 18, "insure-fee-limit-reached"); @@ -143,6 +153,11 @@ contract Registry { emit LogUpdateInsureFee(_pool, _newFee); } + /** + * @dev update pool withdrawal fee + * @param _pool pool address + * @param _newFee new withdrawal fee amount + */ function updateWithdrawalFee(address _pool, uint _newFee) external isMaster { require(isPool[_pool], "not-pool"); require(_newFee < 1 * 10 ** 16, "withdrawal-fee-limit-reached"); @@ -151,6 +166,11 @@ contract Registry { emit LogUpdateWithdrawalFee(_pool, _newFee); } + /** + * @dev add dsa for a pool + * @param _pool pool address + * @param _dsa DSA address + */ function addDsa(address _pool, address _dsa) external isMaster { require(isPool[_pool], "not-pool"); if (_dsa == address(0)) _dsa = instaIndex.build(_pool, 1, address(this)); @@ -159,6 +179,11 @@ contract Registry { emit LogNewDSA(_pool, _dsa); } + /** + * @dev remove dsa from a pool + * @param _pool pool address + * @param _dsa DSA address + */ function removeDsa(address _pool, address _dsa) external isMaster { require(isPool[_pool], "not-pool"); require(isDsa[_pool][_dsa], "not-dsa-for-pool"); From d43a1509eef0563f720d98f9eeb1e996f35c63f7 Mon Sep 17 00:00:00 2001 From: Thrilok Kumar Date: Mon, 31 Aug 2020 00:49:38 +0530 Subject: [PATCH 11/13] Check `to` is vaild for withdraw function --- contracts/pools/erc20.sol | 1 + contracts/pools/eth.sol | 1 + 2 files changed, 2 insertions(+) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index 947d52e..e5f71da 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -164,6 +164,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { */ function withdraw(uint tknAmt, address to) external nonReentrant whenNotPaused returns (uint _tknAmt) { uint poolBal = baseToken.balanceOf(address(this)); + require(to != address(0), "to-address-not-vaild"); require(tknAmt <= poolBal, "not-enough-liquidity-available"); uint _bal = balanceOf(msg.sender); uint _tknBal = wdiv(_bal, exchangeRate); diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index 27bffc5..d6a8932 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -160,6 +160,7 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { */ function withdraw(uint tknAmt, address to) external nonReentrant whenNotPaused returns (uint _tknAmt) { uint poolBal = address(this).balance; + require(to != address(0), "to-address-not-vaild"); require(tknAmt <= poolBal, "not-enough-liquidity-available"); uint _bal = balanceOf(msg.sender); uint _tknBal = wdiv(_bal, exchangeRate); From ee9e1b39d052d1b8b388c6eee91febd7d22fd625 Mon Sep 17 00:00:00 2001 From: Thrilok Kumar Date: Mon, 31 Aug 2020 12:54:45 +0530 Subject: [PATCH 12/13] Set max if amount higher than max withdraw amount --- contracts/pools/erc20.sol | 3 +-- contracts/pools/eth.sol | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index e5f71da..00c7e3c 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -169,11 +169,10 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { uint _bal = balanceOf(msg.sender); uint _tknBal = wdiv(_bal, exchangeRate); uint _burnAmt; - if (tknAmt == uint(-1)) { + if (tknAmt >= _tknBal) { _burnAmt = _bal; _tknAmt = _tknBal; } else { - require(tknAmt <= _tknBal, "balance-exceeded"); _burnAmt = wmul(tknAmt, exchangeRate); _tknAmt = tknAmt; } diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index d6a8932..b184ccf 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -165,11 +165,10 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { uint _bal = balanceOf(msg.sender); uint _tknBal = wdiv(_bal, exchangeRate); uint _burnAmt; - if (tknAmt == uint(-1)) { + if (tknAmt >= _tknBal) { _burnAmt = _bal; _tknAmt = _tknBal; } else { - require(tknAmt <= _tknBal, "balance-exceeded"); _burnAmt = wmul(tknAmt, exchangeRate); _tknAmt = tknAmt; } From d383ec4e3a3e9e8088edd4c6d4172fdf12da6966 Mon Sep 17 00:00:00 2001 From: Thrilok Kumar Date: Mon, 31 Aug 2020 12:59:20 +0530 Subject: [PATCH 13/13] Fixed max withdrawal bug --- contracts/pools/erc20.sol | 2 +- contracts/pools/eth.sol | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/contracts/pools/erc20.sol b/contracts/pools/erc20.sol index 00c7e3c..d183790 100644 --- a/contracts/pools/erc20.sol +++ b/contracts/pools/erc20.sol @@ -165,7 +165,6 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { function withdraw(uint tknAmt, address to) external nonReentrant whenNotPaused returns (uint _tknAmt) { uint poolBal = baseToken.balanceOf(address(this)); require(to != address(0), "to-address-not-vaild"); - require(tknAmt <= poolBal, "not-enough-liquidity-available"); uint _bal = balanceOf(msg.sender); uint _tknBal = wdiv(_bal, exchangeRate); uint _burnAmt; @@ -176,6 +175,7 @@ contract PoolToken is ReentrancyGuard, DSMath, ERC20Pausable { _burnAmt = wmul(tknAmt, exchangeRate); _tknAmt = tknAmt; } + require(tknAmt <= poolBal, "not-enough-liquidity-available"); tokenBalance = sub(tokenBalance, _tknAmt); diff --git a/contracts/pools/eth.sol b/contracts/pools/eth.sol index b184ccf..15acfa2 100644 --- a/contracts/pools/eth.sol +++ b/contracts/pools/eth.sol @@ -161,7 +161,6 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { function withdraw(uint tknAmt, address to) external nonReentrant whenNotPaused returns (uint _tknAmt) { uint poolBal = address(this).balance; require(to != address(0), "to-address-not-vaild"); - require(tknAmt <= poolBal, "not-enough-liquidity-available"); uint _bal = balanceOf(msg.sender); uint _tknBal = wdiv(_bal, exchangeRate); uint _burnAmt; @@ -172,6 +171,7 @@ contract PoolToken is ReentrancyGuard, ERC20Pausable, DSMath { _burnAmt = wmul(tknAmt, exchangeRate); _tknAmt = tknAmt; } + require(tknAmt <= poolBal, "not-enough-liquidity-available"); tokenBalance = sub(tokenBalance, _tknAmt);