upgradeable.patch 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
  2. deleted file mode 100644
  3. index 2797a088..00000000
  4. --- a/.github/ISSUE_TEMPLATE/bug_report.md
  5. +++ /dev/null
  6. @@ -1,21 +0,0 @@
  7. ----
  8. -name: Bug report
  9. -about: Report a bug in OpenZeppelin Contracts
  10. -
  11. ----
  12. -
  13. -<!-- Briefly describe the issue you're experiencing. Tell us what you were trying to do and what happened instead. -->
  14. -
  15. -<!-- Remember, this is not a place to ask for help debugging code. For that, we welcome you in the OpenZeppelin Community Forum: https://forum.openzeppelin.com/. -->
  16. -
  17. -**💻 Environment**
  18. -
  19. -<!-- Tell us what version of OpenZeppelin Contracts you're using, and how you're using it: Truffle, Remix, etc. -->
  20. -
  21. -**📝 Details**
  22. -
  23. -<!-- Describe the problem you have been experiencing in more detail. Include as much information as you think is relevant. Keep in mind that transactions can fail for many reasons; context is key here. -->
  24. -
  25. -**🔢 Code to reproduce bug**
  26. -
  27. -<!-- We will be able to better help if you provide a minimal example that triggers the bug. -->
  28. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
  29. index 4018cef2..d343a53d 100644
  30. --- a/.github/ISSUE_TEMPLATE/config.yml
  31. +++ b/.github/ISSUE_TEMPLATE/config.yml
  32. @@ -1,4 +1,8 @@
  33. +blank_issues_enabled: false
  34. contact_links:
  35. + - name: Bug Reports & Feature Requests
  36. + url: https://github.com/OpenZeppelin/openzeppelin-contracts/issues/new/choose
  37. + about: Visit the OpenZeppelin Contracts repository
  38. - name: Questions & Support Requests
  39. url: https://forum.openzeppelin.com/c/support/contracts/18
  40. about: Ask in the OpenZeppelin Forum
  41. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
  42. deleted file mode 100644
  43. index ff596b0c..00000000
  44. --- a/.github/ISSUE_TEMPLATE/feature_request.md
  45. +++ /dev/null
  46. @@ -1,14 +0,0 @@
  47. ----
  48. -name: Feature request
  49. -about: Suggest an idea for OpenZeppelin Contracts
  50. -
  51. ----
  52. -
  53. -**🧐 Motivation**
  54. -<!-- Is your feature request related to a specific problem? Is it just a crazy idea? Tell us about it! -->
  55. -
  56. -**📝 Details**
  57. -<!-- Please describe your feature request in detail. -->
  58. -
  59. -<!-- Make sure that you have reviewed the OpenZeppelin Contracts Contributor Guidelines. -->
  60. -<!-- https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/CONTRIBUTING.md -->
  61. diff --git a/README.md b/README.md
  62. index 9fc95518..53130e3c 100644
  63. --- a/README.md
  64. +++ b/README.md
  65. @@ -16,17 +16,20 @@
  66. :building_construction: **Want to scale your decentralized application?** Check out [OpenZeppelin Defender](https://openzeppelin.com/defender) — a secure platform for automating and monitoring your operations.
  67. +> **Note**
  68. +> You are looking at the upgradeable variant of OpenZeppelin Contracts. Be sure to review the documentation on [Using OpenZeppelin Contracts with Upgrades](https://docs.openzeppelin.com/contracts/4.x/upgradeable).
  69. +
  70. ## Overview
  71. ### Installation
  72. ```
  73. -$ npm install @openzeppelin/contracts
  74. +$ npm install @openzeppelin/contracts-upgradeable
  75. ```
  76. OpenZeppelin Contracts features a [stable API](https://docs.openzeppelin.com/contracts/releases-stability#api-stability), which means that your contracts won't break unexpectedly when upgrading to a newer minor version.
  77. -An alternative to npm is to use the GitHub repository (`openzeppelin/openzeppelin-contracts`) to retrieve the contracts. When doing this, make sure to specify the tag for a release such as `v4.5.0`, instead of using the `master` branch.
  78. +An alternative to npm is to use the GitHub repository (`openzeppelin/openzeppelin-contracts-upgradeable`) to retrieve the contracts. When doing this, make sure to specify the tag for a release such as `v4.5.0`, instead of using the `master` branch.
  79. ### Usage
  80. @@ -35,10 +38,11 @@ Once installed, you can use the contracts in the library by importing them:
  81. ```solidity
  82. pragma solidity ^0.8.0;
  83. -import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
  84. +import "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
  85. -contract MyCollectible is ERC721 {
  86. - constructor() ERC721("MyCollectible", "MCO") {
  87. +contract MyCollectible is ERC721Upgradeable {
  88. + function initialize() initializer public {
  89. + __ERC721_init("MyCollectible", "MCO");
  90. }
  91. }
  92. ```
  93. diff --git a/contracts/finance/VestingWallet.sol b/contracts/finance/VestingWallet.sol
  94. index fe67eb54..d26ea4e1 100644
  95. --- a/contracts/finance/VestingWallet.sol
  96. +++ b/contracts/finance/VestingWallet.sol
  97. @@ -15,6 +15,8 @@ import "../utils/Context.sol";
  98. * Any token transferred to this contract will follow the vesting schedule as if they were locked from the beginning.
  99. * Consequently, if the vesting has already started, any amount of tokens sent to this contract will (at least partly)
  100. * be immediately releasable.
  101. + *
  102. + * @custom:storage-size 52
  103. */
  104. contract VestingWallet is Context {
  105. event EtherReleased(uint256 amount);
  106. diff --git a/contracts/governance/extensions/GovernorVotes.sol b/contracts/governance/extensions/GovernorVotes.sol
  107. index 64431711..885f0e42 100644
  108. --- a/contracts/governance/extensions/GovernorVotes.sol
  109. +++ b/contracts/governance/extensions/GovernorVotes.sol
  110. @@ -10,6 +10,8 @@ import "../../interfaces/IERC5805.sol";
  111. * @dev Extension of {Governor} for voting weight extraction from an {ERC20Votes} token, or since v4.5 an {ERC721Votes} token.
  112. *
  113. * _Available since v4.3._
  114. + *
  115. + * @custom:storage-size 51
  116. */
  117. abstract contract GovernorVotes is Governor {
  118. IERC5805 public immutable token;
  119. diff --git a/contracts/governance/extensions/GovernorVotesComp.sol b/contracts/governance/extensions/GovernorVotesComp.sol
  120. index 17250ad7..1d26b72e 100644
  121. --- a/contracts/governance/extensions/GovernorVotesComp.sol
  122. +++ b/contracts/governance/extensions/GovernorVotesComp.sol
  123. @@ -10,6 +10,8 @@ import "../../token/ERC20/extensions/ERC20VotesComp.sol";
  124. * @dev Extension of {Governor} for voting weight extraction from a Comp token.
  125. *
  126. * _Available since v4.3._
  127. + *
  128. + * @custom:storage-size 51
  129. */
  130. abstract contract GovernorVotesComp is Governor {
  131. ERC20VotesComp public immutable token;
  132. diff --git a/contracts/package.json b/contracts/package.json
  133. index 55e70b17..ceefb984 100644
  134. --- a/contracts/package.json
  135. +++ b/contracts/package.json
  136. @@ -1,5 +1,5 @@
  137. {
  138. - "name": "@openzeppelin/contracts",
  139. + "name": "@openzeppelin/contracts-upgradeable",
  140. "description": "Secure Smart Contract library for Solidity",
  141. "version": "4.8.2",
  142. "files": [
  143. @@ -13,7 +13,7 @@
  144. },
  145. "repository": {
  146. "type": "git",
  147. - "url": "https://github.com/OpenZeppelin/openzeppelin-contracts.git"
  148. + "url": "https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable.git"
  149. },
  150. "keywords": [
  151. "solidity",
  152. diff --git a/contracts/token/ERC20/extensions/ERC20Capped.sol b/contracts/token/ERC20/extensions/ERC20Capped.sol
  153. index 16f830d1..9ef98148 100644
  154. --- a/contracts/token/ERC20/extensions/ERC20Capped.sol
  155. +++ b/contracts/token/ERC20/extensions/ERC20Capped.sol
  156. @@ -7,6 +7,8 @@ import "../ERC20.sol";
  157. /**
  158. * @dev Extension of {ERC20} that adds a cap to the supply of tokens.
  159. + *
  160. + * @custom:storage-size 51
  161. */
  162. abstract contract ERC20Capped is ERC20 {
  163. uint256 private immutable _cap;
  164. diff --git a/contracts/token/ERC20/extensions/ERC20Permit.sol b/contracts/token/ERC20/extensions/ERC20Permit.sol
  165. index a357199b..9dc8e894 100644
  166. --- a/contracts/token/ERC20/extensions/ERC20Permit.sol
  167. +++ b/contracts/token/ERC20/extensions/ERC20Permit.sol
  168. @@ -18,6 +18,8 @@ import "../../../utils/Counters.sol";
  169. * need to send a transaction, and thus is not required to hold Ether at all.
  170. *
  171. * _Available since v3.4._
  172. + *
  173. + * @custom:storage-size 51
  174. */
  175. abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712 {
  176. using Counters for Counters.Counter;
  177. diff --git a/contracts/token/ERC20/extensions/ERC20Wrapper.sol b/contracts/token/ERC20/extensions/ERC20Wrapper.sol
  178. index bfe782e4..7264fe32 100644
  179. --- a/contracts/token/ERC20/extensions/ERC20Wrapper.sol
  180. +++ b/contracts/token/ERC20/extensions/ERC20Wrapper.sol
  181. @@ -14,6 +14,8 @@ import "../utils/SafeERC20.sol";
  182. * wrapping of an existing "basic" ERC20 into a governance token.
  183. *
  184. * _Available since v4.2._
  185. + *
  186. + * @custom:storage-size 51
  187. */
  188. abstract contract ERC20Wrapper is ERC20 {
  189. IERC20 private immutable _underlying;
  190. diff --git a/contracts/token/ERC20/utils/TokenTimelock.sol b/contracts/token/ERC20/utils/TokenTimelock.sol
  191. index ed855b7b..3d30f59d 100644
  192. --- a/contracts/token/ERC20/utils/TokenTimelock.sol
  193. +++ b/contracts/token/ERC20/utils/TokenTimelock.sol
  194. @@ -11,6 +11,8 @@ import "./SafeERC20.sol";
  195. *
  196. * Useful for simple vesting schedules like "advisors get all of their tokens
  197. * after 1 year".
  198. + *
  199. + * @custom:storage-size 53
  200. */
  201. contract TokenTimelock {
  202. using SafeERC20 for IERC20;
  203. diff --git a/contracts/utils/cryptography/EIP712.sol b/contracts/utils/cryptography/EIP712.sol
  204. index 6a4e1cad..55d8eced 100644
  205. --- a/contracts/utils/cryptography/EIP712.sol
  206. +++ b/contracts/utils/cryptography/EIP712.sol
  207. @@ -4,7 +4,6 @@
  208. pragma solidity ^0.8.8;
  209. import "./ECDSA.sol";
  210. -import "../ShortStrings.sol";
  211. import "../../interfaces/IERC5267.sol";
  212. /**
  213. @@ -30,27 +29,19 @@ import "../../interfaces/IERC5267.sol";
  214. *
  215. * _Available since v3.4._
  216. *
  217. - * @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
  218. + * @custom:storage-size 52
  219. */
  220. abstract contract EIP712 is IERC5267 {
  221. - using ShortStrings for *;
  222. -
  223. bytes32 private constant _TYPE_HASH =
  224. keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
  225. - // Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
  226. - // invalidate the cached domain separator if the chain id changes.
  227. - bytes32 private immutable _cachedDomainSeparator;
  228. - uint256 private immutable _cachedChainId;
  229. - address private immutable _cachedThis;
  230. -
  231. + /// @custom:oz-renamed-from _HASHED_NAME
  232. bytes32 private immutable _hashedName;
  233. + /// @custom:oz-renamed-from _HASHED_VERSION
  234. bytes32 private immutable _hashedVersion;
  235. - ShortString private immutable _name;
  236. - ShortString private immutable _version;
  237. - string private _nameFallback;
  238. - string private _versionFallback;
  239. + string private _name;
  240. + string private _version;
  241. /**
  242. * @dev Initializes the domain separator and parameter caches.
  243. @@ -65,29 +56,23 @@ abstract contract EIP712 is IERC5267 {
  244. * contract upgrade].
  245. */
  246. constructor(string memory name, string memory version) {
  247. - _name = name.toShortStringWithFallback(_nameFallback);
  248. - _version = version.toShortStringWithFallback(_versionFallback);
  249. - _hashedName = keccak256(bytes(name));
  250. - _hashedVersion = keccak256(bytes(version));
  251. -
  252. - _cachedChainId = block.chainid;
  253. - _cachedDomainSeparator = _buildDomainSeparator();
  254. - _cachedThis = address(this);
  255. + _name = name;
  256. + _version = version;
  257. +
  258. + // Reset prior values in storage if upgrading
  259. + _hashedName = 0;
  260. + _hashedVersion = 0;
  261. }
  262. /**
  263. * @dev Returns the domain separator for the current chain.
  264. */
  265. function _domainSeparatorV4() internal view returns (bytes32) {
  266. - if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
  267. - return _cachedDomainSeparator;
  268. - } else {
  269. - return _buildDomainSeparator();
  270. - }
  271. + return _buildDomainSeparator();
  272. }
  273. function _buildDomainSeparator() private view returns (bytes32) {
  274. - return keccak256(abi.encode(_TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
  275. + return keccak256(abi.encode(_TYPE_HASH, _EIP712NameHash(), _EIP712VersionHash(), block.chainid, address(this)));
  276. }
  277. /**
  278. @@ -129,14 +114,80 @@ abstract contract EIP712 is IERC5267 {
  279. uint256[] memory extensions
  280. )
  281. {
  282. + // If the hashed name and version in storage are non-zero, the contract hasn't been properly initialized
  283. + // and the EIP712 domain is not reliable, as it will be missing name and version.
  284. + require(_hashedName == 0 && _hashedVersion == 0, "EIP712: Uninitialized");
  285. +
  286. return (
  287. hex"0f", // 01111
  288. - _name.toStringWithFallback(_nameFallback),
  289. - _version.toStringWithFallback(_versionFallback),
  290. + _EIP712Name(),
  291. + _EIP712Version(),
  292. block.chainid,
  293. address(this),
  294. bytes32(0),
  295. new uint256[](0)
  296. );
  297. }
  298. +
  299. + /**
  300. + * @dev The name parameter for the EIP712 domain.
  301. + *
  302. + * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
  303. + * are a concern.
  304. + */
  305. + function _EIP712Name() internal virtual view returns (string memory) {
  306. + return _name;
  307. + }
  308. +
  309. + /**
  310. + * @dev The version parameter for the EIP712 domain.
  311. + *
  312. + * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
  313. + * are a concern.
  314. + */
  315. + function _EIP712Version() internal virtual view returns (string memory) {
  316. + return _version;
  317. + }
  318. +
  319. + /**
  320. + * @dev The hash of the name parameter for the EIP712 domain.
  321. + *
  322. + * NOTE: In previous versions this function was virtual. In this version you should override `_EIP712Name` instead.
  323. + */
  324. + function _EIP712NameHash() internal view returns (bytes32) {
  325. + string memory name = _EIP712Name();
  326. + if (bytes(name).length > 0) {
  327. + return keccak256(bytes(name));
  328. + } else {
  329. + // If the name is empty, the contract may have been upgraded without initializing the new storage.
  330. + // We return the name hash in storage if non-zero, otherwise we assume the name is empty by design.
  331. + bytes32 hashedName = _hashedName;
  332. + if (hashedName != 0) {
  333. + return hashedName;
  334. + } else {
  335. + return keccak256("");
  336. + }
  337. + }
  338. + }
  339. +
  340. + /**
  341. + * @dev The hash of the version parameter for the EIP712 domain.
  342. + *
  343. + * NOTE: In previous versions this function was virtual. In this version you should override `_EIP712Version` instead.
  344. + */
  345. + function _EIP712VersionHash() internal view returns (bytes32) {
  346. + string memory version = _EIP712Version();
  347. + if (bytes(version).length > 0) {
  348. + return keccak256(bytes(version));
  349. + } else {
  350. + // If the version is empty, the contract may have been upgraded without initializing the new storage.
  351. + // We return the version hash in storage if non-zero, otherwise we assume the version is empty by design.
  352. + bytes32 hashedVersion = _hashedVersion;
  353. + if (hashedVersion != 0) {
  354. + return hashedVersion;
  355. + } else {
  356. + return keccak256("");
  357. + }
  358. + }
  359. + }
  360. }
  361. diff --git a/package.json b/package.json
  362. index 8458dd61..b4672240 100644
  363. --- a/package.json
  364. +++ b/package.json
  365. @@ -36,7 +36,7 @@
  366. },
  367. "repository": {
  368. "type": "git",
  369. - "url": "https://github.com/OpenZeppelin/openzeppelin-contracts.git"
  370. + "url": "https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable.git"
  371. },
  372. "keywords": [
  373. "solidity",
  374. diff --git a/test/utils/cryptography/EIP712.test.js b/test/utils/cryptography/EIP712.test.js
  375. index 54a4e772..ba4602ed 100644
  376. --- a/test/utils/cryptography/EIP712.test.js
  377. +++ b/test/utils/cryptography/EIP712.test.js
  378. @@ -47,26 +47,6 @@ contract('EIP712', function (accounts) {
  379. const rebuildDomain = await getDomain(this.eip712);
  380. expect(mapValues(rebuildDomain, String)).to.be.deep.equal(mapValues(this.domain, String));
  381. });
  382. -
  383. - if (shortOrLong === 'short') {
  384. - // Long strings are in storage, and the proxy will not be properly initialized unless
  385. - // the upgradeable contract variant is used and the initializer is invoked.
  386. -
  387. - it('adjusts when behind proxy', async function () {
  388. - const factory = await Clones.new();
  389. - const cloneReceipt = await factory.$clone(this.eip712.address);
  390. - const cloneAddress = cloneReceipt.logs.find(({ event }) => event === 'return$clone').args.instance;
  391. - const clone = new EIP712Verifier(cloneAddress);
  392. -
  393. - const cloneDomain = { ...this.domain, verifyingContract: clone.address };
  394. -
  395. - const reportedDomain = await getDomain(clone);
  396. - expect(mapValues(reportedDomain, String)).to.be.deep.equal(mapValues(cloneDomain, String));
  397. -
  398. - const expectedSeparator = await domainSeparator(cloneDomain);
  399. - expect(await clone.$_domainSeparatorV4()).to.equal(expectedSeparator);
  400. - });
  401. - }
  402. });
  403. it('hash digest', async function () {