@openzeppelin/wizard 0.5.1 → 0.5.3

package/src/set-upgradeable.ts

@@ -1,10 +1,11 @@
 import type { ContractBuilder } from './contract';
-import { Access, requireAccessControl } from './set-access-control';
+import type { Access } from './set-access-control';
+import { requireAccessControl } from './set-access-control';
 import { defineFunctions } from './utils/define-functions';
 
 export const upgradeableOptions = [false, 'transparent', 'uups'] as const;
 
-export type Upgradeable = typeof upgradeableOptions[number];
+export type Upgradeable = (typeof upgradeableOptions)[number];
 
 export function setUpgradeable(c: ContractBuilder, upgradeable: Upgradeable, access: Access) {
   if (upgradeable === false) {
@@ -19,7 +20,8 @@ export function setUpgradeable(c: ContractBuilder, upgradeable: Upgradeable, acc
   });
 
   switch (upgradeable) {
-    case 'transparent': break;
+    case 'transparent':
+      break;
 
     case 'uups': {
       requireAccessControl(c, functions._authorizeUpgrade, access, 'UPGRADER', 'upgrader');
@@ -42,9 +44,7 @@ export function setUpgradeable(c: ContractBuilder, upgradeable: Upgradeable, acc
 
 const functions = defineFunctions({
   _authorizeUpgrade: {
-    args: [
-      { name: 'newImplementation', type: 'address' },
-    ],
+    args: [{ name: 'newImplementation', type: 'address' }],
     kind: 'internal',
   },
 });

package/src/stablecoin.ts

@@ -1,11 +1,18 @@
-import { Contract, ContractBuilder } from './contract';
-import { Access, setAccessControl, requireAccessControl } from './set-access-control';
+import type { Contract, ContractBuilder } from './contract';
+import type { Access } from './set-access-control';
+import { setAccessControl, requireAccessControl } from './set-access-control';
 import { defineFunctions } from './utils/define-functions';
 import { printContract } from './print';
-import { buildERC20, ERC20Options, defaults as erc20defaults, withDefaults as withERC20Defaults, functions as erc20functions } from './erc20';
+import type { ERC20Options } from './erc20';
+import {
+  buildERC20,
+  defaults as erc20defaults,
+  withDefaults as withERC20Defaults,
+  functions as erc20functions,
+} from './erc20';
 
 export interface StablecoinOptions extends ERC20Options {
-  limitations?: false | "allowlist" | "blocklist";
+  limitations?: false | 'allowlist' | 'blocklist';
   custodian?: boolean;
 }
 
@@ -65,7 +72,7 @@ function addLimitations(c: ContractBuilder, access: Access, mode: boolean | 'all
   c.addOverride(ERC20Limitation, functions._update);
   c.addOverride(ERC20Limitation, functions._approve);
 
-  const [addFn, removeFn] = type 
+  const [addFn, removeFn] = type
     ? [functions.allowUser, functions.disallowUser]
     : [functions.blockUser, functions.unblockUser];
 
@@ -89,7 +96,7 @@ function addCustodian(c: ContractBuilder, access: Access) {
   if (access === false) {
     access = 'ownable';
   }
-  
+
   setAccessControl(c, access);
 
   switch (access) {
@@ -102,7 +109,7 @@ function addCustodian(c: ContractBuilder, access: Access) {
       const roleId = 'CUSTODIAN_ROLE';
       const addedConstant = c.addVariable(`bytes32 public constant ${roleId} = keccak256("${roleId}");`);
       if (roleOwner && addedConstant) {
-        c.addConstructorArgument({type: 'address', name: roleOwner});
+        c.addConstructorArgument({ type: 'address', name: roleOwner });
         c.addConstructorCode(`_grantRole(${roleId}, ${roleOwner});`);
       }
       c.setFunctionBody([`return hasRole(CUSTODIAN_ROLE, user);`], functions._isCustodian);
@@ -115,8 +122,8 @@ function addCustodian(c: ContractBuilder, access: Access) {
       });
       const logic = [
         `(bool immediate,) = AuthorityUtils.canCallWithDelay(authority(), user, address(this), bytes4(_msgData()[0:4]));`,
-        `return immediate;`
-      ]
+        `return immediate;`,
+      ];
       c.setFunctionBody(logic, functions._isCustodian);
       break;
     }
@@ -128,40 +135,29 @@ const functions = {
   ...defineFunctions({
     _isCustodian: {
       kind: 'internal' as const,
-      args: [
-        { name: 'user', type: 'address' },
-      ],
+      args: [{ name: 'user', type: 'address' }],
       returns: ['bool'],
-      mutability: 'view' as const
+      mutability: 'view' as const,
     },
 
     allowUser: {
       kind: 'public' as const,
-      args: [
-        { name: 'user', type: 'address' }
-      ],
+      args: [{ name: 'user', type: 'address' }],
     },
 
     disallowUser: {
       kind: 'public' as const,
-      args: [
-        { name: 'user', type: 'address' }
-      ],
+      args: [{ name: 'user', type: 'address' }],
     },
 
     blockUser: {
       kind: 'public' as const,
-      args: [
-        { name: 'user', type: 'address' }
-      ],
+      args: [{ name: 'user', type: 'address' }],
     },
 
     unblockUser: {
       kind: 'public' as const,
-      args: [
-        { name: 'user', type: 'address' }
-      ],
+      args: [{ name: 'user', type: 'address' }],
     },
-  })
+  }),
 };
-

package/src/test.ts

@@ -1,5 +1,6 @@
 import { promises as fs } from 'fs';
-import _test, { TestFn, ExecutionContext } from 'ava';
+import type { TestFn, ExecutionContext } from 'ava';
+import _test from 'ava';
 import hre from 'hardhat';
 import path from 'path';
 
@@ -8,7 +9,7 @@ import type { GenericOptions, KindedOptions } from './build-generic';
 import { custom, erc1155, stablecoin, erc20, erc721, governor } from './api';
 
 interface Context {
-  generatedSourcesPath: string
+  generatedSourcesPath: string;
 }
 
 const test = _test as TestFn<Context>;
@@ -54,7 +55,7 @@ async function testCompile(t: ExecutionContext<Context>, kind: keyof KindedOptio
 }
 
 function isAccessControlRequired(opts: GenericOptions) {
-  switch(opts.kind) {
+  switch (opts.kind) {
     case 'ERC20':
       return erc20.isAccessControlRequired(opts);
     case 'ERC721':
@@ -70,7 +71,7 @@ function isAccessControlRequired(opts: GenericOptions) {
     case 'Custom':
       return custom.isAccessControlRequired(opts);
     default:
-      throw new Error("No such kind");
+      throw new Error('No such kind');
   }
 }
 
@@ -86,4 +87,4 @@ test('is access control required', async t => {
       }
     }
   }
-});
+});

package/src/utils/define-functions.ts

@@ -2,17 +2,8 @@ import type { BaseFunction } from '../contract';
 
 type ImplicitNameFunction = Omit<BaseFunction, 'name'>;
 
-export function defineFunctions<F extends string>(
-  fns: Record<F, ImplicitNameFunction>,
-): Record<F, BaseFunction>;
+export function defineFunctions<F extends string>(fns: Record<F, ImplicitNameFunction>): Record<F, BaseFunction>;
 
-export function defineFunctions(
-  fns: Record<string, ImplicitNameFunction>,
-): Record<string, BaseFunction> {
-  return Object.fromEntries(
-    Object.entries(fns).map(([name, fn]) => [
-      name,
-      Object.assign({ name }, fn),
-    ]),
-  );
+export function defineFunctions(fns: Record<string, ImplicitNameFunction>): Record<string, BaseFunction> {
+  return Object.fromEntries(Object.entries(fns).map(([name, fn]) => [name, Object.assign({ name }, fn)]));
 }

package/src/utils/duration.ts

@@ -1,5 +1,5 @@
 const durationUnits = ['block', 'second', 'minute', 'hour', 'day', 'week', 'month', 'year'] as const;
-type DurationUnit = typeof durationUnits[number];
+type DurationUnit = (typeof durationUnits)[number];
 export const durationPattern = new RegExp(`^(\\d+(?:\\.\\d+)?) +(${durationUnits.join('|')})s?$`);
 
 const second = 1;
@@ -49,4 +49,4 @@ export function durationToTimestamp(duration: string): string {
   }
 
   return `${value} ${unit}s`;
-}
+}

package/src/utils/format-lines.ts

@@ -10,11 +10,7 @@ export function formatLinesWithSpaces(spacesPerIndent: number, ...lines: Lines[]
   return [...indentEach(0, lines, spacesPerIndent)].join('\n') + '\n';
 }
 
-function* indentEach(
-  indent: number,
-  lines: Lines[],
-  spacesPerIndent: number,
-): Generator<string | typeof whitespace> {
+function* indentEach(indent: number, lines: Lines[], spacesPerIndent: number): Generator<string | typeof whitespace> {
   for (const line of lines) {
     if (line === whitespace) {
       yield '';

package/src/utils/map-values.ts

@@ -1,7 +1,5 @@
-export function mapValues<K extends keyof any, V, W>(
-  obj: Record<K, V>,
-  fn: (val: V) => W,
-): Record<K, W> {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function mapValues<K extends keyof any, V, W>(obj: Record<K, V>, fn: (val: V) => W): Record<K, W> {
   const res = {} as Record<K, W>;
   for (const key in obj) {
     res[key] = fn(obj[key]);

package/src/utils/to-identifier.ts

@@ -1,7 +1,8 @@
 export function toIdentifier(str: string, capitalize = false): string {
   return str
-    .normalize('NFD').replace(/[\u0300-\u036f]/g, '') // remove accents
+    .normalize('NFD')
+    .replace(/[\u0300-\u036f]/g, '') // remove accents
     .replace(/^[^a-zA-Z$_]+/, '')
-    .replace(/^(.)/, c => capitalize ? c.toUpperCase() : c)
+    .replace(/^(.)/, c => (capitalize ? c.toUpperCase() : c))
     .replace(/[^\w$]+(.?)/g, (_, c) => c.toUpperCase());
 }

package/src/zip-foundry.ts

@@ -1,32 +1,21 @@
-import JSZip from "jszip";
-import type { GenericOptions } from "./build-generic";
-import type { Contract } from "./contract";
-import { printContract } from "./print";
+import JSZip from 'jszip';
+import type { GenericOptions } from './build-generic';
+import type { Contract } from './contract';
+import { printContract } from './print';
 import SOLIDITY_VERSION from './solidity-version.json';
 import contracts from '../openzeppelin-contracts';
-import { formatLinesWithSpaces, Lines, spaceBetween } from "./utils/format-lines";
+import type { Lines } from './utils/format-lines';
+import { formatLinesWithSpaces, spaceBetween } from './utils/format-lines';
 
 function getHeader(c: Contract) {
-  return [
-    `// SPDX-License-Identifier: ${c.license}`,
-    `pragma solidity ^${SOLIDITY_VERSION};`
-  ];
+  return [`// SPDX-License-Identifier: ${c.license}`, `pragma solidity ^${SOLIDITY_VERSION};`];
 }
 
 const test = (c: Contract, opts?: GenericOptions) => {
-  return formatLinesWithSpaces(
-    2,
-    ...spaceBetween(
-      getHeader(c),
-      getImports(c),
-      getTestCase(c),
-    ),
-  );
+  return formatLinesWithSpaces(2, ...spaceBetween(getHeader(c), getImports(c), getTestCase(c)));
 
   function getImports(c: Contract) {
-    const result = [
-      'import {Test} from "forge-std/Test.sol";',
-    ];
+    const result = ['import {Test} from "forge-std/Test.sol";'];
     if (c.upgradeable) {
       result.push('import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";');
     }
@@ -39,15 +28,8 @@ const test = (c: Contract, opts?: GenericOptions) => {
     return [
       `contract ${c.name}Test is Test {`,
       spaceBetween(
-        [
-          `${c.name} public instance;`,
-        ],
-        [
-          'function setUp() public {',
-          getAddressVariables(c, args),
-          getDeploymentCode(c, args),
-          '}',
-        ],
+        [`${c.name} public instance;`],
+        ['function setUp() public {', getAddressVariables(c, args), getDeploymentCode(c, args), '}'],
         getContractSpecificTestFunction(),
       ),
       '}',
@@ -59,29 +41,20 @@ const test = (c: Contract, opts?: GenericOptions) => {
       if (opts?.upgradeable === 'transparent') {
         return [
           `address proxy = Upgrades.deployTransparentProxy(`,
-          [
-            `"${c.name}.sol",`,
-            `initialOwner,`,
-            `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`
-          ],
+          [`"${c.name}.sol",`, `initialOwner,`, `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`],
           ');',
           `instance = ${c.name}(proxy);`,
         ];
       } else {
         return [
           `address proxy = Upgrades.deployUUPSProxy(`,
-          [
-            `"${c.name}.sol",`,
-            `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`
-          ],
+          [`"${c.name}.sol",`, `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`],
           ');',
           `instance = ${c.name}(proxy);`,
         ];
       }
     } else {
-      return [
-        `instance = new ${c.name}(${args.join(', ')});`,
-      ];
+      return [`instance = new ${c.name}(${args.join(', ')});`];
     }
   }
 
@@ -102,32 +75,14 @@ const test = (c: Contract, opts?: GenericOptions) => {
       switch (opts.kind) {
         case 'ERC20':
         case 'ERC721':
-          return [
-            'function testName() public view {',
-            [
-              `assertEq(instance.name(), "${opts.name}");`
-            ],
-            '}',
-          ];
+          return ['function testName() public view {', [`assertEq(instance.name(), "${opts.name}");`], '}'];
 
         case 'ERC1155':
-          return [
-            'function testUri() public view {',
-            [
-              `assertEq(instance.uri(0), "${opts.uri}");`
-            ],
-            '}',
-          ];
+          return ['function testUri() public view {', [`assertEq(instance.uri(0), "${opts.uri}");`], '}'];
 
         case 'Governor':
         case 'Custom':
-          return [
-            'function testSomething() public {',
-            [
-              '// Add your test here',
-            ],
-            '}',
-          ]
+          return ['function testSomething() public {', ['// Add your test here'], '}'];
 
         default:
           throw new Error('Unknown ERC');
@@ -148,20 +103,10 @@ function getAddressArgs(c: Contract): string[] {
 }
 
 const script = (c: Contract, opts?: GenericOptions) => {
-  return formatLinesWithSpaces(
-    2,
-    ...spaceBetween(
-      getHeader(c),
-      getImports(c),
-      getScript(c),
-    ),
-  );
+  return formatLinesWithSpaces(2, ...spaceBetween(getHeader(c), getImports(c), getScript(c)));
 
   function getImports(c: Contract) {
-    const result = [
-      'import {Script} from "forge-std/Script.sol";',
-      'import {console} from "forge-std/console.sol";',
-    ];
+    const result = ['import {Script} from "forge-std/Script.sol";', 'import {console} from "forge-std/console.sol";'];
     if (c.upgradeable) {
       result.push('import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";');
     }
@@ -181,14 +126,8 @@ const script = (c: Contract, opts?: GenericOptions) => {
     return [
       `contract ${c.name}Script is Script {`,
       spaceBetween(
-        [
-          'function setUp() public {}',
-        ],
-        [
-          'function run() public {',
-          args.length > 0 ? addTodoAndCommentOut(deploymentLines) : deploymentLines,
-          '}',
-        ],
+        ['function setUp() public {}'],
+        ['function run() public {', args.length > 0 ? addTodoAndCommentOut(deploymentLines) : deploymentLines, '}'],
       ),
       '}',
     ];
@@ -199,29 +138,20 @@ const script = (c: Contract, opts?: GenericOptions) => {
       if (opts?.upgradeable === 'transparent') {
         return [
           `address proxy = Upgrades.deployTransparentProxy(`,
-          [
-            `"${c.name}.sol",`,
-            `initialOwner,`,
-            `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`
-          ],
+          [`"${c.name}.sol",`, `initialOwner,`, `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`],
           ');',
           `${c.name} instance = ${c.name}(proxy);`,
         ];
       } else {
         return [
           `address proxy = Upgrades.deployUUPSProxy(`,
-          [
-            `"${c.name}.sol",`,
-            `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`
-          ],
+          [`"${c.name}.sol",`, `abi.encodeCall(${c.name}.initialize, (${args.join(', ')}))`],
           ');',
           `${c.name} instance = ${c.name}(proxy);`,
         ];
       }
     } else {
-      return [
-        `${c.name} instance = new ${c.name}(${args.join(', ')});`,
-      ];
+      return [`${c.name} instance = new ${c.name}(${args.join(', ')});`];
     }
   }
 
@@ -274,14 +204,18 @@ then
   # Initialize sample Foundry project
   forge init --force --no-commit --quiet
 
-${c.upgradeable ? `\
+${
+  c.upgradeable
+    ? `\
   # Install OpenZeppelin Contracts and Upgrades
   forge install OpenZeppelin/openzeppelin-contracts-upgradeable@v${contracts.version} --no-commit --quiet
   forge install OpenZeppelin/openzeppelin-foundry-upgrades --no-commit --quiet\
-` : `\
+`
+    : `\
   # Install OpenZeppelin Contracts
   forge install OpenZeppelin/openzeppelin-contracts@v${contracts.version} --no-commit --quiet\
-`}
+`
+}
 
   # Remove unneeded Foundry template files
   rm src/Counter.sol
@@ -297,7 +231,9 @@ ${c.upgradeable ? `\
   then
     echo "" >> remappings.txt
   fi
-${c.upgradeable ? `\
+${
+  c.upgradeable
+    ? `\
   echo "@openzeppelin/contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts/" >> remappings.txt
   echo "@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/" >> remappings.txt
 
@@ -307,9 +243,11 @@ ${c.upgradeable ? `\
   echo "ast = true" >> foundry.toml
   echo "build_info = true" >> foundry.toml
   echo "extra_output = [\\"storageLayout\\"]" >> foundry.toml\
-` : `\
+`
+    : `\
   echo "@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/" >> remappings.txt\
-`}
+`
+}
 
   # Perform initial git commit
   git add .
@@ -350,7 +288,7 @@ You can simulate a deployment by running the script:
 forge script script/${c.name}.s.sol${c.upgradeable ? ' --force' : ''}
 \`\`\`
 
-See [Solidity scripting guide](https://book.getfoundry.sh/tutorials/solidity-scripting) for more information.
+See [Solidity scripting guide](https://book.getfoundry.sh/guides/scripting-with-solidity) for more information.
 `;
 
 export async function zipFoundry(c: Contract, opts?: GenericOptions) {
@@ -363,4 +301,4 @@ export async function zipFoundry(c: Contract, opts?: GenericOptions) {
   zip.file('README.md', readme(c));
 
   return zip;
-}
+}

package/src/zip-hardhat.ts

@@ -1,9 +1,10 @@
-import JSZip from "jszip";
-import type { GenericOptions } from "./build-generic";
-import type { Contract } from "./contract";
-import { printContract } from "./print";
+import JSZip from 'jszip';
+import type { GenericOptions } from './build-generic';
+import type { Contract } from './contract';
+import { printContract } from './print';
 import SOLIDITY_VERSION from './solidity-version.json';
-import { formatLinesWithSpaces, Lines, spaceBetween } from "./utils/format-lines";
+import type { Lines } from './utils/format-lines';
+import { formatLinesWithSpaces, spaceBetween } from './utils/format-lines';
 
 const hardhatConfig = (upgradeable: boolean) => `\
 import { HardhatUserConfig } from "hardhat/config";
@@ -52,13 +53,7 @@ artifacts
 `;
 
 const test = (c: Contract, opts?: GenericOptions) => {
-  return formatLinesWithSpaces(
-    2,
-    ...spaceBetween(
-      getImports(c),
-      getTestCase(c),
-    ),
-  );
+  return formatLinesWithSpaces(2, ...spaceBetween(getImports(c), getTestCase(c)));
 
   function getTestCase(c: Contract) {
     const args = getAddressArgs(c);
@@ -67,27 +62,19 @@ const test = (c: Contract, opts?: GenericOptions) => {
       [
         'it("Test contract", async function () {',
         spaceBetween(
-          [
-            `const ContractFactory = await ethers.getContractFactory("${c.name}");`,
-          ],
+          [`const ContractFactory = await ethers.getContractFactory("${c.name}");`],
           getAddressVariables(args),
-          [
-            `const instance = await ${getDeploymentCall(c, args)};`,
-            'await instance.waitForDeployment();'
-          ],
+          [`const instance = await ${getDeploymentCall(c, args)};`, 'await instance.waitForDeployment();'],
           getExpects(),
         ),
-        '});'
+        '});',
       ],
       '});',
     ];
   }
 
   function getImports(c: Contract) {
-    return [
-      'import { expect } from "chai";',
-      `import { ${getHardhatPlugins(c).join(', ')} } from "hardhat";`,
-    ];
+    return ['import { expect } from "chai";', `import { ${getHardhatPlugins(c).join(', ')} } from "hardhat";`];
   }
 
   function getExpects(): Lines[] {
@@ -131,7 +118,9 @@ function getAddressArgs(c: Contract): string[] {
 }
 
 function getDeploymentCall(c: Contract, args: string[]): string {
-  return c.upgradeable ? `upgrades.deployProxy(ContractFactory, [${args.join(', ')}])` : `ContractFactory.deploy(${args.join(', ')})`;
+  return c.upgradeable
+    ? `upgrades.deployProxy(ContractFactory, [${args.join(', ')}])`
+    : `ContractFactory.deploy(${args.join(', ')})`;
 }
 
 const script = (c: Contract) => {
@@ -155,7 +144,8 @@ main().catch((error) => {
   console.error(error);
   process.exitCode = 1;
 });
-`};
+`;
+};
 
 const readme = `\
 # Sample Hardhat Project
@@ -184,7 +174,7 @@ npx hardhat run --network <network-name> scripts/deploy.ts
 `;
 
 function getHardhatPlugins(c: Contract) {
-  let plugins = ['ethers'];
+  const plugins = ['ethers'];
   if (c.upgradeable) {
     plugins.push('upgrades');
   }
@@ -194,10 +184,14 @@ function getHardhatPlugins(c: Contract) {
 export async function zipHardhat(c: Contract, opts?: GenericOptions) {
   const zip = new JSZip();
 
-  const { default: packageJson } = c.upgradeable ? await import("./environments/hardhat/upgradeable/package.json") : await import("./environments/hardhat/package.json");
+  const { default: packageJson } = c.upgradeable
+    ? await import('./environments/hardhat/upgradeable/package.json')
+    : await import('./environments/hardhat/package.json');
   packageJson.license = c.license;
 
-  const { default: packageLock } = c.upgradeable ? await import("./environments/hardhat/upgradeable/package-lock.json") : await import("./environments/hardhat/package-lock.json");
+  const { default: packageLock } = c.upgradeable
+    ? await import('./environments/hardhat/upgradeable/package-lock.json')
+    : await import('./environments/hardhat/package-lock.json');
   packageLock.packages[''].license = c.license;
 
   zip.file(`contracts/${c.name}.sol`, printContract(c));
@@ -211,4 +205,4 @@ export async function zipHardhat(c: Contract, opts?: GenericOptions) {
   zip.file('tsconfig.json', tsConfig);
 
   return zip;
-}
+}