Voting Multipliers #100

RonTuretzky · 2024-09-28T09:13:43Z

This is not upgrade-safe due to new variables introduced in an inherited class. Suggesting to couple this PR with #96 and create a brand new YieldDistributor

…onfig with tests Changes to be committed:

src/YieldDistributor.sol

bagelface · 2024-10-23T16:32:24Z

src/YieldDistributor.sol

+        uint256 breadVotingPower = this.getVotingPowerForPeriod(BREAD, lastCycleStart, lastClaimedBlockNumber, _account);
+        uint256 butteredBreadVotingPower =
+            this.getVotingPowerForPeriod(BUTTERED_BREAD, lastCycleStart, lastClaimedBlockNumber, _account);
+        return (breadVotingPower + butteredBreadVotingPower) * multiplier / PRECISION;


Ok I see what's going on. TBH I don't think PRECISION should be shared here since it's being used in two different calculations. I think the getTotalMultipliers function should probably return a tuple like (multiplier, multiplier_precision) and that should be used here. Ignore my previous comment about using "1 instead of 1e18"

so you're saying each multiplier should have it's own precision potentially? can't we just assume they are all 1e18?

I think we should return a single number formatted to 1e18, to avoid confusion and enforce standardization

bagelface · 2024-10-23T16:39:01Z

src/YieldDistributor.sol

@@ -20,7 +21,7 @@ import {IYieldDistributor} from "src/interfaces/IYieldDistributor.sol";
 * @custom:coauthor kassandra.eth
 * @custom:coauthor theblockchainsocialist.eth
 */
-contract YieldDistributor is IYieldDistributor, OwnableUpgradeable {
+contract YieldDistributor is IYieldDistributor, OwnableUpgradeable, VotingMultipliers {


TBH I'm a little dubious of the upgrade safety here. It would probably be best to implement VotingMultipliers to use ERC7201 storage layouts (like they do with OwnableUpgradeable) to avoid storage layout collisions. It seems complicated but it's actually a pretty trivial one time calculation and some boilerplate code for accessing storage variables.

I was thinking we should just deploy a new proxy for this version, and use the setter on the bread contract, as this would also help us resolve #96

Is there a foreseeable problem deploying as a new proxy, thus changing the address? if there is not, i would prefer we deploy fresh, therefore do not need to worry about upgrade-safety, and not over-complicated things. but again, this is assuming there is no major problem with changing the address.

Deploying a new contract is definitely the move in this instance but I mean in future instances where we maybe want to make some changes to the VotingMultipliers.sol contract. Namespacing the storage layouts ensure YieldDistributor and VotingMultipliers are using their own storage locations that won't clash, so if we want to add a variable to one or the other, we can do so safely. I can make a quick branch so show what it would look like.

I also think there is a strong case to be made for VotingMultipliers to be its own contract.

src/VotingMultipliers.sol

RonTuretzky · 2024-11-20T18:19:07Z

Deprioritizing for now

src/YieldDistributor.sol

src/interfaces/IVotingMultipliers.sol

src/multipliers/NFTMultiplier.sol

src/multipliers/PermanentNFTMultiplier.sol

test/YieldDistributor.t.sol

src/VotingMultipliers.sol

src/YieldDistributor.sol

…mit rename

This reverts commit de0309d.

…h voting function to prevent on-chain iteriations

bagelface · 2024-12-04T18:02:22Z

src/VotingMultipliers.sol

+    /// @notice Calculates the total multiplier for a given _user
+    /// @param _user The address of the _user
+    /// @return The total multiplier value for the _user
+    function getTotalMultipliers(address _user) public view returns (uint256) {


Assuming we keeping this as a quality of life function so we can avoid the double query getValidMultiplierIndexes(address) -> getTotalMultipliers(address, uint256[])? If so, I think this should be moved to be closer to getTotalMultipliers(address, uint256[]) so the overload is obvious. Maybe word adding a note in the natspec comments with a @dev tag

bagelface · 2024-12-04T18:03:39Z

src/VotingMultipliers.sol

+    /// @notice Array of allowlisted multiplier contracts
+    IMultiplier[] public allowlistedMultipliers;
+
+    /// @notice Calculates the total multiplier for a given _user


Drop the underscore form _user when referring to it in the comments to be consistent with other comments.

bagelface · 2024-12-04T18:17:28Z

src/interfaces/IVotingMultipliers.sol

+    /// @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
+


remove line break

bagelface · 2024-12-04T18:17:32Z

src/interfaces/IVotingMultipliers.sol

+    error InvalidMultiplierIndex();
+    /// @notice Emitted when a new multiplier is added to the allowlist
+    /// @param multiplier The address of the added multiplier
+


remove line break

bagelface · 2024-12-04T18:26:55Z

src/interfaces/multipliers/ICrossChainProveableMultiplier.sol

+
+/// @title Cross-Chain Proveable Multiplier Interface
+/// @notice Interface for contracts that provide a cross-chain proveable multiplying factor
+


remove line break

bagelface · 2024-12-04T18:27:07Z

src/interfaces/multipliers/IDynamicNFTMultiplier.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
+


remove line break

bagelface · 2024-12-04T18:30:19Z

src/interfaces/multipliers/IOnChainProveableMultiplier.sol

+import {IProveableMultiplier} from "src/interfaces/multipliers/IProveableMultiplier.sol";
+/// @title On-Chain Proveable Multiplier Interface
+/// @notice Interface for contracts that provide an on-chain proveable multiplying factor
+


remove line break

bagelface · 2024-12-04T18:30:27Z

src/interfaces/multipliers/IProveableMultiplier.sol

+import {IDynamicNFTMultiplier} from "src/interfaces/multipliers/IDynamicNFTMultiplier.sol";
+/// @title Proveable Multiplier Interface
+/// @notice Interface for contracts that provide a proveable multiplying factor based on _user activities
+


remove line break

bagelface · 2024-12-04T23:32:36Z

src/YieldDistributor.sol

+     */
+    function castVoteWithMultipliers(uint256[] calldata _points, uint256[] calldata _multiplierIndices) public {
+        uint256 _currentVotingPower = getCurrentVotingPower(msg.sender);
+        if (_currentVotingPower < minRequiredVotingPower) revert BelowMinRequiredVotingPower();


Are we sure we want to check this requirement before multipliers are applied??

bagelface · 2024-12-04T23:38:58Z

src/YieldDistributor.sol

@@ -110,17 +112,20 @@ contract YieldDistributor is IYieldDistributor, OwnableUpgradeable {
     * @return uint256 The voting power of the user
     */
    function getCurrentVotingPower(address _account) public view returns (uint256) {
-        return this.getVotingPowerForPeriod(BREAD, previousCycleStartingBlock, lastClaimedBlockNumber, _account)
-            + this.getVotingPowerForPeriod(BUTTERED_BREAD, previousCycleStartingBlock, lastClaimedBlockNumber, _account);
+        uint256 lastCycleStart = lastClaimedBlockNumber - cycleLength;


Just realizing this will be invalid if cycleLength is changed. We need a "lastCycleLength" variable. Maybe it'd be good to create a Cycle struct?

We should open a separate issue for this ... also mark it as bug so we don't upgrade changes without considering this...

Ron Turetzky and others added 17 commits September 23, 2024 10:11

chore: init

47bdbff

chore: init of Imultiplier @secbajor

0aa29f4

chore: implementing interfaces from #71

2534725

chore: init permanftmul impl

bc9abf8

chore: tmp commit

12fa7ea

fix: reverting auto changes to yd

faf437f

fix: changing to interface

8c89ed0

fix: fixing imports

8dd45db

chore: init derived interfaces

e0d2527

fix: changing variable name"

3906049

fix: removing ref to external, impl in implemtations

3f06af0

chore: first multiplier

0cc8661

chore: Adding voting multiplier handling and integration to yd

6f95cc5

fix: amending functionality to handle no multiplier for voter properly

1c6c8c0

chore: adding unit and fuzzy tests

fffe13b

chore: adding basic NFTMultiplier implementation, deploy script and c…

fc1221b

…onfig with tests Changes to be committed:

fix: updating wrong documentation

daeb1ce

RonTuretzky force-pushed the feat/voting_multiplier branch from 3a0c818 to daeb1ce Compare September 28, 2024 11:59

fix: reducing scope of pr

cf53a4f

bagelface reviewed Oct 23, 2024

View reviewed changes

src/YieldDistributor.sol Outdated Show resolved Hide resolved

bagelface reviewed Oct 23, 2024

View reviewed changes

src/YieldDistributor.sol Outdated Show resolved Hide resolved

bagelface reviewed Oct 23, 2024

View reviewed changes

src/VotingMultipliers.sol Show resolved Hide resolved

RonTuretzky requested a review from daopunk October 24, 2024 06:37

RonTuretzky added 4 commits October 24, 2024 08:37

Merge branch 'dev' into feat/voting_multiplier

dce84d8

merge: merging dev

3d92685

fix: order of operations clarification

bf324f1

chore: adding gas benchmark tests for mutipliers

5b9b7b3

RonTuretzky requested a review from bagelface October 29, 2024 14:08

RonTuretzky linked an issue Oct 30, 2024 that may be closed by this pull request

Voting Multiplier Spec #71

Open

RonTuretzky closed this Nov 20, 2024

daopunk reopened this Dec 1, 2024

daopunk requested changes Dec 1, 2024

View reviewed changes

RonTuretzky added 13 commits December 1, 2024 12:37

rename: using PRECISION instead of hardcoded 1e18 for clarity"

12bfd60

chore: removing external calls by declaring public

50787c1

chore: renaming outdating convention

47333b3

chore: including prefix for function param and fixing up previous com…

967d6cc

…mit rename

chore: renaming constant to fit camel case convention

706cd8e

chore: refactoring constant to snake case

2d04f5c

style: underscore for internal vars"

6e78550

docs: updating authors

ec07fb1

chore: removing voting multiplier gas snapshot testing

f867e06

style: internal / function-scoped variables should have underscore

80b7345

perf: optimizing init variable validation

de0309d

Revert "perf: optimizing init variable validation"

1c5f5cd

This reverts commit de0309d.

chore: introducing offchain indexing of multipliers to be bundled wit…

0d4836e

…h voting function to prevent on-chain iteriations

daopunk approved these changes Dec 1, 2024

View reviewed changes

bagelface reviewed Dec 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Voting Multipliers #100

Voting Multipliers #100

RonTuretzky commented Sep 28, 2024

bagelface Oct 23, 2024

RonTuretzky Oct 26, 2024 •

edited

Loading

daopunk Dec 1, 2024

bagelface Oct 23, 2024

RonTuretzky Oct 24, 2024

daopunk Dec 1, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024 •

edited

Loading

RonTuretzky commented Nov 20, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

bagelface Dec 4, 2024

RonTuretzky Dec 5, 2024

bagelface Dec 4, 2024

RonTuretzky Dec 5, 2024


		/// @title Cross-Chain Proveable Multiplier Interface
		/// @notice Interface for contracts that provide a cross-chain proveable multiplying factor

Voting Multipliers #100

Are you sure you want to change the base?

Voting Multipliers #100

Conversation

RonTuretzky commented Sep 28, 2024

Choose a reason for hiding this comment

RonTuretzky Oct 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bagelface Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

RonTuretzky commented Nov 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RonTuretzky Oct 26, 2024 •

edited

Loading

bagelface Dec 4, 2024 •

edited

Loading