From e1e24f8007fb010ac2bcbbf59571c44970d2bffd Mon Sep 17 00:00:00 2001
From: mingda <leimingda@pku.edu.cn>
Date: Sun, 7 Feb 2021 15:39:55 +0800
Subject: [PATCH] add helper functions

---
 contracts/DODOToken/vDODOToken.sol | 42 ++++++++++++++++--------------
 1 file changed, 23 insertions(+), 19 deletions(-)

diff --git a/contracts/DODOToken/vDODOToken.sol b/contracts/DODOToken/vDODOToken.sol
index 97cb4e1..f81608e 100644
--- a/contracts/DODOToken/vDODOToken.sol
+++ b/contracts/DODOToken/vDODOToken.sol
@@ -134,7 +134,7 @@ contract vDODOToken is InitializableOwnable {
         IERC20(_DODO_TOKEN_).transfer(_OWNER_, dodoBalance);
     }
 
-    // ============ Functions ============
+    // ============ Mint & Redeem & Donate ============
 
     function mint(uint256 dodoAmount, address superiorAddress) public {
         require(
@@ -215,7 +215,7 @@ contract vDODOToken is InitializableOwnable {
         );
     }
 
-    // ============ Functions(ERC20) ============
+    // ============ ERC20 Functions ============
 
     function totalSupply() public view returns (uint256 vDODOSupply) {
         vDODOSupply = IERC20(_DODO_TOKEN_).balanceOf(address(this)) / _DODO_RATIO_;
@@ -225,22 +225,6 @@ contract vDODOToken is InitializableOwnable {
         vDODOAmount = dodoBalanceOf(account) / _DODO_RATIO_;
     }
 
-    function availableBalanceOf(address account) public view returns (uint256 balance) {
-        if (_DOOD_GOV_ == address(0)) {
-            balance = balanceOf(account);
-        } else {
-            uint256 lockedBalance = IGovernance(_DOOD_GOV_).getLockedDODO(account);
-            balance = balanceOf(account).sub(lockedBalance);
-        }
-    }
-
-    function dodoBalanceOf(address account) public view returns (uint256 dodoAmount) {
-        UserInfo memory user = userInfo[account];
-        dodoAmount = DecimalMath.mulFloor(uint256(user.stakingPower), getLatestAlpha()).sub(
-            user.credit
-        );
-    }
-
     function transfer(address to, uint256 vDODOAmount) public returns (bool) {
         _updateAlpha();
         _transfer(msg.sender, to, vDODOAmount);
@@ -269,7 +253,7 @@ contract vDODOToken is InitializableOwnable {
         return _ALLOWED_[owner][spender];
     }
 
-    // ============ View Functions ============
+    // ============ Helper Functions ============
 
     function getLatestAlpha() public view returns (uint256) {
         uint256 accuDODO = _DODO_PER_BLOCK_ * (block.number - lastRewardBlock);
@@ -280,6 +264,22 @@ contract vDODOToken is InitializableOwnable {
         }
     }
 
+    function availableBalanceOf(address account) public view returns (uint256 balance) {
+        if (_DOOD_GOV_ == address(0)) {
+            balance = balanceOf(account);
+        } else {
+            uint256 lockedBalance = IGovernance(_DOOD_GOV_).getLockedDODO(account);
+            balance = balanceOf(account).sub(lockedBalance);
+        }
+    }
+
+    function dodoBalanceOf(address account) public view returns (uint256 dodoAmount) {
+        UserInfo memory user = userInfo[account];
+        dodoAmount = DecimalMath.mulFloor(uint256(user.stakingPower), getLatestAlpha()).sub(
+            user.credit
+        );
+    }
+
     function getWithdrawResult(uint256 dodoAmount)
         public
         view
@@ -303,6 +303,10 @@ contract vDODOToken is InitializableOwnable {
         feeRatio = IDODOCirculationHelper(_DODO_CIRCULATION_HELPER_).getDodoWithdrawFeeRatio();
     }
 
+    function getSuperior(address account) public view returns (address superior) {
+        return userInfo[account].superior;
+    }
+
     // ============ Internal Functions ============
 
     function _updateAlpha() internal {