@openzeppelin/wizard 0.6.0 → 0.7.1

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/print.ts

@@ -17,6 +17,8 @@ import SOLIDITY_VERSION from './solidity-version.json';
 import { inferTranspiled } from './infer-transpiled';
 import { compatibleContractsSemver } from './utils/version';
 import { stringifyUnicodeSafe } from './utils/sanitize';
+import { importsCommunityContracts } from './utils/imports-libraries';
+import { getCommunityContractsGitCommit } from './utils/community-contracts-git-commit';
 
 export function printContract(contract: Contract, opts?: Options): string {
   const helpers = withHelpers(contract, opts);
@@ -29,7 +31,7 @@ export function printContract(contract: Contract, opts?: Options): string {
     ...spaceBetween(
       [
         `// SPDX-License-Identifier: ${contract.license}`,
-        `// Compatible with OpenZeppelin Contracts ${compatibleContractsSemver}`,
+        printCompatibleLibraryVersions(contract),
         `pragma solidity ^${SOLIDITY_VERSION};`,
       ],
 
@@ -54,6 +56,19 @@ export function printContract(contract: Contract, opts?: Options): string {
   );
 }
 
+function printCompatibleLibraryVersions(contract: Contract): string {
+  let result = `// Compatible with OpenZeppelin Contracts ${compatibleContractsSemver}`;
+  if (importsCommunityContracts(contract)) {
+    try {
+      const commit = getCommunityContractsGitCommit();
+      result += ` and Community Contracts commit ${commit}`;
+    } catch (e) {
+      console.error(e);
+    }
+  }
+  return result;
+}
+
 function printInheritance(contract: Contract, { transformName }: Helpers): [] | [string] {
   if (contract.parents.length > 0) {
     return ['is ' + contract.parents.map(p => transformName(p.contract)).join(', ')];

package/src/utils/community-contracts-git-commit.ts

@@ -0,0 +1,38 @@
+import { devDependencies } from '../../package.json';
+
+/**
+ * @returns The git commit hash of the @openzeppelin/community-contracts package dependency.
+ * @throws Error if the @openzeppelin/community-contracts package dependency is not found in devDependencies.
+ */
+export function getCommunityContractsGitCommit(): string {
+  const communityContractsVersion = devDependencies['@openzeppelin/community-contracts'];
+  if (!communityContractsVersion) {
+    throw new Error('@openzeppelin/community-contracts not found in devDependencies');
+  }
+  return extractGitCommitHash('@openzeppelin/community-contracts', communityContractsVersion);
+}
+
+/**
+ * Extracts the git commit hash from a package dependency version string.
+ * The expected format is `git+<url>#<commit-hash>`.
+ *
+ * @param dependencyName The name of the package dependency.
+ * @param dependencyVersion The version string of the package dependency.
+ * @returns The git commit hash, normalized to lowercase.
+ * @throws Error if the version string or commit hash is not in the expected format.
+ */
+export function extractGitCommitHash(dependencyName: string, dependencyVersion: string): string {
+  const split = dependencyVersion.split('#');
+  if (!dependencyVersion.startsWith('git+') || split.length !== 2) {
+    throw new Error(
+      `Expected package dependency for ${dependencyName} in format git+<url>#<commit-hash>, but got ${dependencyVersion}`,
+    );
+  }
+  const hash = split[1]!;
+  if (!/^[a-fA-F0-9]{7,40}$/.test(hash)) {
+    throw new Error(
+      `Expected git commit hash for package dependency ${dependencyName} to have between 7 and 40 hex chars, but got ${hash}`,
+    );
+  }
+  return hash.toLowerCase();
+}

package/src/utils/imports-libraries.ts

@@ -0,0 +1,5 @@
+import type { Contract } from '../contract';
+
+export function importsCommunityContracts(contract: Contract) {
+  return contract.imports.some(i => i.path.startsWith('@openzeppelin/community-contracts/'));
+}

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';