Skip to content

Commit

Permalink
Simplify Changelog description and include instructions for resolving…
Browse files Browse the repository at this point in the history
… breaking changes
  • Loading branch information
apbendi committed Feb 15, 2022
1 parent 5a905ad commit 3e27efd
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions CHANGELOG.md
Expand Up @@ -5,17 +5,13 @@
* `AccessControl`: add a virtual `_checkRole(bytes32)` function that can be overridden to alter the `onlyRole` modifier behavior. ([#3137](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3137))
* `EnumerableMap`: add new `AddressToUintMap` map type. ([#3150](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3150))
* `ERC1155`: Add a `_afterTokenTransfer` hook for improved extensibility. ([#3166](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3166))
* `IGovernor`: Add two new methods to the interface, `castVoteWithReasonAndParams` and `castVoteWithReasonAndParamsBySig`, allowing voting extensions to include more data about how the vote is to be interpreted. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `IGovernor`: Add a new event `VoteCastWithParams` that is emitted when a vote is cast that includes non-empty params data. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Add internal `_defaultParams` method and default implementation. The return value is passed as params data when `castVote` methods without params are called. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Add default `getVotes` implementation which calls virtual internal `_getVotes` method. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Add `EXTENDED_BALLOT_TYPEHASH` used for signature validation in `castVoteWithReasonAndParamsBySig`. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Add a way to parameterize votes. This can be used to implement voting systems such as fractionalized voting, ERC721 based voting, or any number of other systems. The `params` argument added to `_countVote` method, and included in the newly added `_getVotes` method, can be used by counting and voting modules respectively for such purposes.

### Breaking changes

* `Governor`: Adds internal virtual `_getVotes` method that must be implemented; this is a breaking change for existing concrete extensions to `Governor`. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Adds `params` parameter to internal virtual `_countVote ` method that; this is a breaking change for existing concrete extensions to `Governor`. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Does not emit `VoteCast` event when params data is non-empty; instead emits `VoteCastWithParams` event. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Adds internal virtual `_getVotes` method that must be implemented; this is a breaking change for existing concrete extensions to `Governor`. To fix this on an existing voting module extension, rename `getVotes` to `_getVotes` and add a `bytes memory` argument. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Adds `params` parameter to internal virtual `_countVote ` method; this is a breaking change for existing concrete extensions to `Governor`. To fix this on an existing counting module extension, add a `bytes memory` argument to `_countVote`. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))
* `Governor`: Does not emit `VoteCast` event when params data is non-empty; instead emits `VoteCastWithParams` event. To fix this on an integration that consumes the `VoteCast` event, also fetch/monitor `VoteCastWithParams` events. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))

## 4.5.0 (2022-02-09)

Expand Down

0 comments on commit 3e27efd

Please sign in to comment.