Audit: Batch NXM withdrawal

contracts/interfaces/IAssessment.sol

@@ -109,7 +109,7 @@ interface IAssessment {
 
   function getVoteCountOfAssessor(address assessor) external view returns (uint);
 
-  function votesOf(address user, uint id) external view
+  function votesOf(address user, uint voteIndex) external view
   returns (uint80 assessmentId, bool accepted, uint32 timestamp, uint96 stakedAmount);
 
   function stakeOf(address user) external view
@@ -122,7 +122,7 @@ interface IAssessment {
     uint8 silentEndingPeriodInDays
   );
 
-  function hasAlreadyVotedOn(address voter, uint pollId) external view returns (bool);
+  function hasAlreadyVotedOn(address voter, uint assessmentId) external view returns (bool);
 
 
   /* === MUTATIVE FUNCTIONS ==== */
@@ -131,6 +131,8 @@ interface IAssessment {
 
   function unstake(uint96 amount, address to) external;
 
+  function unstakeAllFor(address staker) external;
+
   function withdrawRewards(
     address user,
     uint104 batchSize
@@ -174,4 +176,20 @@ interface IAssessment {
   event FraudProcessed(uint assessmentId, address assessor, Poll poll);
   event FraudSubmitted(bytes32 root);
 
+  /* ========== ERRORS ========== */
+
+  error InvalidAmount(uint maxUnstakeAmount);
+  error StakeLockedForAssessment(uint lockupExpiry);
+  error StakeLockedForGovernance(uint lockupExpiry);
+  error NotMember(address nonMember);
+  error NoWithdrawableRewards();
+  error InvalidMerkleProof();
+
+  // Votes
+  error AssessmentIdsVotesLengthMismatch();
+  error AssessmentIdsIpfsLengthMismatch();
+  error AlreadyVoted();
+  error StakeRequired();
+  error VotingClosed();
+  error AcceptVoteRequired();
 }

contracts/interfaces/ITokenController.sol

@@ -24,13 +24,74 @@ interface ITokenController {
     uint96 deadline;
   }
 
+  struct WithdrawAssessment {
+    bool stake;
+    bool rewards;
+  }
+
+  /// @notice The stake deposit / rewards in a staking pool that will be withdrawn.
+  /// @dev    Call StakingViewer.getToken to get tokenId / trancheId information
+  /// @param tokenId The ID of the token stake deposit / rewards that will be withrawn.
+  /// @param trancheIds An array of tranche IDs representing the tranches where the stake was deposited.
+  struct StakingPoolDeposit {
+    uint tokenId;
+    uint[] trancheIds;
+  }
+
+  /// @notice Represents the rewards distributed to a staking pool manager.
+  /// @dev    Call StakingViewer.getManagerTokenRewardsByAddr to get poolId / trancheId information
+  /// @param poolId The ID of the pool managed by the manager.
+  /// @param trancheIds An array of tranche IDs representing the tranches where the manager rewards were distributed.
+  struct StakingPoolManagerReward {
+    uint poolId;
+    uint[] trancheIds;
+  }
+
+  /* ========== VIEWS ========== */
+
+  function token() external view returns (INXMToken);
+
   function coverInfo(uint id) external view returns (
     uint16 claimCount,
     bool hasOpenClaim,
     bool hasAcceptedClaim,
     uint96 requestedPayoutAmount
   );
 
+  function getLockReasons(address _of) external view returns (bytes32[] memory reasons);
+
+  function totalSupply() external view returns (uint);
+
+  function totalBalanceOf(address _of) external view returns (uint amount);
+
+  function totalBalanceOfWithoutDelegations(address _of) external view returns (uint amount);
+
+  function getTokenPrice() external view returns (uint tokenPrice);
+
+  function getPendingRewards(address member) external view returns (uint);
+
+  function tokensLocked(address _of, bytes32 _reason) external view returns (uint256 amount);
+
+  function getWithdrawableCoverNotes(
+    address coverOwner
+  ) external view returns (
+    uint[] memory coverIds,
+    bytes32[] memory lockReasons,
+    uint withdrawableAmount
+  );
+
+  function getStakingPoolManager(uint poolId) external view returns (address manager);
+
+  function getManagerStakingPools(address manager) external view returns (uint[] memory poolIds);
+
+  function isStakingPoolManager(address member) external view returns (bool);
+
+  function getStakingPoolOwnershipOffer(uint poolId) external view returns (address proposedManager, uint deadline);
+
+  function stakingPoolNXMBalances(uint poolId) external view returns (uint128 rewards, uint128 deposits);
+
+  /* ========== MUTATIVE FUNCTIONS ========== */
+
   function withdrawCoverNote(
     address _of,
     uint[] calldata _coverIds,
@@ -53,26 +114,6 @@ interface ITokenController {
 
   function withdrawClaimAssessmentTokens(address[] calldata users) external;
 
-  function getLockReasons(address _of) external view returns (bytes32[] memory reasons);
-
-  function totalSupply() external view returns (uint);
-
-  function totalBalanceOf(address _of) external view returns (uint amount);
-
-  function totalBalanceOfWithoutDelegations(address _of) external view returns (uint amount);
-
-  function getTokenPrice() external view returns (uint tokenPrice);
-
-  function token() external view returns (INXMToken);
-
-  function getStakingPoolManager(uint poolId) external view returns (address manager);
-
-  function getManagerStakingPools(address manager) external view returns (uint[] memory poolIds);
-
-  function isStakingPoolManager(address member) external view returns (bool);
-
-  function getStakingPoolOwnershipOffer(uint poolId) external view returns (address proposedManager, uint deadline);
-
   function transferStakingPoolsOwnership(address from, address to) external;
 
   function assignStakingPoolManager(uint poolId, address manager) external;
@@ -92,18 +133,4 @@ interface ITokenController {
   function withdrawNXMStakeAndRewards(address to, uint stakeToWithdraw, uint rewardsToWithdraw, uint poolId) external;
 
   function burnStakedNXM(uint amount, uint poolId) external;
-
-  function stakingPoolNXMBalances(uint poolId) external view returns(uint128 rewards, uint128 deposits);
-
-  function tokensLocked(address _of, bytes32 _reason) external view returns (uint256 amount);
-
-  function getWithdrawableCoverNotes(
-    address coverOwner
-  ) external view returns (
-    uint[] memory coverIds,
-    bytes32[] memory lockReasons,
-    uint withdrawableAmount
-  );
-
-  function getPendingRewards(address member) external view returns (uint);
 }

contracts/mocks/disposables/DisposableTokenController.sol

@@ -11,8 +11,15 @@ contract DisposableTokenController is TokenController {
     address quotationDataAddress,
     address claimsRewardAddress,
     address stakingPoolFactoryAddress,
-    address tokenAddress
-  ) TokenController(quotationDataAddress, claimsRewardAddress, stakingPoolFactoryAddress, tokenAddress) {}
+    address tokenAddress,
+    address stakingNFTAddress
+  ) TokenController(
+    quotationDataAddress,
+    claimsRewardAddress,
+    stakingPoolFactoryAddress,
+    tokenAddress,
+    stakingNFTAddress
+  ) {}
 
   function initialize(
     address payable _masterAddress,

contracts/mocks/generic/AssessmentGeneric.sol

@@ -17,54 +17,58 @@ contract AssessmentGeneric is IAssessment {
   mapping(address => mapping(uint => bool)) public hasAlreadyVotedOn;
 
   function getAssessmentsCount() external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("getAssessmentsCount unsupported");
   }
 
   function getPoll(uint) external virtual view returns (Poll memory) {
-    revert("Unsupported");
+    revert("getPoll unsupported");
   }
 
-  function getRewards(address) external pure returns (uint, uint, uint) {
-    revert("Unsupported");
+  function getRewards(address) external virtual view returns (uint, uint, uint) {
+    revert("getRewards unsupported");
   }
 
   function getVoteCountOfAssessor(address) external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("getVoteCountOfAssessor unsupported");
   }
 
   function stake(uint96) external pure {
-    revert("Unsupported");
+    revert("stake unsupported");
   }
 
   function unstake(uint96, address) external pure {
-    revert("Unsupported");
+    revert("unstake unsupported");
+  }
+
+  function unstakeAllFor(address) external pure {
+    revert("unstakeFor unsupported");
   }
 
   function withdrawRewards(address, uint104) external virtual returns (uint, uint) {
-    revert("Unsupported");
+    revert("withdrawRewards unsupported");
   }
 
   function withdrawRewardsTo(address, uint104) external virtual returns (uint, uint) {
-    revert("Unsupported");
+    revert("withdrawRewardsTo unsupported");
   }
 
   function startAssessment(uint, uint) external virtual returns (uint) {
-    revert("Unsupported");
+    revert("startAssessment unsupported");
   }
 
   function castVotes(uint[] calldata, bool[] calldata, string[] calldata, uint96) external virtual pure {
-    revert("Unsupported");
+    revert("castVotes unsupported");
   }
 
   function submitFraud(bytes32) external pure {
-    revert("Unsupported");
+    revert("submitFraud unsupported");
   }
 
   function processFraud(uint256, bytes32[] calldata, address, uint256, uint96, uint16, uint256) external pure {
-    revert("Unsupported");
+    revert("processFraud unsupported");
   }
 
   function updateUintParameters(UintParams[] calldata, uint[] calldata) external pure {
-    revert("Unsupported");
+    revert("updateUintParameters unsupported");
   }
 }

contracts/mocks/generic/PooledStakingGeneric.sol

@@ -7,50 +7,50 @@ import "../../interfaces/IPooledStaking.sol";
 contract PooledStakingGeneric is IPooledStaking {
 
   function accumulateReward(address, uint) external virtual {
-    revert("Unsupported");
+    revert("accumulateReward unsupported");
   }
 
   function pushBurn(address, uint) external virtual {
-    revert("Unsupported");
+    revert("pushBurn unsupported");
   }
 
   function hasPendingActions() external virtual view returns (bool) {
-    revert("Unsupported");
+    revert("hasPendingActions unsupported");
   }
 
   function processPendingActions(uint) external virtual returns (bool) {
-    revert("Unsupported");
+    revert("processPendingActions unsupported");
   }
 
   function contractStake(address) external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("contractStake unsupported");
   }
 
   function stakerReward(address) external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("stakerReward unsupported");
   }
 
   function stakerDeposit(address) external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("stakerDeposit unsupported");
   }
 
   function stakerContractStake(address, address) external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("stakerContractStake unsupported");
   }
 
   function withdraw(uint) external virtual {
-    revert("Unsupported");
+    revert("withdraw unsupported");
   }
 
   function withdrawForUser(address) external virtual {
-    revert("Unsupported");
+    revert("withdrawForUser unsupported");
   }
 
   function stakerMaxWithdrawable(address) external virtual view returns (uint) {
-    revert("Unsupported");
+    revert("stakerMaxWithdrawable unsupported");
   }
 
   function withdrawReward(address) external virtual {
-    revert("Unsupported");
+    revert("withdrawReward unsupported");
   }
 }