Browse Source

Clarify Governor events' lack of indexed parameters (#5175)

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Ernesto García 1 year ago
parent
commit
55d69573fc
1 changed files with 3 additions and 0 deletions
  1. 3 0
      contracts/governance/IGovernor.sol

+ 3 - 0
contracts/governance/IGovernor.sol

@@ -8,6 +8,9 @@ import {IERC6372} from "../interfaces/IERC6372.sol";
 
 
 /**
 /**
  * @dev Interface of the {Governor} core.
  * @dev Interface of the {Governor} core.
+ *
+ * NOTE: Event parameters lack the `indexed` keyword for compatibility with GovernorBravo events.
+ * Making event parameters `indexed` affects how events are decoded, potentially breaking existing indexers.
  */
  */
 interface IGovernor is IERC165, IERC6372 {
 interface IGovernor is IERC165, IERC6372 {
     enum ProposalState {
     enum ProposalState {