feat: Add minimal approval configuration

packages/contracts/src/IMajorityVoting.sol

@@ -36,6 +36,10 @@ interface IMajorityVoting {
     /// @return The support threshold parameter.
     function supportThreshold() external view returns (uint32);
 
+    /// @notice Returns the min approval value stored configured.
+    /// @return The minimal approval value.
+    function minApproval() external view returns (uint256);
+
     /// @notice Returns the minimum participation parameter stored in the voting settings.
     /// @return The minimum participation parameter.
     function minParticipation() external view returns (uint32);
@@ -61,6 +65,13 @@ interface IMajorityVoting {
     /// @return Returns `true` if the participation is greater than the minimum participation and `false` otherwise.
     function isMinParticipationReached(uint256 _proposalId) external view returns (bool);
 
+    /// @notice Checks if the min approval value defined as:
+    ///$$\texttt{minApproval} = \frac{N_\text{yes}}{N_\text{total}}$$
+    /// for a proposal vote is greater or equal than the minimum approval value.
+    /// @param _proposalId The ID of the proposal.
+    /// @return Returns `true` if the participation is greater than the minimum participation and `false` otherwise.
+    function isMinApprovalReached(uint256 _proposalId) external view returns (bool);
+
     /// @notice Checks if an account can participate on a proposal vote. This can be because the vote
     /// - has not started,
     /// - has ended,

packages/contracts/src/MajorityVotingBase.sol

@@ -165,6 +165,7 @@ abstract contract MajorityVotingBase is
     /// @param voters The votes casted by the voters.
     /// @param actions The actions to be executed when the proposal passes.
     /// @param allowFailureMap A bitmap allowing the proposal to succeed, even if individual actions might revert.
+    /// @param minApprovalPower The minimum amount of yes votes power needed for the proposal advance.
     /// If the bit at index `i` is 1, the proposal succeeds even if the `i`th action reverts.
     /// A failure map value of 0 requires every action to not revert.
     struct Proposal {
@@ -174,6 +175,7 @@ abstract contract MajorityVotingBase is
         mapping(address => IMajorityVoting.VoteOption) voters;
         IDAO.Action[] actions;
         uint256 allowFailureMap;
+        uint256 minApprovalPower;
     }
 
     /// @notice A container for the proposal parameters at the time of proposal creation.
@@ -211,6 +213,7 @@ abstract contract MajorityVotingBase is
             this.totalVotingPower.selector ^
             this.getProposal.selector ^
             this.updateVotingSettings.selector ^
+            this.updateMinApprovals.selector ^
             this.createProposal.selector;
 
     /// @notice The ID of the permission required to call the `updateVotingSettings` function.
@@ -224,6 +227,10 @@ abstract contract MajorityVotingBase is
     /// @notice The struct storing the voting settings.
     VotingSettings private votingSettings;
 
+    /// @notice The minimal ratio of yes votes needed for a proposal succeed.
+    /// @dev is not on the VotingSettings for compatibility reasons.
+    uint256 private minApprovals; // added in v1.3
+
     /// @notice Thrown if a date is out of bounds.
     /// @param limit The limit value.
     /// @param actual The actual value.
@@ -266,17 +273,23 @@ abstract contract MajorityVotingBase is
         uint256 minProposerVotingPower
     );
 
+    /// @notice Emitted when the min approval value is updated.
+    /// @param minApprovals The minimum amount of yes votes needed for a proposal succeed.
+    event VotingMinApprovalUpdated(uint256 minApprovals);
+
     /// @notice Initializes the component to be used by inheriting contracts.
     /// @dev This method is required to support [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822).
     /// @param _dao The IDAO interface of the associated DAO.
     /// @param _votingSettings The voting settings.
     // solhint-disable-next-line func-name-mixedcase
     function __MajorityVotingBase_init(
         IDAO _dao,
-        VotingSettings calldata _votingSettings
+        VotingSettings calldata _votingSettings,
+        uint256 _minApprovals
     ) internal onlyInitializing {
         __PluginUUPSUpgradeable_init(_dao);
         _updateVotingSettings(_votingSettings);
+        _updateMinApprovals(_minApprovals);
     }
 
     /// @notice Checks if this or the parent contract supports an interface by its ID.
@@ -291,9 +304,17 @@ abstract contract MajorityVotingBase is
         override(ERC165Upgradeable, PluginUUPSUpgradeable, ProposalUpgradeable)
         returns (bool)
     {
+        // In addition to the current IMajorityVoting interface, also support previous version
+        // that did not include the isMinApprovalReached() and minApproval() functions, same
+        // happens with MAJORITY_VOTING_BASE_INTERFACE which did not included updateMinApprovals().
         return
             _interfaceId == MAJORITY_VOTING_BASE_INTERFACE_ID ||
+            _interfaceId == MAJORITY_VOTING_BASE_INTERFACE_ID ^ this.updateMinApprovals.selector ||
             _interfaceId == type(IMajorityVoting).interfaceId ||
+            _interfaceId ==
+            type(IMajorityVoting).interfaceId ^
+                this.isMinApprovalReached.selector ^
+                this.minApproval.selector ||
             super.supportsInterface(_interfaceId);
     }
 
@@ -386,6 +407,16 @@ abstract contract MajorityVotingBase is
             proposal_.parameters.minVotingPower;
     }
 
+    /// @inheritdoc IMajorityVoting
+    function isMinApprovalReached(uint256 _proposalId) public view virtual returns (bool) {
+        return proposals[_proposalId].tally.yes >= proposals[_proposalId].minApprovalPower;
+    }
+
+    /// @inheritdoc IMajorityVoting
+    function minApproval() public view virtual returns (uint256) {
+        return minApprovals;
+    }
+
     /// @inheritdoc IMajorityVoting
     function supportThreshold() public view virtual returns (uint32) {
         return votingSettings.supportThreshold;
@@ -460,6 +491,15 @@ abstract contract MajorityVotingBase is
         _updateVotingSettings(_votingSettings);
     }
 
+    // todo TBD define if permission should be the same one as update settings
+    /// @notice Updates the minimal approval value.
+    /// @param _minApprovals The new minimal approval value.
+    function updateMinApprovals(
+        uint256 _minApprovals
+    ) external virtual auth(UPDATE_VOTING_SETTINGS_PERMISSION_ID) {
+        _updateMinApprovals(_minApprovals);
+    }
+
     /// @notice Creates a new majority voting proposal.
     /// @param _metadata The metadata of the proposal.
     /// @param _actions The actions that will be executed after the proposal passes.
@@ -550,6 +590,9 @@ abstract contract MajorityVotingBase is
         if (!isMinParticipationReached(_proposalId)) {
             return false;
         }
+        if (!isMinApprovalReached(_proposalId)) {
+            return false;
+        }
 
         return true;
     }
@@ -570,7 +613,7 @@ abstract contract MajorityVotingBase is
     /// @param _votingSettings The voting settings to be validated and updated.
     function _updateVotingSettings(VotingSettings calldata _votingSettings) internal virtual {
         // Require the support threshold value to be in the interval [0, 10^6-1],
-        // because `>` comparision is used in the support criterion and >100% could never be reached.
+        // because `>` comparison is used in the support criterion and >100% could never be reached.
         if (_votingSettings.supportThreshold > RATIO_BASE - 1) {
             revert RatioOutOfBounds({
                 limit: RATIO_BASE - 1,
@@ -579,7 +622,7 @@ abstract contract MajorityVotingBase is
         }
 
         // Require the minimum participation value to be in the interval [0, 10^6],
-        // because `>=` comparision is used in the participation criterion.
+        // because `>=` comparison is used in the participation criterion.
         if (_votingSettings.minParticipation > RATIO_BASE) {
             revert RatioOutOfBounds({limit: RATIO_BASE, actual: _votingSettings.minParticipation});
         }
@@ -603,6 +646,19 @@ abstract contract MajorityVotingBase is
         });
     }
 
+    /// @notice Internal function to update minimal approval value.
+    /// @param _minApprovals The new minimal approval value.
+    function _updateMinApprovals(uint256 _minApprovals) internal virtual {
+        // Require the minimum approval value to be in the interval [0, 10^6],
+        // because `>=` comparison is used in the participation criterion.
+        if (_minApprovals > RATIO_BASE) {
+            revert RatioOutOfBounds({limit: RATIO_BASE, actual: _minApprovals});
+        }
+
+        minApprovals = _minApprovals;
+        emit VotingMinApprovalUpdated(_minApprovals);
+    }
+
     /// @notice Validates and returns the proposal vote dates.
     /// @param _start The start date of the proposal vote.
     /// If 0, the current timestamp is used and the vote starts immediately.
@@ -644,5 +700,5 @@ abstract contract MajorityVotingBase is
     /// new variables without shifting down storage in the inheritance chain
     /// (see [OpenZeppelin's guide about storage gaps]
     /// (https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps)).
-    uint256[47] private __gap;
+    uint256[46] private __gap;
 }

packages/contracts/src/TokenVoting.sol

@@ -23,8 +23,11 @@ contract TokenVoting is IMembership, MajorityVotingBase {
     using SafeCastUpgradeable for uint256;
 
     /// @notice The [ERC-165](https://eips.ethereum.org/EIPS/eip-165) interface ID of the contract.
-    bytes4 internal constant TOKEN_VOTING_INTERFACE_ID =
-        this.initialize.selector ^ this.getVotingToken.selector;
+    // todo double check there is a strong reason for keeping the initialize function on the interface id
+    bytes4 internal constant TOKEN_VOTING_INTERFACE_ID = this.getVotingToken.selector;
+    bytes4 internal constant OLD_TOKEN_VOTING_INTERFACE_ID =
+        bytes4(keccak256("initialize(address,(uint8,uint32,uint32,uint64,uint256),address)")) ^
+            this.getVotingToken.selector;
 
     /// @notice An [OpenZeppelin `Votes`](https://docs.openzeppelin.com/contracts/4.x/api/governance#Votes)
     /// compatible contract referencing the token being used for voting.
@@ -33,29 +36,52 @@ contract TokenVoting is IMembership, MajorityVotingBase {
     /// @notice Thrown if the voting power is zero
     error NoVotingPower();
 
+    error FunctionDeprecated();
+
+    /// @dev Deprecated function.
+    function initialize(
+        IDAO _dao,
+        VotingSettings calldata _votingSettings,
+        IVotesUpgradeable _token
+    ) external initializer {
+        (_dao, _votingSettings, _token);
+
+        // todo TBD should we deprecate this function or only continue with old flow?
+        revert FunctionDeprecated();
+    }
+
     /// @notice Initializes the component.
     /// @dev This method is required to support [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822).
     /// @param _dao The IDAO interface of the associated DAO.
     /// @param _votingSettings The voting settings.
     /// @param _token The [ERC-20](https://eips.ethereum.org/EIPS/eip-20) token used for voting.
+    /// @param _minApprovals The minimal amount of approvals the proposal needs to succeed.
     function initialize(
         IDAO _dao,
         VotingSettings calldata _votingSettings,
-        IVotesUpgradeable _token
+        IVotesUpgradeable _token,
+        uint256 _minApprovals
     ) external initializer {
-        __MajorityVotingBase_init(_dao, _votingSettings);
+        __MajorityVotingBase_init(_dao, _votingSettings, _minApprovals);
 
         votingToken = _token;
 
         emit MembershipContractAnnounced({definingContract: address(_token)});
     }
 
+    /// @notice Initializes the plugin after an upgrade from a previous version.
+    /// @param _minApprovals The minimal amount of approvals the proposal needs to succeed.
+    function initializeFrom(uint256 _minApprovals) external reinitializer(2) {
+        _updateMinApprovals(_minApprovals);
+    }
+
     /// @notice Checks if this or the parent contract supports an interface by its ID.
     /// @param _interfaceId The ID of the interface.
     /// @return Returns `true` if the interface is supported.
     function supportsInterface(bytes4 _interfaceId) public view virtual override returns (bool) {
         return
             _interfaceId == TOKEN_VOTING_INTERFACE_ID ||
+            _interfaceId == OLD_TOKEN_VOTING_INTERFACE_ID ||
             _interfaceId == type(IMembership).interfaceId ||
             super.supportsInterface(_interfaceId);
     }
@@ -137,6 +163,8 @@ contract TokenVoting is IMembership, MajorityVotingBase {
             minParticipation()
         );
 
+        proposal_.minApprovalPower = _applyRatioCeiled(totalVotingPower_, minApproval());
+
         // Reduce costs
         if (_allowFailureMap != 0) {
             proposal_.allowFailureMap = _allowFailureMap;

packages/contracts/src/TokenVotingSetup.sol

@@ -96,10 +96,16 @@ contract TokenVotingSetup is PluginUpgradeableSetup {
             MajorityVotingBase.VotingSettings memory votingSettings,
             TokenSettings memory tokenSettings,
             // only used for GovernanceERC20(token is not passed)
-            GovernanceERC20.MintSettings memory mintSettings
+            GovernanceERC20.MintSettings memory mintSettings,
+            uint256 minApprovals
         ) = abi.decode(
                 _data,
-                (MajorityVotingBase.VotingSettings, TokenSettings, GovernanceERC20.MintSettings)
+                (
+                    MajorityVotingBase.VotingSettings,
+                    TokenSettings,
+                    GovernanceERC20.MintSettings,
+                    uint256
+                )
             );
 
         address token = tokenSettings.addr;
@@ -154,9 +160,12 @@ contract TokenVotingSetup is PluginUpgradeableSetup {
 
         // Prepare and deploy plugin proxy.
         plugin = address(tokenVotingBase).deployUUPSProxy(
-            abi.encodeCall(
-                TokenVoting.initialize,
-                (IDAO(_dao), votingSettings, IVotesUpgradeable(token))
+            abi.encodeWithSignature(
+                "initialize(address,(uint8,uint32,uint32,uint64,uint256),address,uint256)",
+                IDAO(_dao),
+                votingSettings,
+                IVotesUpgradeable(token),
+                minApprovals
             )
         );
 
@@ -213,7 +222,6 @@ contract TokenVotingSetup is PluginUpgradeableSetup {
         override
         returns (bytes memory initData, PreparedSetupData memory preparedSetupData)
     {
-        (initData);
         if (_fromBuild < 3) {
             PermissionLib.MultiTargetPermission[]
                 memory permissions = new PermissionLib.MultiTargetPermission[](1);
@@ -227,6 +235,12 @@ contract TokenVotingSetup is PluginUpgradeableSetup {
             });
 
             preparedSetupData.permissions = permissions;
+
+            // initialize the minAdvance value
+            initData = abi.encodeCall(
+                TokenVoting.initializeFrom,
+                (abi.decode(_payload.data, (uint256)))
+            );
         }
     }
 

packages/contracts/src/build-metadata.json

@@ -88,6 +88,12 @@
           "name": "mintSettings",
           "type": "tuple",
           "description": "The token mint settings struct containing the `receivers` and `amounts`."
+        },
+        {
+          "internalType": "uint32",
+          "name": "minApproval",
+          "type": "uint32",
+          "description": "The minimum amount of yes votes needed for the proposal advance."
         }
       ]
     },
@@ -99,6 +105,17 @@
       "2": {
         "description": "No input is required for the update.",
         "inputs": []
+      },
+      "3": {
+        "description": "The information required for the installation.",
+        "inputs": [
+          {
+            "internalType": "uint32",
+            "name": "minApproval",
+            "type": "uint32",
+            "description": "The minimum amount of yes votes needed for the proposal advance."
+          }
+        ]
       }
     },
     "prepareUninstallation": {

packages/contracts/src/mocks/MajorityVotingMock.sol

@@ -5,8 +5,12 @@ pragma solidity ^0.8.8;
 import {MajorityVotingBase, IDAO} from "../MajorityVotingBase.sol";
 
 contract MajorityVotingMock is MajorityVotingBase {
-    function initializeMock(IDAO _dao, VotingSettings calldata _votingSettings) public initializer {
-        __MajorityVotingBase_init(_dao, _votingSettings);
+    function initializeMock(
+        IDAO _dao,
+        VotingSettings calldata _votingSettings,
+        uint256 _minApprovals
+    ) public initializer {
+        __MajorityVotingBase_init(_dao, _votingSettings, _minApprovals);
     }
 
     function createProposal(