@web3dotorg/evm-slc-core-contracts 0.3.2 → 0.3.3

package/governance/NeutralsRegistry.sol

@@ -63,7 +63,7 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
     }
 
     struct Delegation {
-        uint256 delegationAmount;
+        uint256 delegatedAmount;
         WithdrawalAnnouncement withdrawal;
         uint256 owedValue;
         uint256 cumulativeSum;
@@ -254,6 +254,13 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
 
         _checkDelegation(neutral_, amount_);
 
+        NeutralsRegistryStorage storage $ = _getNeutralsRegistryStorage();
+
+        if ($.delegations[msg.sender][neutral_].delegatedAmount == 0) {
+            $.neutralsPerDelegator[msg.sender].add(neutral_);
+            $.delegatorsPerNeutral[neutral_].add(msg.sender);
+        }
+
         _addDelegationStake(msg.sender, neutral_, amount_);
 
         _getNeutralsRegistryStorage().stakeToken.safeTransferFrom(
@@ -282,6 +289,11 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
 
         delete $.delegations[neutral_][msg.sender].withdrawal;
 
+        if ($.delegations[msg.sender][neutral_].delegatedAmount == 0) {
+            $.neutralsPerDelegator[msg.sender].remove(neutral_);
+            $.delegatorsPerNeutral[neutral_].remove(msg.sender);
+        }
+
         $.stakeToken.safeTransfer(msg.sender, amount_);
 
         emit DelegationWithdrawn(msg.sender, neutral_, amount_);
@@ -657,7 +669,7 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
         WithdrawalAnnouncement storage announcement = $
         .delegations[msg.sender][neutral_].withdrawal;
 
-        uint256 delegationAmount_ = $.delegations[msg.sender][neutral_].delegationAmount;
+        uint256 delegationAmount_ = $.delegations[msg.sender][neutral_].delegatedAmount;
 
         if (amount_ > delegationAmount_)
             revert InsufficientDelegationAmount(msg.sender, neutral_, amount_, delegationAmount_);
@@ -714,14 +726,39 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
     }
 
     /**
-     * @notice Get the available rewards for a neutral
+     * @notice Get the available rewards for the neutral
      * @param neutral_ Address of the neutral
-     * @return Amount of available rewards
+     * @return Amount of rewards availible to claim
      */
-    function getAvailibleRewards(address neutral_) public view returns (uint256) {
+    function getNeutralRewards(address neutral_) public view returns (uint256) {
         return _getNeutralsRegistryStorage().neutrals[neutral_].rewards;
     }
 
+    /**
+     * @notice Get rewards for delegator per neutral
+     * @param delegator_ Address of the delegator
+     * @param neutral_ Address of the delegated neutral
+     * @return Amount of rewards availlible to claim
+     */
+    function getDelegatorRewards(
+        address delegator_,
+        address neutral_
+    ) public view returns (uint256) {
+        NeutralsRegistryStorage storage $ = _getNeutralsRegistryStorage();
+        Delegation storage delegation = $.delegations[delegator_][neutral_];
+
+        uint256 poolCumulativeSum_ = $.delegatorsRewardPools[neutral_].cumulativeSum;
+        uint256 delegatorShares_ = delegation.delegatedAmount;
+
+        return
+            delegation.owedValue +
+            Math.mulDiv(
+                delegatorShares_,
+                poolCumulativeSum_ - delegation.cumulativeSum,
+                PRECISION
+            );
+    }
+
     /// @inheritdoc	ERC165
     function supportsInterface(
         bytes4 interfaceId_
@@ -961,12 +998,7 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
         NeutralsInfo storage neutralsInfo = $.neutrals[neutral_];
         Delegation storage delegation = $.delegations[delegator_][neutral_];
 
-        if (delegation.delegationAmount == 0) {
-            $.neutralsPerDelegator[delegator_].add(neutral_);
-            $.delegatorsPerNeutral[neutral_].add(delegator_);
-        }
-
-        delegation.delegationAmount += amount_;
+        delegation.delegatedAmount += amount_;
         neutralsInfo.delegatedStake += amount_;
 
         _recalculateNeutralWeight(neutral_);
@@ -983,14 +1015,9 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
         NeutralsInfo storage neutralsInfo = $.neutrals[neutral_];
         Delegation storage delegation = $.delegations[delegator_][neutral_];
 
-        delegation.delegationAmount -= amount_;
+        delegation.delegatedAmount -= amount_;
         neutralsInfo.delegatedStake -= amount_;
 
-        if (delegation.delegationAmount == 0) {
-            $.neutralsPerDelegator[delegator_].remove(neutral_);
-            $.delegatorsPerNeutral[neutral_].remove(delegator_);
-        }
-
         _recalculateNeutralWeight(neutral_);
     }
 
@@ -1027,13 +1054,13 @@ contract NeutralsRegistry is INeutralsRegistry, ERC165, UUPSUpgradeable {
         DelegatorRewardPool storage rewardPool = $.delegatorsRewardPools[neutral_];
         Delegation storage delegation = $.delegations[delegator_][neutral_];
 
-        uint256 delegatedAmount_ = delegation.delegationAmount;
-        uint256 poolCummulativeSum_ = rewardPool.cumulativeSum;
-        uint256 delegatorCummulativeSum_ = delegation.cumulativeSum;
+        uint256 delegatedAmount_ = delegation.delegatedAmount;
+        uint256 poolCumulativeSum_ = rewardPool.cumulativeSum;
+        uint256 delegatorCumulativeSum_ = delegation.cumulativeSum;
 
         delegation.owedValue += Math.mulDiv(
             delegatedAmount_,
-            poolCummulativeSum_ - delegatorCummulativeSum_,
+            poolCumulativeSum_ - delegatorCumulativeSum_,
             PRECISION
         );
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3dotorg/evm-slc-core-contracts",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "author": "<TBD>",
   "repository": {
     "type": "git",