Skip to content

Commit f4c5ce3

Browse files
frangionventuro
authored andcommitted
Add section on how to upgrade from 2.4-beta (#1981)
* add how to upgrade from 2.4-beta * add how-to * Update CHANGELOG.md
1 parent 5b2de26 commit f4c5ce3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,22 @@
3232
* `Address` now requires a minimum Solidity compiler version of 0.5.5. ([#1802](https://github.com/OpenZeppelin/openzeppelin-solidity/pull/1802))
3333
* `SignatureBouncer` has been removed from drafts, both to avoid confusions with the GSN and `GSNRecipientSignature` (previously called `GSNBouncerSignature`) and because the API was not very clear. ([#1879](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/1879))
3434

35+
### How to upgrade from 2.4.0-beta
36+
37+
The final 2.4.0 release includes a refactor of the GSN contracts that will be a breaking change for 2.4.0-beta users.
38+
39+
* The default empty implementations of `_preRelayedCall` and `_postRelayedCall` were removed and must now be explicitly implemented always in custom recipients. If your custom recipient didn't include an implementation, you can provide an empty one.
40+
* `GSNRecipient`, `GSNBouncerBase`, and `GSNContext` were all merged into `GSNRecipient`.
41+
* `GSNBouncerSignature` and `GSNBouncerERC20Fee` were renamed to `GSNRecipientSignature` and `GSNRecipientERC20Fee`.
42+
* It is no longer necessary to inherit from `GSNRecipient` when using `GSNRecipientSignature` and `GSNRecipientERC20Fee`.
43+
44+
Refer to the table below to adjust your import statements.
45+
46+
| 2.4.0-beta | 2.4.0 |
47+
| ---------------------------------- | ---------------------------- |
48+
| `GSNRecipient, GSNBouncerSignature`| `GSNRecipientSignature` |
49+
| `GSNRecipient, GSNBouncerERC20Fee` | `GSNRecipientERC20Fee` |
50+
3551
## 2.3.0 (2019-05-27)
3652

3753
### New features:

0 commit comments

Comments
 (0)