Skip to content

Commit 52c36d4

Browse files
authored
Fix UPGRADE_INTERFACE_VERSION documentation in ProxyAdmin (#5031)
1 parent c80b675 commit 52c36d4

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.changeset/chilly-humans-warn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'openzeppelin-solidity': patch
3+
---
4+
5+
`ProxyAdmin`: Fixed documentation for `UPGRADE_INTERFACE_VERSION` getter.

contracts/proxy/transparent/ProxyAdmin.sol

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ import {Ownable} from "../../access/Ownable.sol";
1212
*/
1313
contract ProxyAdmin is Ownable {
1414
/**
15-
* @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgrade(address)`
16-
* and `upgradeAndCall(address,bytes)` are present, and `upgradeTo` must be used if no function should be called,
17-
* while `upgradeAndCall` will invoke the `receive` function if the second argument is the empty byte string.
18-
* If the getter returns `"5.0.0"`, only `upgradeAndCall(address,bytes)` is present, and the second argument must
15+
* @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgrade(address,address)`
16+
* and `upgradeAndCall(address,address,bytes)` are present, and `upgrade` must be used if no function should be called,
17+
* while `upgradeAndCall` will invoke the `receive` function if the third argument is the empty byte string.
18+
* If the getter returns `"5.0.0"`, only `upgradeAndCall(address,address,bytes)` is present, and the third argument must
1919
* be the empty byte string if no function should be called, making it impossible to invoke the `receive` function
2020
* during an upgrade.
2121
*/

0 commit comments

Comments
 (0)