First pass at function to recover funds staked in misaligned motions

contracts/extensions/IColonyExtension.sol

@@ -0,0 +1,36 @@
+/*
+  This file is part of The Colony Network.
+
+  The Colony Network is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  The Colony Network is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with The Colony Network. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+pragma solidity 0.7.3;
+pragma experimental ABIEncoderV2;
+
+interface IColonyExtension {
+
+  function identifier() external pure returns (bytes32);
+  function version() external pure virtual returns (uint256);
+  function install(address _colony) external virtual;
+  function finishUpgrade() external virtual;
+  function deprecate(bool _deprecated) external virtual;
+  function uninstall() external virtual;
+
+  function getCapabilityRoles(bytes4 _sig) external view virtual returns (bytes32);
+
+  function getDeprecated() external view returns (bool);
+
+  function getColony() external view returns(address);
+
+}

contracts/extensions/VotingReputation/IVotingReputation.sol

@@ -0,0 +1,321 @@
+/*
+  This file is part of The Colony Network.
+
+  The Colony Network is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General external License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  The Colony Network is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General external License for more details.
+
+  You should have received a copy of the GNU General external License
+  along with The Colony Network. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+pragma solidity 0.7.3;
+pragma experimental ABIEncoderV2;
+
+// import "./../colonyNetwork/IColonyNetwork.sol";
+// import "./../colony/ColonyRoles.sol";
+import "./../../common/IBasicMetaTransaction.sol";
+import "./../IColonyExtension.sol";
+import "./VotingReputationDataTypes.sol";
+// import "./../patriciaTree/PatriciaTreeProofs.sol";
+// import "./../tokenLocking/ITokenLocking.sol";
+// import "./ColonyExtension.sol";
+
+
+interface IVotingReputation is IBasicMetaTransaction, IColonyExtension, VotingReputationDataTypes {
+
+  // function getMetatransactionNonce(address userAddress) override external view returns (uint256 nonce);
+
+
+  /// @notice Initialise the extension
+  /// @param _totalStakeFraction The fraction of the domain's reputation we need to stake
+  /// @param _userMinStakeFraction The minimum per-user stake as fraction of total stake
+  /// @param _maxVoteFraction The fraction of the domain's reputation which must submit for quick-end
+  /// @param _voterRewardFraction The fraction of the total stake paid out to voters as rewards
+  /// @param _stakePeriod The length of the staking period in seconds
+  /// @param _submitPeriod The length of the submit period in seconds
+  /// @param _revealPeriod The length of the reveal period in seconds
+  /// @param _escalationPeriod The length of the escalation period in seconds
+  function initialise(
+    uint256 _totalStakeFraction,
+    uint256 _voterRewardFraction,
+    uint256 _userMinStakeFraction,
+    uint256 _maxVoteFraction,
+    uint256 _stakePeriod,
+    uint256 _submitPeriod,
+    uint256 _revealPeriod,
+    uint256 _escalationPeriod
+  )
+    external;
+
+ //  // Data structures
+
+  // external functions (interface)
+
+  /// @notice Create a motion
+  /// @param _domainId The domain where we vote on the motion
+  /// @param _childSkillIndex The childSkillIndex pointing to the domain of the action
+  /// @param _altTarget The contract to which we send the action (0x0 for the colony)
+  /// @param _action A bytes array encoding a function call
+  /// @param _key Reputation tree key for the root domain
+  /// @param _value Reputation tree value for the root domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+ function createMotion(
+    uint256 _domainId,
+    uint256 _childSkillIndex,
+    address _altTarget,
+    bytes memory _action,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  /// @notice Create a motion in the root domain (DEPRECATED)
+  /// @param _altTarget The contract to which we send the action (0x0 for the colony)
+  /// @param _action A bytes array encoding a function call
+  /// @param _key Reputation tree key for the root domain
+  /// @param _value Reputation tree value for the root domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+  function createRootMotion(
+    address _altTarget,
+    bytes memory _action,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  /// @notice Create a motion in any domain (DEPRECATED)
+  /// @param _domainId The domain where we vote on the motion
+  /// @param _childSkillIndex The childSkillIndex pointing to the domain of the action
+  /// @param _action A bytes array encoding a function call
+  /// @param _key Reputation tree key for the domain
+  /// @param _value Reputation tree value for the domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+  function createDomainMotion(
+    uint256 _domainId,
+    uint256 _childSkillIndex,
+    bytes memory _action,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  /// @notice Stake on a motion
+  /// @param _motionId The id of the motion
+  /// @param _permissionDomainId The domain where the extension has the arbitration permission
+  /// @param _childSkillIndex For the domain in which the motion is occurring
+  /// @param _vote The side being supported (0 = NAY, 1 = YAY)
+  /// @param _amount The amount of tokens being staked
+  /// @param _key Reputation tree key for the staker/domain
+  /// @param _value Reputation tree value for the staker/domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+  function stakeMotion(
+    uint256 _motionId,
+    uint256 _permissionDomainId,
+    uint256 _childSkillIndex,
+    uint256 _vote,
+    uint256 _amount,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  /// @notice Submit a vote secret for a motion
+  /// @param _motionId The id of the motion
+  /// @param _voteSecret The hashed vote secret
+  /// @param _key Reputation tree key for the staker/domain
+  /// @param _value Reputation tree value for the staker/domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+  function submitVote(
+    uint256 _motionId,
+    bytes32 _voteSecret,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  /// @notice Reveal a vote secret for a motion
+  /// @param _motionId The id of the motion
+  /// @param _salt The salt used to hash the vote
+  /// @param _vote The side being supported (0 = NAY, 1 = YAY)
+  /// @param _key Reputation tree key for the staker/domain
+  /// @param _value Reputation tree value for the staker/domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+  function revealVote(
+    uint256 _motionId,
+    bytes32 _salt,
+    uint256 _vote,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  /// @notice Escalate a motion to a higher domain
+  /// @param _motionId The id of the motion
+  /// @param _newDomainId The desired domain of escalation
+  /// @param _childSkillIndex For the current domain, relative to the escalated domain
+  /// @param _key Reputation tree key for the new domain
+  /// @param _value Reputation tree value for the new domain
+  /// @param _branchMask The branchmask of the proof
+  /// @param _siblings The siblings of the proof
+  function escalateMotion(
+    uint256 _motionId,
+    uint256 _newDomainId,
+    uint256 _childSkillIndex,
+    bytes memory _key,
+    bytes memory _value,
+    uint256 _branchMask,
+    bytes32[] memory _siblings
+  )
+    external;
+
+  function finalizeMotion(uint256 _motionId) external;
+
+
+  /// @notice Return whether a motion, assuming it's in the finalizable state,
+  // is allowed to finalize without the call executing successfully.
+  /// @param _motionId The id of the motion
+  /// @dev We are only expecting this to be called from finalize motion in the contracts.
+  /// It is marked as external only so that the frontend can use it.
+  function failingExecutionAllowed(uint256 _motionId) external view returns (bool);
+
+  /// @notice Claim the staker's reward
+  /// @param _motionId The id of the motion
+  /// @param _permissionDomainId The domain where the extension has the arbitration permission
+  /// @param _childSkillIndex For the domain in which the motion is occurring
+  /// @param _staker The staker whose reward is being claimed
+  /// @param _vote The side being supported (0 = NAY, 1 = YAY)
+  function claimReward(
+    uint256 _motionId,
+    uint256 _permissionDomainId,
+    uint256 _childSkillIndex,
+    address _staker,
+    uint256 _vote
+  )
+    external;
+
+  // external view functions
+
+  /// @notice Get the total stake fraction
+  /// @return The total stake fraction
+  function getTotalStakeFraction() external view returns (uint256);
+
+  /// @notice Get the voter reward fraction
+  /// @return The voter reward fraction
+  function getVoterRewardFraction() external view returns (uint256) ;
+
+  /// @notice Get the user min stake fraction
+  /// @return The user min stake fraction
+  function getUserMinStakeFraction() external view returns (uint256) ;
+
+  /// @notice Get the max vote fraction
+  /// @return The max vote fraction
+  function getMaxVoteFraction() external view returns (uint256);
+
+  /// @notice Get the stake period
+  /// @return The stake period
+  function getStakePeriod() external view returns (uint256);
+
+  /// @notice Get the submit period
+  /// @return The submit period
+  function getSubmitPeriod() external view returns (uint256);
+
+  /// @notice Get the reveal period
+  /// @return The reveal period
+  function getRevealPeriod() external view returns (uint256);
+
+  /// @notice Get the escalation period
+  /// @return The escalation period
+  function getEscalationPeriod() external view returns (uint256);
+
+
+  /// @notice Get the total motion count
+  /// @return The total motion count
+  function getMotionCount() external view returns (uint256) ;
+
+  /// @notice Get the data for a single motion
+  /// @param _motionId The id of the motion
+  /// @return motion The motion struct
+  function getMotion(uint256 _motionId) external view returns (Motion memory motion);
+
+  /// @notice Get a user's stake on a motion
+  /// @param _motionId The id of the motion
+  /// @param _staker The staker address
+  /// @param _vote The side being supported (0 = NAY, 1 = YAY)
+  /// @return The user's stake
+  function getStake(uint256 _motionId, address _staker, uint256 _vote) external view returns (uint256);
+
+  /// @notice Get the number of ongoing motions for a single expenditure / expenditure slot
+  /// @param _structHash The hash of the expenditureId or expenditureId*expenditureSlot
+  /// @return The number of ongoing motions
+  function getExpenditureMotionCount(bytes32 _structHash) external view returns (uint256);
+
+  /// @notice Get the largest past vote on a single expenditure variable
+  /// @param _actionHash The hash of the particular expenditure action
+  /// @return The largest past vote on this variable
+  function getExpenditurePastVote(bytes32 _actionHash) external view returns (uint256);
+
+  /// @notice Get the current state of the motion
+  /// @return The current motion state
+  function getMotionState(uint256 _motionId) external view returns (MotionState) ;
+
+  /// @notice Get the voter reward
+  /// NB This function will only return a meaningful value if in the reveal state.
+  /// Prior to the reveal state, getVoterRewardRange should be used.
+  /// @param _motionId The id of the motion
+  /// @param _voterRep The reputation the voter has in the domain
+  /// @return The voter reward
+  function getVoterReward(uint256 _motionId, uint256 _voterRep) external view returns (uint256) ;
+
+  /// @notice Get the range of potential rewards for a voter on a specific motion, intended to be
+  /// used when the motion is in the reveal state.
+  /// Once a motion is in the reveal state the reward is known, and getVoterRewardRange should be used.
+  /// @param _motionId The id of the motion
+  /// @param _voterRep The reputation the voter has in the domain
+  /// @param _voterAddress The address the user will be voting as
+  /// @return The voter reward
+  function getVoterRewardRange(uint256 _motionId, uint256 _voterRep, address _voterAddress) external view returns (uint256, uint256) ;
+  /// @notice Get the staker reward
+  /// @param _motionId The id of the motion
+  /// @param _staker The staker's address
+  /// @param _vote The vote (0 = NAY, 1 = YAY)
+  /// @return The staker reward and the reputation penalty (if any)
+  function getStakerReward(uint256 _motionId, address _staker, uint256 _vote) external view returns (uint256, uint256);
+
+  function createClaimDelayAction(bytes memory action, uint256 value)
+    external
+    returns (bytes memory);
+
+  function claimMisalignedReward(
+    uint256 _motionId,
+    uint256 _permissionDomainId,
+    uint256 _childSkillIndex,
+    address _staker,
+    uint256 _vote
+  )
+    external;
+}