@openzeppelin/wizard 0.1.1 → 0.2.1

package/dist/zip-hardhat.js

@@ -0,0 +1,187 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zipHardhat = void 0;
+const jszip_1 = __importDefault(require("jszip"));
+const print_1 = require("./print");
+const solidity_version_json_1 = __importDefault(require("./solidity-version.json"));
+const format_lines_1 = require("./utils/format-lines");
+const hardhatConfig = (upgradeable) => `\
+import { HardhatUserConfig } from "hardhat/config";
+import "@nomicfoundation/hardhat-toolbox";
+${upgradeable ? `import "@openzeppelin/hardhat-upgrades";` : ''}
+
+const config: HardhatUserConfig = {
+  solidity: {
+    version: "${solidity_version_json_1.default}",
+    settings: {
+      optimizer: {
+        enabled: true,
+      },
+    },
+  },
+};
+
+export default config;
+`;
+const tsConfig = `\
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}
+`;
+const gitIgnore = `\
+node_modules
+.env
+coverage
+coverage.json
+typechain
+typechain-types
+
+#Hardhat files
+cache
+artifacts
+`;
+const test = (c, opts) => {
+    return (0, format_lines_1.formatLinesWithSpaces)(2, ...(0, format_lines_1.spaceBetween)(getImports(c), getTestCase(c)));
+    function getTestCase(c) {
+        return [
+            `describe("${c.name}", function () {`,
+            [
+                'it("Test contract", async function () {',
+                (0, format_lines_1.spaceBetween)([
+                    `const ContractFactory = await ethers.getContractFactory("${c.name}");`,
+                ], [
+                    `const instance = await ${c.upgradeable ? 'upgrades.deployProxy(ContractFactory)' : 'ContractFactory.deploy()'};`,
+                    'await instance.deployed();'
+                ], getContractSpecificExpects()),
+                '});'
+            ],
+            '});',
+        ];
+    }
+    function getImports(c) {
+        return [
+            'import { expect } from "chai";',
+            `import { ${getHardhatPlugins(c).join(', ')} } from "hardhat";`,
+        ];
+    }
+    function getContractSpecificExpects() {
+        if (opts !== undefined) {
+            switch (opts.kind) {
+                case 'ERC20':
+                case 'ERC721':
+                    return [`expect(await instance.name()).to.equal("${opts.name}");`];
+                case 'ERC1155':
+                    return [`expect(await instance.uri(0)).to.equal("${opts.uri}");`];
+                case 'Governor':
+                case 'Custom':
+                    break;
+                default:
+                    throw new Error('Unknown ERC');
+            }
+        }
+        return [];
+    }
+};
+const script = (c) => `\
+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();
+
+  console.log(\`${c.upgradeable ? 'Proxy' : 'Contract'} deployed to \${instance.address}\`);
+}
+
+// We recommend this pattern to be able to use async/await everywhere
+// and properly handle errors.
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});
+`;
+const readme = `\
+# 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.
+
+## Installing dependencies
+
+\`\`\`
+npm install
+\`\`\`
+
+## Testing the contract
+
+\`\`\`
+npm test
+\`\`\`
+
+## Deploying the contract
+
+You can target any network from your Hardhat config using:
+
+\`\`\`
+npx hardhat run --network <network-name> scripts/deploy.ts
+\`\`\`
+`;
+function getHardhatPlugins(c) {
+    let plugins = ['ethers'];
+    if (c.upgradeable) {
+        plugins.push('upgrades');
+    }
+    return plugins;
+}
+async function zipHardhat(c, opts) {
+    const zip = new jszip_1.default();
+    const { default: packageJson } = c.upgradeable ? await Promise.resolve().then(() => __importStar(require("./environments/hardhat/upgradeable/package.json"))) : await Promise.resolve().then(() => __importStar(require("./environments/hardhat/package.json")));
+    packageJson.license = c.license;
+    const { default: packageLock } = c.upgradeable ? await Promise.resolve().then(() => __importStar(require("./environments/hardhat/upgradeable/package-lock.json"))) : await Promise.resolve().then(() => __importStar(require("./environments/hardhat/package-lock.json")));
+    packageLock.packages[''].license = c.license;
+    zip.file(`contracts/${c.name}.sol`, (0, print_1.printContract)(c));
+    zip.file('test/test.ts', test(c, opts));
+    zip.file('scripts/deploy.ts', script(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('tsconfig.json', tsConfig);
+    return zip;
+}
+exports.zipHardhat = zipHardhat;
+//# sourceMappingURL=zip-hardhat.js.map

package/dist/zip-hardhat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-hardhat.js","sourceRoot":"","sources":["../src/zip-hardhat.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAG1B,mCAAwC;AACxC,oFAAuD;AACvD,uDAAkF;AAElF,MAAM,aAAa,GAAG,CAAC,WAAoB,EAAE,EAAE,CAAC;;;EAG9C,WAAW,CAAC,CAAC,CAAC,0CAA0C,CAAC,CAAC,CAAC,EAAE;;;;gBAI/C,+BAAgB;;;;;;;;;;CAU/B,CAAC;AAEF,MAAM,QAAQ,GAAG;;;;;;;;;;;CAWhB,CAAC;AAEF,MAAM,SAAS,GAAG;;;;;;;;;;;CAWjB,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,CAAW,EAAE,IAAqB,EAAE,EAAE;IAClD,OAAO,IAAA,oCAAqB,EAC1B,CAAC,EACD,GAAG,IAAA,2BAAY,EACb,UAAU,CAAC,CAAC,CAAC,EACb,WAAW,CAAC,CAAC,CAAC,CACf,CACF,CAAC;IAEF,SAAS,WAAW,CAAC,CAAW;QAC9B,OAAO;YACL,aAAa,CAAC,CAAC,IAAI,kBAAkB;YACrC;gBACE,yCAAyC;gBACzC,IAAA,2BAAY,EACV;oBACE,4DAA4D,CAAC,CAAC,IAAI,KAAK;iBACxE,EACD;oBACE,0BAA0B,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,uCAAuC,CAAC,CAAC,CAAC,0BAA0B,GAAG;oBACjH,4BAA4B;iBAC7B,EACD,0BAA0B,EAAE,CAC7B;gBACD,KAAK;aACN;YACD,KAAK;SACN,CAAC;IACJ,CAAC;IAED,SAAS,UAAU,CAAC,CAAW;QAC7B,OAAO;YACL,gCAAgC;YAChC,YAAY,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB;SAChE,CAAC;IACJ,CAAC;IAED,SAAS,0BAA0B;QACjC,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACjB,KAAK,OAAO,CAAC;gBACb,KAAK,QAAQ;oBACX,OAAO,CAAC,2CAA2C,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC;gBAErE,KAAK,SAAS;oBACZ,OAAO,CAAC,2CAA2C,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;gBAEpE,KAAK,UAAU,CAAC;gBAChB,KAAK,QAAQ;oBACX,MAAM;gBAER;oBACE,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;aAClC;SACF;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAW,EAAE,EAAE,CAAC;WACrB,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;6DAGmB,CAAC,CAAC,IAAI;;2BAExC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,uCAAuC,CAAC,CAAC,CAAC,0BAA0B;;;kBAG7F,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU;;;;;;;;;CASrD,CAAC;AAEF,MAAM,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;CAwBd,CAAC;AAEF,SAAS,iBAAiB,CAAC,CAAW;IACpC,IAAI,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzB,IAAI,CAAC,CAAC,WAAW,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KAC1B;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAEM,KAAK,UAAU,UAAU,CAAC,CAAW,EAAE,IAAqB;IACjE,MAAM,GAAG,GAAG,IAAI,eAAK,EAAE,CAAC;IAExB,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,wDAAa,iDAAiD,GAAC,CAAC,CAAC,CAAC,wDAAa,qCAAqC,GAAC,CAAC;IACvK,WAAW,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;IAEhC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,wDAAa,sDAAsD,GAAC,CAAC,CAAC,CAAC,wDAAa,0CAA0C,GAAC,CAAC;IACjL,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;IAE7C,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,MAAM,EAAE,IAAA,qBAAa,EAAC,CAAC,CAAC,CAAC,CAAC;IACtD,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACxC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAClC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/D,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACpE,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC9B,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAEpC,OAAO,GAAG,CAAC;AACb,CAAC;AApBD,gCAoBC"}

package/dist/zip.js

@@ -28,7 +28,7 @@ function zipContract(c) {
     const contractsVariant = c.upgradeable ? '-upgradeable' : '';
     const fileName = c.name + '.sol';
     const dependencies = {
-        [fileName]: c.parents.map(p => transformImport(p.contract.path)),
+        [fileName]: c.imports.map(i => transformImport(i)),
         ...openzeppelin_contracts_1.default.dependencies,
     };
     const allImports = (0, transitive_closure_1.reachable)(dependencies, fileName);

package/dist/zip.js.map

@@ -1 +1 @@
-{"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,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChE,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"}
+{"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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "A boilerplate generator to get started with OpenZeppelin Contracts",
   "license": "MIT",
   "repository": "github:OpenZeppelin/contracts-wizard",
@@ -9,27 +9,29 @@
   "files": [
     "/dist",
     "/src",
-    "!*.test.{js,d.ts}{,.map}"
+    "!**/*.test.*"
   ],
   "scripts": {
     "prepare": "tsc && node dist/scripts/prepare.js",
     "prepublish": "rimraf dist *.tsbuildinfo && hardhat clean",
     "test": "ava",
-    "test:watch": "ava --watch"
+    "test:watch": "ava --watch",
+    "version": "node ../../scripts/bump-changelog.js",
+    "update-env": "rm ./src/environments/hardhat/package-lock.json && npm install --package-lock-only --prefix ./src/environments/hardhat && rm ./src/environments/hardhat/upgradeable/package-lock.json && npm install --package-lock-only --prefix ./src/environments/hardhat/upgradeable"
   },
   "devDependencies": {
-    "@openzeppelin/contracts": "4.7.0",
-    "@openzeppelin/contracts-upgradeable": "4.7.0",
+    "@openzeppelin/contracts": "4.8.2",
+    "@openzeppelin/contracts-upgradeable": "4.8.2",
     "@types/node": "^10.17.51",
     "@types/rimraf": "^3.0.0",
     "array.prototype.flat": "^1.2.4",
-    "ava": "^4.0.0",
+    "ava": "^5.0.0",
     "hardhat": "^2.1.1",
     "jszip": "^3.6.0",
     "rimraf": "^3.0.2",
     "solidity-ast": "^0.4.18",
     "ts-node": "^10.4.0",
-    "typescript": "^4.1.3"
+    "typescript": "^4.9.0"
   },
   "dependencies": {
     "array.prototype.flatmap": "^1.2.4"