From 52c36d412e8681053975396223d0ea39687fe33b Mon Sep 17 00:00:00 2001 From: Eric Lau Date: Fri, 3 May 2024 09:27:03 -0400 Subject: [PATCH] Fix `UPGRADE_INTERFACE_VERSION` documentation in `ProxyAdmin` (#5031) --- .changeset/chilly-humans-warn.md | 5 +++++ contracts/proxy/transparent/ProxyAdmin.sol | 8 ++++---- 2 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 .changeset/chilly-humans-warn.md diff --git a/.changeset/chilly-humans-warn.md b/.changeset/chilly-humans-warn.md new file mode 100644 index 000000000..1301dfec4 --- /dev/null +++ b/.changeset/chilly-humans-warn.md @@ -0,0 +1,5 @@ +--- +'openzeppelin-solidity': patch +--- + +`ProxyAdmin`: Fixed documentation for `UPGRADE_INTERFACE_VERSION` getter. diff --git a/contracts/proxy/transparent/ProxyAdmin.sol b/contracts/proxy/transparent/ProxyAdmin.sol index dab55ef2a..7fbdca6fd 100644 --- a/contracts/proxy/transparent/ProxyAdmin.sol +++ b/contracts/proxy/transparent/ProxyAdmin.sol @@ -12,10 +12,10 @@ import {Ownable} from "../../access/Ownable.sol"; */ contract ProxyAdmin is Ownable { /** - * @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgrade(address)` - * and `upgradeAndCall(address,bytes)` are present, and `upgradeTo` must be used if no function should be called, - * while `upgradeAndCall` will invoke the `receive` function if the second argument is the empty byte string. - * If the getter returns `"5.0.0"`, only `upgradeAndCall(address,bytes)` is present, and the second argument must + * @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgrade(address,address)` + * and `upgradeAndCall(address,address,bytes)` are present, and `upgrade` must be used if no function should be called, + * while `upgradeAndCall` will invoke the `receive` function if the third argument is the empty byte string. + * If the getter returns `"5.0.0"`, only `upgradeAndCall(address,address,bytes)` is present, and the third argument must * be the empty byte string if no function should be called, making it impossible to invoke the `receive` function * during an upgrade. */