@openzeppelin/wizard 0.3.0 → 0.4.0

package/src/zip-foundry.ts

@@ -0,0 +1,259 @@
+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";
+
+function getHeader(c: Contract) {
+  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),
+    ),
+  );
+
+  function getImports(c: Contract) {
+    return [
+      'import "forge-std/Test.sol";',
+      `import "../src/${c.name}.sol";`,
+    ];
+  }
+
+  function getTestCase(c: Contract) {
+    const args = getAddressArgs(c);
+    return [
+      `contract ${c.name}Test is Test {`,
+      spaceBetween(
+        [
+          `${c.name} public instance;`,
+        ],
+        [
+          'function setUp() public {',
+          getAddressVariables(args),
+          [
+            `instance = new ${getDeploymentCall(c, args)};`,
+          ],
+          '}',
+        ],
+        getContractSpecificTestFunction(),
+      ),
+      '}',
+    ];
+  }
+
+  function getAddressVariables(args: string[]): Lines[] {
+    const vars = [];
+    for (let i = 0; i < args.length; i++) {
+      // use i + 1 as the private key since it must be non-zero
+      vars.push(`address ${args[i]} = vm.addr(${i + 1});`);
+    }
+    return vars;
+  }
+
+  function getContractSpecificTestFunction(): Lines[] {
+    if (opts !== undefined) {
+      switch (opts.kind) {
+        case 'ERC20':
+        case 'ERC721':
+          return [
+            'function testName() public {',
+            [
+              `assertEq(instance.name(), "${opts.name}");`
+            ],
+            '}',
+          ];
+
+        case 'ERC1155':
+          return [
+            'function testUri() public {',
+            [
+              `assertEq(instance.uri(0), "${opts.uri}");`
+            ],
+            '}',
+          ];
+
+        case 'Governor':
+        case 'Custom':
+          return [
+            'function testSomething() public {',
+            [
+              '// Add your test here',
+            ],
+            '}',
+          ]
+
+        default:
+          throw new Error('Unknown ERC');
+      }
+    }
+    return [];
+  }
+};
+
+function getAddressArgs(c: Contract): string[] {
+  const args = [];
+  for (const constructorArg of c.constructorArgs) {
+    if (constructorArg.type === 'address') {
+      args.push(constructorArg.name);
+    }
+  }
+  return args;
+}
+
+function getDeploymentCall(c: Contract, args: string[]): string {
+  return `${c.name}(${args.join(', ')})`;
+}
+
+const script = (c: Contract) => {
+  return formatLinesWithSpaces(
+    2,
+    ...spaceBetween(
+      getHeader(c),
+      getImports(c),
+      getScript(c),
+    ),
+  );
+
+  function getImports(c: Contract) {
+    return [
+      'import "forge-std/Script.sol";',
+      `import "../src/${c.name}.sol";`,
+    ];
+  }
+
+  function getScript(c: Contract) {
+    const args = getAddressArgs(c);
+    const deploymentLines = [
+      'vm.startBroadcast();',
+      `${c.name} instance = new ${getDeploymentCall(c, args)};`,
+      'console.log("Contract deployed to %s", address(instance));',
+      'vm.stopBroadcast();',
+    ];
+    return [
+      `contract ${c.name}Script is Script {`,
+      spaceBetween(
+        [
+          'function setUp() public {}',
+        ],
+        [
+          'function run() public {',
+          args.length > 0 ? addTodoAndCommentOut(deploymentLines) : deploymentLines,
+          '}',
+        ],
+      ),
+      '}',
+    ];
+  }
+
+  function addTodoAndCommentOut(lines: string[]) {
+    return [
+      '// TODO: Set addresses for the contract arguments below, then uncomment the following lines',
+      ...lines.map(l => `// ${l}`),
+    ];
+  }
+};
+
+const setupSh = `\
+#!/usr/bin/env bash
+
+# Check if git is installed
+if ! which git &> /dev/null
+then
+  echo "git command not found. Install git and try again."
+  exit 1
+fi
+
+# Check if Foundry is installed
+if ! which forge &> /dev/null
+then
+  echo "forge command not found. Install Foundry and try again. See https://book.getfoundry.sh/getting-started/installation"
+  exit 1
+fi
+
+# Setup Foundry project
+if ! [ -f "foundry.toml" ]
+then
+  echo "Initializing Foundry project..."
+
+  # Initialize sample Foundry project
+  forge init --force --no-commit --quiet
+
+  # Install OpenZeppelin Contracts
+  forge install OpenZeppelin/openzeppelin-contracts@v${contracts.version} --no-commit --quiet
+
+  # Remove template contracts
+  rm src/Counter.sol
+  rm script/Counter.s.sol
+  rm test/Counter.t.sol
+
+  # Add remappings
+  if [ -f "remappings.txt" ]
+  then
+    echo "" >> remappings.txt
+  fi
+  echo "@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/" >> remappings.txt
+
+  # Perform initial git commit
+  git add .
+  git commit -m "openzeppelin: add wizard output" --quiet
+
+  echo "Done."
+else
+  echo "Foundry project already initialized."
+fi
+`;
+
+const readme = (c: Contract) => `\
+# Sample Foundry Project
+
+This project demonstrates a basic Foundry 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.
+
+## Installing Foundry
+
+See [Foundry installation guide](https://book.getfoundry.sh/getting-started/installation).
+
+## Initializing the project
+
+\`\`\`
+bash setup.sh
+\`\`\`
+
+## Testing the contract
+
+\`\`\`
+forge test
+\`\`\`
+
+## Deploying the contract
+
+You can simulate a deployment by running the script:
+
+\`\`\`
+forge script script/${c.name}.s.sol
+\`\`\`
+
+See [Solidity scripting guide](https://book.getfoundry.sh/tutorials/solidity-scripting) for more information.
+`;
+
+export async function zipFoundry(c: Contract, opts?: GenericOptions) {
+  const zip = new JSZip();
+
+  zip.file(`src/${c.name}.sol`, printContract(c));
+  zip.file(`test/${c.name}.t.sol`, test(c, opts));
+  zip.file(`script/${c.name}.s.sol`, script(c));
+  zip.file('setup.sh', setupSh);
+  zip.file('README.md', readme(c));
+
+  return zip;
+}

package/src/zip-hardhat.ts

@@ -32,7 +32,8 @@ const tsConfig = `\
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "resolveJsonModule": true
   }
 }
 `;
@@ -45,7 +46,7 @@ coverage.json
 typechain
 typechain-types
 
-#Hardhat files
+# Hardhat files
 cache
 artifacts
 `;
@@ -60,6 +61,7 @@ const test = (c: Contract, opts?: GenericOptions) => {
   );
 
   function getTestCase(c: Contract) {
+    const args = getAddressArgs(c);
     return [
       `describe("${c.name}", function () {`,
       [
@@ -68,11 +70,12 @@ const test = (c: Contract, opts?: GenericOptions) => {
           [
             `const ContractFactory = await ethers.getContractFactory("${c.name}");`,
           ],
+          getAddressVariables(args),
           [
-            `const instance = await ${c.upgradeable ? 'upgrades.deployProxy(ContractFactory)' : 'ContractFactory.deploy()'};`,
-            'await instance.deployed();'
+            `const instance = await ${getDeploymentCall(c, args)};`,
+            'await instance.waitForDeployment();'
           ],
-          getContractSpecificExpects(),
+          getExpects(),
         ),
         '});'
       ],
@@ -87,7 +90,7 @@ const test = (c: Contract, opts?: GenericOptions) => {
     ];
   }
 
-  function getContractSpecificExpects(): Lines[] {
+  function getExpects(): Lines[] {
     if (opts !== undefined) {
       switch (opts.kind) {
         case 'ERC20':
@@ -107,18 +110,43 @@ const test = (c: Contract, opts?: GenericOptions) => {
     }
     return [];
   }
+
+  function getAddressVariables(args: string[]): Lines[] {
+    const vars = [];
+    for (let i = 0; i < args.length; i++) {
+      vars.push(`const ${args[i]} = (await ethers.getSigners())[${i}].address;`);
+    }
+    return vars;
+  }
 };
 
-const script = (c: Contract) => `\
+function getAddressArgs(c: Contract): string[] {
+  const args = [];
+  for (const constructorArg of c.constructorArgs) {
+    if (constructorArg.type === 'address') {
+      args.push(constructorArg.name);
+    }
+  }
+  return args;
+}
+
+function getDeploymentCall(c: Contract, args: string[]): string {
+  return c.upgradeable ? `upgrades.deployProxy(ContractFactory, [${args.join(', ')}])` : `ContractFactory.deploy(${args.join(', ')})`;
+}
+
+const script = (c: Contract) => {
+  const args = getAddressArgs(c);
+  return `\
 import { ${getHardhatPlugins(c).join(', ')} } from "hardhat";
 
 async function main() {
   const ContractFactory = await ethers.getContractFactory("${c.name}");
 
-  const instance = await ${c.upgradeable ? 'upgrades.deployProxy(ContractFactory)' : 'ContractFactory.deploy()'};
-  await instance.deployed();
+  ${args.length > 0 ? '// TODO: Set addresses for the contract arguments below' : ''}
+  const instance = await ${getDeploymentCall(c, args)};
+  await instance.waitForDeployment();
 
-  console.log(\`${c.upgradeable ? 'Proxy' : 'Contract'} deployed to \${instance.address}\`);
+  console.log(\`${c.upgradeable ? 'Proxy' : 'Contract'} deployed to \${await instance.getAddress()}\`);
 }
 
 // We recommend this pattern to be able to use async/await everywhere
@@ -127,7 +155,7 @@ main().catch((error) => {
   console.error(error);
   process.exitCode = 1;
 });
-`;
+`};
 
 const readme = `\
 # Sample Hardhat Project

package/CHANGELOG.md

@@ -1,30 +0,0 @@
-# Changelog
-
-## 0.3.0 (2023-05-25)
-
-- **Breaking change**: Update to OpenZeppelin Contracts 4.9. ([#252](https://github.com/OpenZeppelin/contracts-wizard/pull/252))
-
-## 0.2.3 (2023-03-23)
-
-- Fix module not found error. ([#235](https://github.com/OpenZeppelin/contracts-wizard/issues/235))
-
-## 0.2.2 (2023-03-17)
-
-- Fix missing file. ([#234](https://github.com/OpenZeppelin/contracts-wizard/pull/234))
-
-## 0.2.1 (2023-03-17)
-
-- Remove unspecified dependency on `@openzeppelin/contracts`. ([#233](https://github.com/OpenZeppelin/contracts-wizard/pull/233))
-
-## 0.2.0 (2022-11-08)
-
-- Reduce default block time to 12 seconds in `governor`. ([fdcf912](https://github.com/OpenZeppelin/contracts-wizard/commit/fdcf9129354692b3b7e0fa694233fdd62a1e99bb))
-- **Breaking change**: Update to OpenZeppelin Contracts 4.8 and Solidity ^0.8.9. ([#199](https://github.com/OpenZeppelin/contracts-wizard/pull/199))
-
-## 0.1.1 (2022-06-30)
-
-- Support custom contract type, optional access control. ([#112](https://github.com/OpenZeppelin/contracts-wizard/pull/112))
-
-## 0.1.0 (2022-06-15)
-
-- Initial API for Solidity. ([#136](https://github.com/OpenZeppelin/contracts-wizard/pull/136))

package/dist/zip.d.ts

@@ -1,4 +0,0 @@
-import JSZip from 'jszip';
-import type { Contract } from './contract';
-export declare function zipContract(c: Contract): JSZip;
-//# sourceMappingURL=zip.d.ts.map

package/dist/zip.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"zip.d.ts","sourceRoot":"","sources":["../src/zip.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,KAAK,EAAE,QAAQ,EAA8C,MAAM,YAAY,CAAC;AAsBvF,wBAAgB,WAAW,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,CA4B9C"}

package/dist/zip.js

@@ -1,48 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.zipContract = void 0;
-const jszip_1 = __importDefault(require("jszip"));
-const print_1 = require("./print");
-const transitive_closure_1 = require("./utils/transitive-closure");
-const openzeppelin_contracts_1 = __importDefault(require("../openzeppelin-contracts"));
-const options_1 = require("./options");
-const readme = (variant) => `\
-# OpenZeppelin Contracts
-
-The files in this directory were sourced unmodified from OpenZeppelin Contracts v${openzeppelin_contracts_1.default.version}.
-
-They are not meant to be edited.
-
-The originals can be found on [GitHub] and [npm].
-
-[GitHub]: https://github.com/OpenZeppelin/openzeppelin-contracts${variant}/tree/v${openzeppelin_contracts_1.default.version}
-[npm]: https://www.npmjs.com/package/@openzeppelin/contracts${variant}/v/${openzeppelin_contracts_1.default.version}
-
-Generated with OpenZeppelin Contracts Wizard (https://zpl.in/wizard).
-`;
-function zipContract(c) {
-    const { transformImport } = (0, options_1.withHelpers)(c);
-    const contractsVariant = c.upgradeable ? '-upgradeable' : '';
-    const fileName = c.name + '.sol';
-    const dependencies = {
-        [fileName]: c.imports.map(i => transformImport(i)),
-        ...openzeppelin_contracts_1.default.dependencies,
-    };
-    const allImports = (0, transitive_closure_1.reachable)(dependencies, fileName);
-    const zip = new jszip_1.default();
-    zip.file(fileName, (0, print_1.printContract)(c, { transformImport: p => './' + p }));
-    zip.file(`@openzeppelin/contracts${contractsVariant}/README.md`, readme(contractsVariant));
-    for (const importPath of allImports) {
-        const source = openzeppelin_contracts_1.default.sources[importPath];
-        if (source === undefined) {
-            throw new Error(`Source for ${importPath} not found`);
-        }
-        zip.file(importPath, source);
-    }
-    return zip;
-}
-exports.zipContract = zipContract;
-//# sourceMappingURL=zip.js.map

package/dist/zip.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"zip.js","sourceRoot":"","sources":["../src/zip.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,mCAAwC;AACxC,mEAAuD;AAEvD,uFAAkD;AAClD,uCAAwC;AAExC,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC;;;mFAG+C,gCAAS,CAAC,OAAO;;;;;;kEAMlC,OAAO,UAAU,gCAAS,CAAC,OAAO;8DACtC,OAAO,MAAM,gCAAS,CAAC,OAAO;;;CAG3F,CAAC;AAEF,SAAgB,WAAW,CAAC,CAAW;IACrC,MAAM,EAAE,eAAe,EAAE,GAAG,IAAA,qBAAW,EAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7D,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC;IAEjC,MAAM,YAAY,GAAG;QACnB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAClD,GAAG,gCAAS,CAAC,YAAY;KAC1B,CAAC;IAEF,MAAM,UAAU,GAAG,IAAA,8BAAS,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAErD,MAAM,GAAG,GAAG,IAAI,eAAK,EAAE,CAAC;IAExB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAA,qBAAa,EAAC,CAAC,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzE,GAAG,CAAC,IAAI,CAAC,0BAA0B,gBAAgB,YAAY,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAE3F,KAAK,MAAM,UAAU,IAAI,UAAU,EAAE;QACnC,MAAM,MAAM,GAAG,gCAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,cAAc,UAAU,YAAY,CAAC,CAAC;SACvD;QACD,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;KAC9B;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AA5BD,kCA4BC"}

package/src/zip.ts

@@ -1,53 +0,0 @@
-import JSZip from 'jszip';
-
-import type { Contract, Parent, ContractFunction, FunctionArgument } from './contract';
-import { printContract } from './print';
-import { reachable } from './utils/transitive-closure';
-
-import contracts from '../openzeppelin-contracts';
-import { withHelpers } from './options';
-
-const readme = (variant: string) => `\
-# OpenZeppelin Contracts
-
-The files in this directory were sourced unmodified from OpenZeppelin Contracts v${contracts.version}.
-
-They are not meant to be edited.
-
-The originals can be found on [GitHub] and [npm].
-
-[GitHub]: https://github.com/OpenZeppelin/openzeppelin-contracts${variant}/tree/v${contracts.version}
-[npm]: https://www.npmjs.com/package/@openzeppelin/contracts${variant}/v/${contracts.version}
-
-Generated with OpenZeppelin Contracts Wizard (https://zpl.in/wizard).
-`;
-
-export function zipContract(c: Contract): JSZip {
-  const { transformImport } = withHelpers(c);
-  const contractsVariant = c.upgradeable ? '-upgradeable' : '';
-
-  const fileName = c.name + '.sol';
-
-  const dependencies = {
-    [fileName]: c.imports.map(i => transformImport(i)),
-    ...contracts.dependencies,
-  };
-
-  const allImports = reachable(dependencies, fileName);
-
-  const zip = new JSZip();
-
-  zip.file(fileName, printContract(c, { transformImport: p => './' + p }));
-
-  zip.file(`@openzeppelin/contracts${contractsVariant}/README.md`, readme(contractsVariant));
-
-  for (const importPath of allImports) {
-    const source = contracts.sources[importPath];
-    if (source === undefined) {
-      throw new Error(`Source for ${importPath} not found`);
-    }
-    zip.file(importPath, source);
-  }
-
-  return zip;
-}