Skip to content

Use onlyGovernance to restrict upgrades for Governor with UUPS #544

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
CoveMB merged 4 commits into from
May 21, 2025
Merged

Use onlyGovernance to restrict upgrades for Governor with UUPS #544

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d557a5
Refactor upgradeable functionality in governor.ts and set-upgradeable.ts
elisafalk May 12, 2025
4b2b27c
Refactor upgradeable handling in set-upgradeable.ts by extracting com…
elisafalk May 13, 2025
1ea2d35
Update changeset
ericglau May 13, 2025
315ee8c
Refactor, fix and update tests
ericglau May 14, 2025
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
4 changes: 2 additions & 2 deletions packages/core/solidity/src/governor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { OptionsError } from './error';
import { setAccessControl } from './set-access-control';
import { printContract } from './print';
import { setInfo } from './set-info';
import { setUpgradeable } from './set-upgradeable';
import { setUpgradeableGovernor } from './set-upgradeable';
import { defineFunctions } from './utils/define-functions';
import { durationToBlocks, durationToTimestamp } from './utils/duration';
import { clockModeDefault, type ClockMode } from './set-clock-mode';
Expand Down Expand Up @@ -99,7 +99,7 @@ export function buildGovernor(opts: GovernorOptions): Contract {
addTimelock(c, allOpts);

setAccessControl(c, allOpts.access);
setUpgradeable(c, allOpts.upgradeable, allOpts.access);
setUpgradeableGovernor(c, allOpts.upgradeable);
setInfo(c, allOpts.info);

return c;
Expand Down
35 changes: 35 additions & 0 deletions packages/core/solidity/src/set-upgradeable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,41 @@ export function setUpgradeable(c: ContractBuilder, upgradeable: Upgradeable, acc
}
}

export function setUpgradeableGovernor(c: ContractBuilder, upgradeable: Upgradeable) {
if (upgradeable === false) {
return;
}

c.upgradeable = true;

c.addParent({
name: 'Initializable',
path: '@openzeppelin/contracts/proxy/utils/Initializable.sol',
});

switch (upgradeable) {
case 'transparent':
break;

case 'uups': {
const UUPSUpgradeable = {
name: 'UUPSUpgradeable',
path: '@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol',
};
c.addParent(UUPSUpgradeable);
c.addOverride(UUPSUpgradeable, functions._authorizeUpgrade);
c.addModifier('onlyGovernance', functions._authorizeUpgrade);
c.setFunctionBody([], functions._authorizeUpgrade);
break;
}

default: {
const _: never = upgradeable;
throw new Error('Unknown value for `upgradeable`');
}
}
}

const functions = defineFunctions({
_authorizeUpgrade: {
args: [{ name: 'newImplementation', type: 'address' }],
Expand Down
Loading