Implement VotingStreakMultiplier

.gitignore

@@ -3,3 +3,4 @@ cache
 out
 broadcast
 .env
+.DS_Store

README.md

@@ -1,14 +1,17 @@
 # Breadchain
+
 Breadchain smart contracts power [Breadchain's governance application](https://app.breadchain.xyz/governance).
 
 To learn more check out the [Breadchain wiki](https://breadchain.notion.site/4d496b311b984bd9841ef9c192b9c1c7).
 
 ## Contributing
+
 Join in on the conversation in our [Discord](https://discord.com/invite/zmNqsHRHDa).
 
 If you have skills (both technical and non-technical) that you believe would benefit our mission, you can fill out [this Google Form](https://forms.gle/UU4FmHq4CZbiEKPc6). Expect to hear from a member of our team shortly regarding any potential opportunities for collaboration.
 
 ### Style Guide
+
 Contributions to this repo are expected to adhere to the [Biconomy Solidity Style Guide](https://github.com/bcnmy/biconomy-solidity-style-guide).
 
 ## Usage
@@ -31,28 +34,41 @@ $ forge fmt
 $ forge snapshot
 ```
 
-### Test 
+### Test
 
-```shell 
+```shell
 $ forge test --fork-url "https://rpc.gnosis.gateway.fm" -vvvv
 ```
+
 ### Deploy
 
 ```shell
 forge script script/deploy/DeployYieldDistributor.s.sol:DeployYieldDistributor --rpc-url "https://rpc.gnosis.gateway.fm" --broadcast --private-key <pk>
 ```
 
 ## Upgrading
-### Validate Upgrade Safety 
-1. Checkout to the deployed implementation commit 
-2. Copy "YieldDistributor.sol" to `test/upgrades/<version>/YieldDistributor.sol`
-3. Checkout to upgrade candidate version (A version that is strictly higher than the version in the previous step)
-4. Update the version in the options object of the `script/upgrades/ValidateUpgrade.s.sol` script
-5. Run `forge clean && forge build && forge script script/upgrades/ValidateUpgrade.s.sol`
-6. If script is runs successfully, proceed, otherwise address errors produced by the script until no errors are produced.
-
-### Test Upgrade with Calldata Locally 
-1. Amend the `data` variable in `script/upgrades/UpgradeYieldDistributor.s.sol` to match desired data 
-2. run `forge clean && forge build && forge script script/upgrades/UpgradeYieldDistributor.s.sol --sig "run(address)" <proxy_address> --rpc-url $RPC_URL  --sender <proxy_admin>` 
-
-The proxy admin address is configured to be the Breadchain multisig at address `0x918dEf5d593F46735f74F9E2B280Fe51AF3A99ad` and the Yield Distributor proxy address is `0xeE95A62b749d8a2520E0128D9b3aCa241269024b`
+
+### Validate Upgrade Safety
+
+Before upgrading to a new version of our deployed contracts, it is necessary to run the upgrade safety validation check. This ensures that upgrading won't break existing functionality or corrupt the contract's state.
+
+1. Checkout the deployed implementation commit (usually the `dev` branch)
+2. Determine the new version targeted by the upgrade; it should be strictly higher than the latest deployed version [tag](https://github.com/BreadchainCoop/breadchain/tags)
+3. Flatten YieldDistributor and ButteredBread (this will output a single .sol file with all dependencies inlined for comparison by the upgrade script):
+
+```
+forge flatten src/YieldDistributor.sol > test/upgrades/<new_version>/YieldDistributor.sol
+forge flatten src/ButteredBread.sol > test/upgrades/<new_version>/ButteredBread.sol
+```
+
+4. Checkout the upgrade branch
+5. Update the version in the options object of the `script/upgrades/ValidateUpgrade.s.sol` script
+6. Run `forge clean && forge build && forge script script/upgrades/ValidateUpgrade.s.sol`
+7. If script is runs successfully, proceed, otherwise address errors produced by the script until no errors are produced.
+
+### Test Upgrade with Calldata Locally
+
+1. Amend the `data` variable in `script/upgrades/UpgradeYieldDistributor.s.sol` to match desired data
+2. run `forge clean && forge build && forge script script/upgrades/UpgradeYieldDistributor.s.sol --sig "run(address)" <proxy_address> --rpc-url $RPC_URL  --sender <proxy_admin>`
+
+The proxy admin address is configured to be the Breadchain multisig at address `0x918dEf5d593F46735f74F9E2B280Fe51AF3A99ad` and the Yield Distributor proxy address is `0xeE95A62b749d8a2520E0128D9b3aCa241269024b`

script/upgrades/ValidateUpgrade.s.sol

@@ -9,7 +9,7 @@ contract DeployYieldDistributor is Script {
     function run() external {
         vm.startBroadcast();
         Options memory opts;
-        opts.referenceContract = "v1.0.1/YieldDistributor.sol:YieldDistributor";
+        opts.referenceContract = "v1.0.4/YieldDistributor.sol:YieldDistributor";
         Upgrades.validateUpgrade("YieldDistributor.sol:YieldDistributor", opts);
         vm.stopBroadcast();
     }

src/VotingMultipliers.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.22;
 
 import {IVotingMultipliers, IMultiplier} from "src/interfaces/IVotingMultipliers.sol";
 import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
+import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
 
 /// @title VotingMultipliers
 /// @notice A contract for managing voting multipliers
@@ -11,6 +12,11 @@ contract VotingMultipliers is Ownable2StepUpgradeable, IVotingMultipliers {
     /// @notice Array of allowlisted multiplier contracts
     IMultiplier[] public allowlistedMultipliers;
 
+    /// @notice Initializes the contract
+    function initialize() public initializer {
+        __Ownable_init(msg.sender);
+    }
+
     /// @notice Adds a multiplier to the allowlist
     /// @param _multiplier The multiplier contract to be added
     function addMultiplier(IMultiplier _multiplier) external onlyOwner {
@@ -68,11 +74,12 @@ contract VotingMultipliers is Ownable2StepUpgradeable, IVotingMultipliers {
     }
 
     /// @notice Calculates the total multiplier for a given user using specific multiplier indexes
+    /// @notice Performs the updateMultiplyingFactor function for each multiplier to ensure the multiplier is up to date
     /// @param _user The address of the user
     /// @param _multiplierIndexes Array of multiplier indexes to use
     /// @return The total multiplier value for the user
-    function getTotalMultipliers(address _user, uint256[] calldata _multiplierIndexes) public view returns (uint256) {
-        uint256 _totalMultiplier = 0;
+    function calculateTotalMultipliers(address _user, uint256[] calldata _multiplierIndexes) public returns (uint256) {
+        uint256 _totalMultiplier = MultiplierConstants.BASE_MULTIPLIER;
 
         for (uint256 i = 0; i < _multiplierIndexes.length; i++) {
             uint256 index = _multiplierIndexes[i];
@@ -81,25 +88,34 @@ contract VotingMultipliers is Ownable2StepUpgradeable, IVotingMultipliers {
             }
 
             IMultiplier multiplier = allowlistedMultipliers[index];
+            multiplier.updateMultiplyingFactor(_user);
             if (block.number <= multiplier.validUntil(_user)) {
-                _totalMultiplier += multiplier.getMultiplyingFactor(_user);
+                uint256 factor = multiplier.getMultiplyingFactor(_user);
+                if (factor > MultiplierConstants.BASE_MULTIPLIER) {
+                    // Add only the bonus amount to the total
+                    _totalMultiplier += (factor - MultiplierConstants.BASE_MULTIPLIER);
+                }
             }
         }
-        return _totalMultiplier;
+        return Math.max(_totalMultiplier, MultiplierConstants.BASE_MULTIPLIER);
     }
 
     /// @notice Calculates the total multiplier for a given user
     /// @param _user The address of the _user
     /// @return The total multiplier value for the _user
     /// @dev This function is intended for frontend and testing purposes
     function getTotalMultipliers(address _user) public view returns (uint256) {
-        uint256 _totalMultiplier = 0;
+        uint256 _totalMultiplier = MultiplierConstants.BASE_MULTIPLIER;
         for (uint256 i = 0; i < allowlistedMultipliers.length; i++) {
             IMultiplier multiplier = allowlistedMultipliers[i];
             if (block.number <= multiplier.validUntil(_user)) {
-                _totalMultiplier += multiplier.getMultiplyingFactor(_user);
+                uint256 factor = multiplier.getMultiplyingFactor(_user);
+                if (factor > MultiplierConstants.BASE_MULTIPLIER) {
+                    // Add only the bonus amount to the total
+                    _totalMultiplier += (factor - MultiplierConstants.BASE_MULTIPLIER);
+                }
             }
         }
-        return _totalMultiplier;
+        return Math.max(_totalMultiplier, MultiplierConstants.BASE_MULTIPLIER);
     }
 }

src/YieldDistributor.sol

@@ -43,11 +43,11 @@ contract YieldDistributor is IYieldDistributor, Ownable2StepUpgradeable, VotingM
     address[] public queuedProjectsForAddition;
     /// @notice Array of projects queued for removal from the next cycle
     address[] public queuedProjectsForRemoval;
-    /// @notice The voting power allocated to projects by voters in the current cycle
+    /// @notice The voting power allocated to each project by voters in the current cycle
     uint256[] public projectDistributions;
     /// @notice The last block number in which a specified account cast a vote
     mapping(address => uint256) public accountLastVoted;
-    /// @notice The voting power allocated to projects by voters in the current cycle
+    /// @notice The voting power allocated to each project by a specific voter in the current cycle
     mapping(address => uint256[]) voterDistributions;
     /// @notice How much of the yield is divided equally among projects
     uint256 public yieldFixedSplitDivisor;
@@ -72,7 +72,7 @@ contract YieldDistributor is IYieldDistributor, Ownable2StepUpgradeable, VotingM
         uint256 _lastClaimedBlockNumber,
         address[] memory _projects
     ) public initializer {
-        __Ownable_init(msg.sender);
+        VotingMultipliers.initialize();
         if (
             _bread == address(0) || _butteredBread == address(0) || _precision == 0 || _minRequiredVotingPower == 0
                 || _maxPoints == 0 || _cycleLength == 0 || _yieldFixedSplitDivisor == 0 || _lastClaimedBlockNumber == 0
@@ -236,7 +236,7 @@ contract YieldDistributor is IYieldDistributor, Ownable2StepUpgradeable, VotingM
      */
     function castVoteWithMultipliers(uint256[] calldata _points, uint256[] calldata _multiplierIndices) public {
         uint256 _currentVotingPower = getCurrentVotingPower(msg.sender);
-        uint256 multiplier = getTotalMultipliers(msg.sender, _multiplierIndices);
+        uint256 multiplier = calculateTotalMultipliers(msg.sender, _multiplierIndices);
         _currentVotingPower = multiplier == 0 ? _currentVotingPower : (_currentVotingPower * multiplier) / PRECISION;
         if (_currentVotingPower < minRequiredVotingPower) revert BelowMinRequiredVotingPower();
         _castVote(msg.sender, _points, _currentVotingPower);

src/interfaces/IVotingMultipliers.sol

@@ -12,12 +12,14 @@ interface IVotingMultipliers {
     error MultiplierNotAllowlisted();
     /// @notice Thrown when an invalid multiplier index is provided
     error InvalidMultiplierIndex();
+
     /// @notice Emitted when a new multiplier is added to the allowlist
     /// @param multiplier The address of the added multiplier
     event MultiplierAdded(IMultiplier indexed multiplier);
     /// @notice Emitted when a multiplier is removed from the allowlist
     /// @param multiplier The address of the removed multiplier
     event MultiplierRemoved(IMultiplier indexed multiplier);
+
     /// @notice Returns the multiplier at the specified index in the allowlist
     /// @param index The index of the multiplier in the allowlist
     /// @return The multiplier contract at the specified index

src/interfaces/multipliers/IDynamicNFTMultiplier.sol

@@ -5,14 +5,14 @@ import {INFTMultiplier} from "src/interfaces/multipliers/INFTMultiplier.sol";
 /// @title Dynamic NFT Multiplier Interface
 /// @notice Interface for contracts that provide a dynamic multiplying factor for _users based on NFT ownership
 /// @dev Extends the INFTMultiplier interface with dynamic multiplier functionality
+
 interface IDynamicNFTMultiplier is INFTMultiplier {
     /// @notice Get the multiplying factor for a _user
     /// @param _user The address of the _user
     /// @return The multiplying factor for the _user
     function userToFactor(address _user) external view returns (uint256);
-
     /// @notice Get the validity period for a _user's factor
     /// @param _user The address of the _user
     /// @return The timestamp until which the _user's factor is valid
-    function _userToValidity(address _user) external view returns (uint256);
+    function _userToValidUntil(address _user) external view returns (uint256);
 }

src/interfaces/multipliers/IMultiplier.sol

@@ -1,8 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
+import {MultiplierConstants} from "src/libraries/MultiplierConstants.sol";
+
 interface IMultiplier {
-    /// @notice Returns the voting multiplier for `_user`.
+    /// @notice Updates the multiplying factor for a specific user
+    /// @param _user The address of the user to update the multiplying factor for
+    function updateMultiplyingFactor(address _user) external;
+
+    /// @notice Returns the multiplying factor for `_user`.
     function getMultiplyingFactor(address _user) external view returns (uint256);
 
     /// @notice Returns the validity period of the multiplier for `_user`.

src/libraries/MultiplierConstants.sol

@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.22;
+
+library MultiplierConstants {
+    /// @notice The base multiplier value (100% in fixed-point representation)
+    uint256 public constant BASE_MULTIPLIER = 1e18;
+}

src/multipliers/NFTMultiplier.sol

@@ -60,10 +60,9 @@ contract NFTMultiplier is INFTMultiplier, Initializable, Ownable2StepUpgradeable
         return validUntilBlock;
     }
 
-    /// @notice Update the multiplying factor
-    /// @param _newMultiplyingFactor New multiplying factor (in basis points)
-    function updateMultiplyingFactor(uint256 _newMultiplyingFactor) external onlyOwner {
-        multiplyingFactor = _newMultiplyingFactor;
+    /// @notice Updates the multiplying factor for a specific user
+    function updateMultiplyingFactor(address /* _user */ ) external pure {
+        return;
     }
 
     /// @notice Update the valid until block

src/multipliers/PermanentNFTMultiplier.sol

@@ -40,4 +40,9 @@ contract PermanentNFTMultiplier is INFTMultiplier {
     function hasNFT(address _user) public view override returns (bool) {
         return NFT_ADDRESS.balanceOf(_user) > 0;
     }
+
+    /// @notice Updates the multiplying factor for a specific user
+    function updateMultiplyingFactor(address /* _user */ ) external pure override {
+        return;
+    }
 }