Use Trace208 in Votes to support ERC6372 clocks #4539

Amxx · 2023-08-25T14:37:51Z

ERC-6372 clocks are 48 bits but our Votes contracts use 32 bit keys. This changes the Votes library to match clocks and use 48 bit keys, to avoid fallible conversions.

PR Checklist

Tests
Documentation
Changeset entry (run npx changeset add)

…ompatibility

changeset-bot · 2023-08-25T14:37:54Z

🦋 Changeset detected

Latest commit: 7927100

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
openzeppelin-solidity	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

frangio · 2023-08-25T17:56:14Z

contracts/token/ERC20/extensions/ERC20Votes.sol

     */
-    function _maxSupply() internal view virtual returns (uint224) {
-        return type(uint224).max;
+    function _maxSupply() internal view virtual returns (uint256) {


Why change this to uint256? Using the smaller type prevents returning a number that is too large for the data structure to support it.

Suggested change

function _maxSupply() internal view virtual returns (uint256) {

function _maxSupply() internal view virtual returns (uint208) {

I'm honestly not sure what it implies/change to use uint208 vs uint256 here (note that it's internal)

uint208 makes it a type error to override with a function that returns type(uint256).max, for example, or any literal that is too large to fit uint208.

What if multiple modules implement that function with different values (votes limit to 208, but other modules would limit to 224, 192 or 128 for some other reason) how would we resolve that ?

If the return types are different it's a mess. If they are both uint256 there may be some hope

This is not a concrete problem we have currently so I would go with the option that is safer.

If that issue happens during the 5.x cycle, would we be able to change it without a major change ?

I don't think overriding this with a bigger function is something anyone would realistically do.

Also the only place we use it, we do an implicit upcast to uint256

If something like this happens in a minor release I think we would just add an internal function with a name other than _maxSupply so they wouldn't clash, and ERC20Votes could implement that internal function in terms of the existing one.

If you feel strongly about this I can accept it. The risk if >uint208 is returned is simply that some transfers might revert but it's a recoverable situation.

frangio · 2023-08-25T20:44:49Z

In 74b8d26 I added continue-on-error for the storage layout checks if the PR is labelled as "breaking change". But note that this doesn't re-run the checks when the label is applied. To do that we would need to add these lines in checks.yml but I feared they might cause tests to restart too often:

openzeppelin-contracts/.github/workflows/changeset.yml

Lines 7 to 11 in b2e7bab

    
           types: 
        
             - opened 
        
             - synchronize 
        
             - labeled 
        
             - unlabeled

Also, we may want to use a separate label specific to storage breakage, so we don't accidentally miss storage changes when we're doing a less serious breaking change in a minor release. @Amxx what do you think?

Amxx · 2023-08-25T20:54:45Z

In 74b8d26 I added continue-on-error for the storage layout checks if the PR is labelled as "breaking change". But note that this doesn't re-run the checks when the label is applied. To do that we would need to add these lines in checks.yml but I feared they might cause tests to restart too often:

openzeppelin-contracts/.github/workflows/changeset.yml

Lines 7 to 11 in b2e7bab

types:

- opened

- synchronize

- labeled

- unlabeled

Also, we may want to use a separate label specific to storage breakage, so we don't accidentally miss storage changes when we're doing a less serious breaking change in a minor release. @Amxx what do you think?

A tag is nice, but I think we should also consider the changeset. This could be done in two ways:

Forget the tag, and automatically disable the storage check if there is a "major" changeset.
Keep the tag, but add a check that if this tag is turned on, then we must have a "major" changeset.

I don't have a strong opinion for the tag name. I'm ok with "breaking change", but if you want to make it more storage specific, then "storage change" would be ok I guess.

The question is, do we want all "breaking change" tags to require a major changeset, or do we accept such tags in patch releases?

frangio · 2023-08-25T23:17:04Z

Is your idea that the layout check would be disabled if there is any major changeset in the PR branch, or if the current PR is adding a new major changeset?

I went with the label because I thought you meant the second option and it seemed a lot more complicated to implement.

Amxx · 2023-08-28T07:17:17Z

if the current PR is adding a new major changeset.

I think is label is good for know.

frangio

I would prefer to make _maxSupply return uint208 but not a blocker to merge. We should probably document the consequence of returning a number that is larger than type(uint208).max though.

Amxx · 2023-08-30T08:38:11Z

I added some documentation.

0xVolosnikov · 2023-08-30T18:14:31Z

contracts/governance/extensions/GovernorVotesQuorumFraction.sol

-        Checkpoints.Checkpoint224 storage latest = _quorumNumeratorHistory._checkpoints[length - 1];
-        uint32 latestKey = latest._key;
-        uint224 latestValue = latest._value;
+        Checkpoints.Checkpoint208 memory latest = _quorumNumeratorHistory._checkpoints[length - 1];


Why memory?

The merge with master wasn't done correctly. Thanks for raising.

Co-authored-by: Francisco <fg@frang.io>

Use trace208 in Checkpoints to support full uint48 keys for ERC6372 c…

06b4189

…ompatibility

add changeset

48fba73

Amxx changed the title ~~Use trace208 in Checkpoints to support full uint48 keys for ERC6372 compatibility~~ Use trace208 in Votes to support ERC6372 clocks Aug 25, 2023

frangio changed the title ~~Use trace208 in Votes to support ERC6372 clocks~~ Use Trace208 in Votes to support ERC6372 clocks Aug 25, 2023

Update wild-peas-remain.md

15ca017

frangio reviewed Aug 25, 2023

View reviewed changes

accept storage breakage when labeled as breaking

74b8d26

frangio added the breaking change Changes that break backwards compatibility of the public API. label Aug 25, 2023

trigger tests

d5ab954

Merge branch 'master' into refactor/checkpoints/use-trace208

b2cd627

frangio previously approved these changes Aug 29, 2023

View reviewed changes

document

bd9595d

Amxx dismissed frangio’s stale review via bd9595d August 30, 2023 08:38

Amxx requested a review from frangio August 30, 2023 08:38

Amxx and others added 3 commits August 30, 2023 10:45

Update ERC20Votes.sol

2d93da5

Update ERC20Votes.sol

bc335f5

lint

7927100

frangio approved these changes Aug 30, 2023

View reviewed changes

frangio enabled auto-merge (squash) August 30, 2023 17:01

frangio merged commit cd67894 into OpenZeppelin:master Aug 30, 2023
15 checks passed

0xVolosnikov reviewed Aug 30, 2023

View reviewed changes

frangio mentioned this pull request Aug 30, 2023

Revert memory pointer to storage pointer #4550

Merged

Amxx deleted the refactor/checkpoints/use-trace208 branch August 30, 2023 19:48

ernestognw pushed a commit that referenced this pull request Sep 8, 2023

Use Trace208 in Votes to support ERC6372 clocks (#4539)

005c2cc

Co-authored-by: Francisco <fg@frang.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Trace208 in Votes to support ERC6372 clocks #4539

Use Trace208 in Votes to support ERC6372 clocks #4539

Amxx commented Aug 25, 2023 •

edited

changeset-bot bot commented Aug 25, 2023 •

edited

frangio Aug 25, 2023

Amxx Aug 25, 2023 •

edited

frangio Aug 25, 2023

Amxx Aug 25, 2023 •

edited

frangio Aug 25, 2023

Amxx Aug 25, 2023

Amxx Aug 25, 2023

frangio Aug 25, 2023

frangio Aug 25, 2023

frangio commented Aug 25, 2023 •

edited

Amxx commented Aug 25, 2023

frangio commented Aug 25, 2023

Amxx commented Aug 28, 2023 •

edited

frangio left a comment •

edited

Amxx commented Aug 30, 2023

0xVolosnikov Aug 30, 2023

frangio Aug 30, 2023

	function _maxSupply() internal view virtual returns (uint256) {
	function _maxSupply() internal view virtual returns (uint208) {

Use Trace208 in Votes to support ERC6372 clocks #4539

Use Trace208 in Votes to support ERC6372 clocks #4539

Conversation

Amxx commented Aug 25, 2023 • edited

PR Checklist

changeset-bot bot commented Aug 25, 2023 • edited

🦋 Changeset detected

Choose a reason for hiding this comment

Amxx Aug 25, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amxx Aug 25, 2023 • edited

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

frangio commented Aug 25, 2023 • edited

Amxx commented Aug 25, 2023

frangio commented Aug 25, 2023

Amxx commented Aug 28, 2023 • edited

frangio left a comment • edited

Choose a reason for hiding this comment

Amxx commented Aug 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amxx commented Aug 25, 2023 •

edited

changeset-bot bot commented Aug 25, 2023 •

edited

Amxx Aug 25, 2023 •

edited

Amxx Aug 25, 2023 •

edited

frangio commented Aug 25, 2023 •

edited

Amxx commented Aug 28, 2023 •

edited

frangio left a comment •

edited