@openzeppelin/wizard 0.5.6 → 0.7.0

package/src/environments/hardhat/upgradeable/package.json

@@ -9,10 +9,10 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@openzeppelin/contracts": "^5.0.0",
-    "@openzeppelin/contracts-upgradeable": "^5.0.0",
+    "@openzeppelin/contracts": "^5.4.0",
+    "@openzeppelin/contracts-upgradeable": "^5.4.0",
     "@openzeppelin/hardhat-upgrades": "^3.0.0",
-    "@nomicfoundation/hardhat-toolbox": "^5.0.0",
+    "@nomicfoundation/hardhat-toolbox": "^6.1.0",
     "hardhat": "^2.16.1"
   }
 }

package/src/erc20.ts

@@ -5,7 +5,6 @@ import { addPauseFunctions } from './add-pausable';
 import { defineFunctions } from './utils/define-functions';
 import type { CommonOptions } from './common-options';
 import { withCommonDefaults, defaults as commonDefaults } from './common-options';
-import type { Upgradeable } from './set-upgradeable';
 import { setUpgradeable } from './set-upgradeable';
 import { setInfo } from './set-info';
 import { printContract } from './print';
@@ -90,7 +89,7 @@ export function buildERC20(opts: ERC20Options): ContractBuilder {
   addBase(c, allOpts.name, allOpts.symbol);
 
   if (allOpts.crossChainBridging) {
-    addCrossChainBridging(c, allOpts.crossChainBridging, allOpts.upgradeable, access);
+    addCrossChainBridging(c, allOpts.crossChainBridging, access);
   }
 
   if (allOpts.premint) {
@@ -305,26 +304,15 @@ function addFlashMint(c: ContractBuilder) {
   });
 }
 
-function addCrossChainBridging(
-  c: ContractBuilder,
-  crossChainBridging: 'custom' | 'superchain',
-  upgradeable: Upgradeable,
-  access: Access,
-) {
+function addCrossChainBridging(c: ContractBuilder, crossChainBridging: 'custom' | 'superchain', access: Access) {
   const ERC20Bridgeable = {
     name: 'ERC20Bridgeable',
-    path: `@openzeppelin/community-contracts/token/ERC20/extensions/ERC20Bridgeable.sol`,
+    path: `@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Bridgeable.sol`,
   };
 
   c.addParent(ERC20Bridgeable);
   c.addOverride(ERC20Bridgeable, supportsInterface);
 
-  if (upgradeable) {
-    throw new OptionsError({
-      crossChainBridging: 'Upgradeability is not currently supported with Cross-Chain Bridging',
-    });
-  }
-
   c.addOverride(ERC20Bridgeable, functions._checkTokenBridge);
   switch (crossChainBridging) {
     case 'custom':
@@ -345,13 +333,13 @@ function addCustomBridging(c: ContractBuilder, access: Access) {
   switch (access) {
     case false:
     case 'ownable': {
-      const addedBridgeImmutable = c.addVariable(`address public immutable TOKEN_BRIDGE;`);
+      const addedBridgeImmutable = c.addVariable(`address public tokenBridge;`);
       if (addedBridgeImmutable) {
-        c.addConstructorArgument({ type: 'address', name: 'tokenBridge' });
-        c.addConstructorCode(`require(tokenBridge != address(0), "Invalid TOKEN_BRIDGE address");`);
-        c.addConstructorCode(`TOKEN_BRIDGE = tokenBridge;`);
+        c.addConstructorArgument({ type: 'address', name: 'tokenBridge_' });
+        c.addConstructorCode(`require(tokenBridge_ != address(0), "Invalid tokenBridge_ address");`);
+        c.addConstructorCode(`tokenBridge = tokenBridge_;`);
       }
-      c.setFunctionBody([`if (caller != TOKEN_BRIDGE) revert Unauthorized();`], functions._checkTokenBridge, 'view');
+      c.setFunctionBody([`if (caller != tokenBridge) revert Unauthorized();`], functions._checkTokenBridge, 'view');
       break;
     }
     case 'roles': {

package/src/governor.ts

@@ -4,7 +4,6 @@ import { withCommonDefaults, defaults as commonDefaults } from './common-options
 import type { Contract, ImportContract } from './contract';
 import { ContractBuilder } from './contract';
 import { OptionsError } from './error';
-import { setAccessControl } from './set-access-control';
 import { printContract } from './print';
 import { setInfo } from './set-info';
 import { setUpgradeableGovernor } from './set-upgradeable';
@@ -13,6 +12,7 @@ import { durationToBlocks, durationToTimestamp } from './utils/duration';
 import { clockModeDefault, type ClockMode } from './set-clock-mode';
 
 export const defaults: Required<GovernorOptions> = {
+  ...commonDefaults,
   name: 'MyGovernor',
   delay: '1 day',
   period: '1 week',
@@ -28,10 +28,6 @@ export const defaults: Required<GovernorOptions> = {
   quorumAbsolute: '',
   storage: false,
   settings: true,
-
-  access: commonDefaults.access,
-  upgradeable: commonDefaults.upgradeable,
-  info: commonDefaults.info,
 } as const;
 
 export const votesOptions = ['erc20votes', 'erc721votes'] as const;
@@ -98,7 +94,6 @@ export function buildGovernor(opts: GovernorOptions): Contract {
   addQuorum(c, allOpts);
   addTimelock(c, allOpts);
 
-  setAccessControl(c, allOpts.access);
   setUpgradeableGovernor(c, allOpts.upgradeable);
   setInfo(c, allOpts.info);
 

package/src/index.ts

@@ -22,3 +22,11 @@ export { sanitizeKind } from './kind';
 export { erc20, erc721, erc1155, stablecoin, realWorldAsset, account, governor, custom } from './api';
 
 export { compatibleContractsSemver } from './utils/version';
+
+export type { ERC20Options } from './erc20';
+export type { ERC721Options } from './erc721';
+export type { ERC1155Options } from './erc1155';
+export type { StablecoinOptions } from './stablecoin';
+export type { AccountOptions } from './account';
+export type { GovernorOptions } from './governor';
+export type { CustomOptions } from './custom';

package/src/signer.ts

@@ -6,11 +6,10 @@ export type SignerOptions = (typeof SignerOptions)[number];
 
 export function addSigner(c: ContractBuilder, signer: SignerOptions): void {
   if (!signer) return;
-  const parent = signers[signer];
-  const name = parent.name;
-  c.addParent(parent);
+
+  c.addParent(signers[signer]);
   c.addOverride(
-    { name: name === signers.MultisigWeighted.name ? signers.Multisig.name : name },
+    { name: signer === 'MultisigWeighted' ? signers.Multisig.name : signers[signer].name },
     signerFunctions._rawSignatureValidation,
   );
 
@@ -21,31 +20,29 @@ export function addSigner(c: ContractBuilder, signer: SignerOptions): void {
     name: 'Initializable',
     path: '@openzeppelin/contracts/proxy/utils/Initializable.sol',
   });
+
+  // Add locking constructor
+  c.addNatspecTag('@custom:oz-upgrades-unsafe-allow', 'constructor');
+  c.addConstructorCode(`_disableInitializers();`);
+
+  // Add initializer
   const fn = signerFunctions[`initialize${signer}`];
   c.addModifier('initializer', fn);
 
-  const args = fn.args;
-
   switch (signer) {
     case 'Multisig':
-      c.addFunctionCode(`_addSigners(${args[0]!.name});`, fn);
-      c.addFunctionCode(`_setThreshold(${args[1]!.name});`, fn);
+      c.addFunctionCode(`_addSigners(${fn.args[0]!.name});`, fn);
+      c.addFunctionCode(`_setThreshold(${fn.args[1]!.name});`, fn);
       break;
     case 'MultisigWeighted':
-      c.addFunctionCode(`_addSigners(${args[0]!.name});`, fn);
-      c.addFunctionCode(`_setSignerWeights(${args[0]!.name}, ${args[1]!.name});`, fn);
-      c.addFunctionCode(`_setThreshold(${args[2]!.name});`, fn);
+      c.addFunctionCode(`_addSigners(${fn.args[0]!.name});`, fn);
+      c.addFunctionCode(`_setSignerWeights(${fn.args[0]!.name}, ${fn.args[1]!.name});`, fn);
+      c.addFunctionCode(`_setThreshold(${fn.args[2]!.name});`, fn);
       break;
     case 'ECDSA':
     case 'P256':
     case 'RSA':
-      c.addFunctionCode(
-        `_setSigner(${fn.args
-          .map(({ name }) => name)
-          .join(', ')
-          .trimEnd()});`,
-        fn,
-      );
+      c.addFunctionCode(`_setSigner(${fn.args.map(({ name }) => name).join(', ')});`, fn);
   }
 }
 
@@ -76,49 +73,47 @@ export const signers = {
   },
 };
 
-export const signerFunctions = {
-  ...defineFunctions({
-    initializeECDSA: {
-      kind: 'public' as const,
-      args: [{ name: 'signer', type: 'address' }],
-    },
-    initializeP256: {
-      kind: 'public' as const,
-      args: [
-        { name: 'qx', type: 'bytes32' },
-        { name: 'qy', type: 'bytes32' },
-      ],
-    },
-    initializeRSA: {
-      kind: 'public' as const,
-      args: [
-        { name: 'e', type: 'bytes memory' },
-        { name: 'n', type: 'bytes memory' },
-      ],
-    },
-    initializeMultisig: {
-      kind: 'public' as const,
-      args: [
-        { name: 'signers', type: 'bytes[] memory' },
-        { name: 'threshold', type: 'uint256' },
-      ],
-    },
-    initializeMultisigWeighted: {
-      kind: 'public' as const,
-      args: [
-        { name: 'signers', type: 'bytes[] memory' },
-        { name: 'weights', type: 'uint256[] memory' },
-        { name: 'threshold', type: 'uint256' },
-      ],
-    },
-    _rawSignatureValidation: {
-      kind: 'internal' as const,
-      args: [
-        { name: 'hash', type: 'bytes32' },
-        { name: 'signature', type: 'bytes calldata' },
-      ],
-      returns: ['bool'],
-      mutability: 'view' as const,
-    },
-  }),
-};
+export const signerFunctions = defineFunctions({
+  initializeECDSA: {
+    kind: 'public' as const,
+    args: [{ name: 'signer', type: 'address' }],
+  },
+  initializeP256: {
+    kind: 'public' as const,
+    args: [
+      { name: 'qx', type: 'bytes32' },
+      { name: 'qy', type: 'bytes32' },
+    ],
+  },
+  initializeRSA: {
+    kind: 'public' as const,
+    args: [
+      { name: 'e', type: 'bytes memory' },
+      { name: 'n', type: 'bytes memory' },
+    ],
+  },
+  initializeMultisig: {
+    kind: 'public' as const,
+    args: [
+      { name: 'signers', type: 'bytes[] memory' },
+      { name: 'threshold', type: 'uint256' },
+    ],
+  },
+  initializeMultisigWeighted: {
+    kind: 'public' as const,
+    args: [
+      { name: 'signers', type: 'bytes[] memory' },
+      { name: 'weights', type: 'uint256[] memory' },
+      { name: 'threshold', type: 'uint256' },
+    ],
+  },
+  _rawSignatureValidation: {
+    kind: 'internal' as const,
+    args: [
+      { name: 'hash', type: 'bytes32' },
+      { name: 'signature', type: 'bytes calldata' },
+    ],
+    returns: ['bool'],
+    mutability: 'view' as const,
+  },
+});

package/src/utils/version.ts

@@ -1,4 +1,4 @@
 /**
  * Semantic version string representing of the minimum compatible version of Contracts to display in output.
  */
-export const compatibleContractsSemver = '^5.0.0';
+export const compatibleContractsSemver = '^5.4.0';

package/src/zip-hardhat.ts

@@ -147,10 +147,28 @@ main().catch((error) => {
 `;
 };
 
-const readme = `\
+const lowerFirstCharacter = (str: string) => str.charAt(0).toLowerCase() + str.slice(1);
+
+const ignitionModule = (c: Contract) => {
+  const deployArguments = getAddressArgs(c);
+  const contractVariableName = lowerFirstCharacter(c.name);
+
+  return `import { buildModule } from "@nomicfoundation/hardhat-ignition/modules";
+
+export default buildModule("${c.name}Module", (m) => {
+
+  ${deployArguments.length > 0 ? '// TODO: Set addresses for the contract arguments below' : ''}
+  const ${contractVariableName} = m.contract("${c.name}", [${deployArguments.join(', ')}]);
+
+  return { ${contractVariableName} };
+});
+`;
+};
+
+const readme = (c: Contract) => `\
 # Sample Hardhat Project
 
-This project demonstrates a basic Hardhat use case. It comes with a contract generated by [OpenZeppelin Wizard](https://wizard.openzeppelin.com/), a test for that contract, and a script that deploys that contract.
+This project demonstrates a basic Hardhat use case. It comes with a contract generated by [OpenZeppelin Wizard](https://wizard.openzeppelin.com/), a test for that contract, ${c.upgradeable ? 'and a script that deploys that contract' : 'and a Hardhat Ignition module that deploys that contract'}.
 
 ## Installing dependencies
 
@@ -169,7 +187,7 @@ npm test
 You can target any network from your Hardhat config using:
 
 \`\`\`
-npx hardhat run --network <network-name> scripts/deploy.ts
+${c.upgradeable ? 'npx hardhat run --network <network-name> scripts/deploy.ts' : `npx hardhat ignition deploy ignition/modules/${c.name}.ts --network <network-name>`}
 \`\`\`
 `;
 
@@ -196,12 +214,18 @@ export async function zipHardhat(c: Contract, opts?: GenericOptions) {
 
   zip.file(`contracts/${c.name}.sol`, printContract(c));
   zip.file('test/test.ts', test(c, opts));
-  zip.file('scripts/deploy.ts', script(c));
+
+  if (c.upgradeable) {
+    zip.file('scripts/deploy.ts', script(c));
+  } else {
+    zip.file(`ignition/modules/${c.name}.ts`, ignitionModule(c));
+  }
+
   zip.file('.gitignore', gitIgnore);
   zip.file('hardhat.config.ts', hardhatConfig(c.upgradeable));
   zip.file('package.json', JSON.stringify(packageJson, null, 2));
   zip.file(`package-lock.json`, JSON.stringify(packageLock, null, 2));
-  zip.file('README.md', readme);
+  zip.file('README.md', readme(c));
   zip.file('tsconfig.json', tsConfig);
 
   return zip;