@openzeppelin/wizard 0.1.0 → 0.1.1

package/dist/set-access-control.js

@@ -1,21 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setAccessControl = exports.accessOptions = void 0;
+exports.requireAccessControl = exports.setAccessControl = exports.accessOptions = void 0;
 const common_functions_1 = require("./common-functions");
-exports.accessOptions = ['ownable', 'roles'];
-function setAccessControl(c, fn, access, role) {
+exports.accessOptions = [false, 'ownable', 'roles'];
+/**
+ * Sets access control for the contract by adding inheritance.
+ */
+function setAccessControl(c, access) {
     switch (access) {
         case 'ownable': {
             c.addParent(parents.Ownable);
-            c.addModifier('onlyOwner', fn);
             break;
         }
         case 'roles': {
-            const roleId = role + '_ROLE';
             if (c.addParent(parents.AccessControl)) {
                 c.addConstructorCode('_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);');
             }
             c.addOverride(parents.AccessControl.name, common_functions_1.supportsInterface);
+            break;
+        }
+    }
+}
+exports.setAccessControl = setAccessControl;
+/**
+ * Enables access control for the contract and restricts the given function with access control.
+ */
+function requireAccessControl(c, fn, access, role) {
+    if (access === false) {
+        access = 'ownable';
+    }
+    setAccessControl(c, access);
+    switch (access) {
+        case 'ownable': {
+            c.addModifier('onlyOwner', fn);
+            break;
+        }
+        case 'roles': {
+            const roleId = role + '_ROLE';
             if (c.addVariable(`bytes32 public constant ${roleId} = keccak256("${roleId}");`)) {
                 c.addConstructorCode(`_grantRole(${roleId}, msg.sender);`);
             }
@@ -24,7 +45,7 @@ function setAccessControl(c, fn, access, role) {
         }
     }
 }
-exports.setAccessControl = setAccessControl;
+exports.requireAccessControl = requireAccessControl;
 const parents = {
     Ownable: {
         name: 'Ownable',

package/dist/set-access-control.js.map

@@ -1 +1 @@
-{"version":3,"file":"set-access-control.js","sourceRoot":"","sources":["../src/set-access-control.ts"],"names":[],"mappings":";;;AACA,yDAAuD;AAE1C,QAAA,aAAa,GAAG,CAAC,SAAS,EAAE,OAAO,CAAU,CAAC;AAI3D,SAAgB,gBAAgB,CAAC,CAAkB,EAAE,EAAgB,EAAE,MAAc,EAAE,IAAY;IACjG,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACd,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7B,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,MAAM;SACP;QACD,KAAK,OAAO,CAAC,CAAC;YACZ,MAAM,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC;YAC9B,IAAI,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;gBACtC,CAAC,CAAC,kBAAkB,CAAC,6CAA6C,CAAC,CAAC;aACrE;YACD,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,oCAAiB,CAAC,CAAC;YAC7D,IAAI,CAAC,CAAC,WAAW,CAAC,2BAA2B,MAAM,iBAAiB,MAAM,KAAK,CAAC,EAAE;gBAChF,CAAC,CAAC,kBAAkB,CAAC,cAAc,MAAM,gBAAgB,CAAC,CAAC;aAC5D;YACD,CAAC,CAAC,WAAW,CAAC,YAAY,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC;YACzC,MAAM;SACP;KACF;AACH,CAAC;AApBD,4CAoBC;AAED,MAAM,OAAO,GAAG;IACd,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,4CAA4C;KACnD;IACD,aAAa,EAAE;QACb,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,kDAAkD;KACzD;CACF,CAAC"}
+{"version":3,"file":"set-access-control.js","sourceRoot":"","sources":["../src/set-access-control.ts"],"names":[],"mappings":";;;AACA,yDAAuD;AAE1C,QAAA,aAAa,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AAIlE;;GAEG;AACH,SAAgB,gBAAgB,CAAC,CAAkB,EAAE,MAAc;IACjE,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACd,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7B,MAAM;SACP;QACD,KAAK,OAAO,CAAC,CAAC;YACZ,IAAI,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;gBACtC,CAAC,CAAC,kBAAkB,CAAC,6CAA6C,CAAC,CAAC;aACrE;YACD,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,oCAAiB,CAAC,CAAC;YAC7D,MAAM;SACP;KACF;AACH,CAAC;AAdD,4CAcC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,CAAkB,EAAE,EAAgB,EAAE,MAAc,EAAE,IAAY;IACrG,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,MAAM,GAAG,SAAS,CAAC;KACpB;IAED,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAE5B,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS,CAAC,CAAC;YACd,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC/B,MAAM;SACP;QACD,KAAK,OAAO,CAAC,CAAC;YACZ,MAAM,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC;YAC9B,IAAI,CAAC,CAAC,WAAW,CAAC,2BAA2B,MAAM,iBAAiB,MAAM,KAAK,CAAC,EAAE;gBAChF,CAAC,CAAC,kBAAkB,CAAC,cAAc,MAAM,gBAAgB,CAAC,CAAC;aAC5D;YACD,CAAC,CAAC,WAAW,CAAC,YAAY,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC;YACzC,MAAM;SACP;KACF;AACH,CAAC;AArBD,oDAqBC;AAED,MAAM,OAAO,GAAG;IACd,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,4CAA4C;KACnD;IACD,aAAa,EAAE;QACb,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,kDAAkD;KACzD;CACF,CAAC"}

package/dist/set-upgradeable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"set-upgradeable.d.ts","sourceRoot":"","sources":["../src/set-upgradeable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,MAAM,EAAoB,MAAM,sBAAsB,CAAC;AAGhE,eAAO,MAAM,kBAAkB,yCAA0C,CAAC;AAE1E,oBAAY,WAAW,GAAG,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AAE5D,wBAAgB,cAAc,CAAC,CAAC,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,QA+B1F"}
+{"version":3,"file":"set-upgradeable.d.ts","sourceRoot":"","sources":["../src/set-upgradeable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,MAAM,EAAwB,MAAM,sBAAsB,CAAC;AAGpE,eAAO,MAAM,kBAAkB,yCAA0C,CAAC;AAE1E,oBAAY,WAAW,GAAG,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AAE5D,wBAAgB,cAAc,CAAC,CAAC,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,QA+B1F"}

package/dist/set-upgradeable.js

@@ -16,7 +16,7 @@ function setUpgradeable(c, upgradeable, access) {
     switch (upgradeable) {
         case 'transparent': break;
         case 'uups': {
-            (0, set_access_control_1.setAccessControl)(c, functions._authorizeUpgrade, access, 'UPGRADER');
+            (0, set_access_control_1.requireAccessControl)(c, functions._authorizeUpgrade, access, 'UPGRADER');
             c.addParent({
                 name: 'UUPSUpgradeable',
                 path: '@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol',

package/dist/set-upgradeable.js.map

@@ -1 +1 @@
-{"version":3,"file":"set-upgradeable.js","sourceRoot":"","sources":["../src/set-upgradeable.ts"],"names":[],"mappings":";;;AACA,6DAAgE;AAChE,+DAA2D;AAE9C,QAAA,kBAAkB,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAU,CAAC;AAI1E,SAAgB,cAAc,CAAC,CAAkB,EAAE,WAAwB,EAAE,MAAc;IACzF,IAAI,WAAW,KAAK,KAAK,EAAE;QACzB,OAAO;KACR;IAED,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC;IAErB,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,uDAAuD;KAC9D,CAAC,CAAC;IAEH,QAAQ,WAAW,EAAE;QACnB,KAAK,aAAa,CAAC,CAAC,MAAM;QAE1B,KAAK,MAAM,CAAC,CAAC;YACX,IAAA,qCAAgB,EAAC,CAAC,EAAE,SAAS,CAAC,iBAAiB,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;YACrE,CAAC,CAAC,SAAS,CAAC;gBACV,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,yDAAyD;aAChE,CAAC,CAAC;YACH,CAAC,CAAC,WAAW,CAAC,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAC9D,CAAC,CAAC,eAAe,CAAC,EAAE,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;YACnD,MAAM;SACP;QAED,OAAO,CAAC,CAAC;YACP,MAAM,CAAC,GAAU,WAAW,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;KACF;AACH,CAAC;AA/BD,wCA+BC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,iBAAiB,EAAE;QACjB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;SAC/C;QACD,IAAI,EAAE,UAAU;KACjB;CACF,CAAC,CAAC"}
+{"version":3,"file":"set-upgradeable.js","sourceRoot":"","sources":["../src/set-upgradeable.ts"],"names":[],"mappings":";;;AACA,6DAAoE;AACpE,+DAA2D;AAE9C,QAAA,kBAAkB,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAU,CAAC;AAI1E,SAAgB,cAAc,CAAC,CAAkB,EAAE,WAAwB,EAAE,MAAc;IACzF,IAAI,WAAW,KAAK,KAAK,EAAE;QACzB,OAAO;KACR;IAED,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC;IAErB,CAAC,CAAC,SAAS,CAAC;QACV,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,uDAAuD;KAC9D,CAAC,CAAC;IAEH,QAAQ,WAAW,EAAE;QACnB,KAAK,aAAa,CAAC,CAAC,MAAM;QAE1B,KAAK,MAAM,CAAC,CAAC;YACX,IAAA,yCAAoB,EAAC,CAAC,EAAE,SAAS,CAAC,iBAAiB,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;YACzE,CAAC,CAAC,SAAS,CAAC;gBACV,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,yDAAyD;aAChE,CAAC,CAAC;YACH,CAAC,CAAC,WAAW,CAAC,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAC9D,CAAC,CAAC,eAAe,CAAC,EAAE,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC;YACnD,MAAM;SACP;QAED,OAAO,CAAC,CAAC;YACP,MAAM,CAAC,GAAU,WAAW,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;KACF;AACH,CAAC;AA/BD,wCA+BC;AAED,MAAM,SAAS,GAAG,IAAA,kCAAe,EAAC;IAChC,iBAAiB,EAAE;QACjB,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;SAC/C;QACD,IAAI,EAAE,UAAU;KACjB;CACF,CAAC,CAAC"}

package/dist/test.js

@@ -5,9 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const ava_1 = __importDefault(require("ava"));
 const hardhat_1 = __importDefault(require("hardhat"));
-require("util");
 const path_1 = __importDefault(require("path"));
 const sources_1 = require("./generate/sources");
+const api_1 = require("./api");
 (0, ava_1.default)('result compiles', async (t) => {
     const generatedSourcesPath = path_1.default.join(hardhat_1.default.config.paths.sources, 'generated');
     await (0, sources_1.writeGeneratedSources)(generatedSourcesPath, 'all');
@@ -20,4 +20,33 @@ const sources_1 = require("./generate/sources");
     await hardhat_1.default.run('compile');
     t.pass();
 });
+function isAccessControlRequired(opts) {
+    switch (opts.kind) {
+        case 'ERC20':
+            return api_1.erc20.isAccessControlRequired(opts);
+        case 'ERC721':
+            return api_1.erc721.isAccessControlRequired(opts);
+        case 'ERC1155':
+            return api_1.erc1155.isAccessControlRequired(opts);
+        case 'Governor':
+            return api_1.governor.isAccessControlRequired(opts);
+        case 'Custom':
+            return api_1.custom.isAccessControlRequired(opts);
+        default:
+            throw new Error("No such kind");
+    }
+}
+(0, ava_1.default)('is access control required', async (t) => {
+    for (const contract of (0, sources_1.generateSources)('all')) {
+        const regexOwnable = /import.*Ownable(Upgradeable)?.sol.*/gm;
+        if (!contract.options.access) {
+            if (isAccessControlRequired(contract.options)) {
+                t.regex(contract.source, regexOwnable, JSON.stringify(contract.options));
+            }
+            else {
+                t.notRegex(contract.source, regexOwnable, JSON.stringify(contract.options));
+            }
+        }
+    }
+});
 //# sourceMappingURL=test.js.map

package/dist/test.js.map

@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,sDAA0B;AAC1B,gBAAiC;AACjC,gDAAwB;AAExB,gDAA2D;AAE3D,IAAA,aAAI,EAAC,iBAAiB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAChC,MAAM,oBAAoB,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9E,MAAM,IAAA,+BAAqB,EAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAEzD,2EAA2E;IAC3E,2EAA2E;IAC3E,wCAAwC;IACxC,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,iBAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE;QACxD,QAAQ,CAAC,eAAe,GAAG,EAAE,CAAC;KAC/B;IAED,MAAM,iBAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzB,CAAC,CAAC,IAAI,EAAE,CAAC;AACX,CAAC,CAAC,CAAC"}
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,sDAA0B;AAC1B,gDAAwB;AAExB,gDAA4E;AAE5E,+BAAiE;AAEjE,IAAA,aAAI,EAAC,iBAAiB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAChC,MAAM,oBAAoB,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9E,MAAM,IAAA,+BAAqB,EAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAEzD,2EAA2E;IAC3E,2EAA2E;IAC3E,wCAAwC;IACxC,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,iBAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE;QACxD,QAAQ,CAAC,eAAe,GAAG,EAAE,CAAC;KAC/B;IAED,MAAM,iBAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzB,CAAC,CAAC,IAAI,EAAE,CAAC;AACX,CAAC,CAAC,CAAC;AAEH,SAAS,uBAAuB,CAAC,IAAoB;IACnD,QAAO,IAAI,CAAC,IAAI,EAAE;QAChB,KAAK,OAAO;YACV,OAAO,WAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,QAAQ;YACX,OAAO,YAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC9C,KAAK,SAAS;YACZ,OAAO,aAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC/C,KAAK,UAAU;YACb,OAAO,cAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAChD,KAAK,QAAQ;YACX,OAAO,YAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC9C;YACE,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;KACnC;AACH,CAAC;AAED,IAAA,aAAI,EAAC,4BAA4B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3C,KAAK,MAAM,QAAQ,IAAI,IAAA,yBAAe,EAAC,KAAK,CAAC,EAAE;QAC7C,MAAM,YAAY,GAAG,uCAAuC,CAAC;QAE7D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;YAC5B,IAAI,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAC7C,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;aAC1E;iBAAM;gBACL,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;aAC7E;SACF;KACF;AACH,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A boilerplate generator to get started with OpenZeppelin Contracts",
   "license": "MIT",
   "repository": "github:OpenZeppelin/contracts-wizard",
@@ -18,8 +18,8 @@
     "test:watch": "ava --watch"
   },
   "devDependencies": {
-    "@openzeppelin/contracts": "4.6.0",
-    "@openzeppelin/contracts-upgradeable": "4.6.0",
+    "@openzeppelin/contracts": "4.7.0",
+    "@openzeppelin/contracts-upgradeable": "4.7.0",
     "@types/node": "^10.17.51",
     "@types/rimraf": "^3.0.0",
     "array.prototype.flat": "^1.2.4",

package/src/add-pausable.ts

@@ -1,5 +1,5 @@
 import type { ContractBuilder, BaseFunction } from './contract';
-import { Access, setAccessControl } from './set-access-control';
+import { Access, requireAccessControl } from './set-access-control';
 import { defineFunctions } from './utils/define-functions';
 
 export function addPausable(c: ContractBuilder, access: Access, pausableFns: BaseFunction[]) {
@@ -12,10 +12,10 @@ export function addPausable(c: ContractBuilder, access: Access, pausableFns: Bas
     c.addModifier('whenNotPaused', fn);
   }
 
-  setAccessControl(c, functions.pause, access, 'PAUSER');
+  requireAccessControl(c, functions.pause, access, 'PAUSER');
   c.addFunctionCode('_pause();', functions.pause);
 
-  setAccessControl(c, functions.unpause, access, 'PAUSER');
+  requireAccessControl(c, functions.unpause, access, 'PAUSER');
   c.addFunctionCode('_unpause();', functions.unpause);
 }
 

package/src/api.ts

@@ -1,8 +1,9 @@
 import type { CommonOptions } from './common-options';
-import { printERC20, defaults as erc20defaults, ERC20Options } from './erc20';
-import { printERC721, defaults as erc721defaults, ERC721Options } from './erc721';
-import { printERC1155, defaults as erc1155defaults, ERC1155Options } from './erc1155';
-import { printGovernor, defaults as governorDefaults, GovernorOptions } from './governor';
+import { printERC20, defaults as erc20defaults, isAccessControlRequired as erc20IsAccessControlRequired, ERC20Options } from './erc20';
+import { printERC721, defaults as erc721defaults, isAccessControlRequired as erc721IsAccessControlRequired, ERC721Options } from './erc721';
+import { printERC1155, defaults as erc1155defaults, isAccessControlRequired as erc1155IsAccessControlRequired, ERC1155Options } from './erc1155';
+import { printGovernor, defaults as governorDefaults, isAccessControlRequired as governorIsAccessControlRequired, GovernorOptions } from './governor';
+import { printCustom, defaults as customDefaults, isAccessControlRequired as customIsAccessControlRequired, CustomOptions } from './custom';
 
 export interface WizardContractAPI<Options extends CommonOptions> {
   /**
@@ -14,26 +15,42 @@ export interface WizardContractAPI<Options extends CommonOptions> {
    * The default options that are used for `print`.
    */
   defaults: Required<Options>;
+
+  /**
+   * Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the 
+   * same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`. 
+   */
+  isAccessControlRequired: (opts: Partial<Options>) => boolean,
 }
 
 export type ERC20 = WizardContractAPI<ERC20Options>;
 export type ERC721 = WizardContractAPI<ERC721Options>;
 export type ERC1155 = WizardContractAPI<ERC1155Options>;
 export type Governor = WizardContractAPI<GovernorOptions>;
+export type Custom = WizardContractAPI<CustomOptions>;
 
 export const erc20: ERC20 = {
   print: printERC20,
-  defaults: erc20defaults
+  defaults: erc20defaults,
+  isAccessControlRequired: erc20IsAccessControlRequired
 }
 export const erc721: ERC721 = {
   print: printERC721,
-  defaults: erc721defaults
+  defaults: erc721defaults,
+  isAccessControlRequired: erc721IsAccessControlRequired
 }
 export const erc1155: ERC1155 = {
   print: printERC1155,
-  defaults: erc1155defaults
+  defaults: erc1155defaults,
+  isAccessControlRequired: erc1155IsAccessControlRequired
 }
 export const governor: Governor = {
   print: printGovernor,
-  defaults: governorDefaults
+  defaults: governorDefaults,
+  isAccessControlRequired: governorIsAccessControlRequired
+}
+export const custom: Custom = {
+  print: printCustom,
+  defaults: customDefaults,
+  isAccessControlRequired: customIsAccessControlRequired
 }

package/src/build-generic.ts

@@ -1,3 +1,4 @@
+import { CustomOptions, buildCustom } from './custom';
 import { ERC20Options, buildERC20 } from './erc20';
 import { ERC721Options, buildERC721 } from './erc721';
 import { ERC1155Options, buildERC1155 } from './erc1155';
@@ -8,6 +9,7 @@ export interface KindedOptions {
   ERC721:   { kind: 'ERC721' }   & ERC721Options;
   ERC1155:  { kind: 'ERC1155' }  & ERC1155Options;
   Governor: { kind: 'Governor' } & GovernorOptions;
+  Custom:  { kind: 'Custom' }  & CustomOptions;
 }
 
 export type GenericOptions = KindedOptions[keyof KindedOptions];
@@ -26,6 +28,9 @@ export function buildGeneric(opts: GenericOptions) {
     case 'Governor':
       return buildGovernor(opts);
 
+    case 'Custom':
+      return buildCustom(opts);
+
     default:
       const _: never = opts;
       throw new Error('Unknown ERC');

package/src/common-options.ts

@@ -4,7 +4,7 @@ import { defaults as infoDefaults } from "./set-info";
 import type { Upgradeable } from "./set-upgradeable";
 
 export const defaults: Required<CommonOptions> = {
-  access: 'ownable',
+  access: false,
   upgradeable: false,
   info: infoDefaults,
 } as const;
@@ -17,7 +17,7 @@ export interface CommonOptions {
 
 export function withCommonDefaults(opts: CommonOptions): Required<CommonOptions> {
   return {
-    access: opts.access ?? 'ownable',
+    access: opts.access ?? false,
     upgradeable: opts.upgradeable ?? false,
     info: opts.info ?? {},
   };

package/src/custom.test.ts

@@ -0,0 +1,80 @@
+import test from 'ava';
+import { custom } from '.';
+
+import { buildCustom, CustomOptions } from './custom';
+import { printContract } from './print';
+
+function testCustom(title: string, opts: Partial<CustomOptions>) {
+  test(title, t => {
+    const c = buildCustom({
+      name: 'MyContract',
+      ...opts,
+    });
+    t.snapshot(printContract(c));
+  });
+}
+
+/**
+ * Tests external API for equivalence with internal API
+ */
+ function testAPIEquivalence(title: string, opts?: CustomOptions) {
+  test(title, t => {
+    t.is(custom.print(opts), printContract(buildCustom({
+      name: 'MyContract',
+      ...opts,
+    })));
+  });
+}
+
+testCustom('custom', {});
+
+testCustom('pausable', {
+  pausable: true,
+});
+
+testCustom('upgradeable transparent', {
+  upgradeable: 'transparent',
+});
+
+testCustom('upgradeable uups', {
+  upgradeable: 'uups',
+});
+
+testCustom('access control disabled', {
+  access: false,
+});
+
+testCustom('access control ownable', {
+  access: 'ownable',
+});
+
+testCustom('access control roles', {
+  access: 'roles',
+});
+
+testCustom('upgradeable uups with access control disabled', {
+  // API should override access to true since it is required for UUPS
+  access: false,
+  upgradeable: 'uups',
+});
+
+testAPIEquivalence('custom API default');
+
+testAPIEquivalence('custom API basic', { name: 'CustomContract' });
+
+testAPIEquivalence('custom API full upgradeable', {
+  name: 'CustomContract',
+  access: 'roles',
+  pausable: true,
+  upgradeable: 'uups',
+});
+
+test('custom API assert defaults', async t => {
+  t.is(custom.print(custom.defaults), custom.print());
+});
+
+test('API isAccessControlRequired', async t => {
+  t.is(custom.isAccessControlRequired({ pausable: true }), true);
+  t.is(custom.isAccessControlRequired({ upgradeable: 'uups' }), true);
+  t.is(custom.isAccessControlRequired({ upgradeable: 'transparent' }), false);
+});

package/src/custom.test.ts.md

@@ -0,0 +1,154 @@
+# Snapshot report for `src/custom.test.ts`
+
+The actual snapshot is saved in `custom.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## custom
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    contract MyContract {␊
+    }␊
+    `
+
+## pausable
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/security/Pausable.sol";␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    ␊
+    contract MyContract is Pausable, Ownable {␊
+        function pause() public onlyOwner {␊
+            _pause();␊
+        }␊
+    ␊
+        function unpause() public onlyOwner {␊
+            _unpause();␊
+        }␊
+    }␊
+    `
+
+## upgradeable transparent
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
+    ␊
+    contract MyContract is Initializable {␊
+        /// @custom:oz-upgrades-unsafe-allow constructor␊
+        constructor() {␊
+            _disableInitializers();␊
+        }␊
+    }␊
+    `
+
+## upgradeable uups
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
+    ␊
+    contract MyContract is Initializable, OwnableUpgradeable, UUPSUpgradeable {␊
+        /// @custom:oz-upgrades-unsafe-allow constructor␊
+        constructor() {␊
+            _disableInitializers();␊
+        }␊
+    ␊
+        function initialize() initializer public {␊
+            __Ownable_init();␊
+            __UUPSUpgradeable_init();␊
+        }␊
+    ␊
+        function _authorizeUpgrade(address newImplementation)␊
+            internal␊
+            onlyOwner␊
+            override␊
+        {}␊
+    }␊
+    `
+
+## access control disabled
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    contract MyContract {␊
+    }␊
+    `
+
+## access control ownable
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    ␊
+    contract MyContract is Ownable {␊
+    }␊
+    `
+
+## access control roles
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/access/AccessControl.sol";␊
+    ␊
+    contract MyContract is AccessControl {␊
+        constructor() {␊
+            _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
+        }␊
+    }␊
+    `
+
+## upgradeable uups with access control disabled
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
+    ␊
+    contract MyContract is Initializable, OwnableUpgradeable, UUPSUpgradeable {␊
+        /// @custom:oz-upgrades-unsafe-allow constructor␊
+        constructor() {␊
+            _disableInitializers();␊
+        }␊
+    ␊
+        function initialize() initializer public {␊
+            __Ownable_init();␊
+            __UUPSUpgradeable_init();␊
+        }␊
+    ␊
+        function _authorizeUpgrade(address newImplementation)␊
+            internal␊
+            onlyOwner␊
+            override␊
+        {}␊
+    }␊
+    `

package/src/custom.ts

@@ -0,0 +1,55 @@
+import { Contract, ContractBuilder } from './contract';
+import { CommonOptions, withCommonDefaults, defaults as commonDefaults } from './common-options';
+import { setUpgradeable } from './set-upgradeable';
+import { setInfo } from './set-info';
+import { setAccessControl } from './set-access-control';
+import { addPausable } from './add-pausable';
+import { printContract } from './print';
+
+export interface CustomOptions extends CommonOptions {
+  name: string;
+  pausable?: boolean;
+}
+
+export const defaults: Required<CustomOptions> = {
+  name: 'MyContract',
+  pausable: false,
+  access: commonDefaults.access,
+  upgradeable: commonDefaults.upgradeable,
+  info: commonDefaults.info,
+} as const;
+
+function withDefaults(opts: CustomOptions): Required<CustomOptions> {
+  return {
+    ...opts,
+    ...withCommonDefaults(opts),
+    pausable: opts.pausable ?? defaults.pausable,
+  };
+}
+
+export function printCustom(opts: CustomOptions = defaults): string {
+  return printContract(buildCustom(opts));
+}
+
+export function isAccessControlRequired(opts: Partial<CustomOptions>): boolean {
+  return opts.pausable || opts.upgradeable === 'uups';
+}
+
+export function buildCustom(opts: CustomOptions): Contract {
+  const allOpts = withDefaults(opts);
+
+  const c = new ContractBuilder(allOpts.name);
+
+  const { access, upgradeable, info } = allOpts;
+
+  if (allOpts.pausable) {
+    addPausable(c, access, []);
+  }
+
+  setAccessControl(c, access);
+  setUpgradeable(c, upgradeable, access);
+  setInfo(c, info);
+
+  return c;
+}
+

package/src/erc1155.test.ts

@@ -34,6 +34,10 @@ testERC1155('basic + roles', {
   access: 'roles',
 });
 
+testERC1155('no updatable uri', {
+  updatableUri: false,
+});
+
 testERC1155('burnable', {
   burnable: true,
 });
@@ -87,4 +91,13 @@ testAPIEquivalence('API full upgradeable', {
 
 test('API assert defaults', async t => {
   t.is(erc1155.print(erc1155.defaults), erc1155.print());
+});
+
+test('API isAccessControlRequired', async t => {
+  t.is(erc1155.isAccessControlRequired({ updatableUri: false, mintable: true }), true);
+  t.is(erc1155.isAccessControlRequired({ updatableUri: false, pausable: true }), true);
+  t.is(erc1155.isAccessControlRequired({ updatableUri: false, upgradeable: 'uups' }), true);
+  t.is(erc1155.isAccessControlRequired({ updatableUri: true }), true);
+  t.is(erc1155.isAccessControlRequired({ updatableUri: false}), false);
+  t.is(erc1155.isAccessControlRequired({}), true); // updatableUri is true by default
 });

package/src/erc1155.test.ts.md

@@ -62,6 +62,22 @@ Generated by [AVA](https://avajs.dev).
     }␊
     `
 
+## no updatable uri
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    ␊
+    contract MyToken is ERC1155 {␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {}␊
+    }␊
+    `
+
 ## burnable
 
 > Snapshot 1