Skip to content

Commit aa438ef

Browse files
0xChin0xOneTony
authored andcommitted
refactor: voting module naming (#404)
* refactor: rename proposalTypeConfigurator to proposalVotingModule * chore: run pre-pr * fix: missing rename in comment * chore: run pre-pr * docs: fix natspec description
1 parent 9d482e8 commit aa438ef

File tree

5 files changed

+51
-56
lines changed

5 files changed

+51
-56
lines changed

packages/contracts-bedrock/interfaces/governance/IProposalValidator.sol

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ interface IProposalValidator is ISemver {
2929

3030
struct ProposalTypeData {
3131
uint256 requiredApprovals;
32-
uint8 proposalTypeConfigurator;
32+
uint8 proposalVotingModule;
3333
}
3434

3535
enum ProposalType {
@@ -48,7 +48,7 @@ interface IProposalValidator is ISemver {
4848
bytes[] calldatas,
4949
string description,
5050
ProposalType proposalType,
51-
uint8 proposalTypeConfigurator
51+
uint8 proposalVotingModule
5252
);
5353

5454
event ProposalApproved(
@@ -67,7 +67,7 @@ interface IProposalValidator is ISemver {
6767

6868
event DistributionThresholdSet(uint256 newDistributionThreshold);
6969

70-
event ProposalTypeDataSet(ProposalType proposalType, uint256 requiredApprovals, uint8 proposalTypeConfigurator);
70+
event ProposalTypeDataSet(ProposalType proposalType, uint256 requiredApprovals, uint8 proposalVotingModule);
7171

7272
event VotingCycleDataSet(
7373
uint256 cycleNumber,
@@ -144,7 +144,7 @@ interface IProposalValidator is ISemver {
144144

145145
function ATTESTATION_SCHEMA_UID() external view returns (bytes32);
146146

147-
function proposalTypesData(ProposalType) external view returns (uint256 requiredApprovals, uint8 proposalTypeConfigurator);
147+
function proposalTypesData(ProposalType) external view returns (uint256 requiredApprovals, uint8 proposalVotingModule);
148148

149149
function votingCycles(uint256) external view returns (
150150
uint256 startingBlock,

packages/contracts-bedrock/snapshots/abi/ProposalValidator.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
},
169169
{
170170
"internalType": "uint8",
171-
"name": "proposalTypeConfigurator",
171+
"name": "proposalVotingModule",
172172
"type": "uint8"
173173
}
174174
],
@@ -259,7 +259,7 @@
259259
},
260260
{
261261
"internalType": "uint8",
262-
"name": "proposalTypeConfigurator",
262+
"name": "proposalVotingModule",
263263
"type": "uint8"
264264
}
265265
],
@@ -315,7 +315,7 @@
315315
},
316316
{
317317
"internalType": "uint8",
318-
"name": "proposalTypeConfigurator",
318+
"name": "proposalVotingModule",
319319
"type": "uint8"
320320
}
321321
],
@@ -600,7 +600,7 @@
600600
{
601601
"indexed": false,
602602
"internalType": "uint8",
603-
"name": "proposalTypeConfigurator",
603+
"name": "proposalVotingModule",
604604
"type": "uint8"
605605
}
606606
],
@@ -625,7 +625,7 @@
625625
{
626626
"indexed": false,
627627
"internalType": "uint8",
628-
"name": "proposalTypeConfigurator",
628+
"name": "proposalVotingModule",
629629
"type": "uint8"
630630
}
631631
],

packages/contracts-bedrock/snapshots/semver-lock.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@
173173
},
174174
"src/governance/ProposalValidator.sol:ProposalValidator": {
175175
"initCodeHash": "0x44d71e84d08aeb7abc82993a0293f646952d83e439e95427d2c432568f95524e",
176-
"sourceCodeHash": "0xd7d94a765bec0d80cac4bce4e62270a27a830b103dd554d7a4be540a49f8f4d5"
176+
"sourceCodeHash": "0xddf3e6506f0155d0120e467cb1437c49b1eff28d362b8e7de55101cd91e43427"
177177
},
178178
"src/legacy/DeployerWhitelist.sol:DeployerWhitelist": {
179179
"initCodeHash": "0x53099379ed48b87f027d55712dbdd1da7d7099925426eb0531da9c0012e02c29",

packages/contracts-bedrock/src/governance/ProposalValidator.sol

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,12 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
6666
}
6767

6868
/// @notice Struct for storing explicit data for each proposal type.
69-
/// @param requiredApprovals The number of approvals each proposal type requires in order to be able to move for voting.
70-
/// @param proposalTypeConfigurator The voting module each proposal type must use.
69+
/// @param requiredApprovals The number of approvals each proposal type requires in order to be able to move for
70+
/// voting.
71+
/// @param proposalVotingModule The voting module each proposal type must use.
7172
struct ProposalTypeData {
7273
uint256 requiredApprovals;
73-
uint8 proposalTypeConfigurator;
74+
uint8 proposalVotingModule;
7475
}
7576

7677
/// @notice Struct for storing voting cycle data.
@@ -113,7 +114,7 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
113114
/// @param calldatas Function data for proposal calls.
114115
/// @param description Description of the proposal.
115116
/// @param proposalType Type of the proposal.
116-
/// @param proposalTypeConfigurator Configuration value specific to the proposal type.
117+
/// @param proposalVotingModule Voting module specific to the proposal type.
117118
event ProposalSubmitted(
118119
bytes32 indexed proposalHash,
119120
address indexed proposer,
@@ -122,7 +123,7 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
122123
bytes[] calldatas,
123124
string description,
124125
ProposalType proposalType,
125-
uint8 proposalTypeConfigurator
126+
uint8 proposalVotingModule
126127
);
127128

128129
/// @notice Emitted when a delegate approves a proposal.
@@ -155,8 +156,8 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
155156
/// @notice Emitted when the proposal type data is set.
156157
/// @param proposalType The type of proposal.
157158
/// @param requiredApprovals The required number of approvals.
158-
/// @param proposalTypeConfigurator The proposal type configurator.
159-
event ProposalTypeDataSet(ProposalType proposalType, uint256 requiredApprovals, uint8 proposalTypeConfigurator);
159+
/// @param proposalVotingModule The proposal voting module.
160+
event ProposalTypeDataSet(ProposalType proposalType, uint256 requiredApprovals, uint8 proposalVotingModule);
160161

161162
/// @notice The schema UID for attestations in the Ethereum Attestation Service.
162163
/// @dev Schema format: { approvedProposer: address, proposalType: uint8 }
@@ -287,7 +288,7 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
287288
_calldatas,
288289
_description,
289290
_proposalType,
290-
proposalTypeData.proposalTypeConfigurator
291+
proposalTypeData.proposalVotingModule
291292
);
292293
}
293294

@@ -346,7 +347,7 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
346347
proposal.inVoting = true;
347348

348349
governorProposalId_ =
349-
GOVERNOR.propose(_targets, _values, _calldatas, _description, proposalTypeData.proposalTypeConfigurator);
350+
GOVERNOR.propose(_targets, _values, _calldatas, _description, proposalTypeData.proposalVotingModule);
350351

351352
emit ProposalMovedToVote(_proposalHash, msg.sender);
352353
}
@@ -511,7 +512,7 @@ contract ProposalValidator is OwnableUpgradeable, ReinitializableBase, ISemver {
511512
function _setProposalTypeData(ProposalType _proposalType, ProposalTypeData memory _proposalTypeData) private {
512513
proposalTypesData[_proposalType] = _proposalTypeData;
513514
emit ProposalTypeDataSet(
514-
_proposalType, _proposalTypeData.requiredApprovals, _proposalTypeData.proposalTypeConfigurator
515+
_proposalType, _proposalTypeData.requiredApprovals, _proposalTypeData.proposalVotingModule
515516
);
516517
}
517518
}

0 commit comments

Comments
 (0)