@openzeppelin/wizard 0.3.0 → 0.4.0

package/src/environments/hardhat/upgradeable/package.json

@@ -9,27 +9,10 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@openzeppelin/contracts-upgradeable": "^4.8.3",
-    "@openzeppelin/hardhat-upgrades": "^1.21.0",
-    "@ethersproject/abi": "^5.7.0",
-    "@ethersproject/providers": "^5.7.2",
-    "@nomicfoundation/hardhat-chai-matchers": "^1.0.4",
-    "@nomicfoundation/hardhat-network-helpers": "^1.0.6",
-    "@nomicfoundation/hardhat-toolbox": "^2.0.0",
-    "@nomiclabs/hardhat-ethers": "^2.2.0",
-    "@nomiclabs/hardhat-etherscan": "^3.1.1",
-    "@typechain/ethers-v5": "^10.1.1",
-    "@typechain/hardhat": "^6.1.4",
-    "@types/chai": "^4.3.3",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^18.11.6",
-    "chai": "^4.3.6",
-    "ethers": "^5.7.2",
-    "hardhat": "^2.12.0",
-    "hardhat-gas-reporter": "^1.0.9",
-    "solidity-coverage": "^0.8.2",
-    "ts-node": "^10.9.1",
-    "typechain": "^8.1.1",
-    "typescript": "^4.8.4"
+    "@openzeppelin/contracts": "^5.0.0",
+    "@openzeppelin/contracts-upgradeable": "^5.0.0",
+    "@openzeppelin/hardhat-upgrades": "^2.0.0",
+    "@nomicfoundation/hardhat-toolbox": "^3.0.0",
+    "hardhat": "^2.16.1"
   }
 }

package/src/erc1155.ts

@@ -1,6 +1,6 @@
 import { Contract, ContractBuilder } from './contract';
 import { Access, setAccessControl, requireAccessControl } from './set-access-control';
-import { addPausable } from './add-pausable';
+import { addPauseFunctions } from './add-pausable';
 import { supportsInterface } from './common-functions';
 import { defineFunctions } from './utils/define-functions';
 import { CommonOptions, withCommonDefaults, defaults as commonDefaults } from './common-options';
@@ -65,7 +65,7 @@ export function buildERC1155(opts: ERC1155Options): Contract {
   }
 
   if (allOpts.pausable) {
-    addPausable(c, access, [functions._beforeTokenTransfer]);
+    addPausableExtension(c, access);
   }
 
   if (allOpts.burnable) {
@@ -88,16 +88,25 @@ export function buildERC1155(opts: ERC1155Options): Contract {
 }
 
 function addBase(c: ContractBuilder, uri: string) {
-  c.addParent(
-    {
-      name: 'ERC1155',
-      path: '@openzeppelin/contracts/token/ERC1155/ERC1155.sol',
-    },
-    [uri],
-  );
-
-  c.addOverride('ERC1155', functions._beforeTokenTransfer);
-  c.addOverride('ERC1155', supportsInterface);
+  const ERC1155 = {
+    name: 'ERC1155',
+    path: '@openzeppelin/contracts/token/ERC1155/ERC1155.sol',
+  };
+  c.addParent(ERC1155, [uri]);
+
+  c.addOverride(ERC1155, functions._update);
+  c.addOverride(ERC1155, supportsInterface);
+}
+
+function addPausableExtension(c: ContractBuilder, access: Access) {
+  const ERC1155Pausable = {
+    name: 'ERC1155Pausable',
+    path: '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Pausable.sol',
+  };
+  c.addParent(ERC1155Pausable);
+  c.addOverride(ERC1155Pausable, functions._update);
+
+  addPauseFunctions(c, access);
 }
 
 function addBurnable(c: ContractBuilder) {
@@ -108,35 +117,34 @@ function addBurnable(c: ContractBuilder) {
 }
 
 function addMintable(c: ContractBuilder, access: Access) {
-  requireAccessControl(c, functions.mint, access, 'MINTER');
-  requireAccessControl(c, functions.mintBatch, access, 'MINTER');
+  requireAccessControl(c, functions.mint, access, 'MINTER', 'minter');
+  requireAccessControl(c, functions.mintBatch, access, 'MINTER', 'minter');
   c.addFunctionCode('_mint(account, id, amount, data);', functions.mint);
   c.addFunctionCode('_mintBatch(to, ids, amounts, data);', functions.mintBatch);
 }
 
 function addSetUri(c: ContractBuilder, access: Access) {
-  requireAccessControl(c, functions.setURI, access, 'URI_SETTER');
+  requireAccessControl(c, functions.setURI, access, 'URI_SETTER', undefined);
   c.addFunctionCode('_setURI(newuri);', functions.setURI);
 }
 
 function addSupply(c: ContractBuilder) {
-  c.addParent({
+  const ERC1155Supply = {
     name: 'ERC1155Supply',
     path: '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol',
-  });
-  c.addOverride('ERC1155Supply', functions._beforeTokenTransfer);
+  };
+  c.addParent(ERC1155Supply);
+  c.addOverride(ERC1155Supply, functions._update);
 }
 
 const functions = defineFunctions({
-  _beforeTokenTransfer: {
+  _update: {
     kind: 'internal' as const,
     args: [
-      { name: 'operator', type: 'address' },
       { name: 'from', type: 'address' },
       { name: 'to', type: 'address' },
       { name: 'ids', type: 'uint256[] memory' },
-      { name: 'amounts', type: 'uint256[] memory' },
-      { name: 'data', type: 'bytes memory' },
+      { name: 'values', type: 'uint256[] memory' },
     ],
   },
 
@@ -166,5 +174,4 @@ const functions = defineFunctions({
       { name: 'data', type: 'bytes memory' },
     ],
   },
-
 });

package/src/erc20.ts

@@ -1,6 +1,6 @@
 import { Contract, ContractBuilder } from './contract';
 import { Access, setAccessControl, requireAccessControl } from './set-access-control';
-import { addPausable } from './add-pausable';
+import { addPauseFunctions } from './add-pausable';
 import { defineFunctions } from './utils/define-functions';
 import { CommonOptions, withCommonDefaults, defaults as commonDefaults } from './common-options';
 import { setUpgradeable } from './set-upgradeable';
@@ -11,7 +11,6 @@ export interface ERC20Options extends CommonOptions {
   name: string;
   symbol: string;
   burnable?: boolean;
-  snapshots?: boolean;
   pausable?: boolean;
   premint?: string;
   mintable?: boolean;
@@ -24,11 +23,10 @@ export const defaults: Required<ERC20Options> = {
   name: 'MyToken',
   symbol: 'MTK',
   burnable: false,
-  snapshots: false,
   pausable: false,
   premint: '0',
   mintable: false,
-  permit: false,
+  permit: true,
   votes: false,
   flashmint: false,
   access: commonDefaults.access,
@@ -41,7 +39,6 @@ function withDefaults(opts: ERC20Options): Required<ERC20Options> {
     ...opts,
     ...withCommonDefaults(opts),
     burnable: opts.burnable ?? defaults.burnable,
-    snapshots: opts.snapshots ?? defaults.snapshots,
     pausable: opts.pausable ?? defaults.pausable,
     premint: opts.premint || defaults.premint,
     mintable: opts.mintable ?? defaults.mintable,
@@ -56,7 +53,7 @@ export function printERC20(opts: ERC20Options = defaults): string {
 }
 
 export function isAccessControlRequired(opts: Partial<ERC20Options>): boolean {
-  return opts.mintable || opts.pausable || opts.snapshots || opts.upgradeable === 'uups';
+  return opts.mintable || opts.pausable || opts.upgradeable === 'uups';
 }
 
 export function buildERC20(opts: ERC20Options): Contract {
@@ -72,12 +69,8 @@ export function buildERC20(opts: ERC20Options): Contract {
     addBurnable(c);
   }
 
-  if (allOpts.snapshots) {
-    addSnapshot(c, access);
-  }
-
   if (allOpts.pausable) {
-    addPausable(c, access, [functions._beforeTokenTransfer]);
+    addPausableExtension(c, access);
   }
 
   if (allOpts.premint) {
@@ -109,18 +102,27 @@ export function buildERC20(opts: ERC20Options): Contract {
 }
 
 function addBase(c: ContractBuilder, name: string, symbol: string) {
+  const ERC20 = {
+    name: 'ERC20',
+    path: '@openzeppelin/contracts/token/ERC20/ERC20.sol',
+  };
   c.addParent(
-    {
-      name: 'ERC20',
-      path: '@openzeppelin/contracts/token/ERC20/ERC20.sol',
-    },
+    ERC20,
     [name, symbol],
   );
 
-  c.addOverride('ERC20', functions._beforeTokenTransfer);
-  c.addOverride('ERC20', functions._afterTokenTransfer);
-  c.addOverride('ERC20', functions._mint);
-  c.addOverride('ERC20', functions._burn);
+  c.addOverride(ERC20, functions._update);
+}
+
+function addPausableExtension(c: ContractBuilder, access: Access) {
+  const ERC20Pausable = {
+    name: 'ERC20Pausable',
+    path: '@openzeppelin/contracts/token/ERC20/extensions/ERC20Pausable.sol',
+  };
+  c.addParent(ERC20Pausable);
+  c.addOverride(ERC20Pausable, functions._update);
+
+  addPauseFunctions(c, access);
 }
 
 function addBurnable(c: ContractBuilder) {
@@ -130,18 +132,6 @@ function addBurnable(c: ContractBuilder) {
   });
 }
 
-function addSnapshot(c: ContractBuilder, access: Access) {
-  c.addParent({
-    name: 'ERC20Snapshot',
-    path: '@openzeppelin/contracts/token/ERC20/extensions/ERC20Snapshot.sol',
-  });
-
-  c.addOverride('ERC20Snapshot', functions._beforeTokenTransfer);
-
-  requireAccessControl(c, functions.snapshot, access, 'SNAPSHOT');
-  c.addFunctionCode('_snapshot();', functions.snapshot);
-}
-
 export const premintPattern = /^(\d*)(?:\.(\d+))?(?:e(\d+))?$/;
 
 function addPremint(c: ContractBuilder, amount: string) {
@@ -162,15 +152,18 @@ function addPremint(c: ContractBuilder, amount: string) {
 }
 
 function addMintable(c: ContractBuilder, access: Access) {
-  requireAccessControl(c, functions.mint, access, 'MINTER');
+  requireAccessControl(c, functions.mint, access, 'MINTER', 'minter');
   c.addFunctionCode('_mint(to, amount);', functions.mint);
 }
 
 function addPermit(c: ContractBuilder, name: string) {
-  c.addParent({
+  const ERC20Permit = {
     name: 'ERC20Permit',
-    path: '@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol',
-  }, [name]);
+    path: '@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol',
+  };
+  c.addParent(ERC20Permit, [name]);
+  c.addOverride(ERC20Permit, functions.nonces);
+
 }
 
 function addVotes(c: ContractBuilder) {
@@ -178,13 +171,15 @@ function addVotes(c: ContractBuilder) {
     throw new Error('Missing ERC20Permit requirement for ERC20Votes');
   }
 
-  c.addParent({
+  const ERC20Votes = {
     name: 'ERC20Votes',
     path: '@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol',
-  });
-  c.addOverride('ERC20Votes', functions._mint);
-  c.addOverride('ERC20Votes', functions._burn);
-  c.addOverride('ERC20Votes', functions._afterTokenTransfer);
+  };
+  c.addParent(ERC20Votes);
+  c.addOverride(ERC20Votes, functions._update);
+  c.addOverride({
+    name: 'Nonces',
+  }, functions.nonces);
 }
 
 function addFlashMint(c: ContractBuilder) {
@@ -195,37 +190,12 @@ function addFlashMint(c: ContractBuilder) {
 }
 
 const functions = defineFunctions({
-  _beforeTokenTransfer: {
-    kind: 'internal' as const,
-    args: [
-      { name: 'from', type: 'address' },
-      { name: 'to', type: 'address' },
-      { name: 'amount', type: 'uint256' },
-    ],
-  },
-
-  _afterTokenTransfer: {
+  _update: {
     kind: 'internal' as const,
     args: [
       { name: 'from', type: 'address' },
       { name: 'to', type: 'address' },
-      { name: 'amount', type: 'uint256' },
-    ],
-  },
-
-  _burn: {
-    kind: 'internal' as const,
-    args: [
-      { name: 'account', type: 'address' },
-      { name: 'amount', type: 'uint256' },
-    ],
-  },
-
-  _mint: {
-    kind: 'internal' as const,
-    args: [
-      { name: 'to', type: 'address' },
-      { name: 'amount', type: 'uint256' },
+      { name: 'value', type: 'uint256' },
     ],
   },
 
@@ -251,4 +221,13 @@ const functions = defineFunctions({
     kind: 'public' as const,
     args: [],
   },
+
+  nonces: {
+    kind: 'public' as const,
+    args: [
+      { name: 'owner', type: 'address' },
+    ],
+    returns: ['uint256'],
+    mutability: 'view' as const,
+  }
 });

package/src/erc721.ts

@@ -1,6 +1,6 @@
 import { Contract, ContractBuilder } from './contract';
 import { Access, setAccessControl, requireAccessControl } from './set-access-control';
-import { addPausable } from './add-pausable';
+import { addPauseFunctions } from './add-pausable';
 import { supportsInterface } from './common-functions';
 import { defineFunctions } from './utils/define-functions';
 import { CommonOptions, withCommonDefaults, defaults as commonDefaults } from './common-options';
@@ -82,7 +82,7 @@ export function buildERC721(opts: ERC721Options): Contract {
   }
 
   if (allOpts.pausable) {
-    addPausable(c, access, [functions._beforeTokenTransfer]);
+    addPausableExtension(c, access);
   }
 
   if (allOpts.burnable) {
@@ -104,46 +104,57 @@ export function buildERC721(opts: ERC721Options): Contract {
   return c;
 }
 
+function addPausableExtension(c: ContractBuilder, access: Access) {
+  const ERC721Pausable = {
+    name: 'ERC721Pausable',
+    path: '@openzeppelin/contracts/token/ERC721/extensions/ERC721Pausable.sol',
+  };
+  c.addParent(ERC721Pausable);
+  c.addOverride(ERC721Pausable, functions._update);
+
+  addPauseFunctions(c, access);
+}
+
+const ERC721 = {
+  name: 'ERC721',
+  path: '@openzeppelin/contracts/token/ERC721/ERC721.sol',
+};
+
 function addBase(c: ContractBuilder, name: string, symbol: string) {
-  c.addParent(
-    {
-      name: 'ERC721',
-      path: '@openzeppelin/contracts/token/ERC721/ERC721.sol',
-    },
-    [name, symbol],
-  );
-
-  c.addOverride('ERC721', functions._beforeTokenTransfer);
-  c.addOverride('ERC721', functions._afterTokenTransfer);
-  c.addOverride('ERC721', functions._burn);
-  c.addOverride('ERC721', functions.tokenURI);
-  c.addOverride('ERC721', supportsInterface);
+  c.addParent(ERC721, [name, symbol]);
+
+  c.addOverride(ERC721, functions._update);
+  c.addOverride(ERC721, functions._increaseBalance);
+  c.addOverride(ERC721, functions.tokenURI);
+  c.addOverride(ERC721, supportsInterface);
 }
 
 function addBaseURI(c: ContractBuilder, baseUri: string) {
-  c.addOverride('ERC721', functions._baseURI);
+  c.addOverride(ERC721, functions._baseURI);
   c.setFunctionBody([`return ${JSON.stringify(baseUri)};`], functions._baseURI);
 }
 
 function addEnumerable(c: ContractBuilder) {
-  c.addParent({
+  const ERC721Enumerable = {
     name: 'ERC721Enumerable',
     path: '@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol',
-  });
+  };
+  c.addParent(ERC721Enumerable);
 
-  c.addOverride('ERC721Enumerable', functions._beforeTokenTransfer);
-  c.addOverride('ERC721Enumerable', supportsInterface);
+  c.addOverride(ERC721Enumerable, functions._update);
+  c.addOverride(ERC721Enumerable, functions._increaseBalance);
+  c.addOverride(ERC721Enumerable, supportsInterface);
 }
 
 function addURIStorage(c: ContractBuilder) {
-  c.addParent({
+  const ERC721URIStorage = {
     name: 'ERC721URIStorage',
     path: '@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol',
-  });
+  };
+  c.addParent(ERC721URIStorage);
 
-  c.addOverride('ERC721URIStorage', functions._burn);
-  c.addOverride('ERC721URIStorage', functions.tokenURI);
-  c.addOverride('ERC721URIStorage', supportsInterface);
+  c.addOverride(ERC721URIStorage, functions.tokenURI);
+  c.addOverride(ERC721URIStorage, supportsInterface);
 }
 
 function addBurnable(c: ContractBuilder) {
@@ -155,16 +166,11 @@ function addBurnable(c: ContractBuilder) {
 
 function addMintable(c: ContractBuilder, access: Access, incremental = false, uriStorage = false) {
   const fn = getMintFunction(incremental, uriStorage);
-  requireAccessControl(c, fn, access, 'MINTER');
+  requireAccessControl(c, fn, access, 'MINTER', 'minter');
 
   if (incremental) {
-    c.addUsing({
-      name: 'Counters',
-      path: '@openzeppelin/contracts/utils/Counters.sol',
-    }, 'Counters.Counter');
-    c.addVariable('Counters.Counter private _tokenIdCounter;');
-    c.addFunctionCode('uint256 tokenId = _tokenIdCounter.current();', fn);
-    c.addFunctionCode('_tokenIdCounter.increment();', fn);
+    c.addVariable('uint256 private _nextTokenId;');
+    c.addFunctionCode('uint256 tokenId = _nextTokenId++;', fn);
     c.addFunctionCode('_safeMint(to, tokenId);', fn);
   } else {
     c.addFunctionCode('_safeMint(to, tokenId);', fn);
@@ -176,47 +182,31 @@ function addMintable(c: ContractBuilder, access: Access, incremental = false, ur
 }
 
 function addVotes(c: ContractBuilder, name: string) {
-  c.addParent(
-    {
-      name: 'EIP712',
-      path: '@openzeppelin/contracts/utils/cryptography/draft-EIP712.sol',
-    },
-    [name, "1"]
-  );
-  c.addParent(
-    {
-      name: 'ERC721Votes',
-      path: '@openzeppelin/contracts/token/ERC721/extensions/draft-ERC721Votes.sol',
-    });
-  c.addOverride('ERC721Votes', functions._afterTokenTransfer);
+  const EIP712 = {
+    name: 'EIP712',
+    path: '@openzeppelin/contracts/utils/cryptography/EIP712.sol',
+  };
+  c.addParent(EIP712, [name, "1"]);
+
+  const ERC721Votes = {
+    name: 'ERC721Votes',
+    path: '@openzeppelin/contracts/token/ERC721/extensions/ERC721Votes.sol',
+  };
+  c.addParent(ERC721Votes);
+
+  c.addOverride(ERC721Votes, functions._update);
+  c.addOverride(ERC721Votes, functions._increaseBalance);
 }
 
 const functions = defineFunctions({
-  _beforeTokenTransfer: {
-    kind: 'internal' as const,
-    args: [
-      { name: 'from', type: 'address' },
-      { name: 'to', type: 'address' },
-      { name: 'tokenId', type: 'uint256' },
-      { name: 'batchSize', type: 'uint256' },
-    ],
-  },
-
-  _afterTokenTransfer: {
+  _update: {
     kind: 'internal' as const,
     args: [
-      { name: 'from', type: 'address' },
       { name: 'to', type: 'address' },
       { name: 'tokenId', type: 'uint256' },
-      { name: 'batchSize', type: 'uint256' },
-    ],
-  },
-
-  _burn: {
-    kind: 'internal' as const,
-    args: [
-      { name: 'tokenId', type: 'uint256' },
+      { name: 'auth', type: 'address' },
     ],
+    returns: ['address'],
   },
 
   tokenURI: {
@@ -234,6 +224,14 @@ const functions = defineFunctions({
     returns: ['string memory'],
     mutability: 'pure' as const,
   },
+
+  _increaseBalance: {
+    kind: 'internal' as const,
+    args: [
+      { name: 'account', type: 'address' },
+      { name: 'value', type: 'uint128' },
+    ],
+  },
 });
 
 function getMintFunction(incremental: boolean, uriStorage: boolean) {

package/src/generate/erc20.ts

@@ -10,7 +10,6 @@ const blueprint = {
   name: ['MyToken'],
   symbol: ['MTK'],
   burnable: booleans,
-  snapshots: booleans,
   pausable: booleans,
   mintable: booleans,
   permit: booleans,

package/src/generate/governor.ts

@@ -18,7 +18,7 @@ const blueprint = {
   quorumAbsolute: ['1000'],
   votes: votesOptions,
   timelock: timelockOptions,
-  bravo: booleans,
+  storage: booleans,
   settings: booleans,
   upgradeable: upgradeableOptions,
   access: accessOptions,