Use oz-upgrades-unsafe-allow-reachable, update snapshots

Author: ericglau

packages/core/solidity/src/account.test.ts.md

@@ -4,7 +4,7 @@ import { defineFunctions } from './utils/define-functions';
 import { printContract } from './print';
 import { defaults as commonDefaults, withCommonDefaults, type CommonOptions } from './common-options';
 import { setInfo } from './set-info';
-import { addSigner, signerArgs, signerFunctions, signers, type SignerOptions } from './signer';
+import { addLockingConstructorAllowReachable, addSigner, signerArgs, signerFunctions, signers, type SignerOptions } from './signer';
 import { setUpgradeableAccount } from './set-upgradeable';
 
 export const defaults: Required<AccountOptions> = {
@@ -184,8 +184,7 @@ function addERC7579Modules(c: ContractBuilder, opts: AccountOptions): void {
 function addSignerInitializer(c: ContractBuilder, opts: AccountOptions): void {
   if (opts.upgradeable) {
     if (!opts.signer) {
-      c.addConstructorComment('/// @custom:oz-upgrades-unsafe-allow constructor');
-      c.addConstructorCode(`_disableInitializers();`);
+      addLockingConstructorAllowReachable(c);
     }
     return; // Initializer added in signer.ts
   }
@@ -196,11 +195,10 @@ function addSignerInitializer(c: ContractBuilder, opts: AccountOptions): void {
     path: `@openzeppelin/${opts.upgradeable ? 'contracts-upgradeable' : 'contracts'}/proxy/utils/Initializable.sol`,
   });
 
-  // Add locking constructor
-  c.addConstructorComment('/// @custom:oz-upgrades-unsafe-allow constructor');
-  c.addConstructorCode('// Accounts are typically deployed and initialized as clones during their first user op,');
-  c.addConstructorCode('// therefore, initializers are disabled for the implementation contract');
-  c.addConstructorCode(`_disableInitializers();`);
+  addLockingConstructorAllowReachable(c, [
+    '// Accounts are typically deployed and initialized as clones during their first user op,',
+    '// therefore, initializers are disabled for the implementation contract'
+  ]);
 
   const fn = { name: 'initialize', kind: 'public' as const, args: signerArgs[opts.signer] };
   c.addModifier('initializer', fn);

packages/core/solidity/src/account.test.ts.snap

@@ -35,9 +35,7 @@ export function addSigner(c: ContractBuilder, signer: SignerOptions, upgradeable
           name: 'Initializable',
           path: '@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol',
         });
-        // Add locking constructor
-        c.addConstructorComment('/// @custom:oz-upgrades-unsafe-allow constructor');
-        c.addConstructorCode(`_disableInitializers();`);
+        addLockingConstructorAllowReachable(c);
 
         const fn = { name: 'initialize', kind: 'public' as const, args: signerArgs[signer] };
         c.addModifier('initializer', fn);
@@ -61,6 +59,19 @@ export function addSigner(c: ContractBuilder, signer: SignerOptions, upgradeable
   }
 }
 
+/**
+ * Adds a locking constructor that disables initializers and annotates it to allow reachable constructors during Upgrades Plugins validations,
+ * which includes constructors in parent contracts.
+ *
+ * @param c The contract builder.
+ * @param bodyComments Optional comments to add to the constructor body, before disabling initializers.
+ */
+export function addLockingConstructorAllowReachable(c: ContractBuilder, bodyComments?: string[]): void {
+  c.addConstructorComment('/// @custom:oz-upgrades-unsafe-allow-reachable constructor');
+  bodyComments?.forEach(comment => c.addConstructorCode(comment));
+  c.addConstructorCode(`_disableInitializers();`);
+}
+
 export const signers = {
   ERC7702: {
     name: 'SignerERC7702',

packages/core/solidity/src/account.ts

@@ -1273,9 +1273,11 @@ Generated by [AVA](https://avajs.dev).
       import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";␊
       import {SignerECDSA} from "@openzeppelin/contracts/utils/cryptography/signers/SignerECDSA.sol";␊
       ␊
-      /// @custom:oz-upgrades-unsafe-allow constructor␊
       contract MyAccount is Initializable, Account, EIP712, ERC7739, SignerECDSA, ERC721Holder, ERC1155Holder {␊
+          /// @custom:oz-upgrades-unsafe-allow-reachable constructor␊
           constructor(address signer) EIP712("My Account", "1") SignerECDSA(signer) {␊
+              // Accounts are typically deployed and initialized as clones during their first user op,␊
+              // therefore, initializers are disabled for the implementation contract␊
               _disableInitializers();␊
           }␊
       ␊
@@ -1429,8 +1431,8 @@ Generated by [AVA](https://avajs.dev).
       import {SignerECDSAUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/cryptography/signers/SignerECDSAUpgradeable.sol";␊
       import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
       ␊
-      /// @custom:oz-upgrades-unsafe-allow constructor␊
       contract MyAccount is Initializable, Account, EIP712, ERC7739, SignerECDSAUpgradeable, ERC721Holder, ERC1155Holder, UUPSUpgradeable {␊
+          /// @custom:oz-upgrades-unsafe-allow-reachable constructor␊
           constructor() EIP712("My Account", "1") {␊
               _disableInitializers();␊
           }␊

packages/core/solidity/src/signer.ts

@@ -503,7 +503,7 @@ Generated by [AVA](https://avajs.dev).
       import {SignerECDSA} from "@openzeppelin/contracts/utils/cryptography/signers/SignerECDSA.sol";␊
       ␊
       contract MyAccount is Initializable, Account, EIP712, ERC7739, SignerECDSA, ERC721Holder, ERC1155Holder {␊
-          /// @custom:oz-upgrades-unsafe-allow constructor␊
+          /// @custom:oz-upgrades-unsafe-allow-reachable constructor␊
           constructor(address signer) EIP712("My Account", "1") SignerECDSA(signer) {␊
               // Accounts are typically deployed and initialized as clones during their first user op,␊
               // therefore, initializers are disabled for the implementation contract␊
@@ -593,7 +593,7 @@ Generated by [AVA](https://avajs.dev).
       import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
       ␊
       contract MyAccount is Initializable, Account, EIP712, ERC7739, SignerECDSAUpgradeable, ERC721Holder, ERC1155Holder, UUPSUpgradeable {␊
-          /// @custom:oz-upgrades-unsafe-allow constructor␊
+          /// @custom:oz-upgrades-unsafe-allow-reachable constructor␊
           constructor() EIP712("My Account", "1") {␊
               _disableInitializers();␊
           }␊