Add VotingToken

Author: kronosapiens

contracts/colony/ColonyAuthority.sol

@@ -97,6 +97,8 @@ contract ColonyAuthority is CommonAuthority {
     addRoleCapability(ROOT_ROLE, "deprecateExtension(bytes32,bool)");
     addRoleCapability(ROOT_ROLE, "uninstallExtension(bytes32)");
     addRoleCapability(ROOT_ROLE, "makeArbitraryTransaction(address,bytes)");
+    addRoleCapability(ROOT_ROLE, "lockToken()");
+    addRoleCapability(ROOT_ROLE, "unlockTokenForUser(address,uint256)");
     addRoleCapability(ARBITRATION_ROLE, "transferStake(uint256,uint256,address,address,uint256,uint256,address)");
     addRoleCapability(ARBITRATION_ROLE, "emitDomainReputationPenalty(uint256,uint256,uint256,address,int256)");
     addRoleCapability(ARBITRATION_ROLE, "emitSkillReputationPenalty(uint256,address,int256)");

contracts/colony/ColonyFunding.sol

@@ -23,6 +23,14 @@ import "./ColonyStorage.sol";
 
 
 contract ColonyFunding is ColonyStorage, PatriciaTreeProofs { // ignore-swc-123
+  function lockToken() public stoppable auth returns (uint256) {
+    return ITokenLocking(tokenLockingAddress).lockToken(token);
+  }
+
+  function unlockTokenForUser(address _user, uint256 _lockId) public stoppable auth {
+    ITokenLocking(tokenLockingAddress).unlockTokenForUser(token, _user, _lockId);
+  }
+
   function setTaskManagerPayout(uint256 _id, address _token, uint256 _amount) public stoppable self {
     setTaskPayout(_id, TaskRole.Manager, _token, _amount);
     emit TaskPayoutSet(_id, TaskRole.Manager, _token, _amount);
@@ -290,8 +298,7 @@ contract ColonyFunding is ColonyStorage, PatriciaTreeProofs { // ignore-swc-123
   function startNextRewardPayout(address _token, bytes memory key, bytes memory value, uint256 branchMask, bytes32[] memory siblings)
   public stoppable auth
   {
-    ITokenLocking tokenLocking = ITokenLocking(tokenLockingAddress);
-    uint256 totalLockCount = tokenLocking.lockToken(token);
+    uint256 totalLockCount = lockToken();
     uint256 thisPayoutAmount = sub(fundingPots[0].balance[_token], pendingRewardPayments[_token]);
     require(thisPayoutAmount > 0, "colony-reward-payout-no-rewards");
     pendingRewardPayments[_token] = add(pendingRewardPayments[_token], thisPayoutAmount);
@@ -459,7 +466,7 @@ contract ColonyFunding is ColonyStorage, PatriciaTreeProofs { // ignore-swc-123
 
     uint256 reward = (mul(squareRoots[4], squareRoots[6]) / squareRoots[5]) ** 2;
 
-    tokenLocking.unlockTokenForUser(token, msg.sender, payoutId);
+    unlockTokenForUser(msg.sender, payoutId);
 
     return (payout.tokenAddress, reward);
   }

contracts/colony/IColony.sol

@@ -215,6 +215,14 @@ interface IColony is ColonyDataTypes, IRecovery {
   /// @param _wad Amount to mint
   function mintTokensFor(address _guy, uint256 _wad) external;
 
+  /// @notice Lock the colony's token. Secured function to authorised members.
+  function lockToken() external returns (uint256);
+
+  /// @notice Unlock the colony's token for a user. Secured function to authorised members.
+  /// @param user The user to unlock
+  /// @param lockId The specific lock to unlock
+  function unlockTokenForUser(address user, uint256 lockId) external;
+
   /// @notice Register colony's ENS label.
   /// @param colonyName The label to register.
   /// @param orbitdb The path of the orbitDB database associated with the colony name

contracts/extensions/VotingBase.sol

@@ -203,6 +203,10 @@ abstract contract VotingBase is ColonyExtension, PatriciaTreeProofs {
 
   function getInfluence(uint256 _motionId, address _user) public view virtual returns (uint256);
 
+  function postReveal(uint256 _motionId, address _user) internal virtual;
+
+  function postClaim(uint256 _motionId, address _user) internal virtual;
+
   // Public functions (interface)
 
   /// @notice Stake on a motion
@@ -299,11 +303,11 @@ abstract contract VotingBase is ColonyExtension, PatriciaTreeProofs {
     require(getMotionState(_motionId) == MotionState.Submit, "voting-base-motion-not-open");
     require(_voteSecret != bytes32(0), "voting-base-invalid-secret");
 
-    uint256 userRep = getInfluence(_motionId, msg.sender);
+    uint256 influence = getInfluence(_motionId, msg.sender);
 
     // Count reputation if first submission
     if (voteSecrets[_motionId][msg.sender] == bytes32(0)) {
-      motion.totalVotes = add(motion.totalVotes, userRep);
+      motion.totalVotes = add(motion.totalVotes, influence);
     }
 
     voteSecrets[_motionId][msg.sender] = _voteSecret;
@@ -345,6 +349,7 @@ abstract contract VotingBase is ColonyExtension, PatriciaTreeProofs {
 
       emit MotionEventSet(_motionId, REVEAL_END);
     }
+
     tokenLocking.transfer(token, voterReward, msg.sender, true);
   }
 
@@ -423,6 +428,8 @@ abstract contract VotingBase is ColonyExtension, PatriciaTreeProofs {
     require(stakerReward > 0, "voting-base-nothing-to-claim");
     delete stakes[_motionId][_staker][_vote];
 
+    postClaim(_motionId, _staker);
+
     tokenLocking.transfer(token, stakerReward, _staker, true);
 
     if (repPenalty > 0) {
@@ -694,7 +701,7 @@ abstract contract VotingBase is ColonyExtension, PatriciaTreeProofs {
     return keccak256(abi.encodePacked(_salt, _vote));
   }
 
-  function getRequiredStake(uint256 _motionId) internal view returns (uint256) {
+  function getRequiredStake(uint256 _motionId) public view returns (uint256) {
     return wmul(motions[_motionId].maxVotes, totalStakeFraction);
   }
 

contracts/extensions/VotingReputation.sol

@@ -62,6 +62,9 @@ contract VotingReputation is VotingBase {
     return influences[motion.rootHash][motion.skillId][_user];
   }
 
+  function postReveal(uint256 _motionId, address _user) internal override {}
+  function postClaim(uint256 _motionId, address _user) internal override {}
+
   /// @notice Create a motion in the root domain
   /// @param _altTarget The contract to which we send the action (0x0 for the colony)
   /// @param _action A bytes array encoding a function call

contracts/extensions/VotingToken.sol

@@ -38,9 +38,18 @@ contract VotingToken is VotingBase {
   // [motionId][user] => tokenBalance
   mapping (uint256 => mapping (address => uint256)) influences;
 
+  // [motionId] => lockId
+  mapping (uint256 => uint256) locks;
+
   // Public
 
   function setInfluence(uint256 _motionId) public {
+    require(
+      getMotionState(_motionId) == MotionState.Staking ||
+      getMotionState(_motionId) == MotionState.Submit,
+      "voting-token-cannot-set-influence"
+    );
+
     uint256 balance = tokenLocking.getUserLock(token, msg.sender).balance;
     influences[_motionId][msg.sender] = balance;
   }
@@ -50,6 +59,19 @@ contract VotingToken is VotingBase {
     return influences[_motionId][_user];
   }
 
+  function postReveal(uint256 _motionId, address _user) internal override {
+    colony.unlockTokenForUser(_user, locks[_motionId]);
+  }
+
+  function postClaim(uint256 _motionId, address _user) internal override {
+    uint256 lockCount = tokenLocking.getUserLock(token, _user).lockCount;
+
+    // Lock may have already been released during reveal
+    if (lockCount < locks[_motionId]) {
+      colony.unlockTokenForUser(_user, locks[_motionId]);
+    }
+  }
+
   /// @notice Create a motion in the root domain
   /// @param _altTarget The contract to which we send the action (0x0 for the colony)
   /// @param _action A bytes array encoding a function call
@@ -58,6 +80,11 @@ contract VotingToken is VotingBase {
   {
     createMotion(_altTarget, _action, 1);
     motions[motionCount].maxVotes = ERC20Extended(token).totalSupply();
+    locks[motionCount] = colony.lockToken();
+  }
+
+  function getLock(uint256 _motionId) public view returns (uint256) {
+    return locks[_motionId];
   }
 
 }

docs/_Interface_IColony.md

@@ -963,6 +963,18 @@ Install an extension to the colony. Secured function to authorised members.
 |version|uint256|The new extension version to install
 
 
+### `lockToken`
+
+Lock the colony's token. Secured function to authorised members.
+
+
+
+**Return Parameters**
+
+|Name|Type|Description|
+|---|---|---|
+|uint256|uint256|
+
 ### `makeArbitraryTransaction`
 
 Execute arbitrary transaction on behalf of the Colony
@@ -1648,6 +1660,19 @@ Uninstall an extension from a colony. Secured function to authorised members.
 |extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
 
 
+### `unlockTokenForUser`
+
+Unlock the colony's token for a user. Secured function to authorised members.
+
+
+**Parameters**
+
+|Name|Type|Description|
+|---|---|---|
+|user|address|The user to unlock
+|lockId|uint256|The specific lock to unlock
+
+
 ### `updateColonyOrbitDB`
 
 Update a colony's orbitdb address. Can only be called by a colony with a registered subdomain

test/extensions/voting-rep.js

@@ -1047,10 +1047,10 @@ contract("Voting Reputation", (accounts) => {
     });
 
     it("can take an action with an arbitrary target", async () => {
-      const { colony: otherColony } = await setupRandomColony(colonyNetwork);
-      await token.mint(otherColony.address, WAD, { from: USER0 });
+      const { colony: otherColony, token: otherToken } = await setupRandomColony(colonyNetwork);
+      await otherToken.mint(otherColony.address, WAD);
 
-      const action = await encodeTxData(colony, "claimColonyFunds", [token.address]);
+      const action = await encodeTxData(colony, "claimColonyFunds", [otherToken.address]);
       await voting.createRootMotion(otherColony.address, action, domain1Key, domain1Value, domain1Mask, domain1Siblings);
       motionId = await voting.getMotionCount();
 
@@ -1060,12 +1060,12 @@ contract("Voting Reputation", (accounts) => {
 
       await forwardTime(STAKE_PERIOD, this);
 
-      const balanceBefore = await otherColony.getFundingPotBalance(1, token.address);
+      const balanceBefore = await otherColony.getFundingPotBalance(1, otherToken.address);
       expect(balanceBefore).to.be.zero;
 
       await voting.finalizeMotion(motionId);
 
-      const balanceAfter = await otherColony.getFundingPotBalance(1, token.address);
+      const balanceAfter = await otherColony.getFundingPotBalance(1, otherToken.address);
       expect(balanceAfter).to.eq.BN(WAD);
     });