Skip to content

🥢 Add notes to ERC20Votes #1559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atarpara merged 1 commit into from
Sep 1, 2026
Merged

🥢 Add notes to ERC20Votes #1559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/tokens/ERC20Votes.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,8 @@ abstract contract ERC20Votes is ERC20 {
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

/// @dev Returns the amount of voting units `delegator` has control over.
/// Override if you need a different formula.
/// Note: Overriding this function may compromise the internal vote accounting.
/// `ERC20Votes` assumes tokens map to voting units 1:1 and this is not easy to change.
function _getVotingUnits(address delegator) internal view virtual returns (uint256) {
return balanceOf(delegator);
}
Expand All @@ -265,6 +266,8 @@ abstract contract ERC20Votes is ERC20 {
}

/// @dev Used in `_afterTokenTransfer(address from, address to, uint256 amount)`.
/// Note: this moves the raw ERC20 `amount`, and on a mint or burn writes it to the total
/// supply checkpoint as well. See the NOTE on `_getVotingUnits`.
function _transferVotingUnits(address from, address to, uint256 amount) internal virtual {
if (from == address(0)) {
_checkpointPushDiff(_ERC20_VOTES_MASTER_SLOT_SEED << 96, clock(), amount, true);
Expand Down