@openzeppelin/wizard 0.1.0

package/src/erc1155.test.ts

@@ -0,0 +1,90 @@
+import test from 'ava';
+import { erc1155 } from '.';
+
+import { buildERC1155, ERC1155Options } from './erc1155';
+import { printContract } from './print';
+
+function testERC1155(title: string, opts: Partial<ERC1155Options>) {
+  test(title, t => {
+    const c = buildERC1155({
+      name: 'MyToken',
+      uri: 'https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/',
+      ...opts,
+    });
+    t.snapshot(printContract(c));
+  });
+}
+
+/**
+ * Tests external API for equivalence with internal API
+ */
+ function testAPIEquivalence(title: string, opts?: ERC1155Options) {
+  test(title, t => {
+    t.is(erc1155.print(opts), printContract(buildERC1155({
+      name: 'MyToken',
+      uri: '',
+      ...opts,
+    })));
+  });
+}
+
+testERC1155('basic', {});
+
+testERC1155('basic + roles', {
+  access: 'roles',
+});
+
+testERC1155('burnable', {
+  burnable: true,
+});
+
+testERC1155('pausable', {
+  pausable: true,
+});
+
+testERC1155('mintable', {
+  mintable: true,
+});
+
+testERC1155('mintable + roles', {
+  mintable: true,
+  access: 'roles',
+});
+
+testERC1155('supply tracking', {
+  supply: true,
+});
+
+testERC1155('full upgradeable transparent', {
+  mintable: true,
+  access: 'roles',
+  burnable: true,
+  pausable: true,
+  upgradeable: 'transparent',
+});
+
+testERC1155('full upgradeable uups', {
+  mintable: true,
+  access: 'roles',
+  burnable: true,
+  pausable: true,
+  upgradeable: 'uups',
+});
+
+testAPIEquivalence('API default');
+
+testAPIEquivalence('API basic', { name: 'CustomToken', uri: 'https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/' });
+
+testAPIEquivalence('API full upgradeable', {
+  name: 'CustomToken',
+  uri: 'https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/',
+  mintable: true,
+  access: 'roles',
+  burnable: true,
+  pausable: true,
+  upgradeable: 'uups',
+});
+
+test('API assert defaults', async t => {
+  t.is(erc1155.print(erc1155.defaults), erc1155.print());
+});

package/src/erc1155.test.ts.md

@@ -0,0 +1,416 @@
+# Snapshot report for `src/erc1155.test.ts`
+
+The actual snapshot is saved in `erc1155.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## basic
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    ␊
+    contract MyToken is ERC1155, Ownable {␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {}␊
+    ␊
+        function setURI(string memory newuri) public onlyOwner {␊
+            _setURI(newuri);␊
+        }␊
+    }␊
+    `
+
+## basic + roles
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/AccessControl.sol";␊
+    ␊
+    contract MyToken is ERC1155, AccessControl {␊
+        bytes32 public constant URI_SETTER_ROLE = keccak256("URI_SETTER_ROLE");␊
+    ␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {␊
+            _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
+            _grantRole(URI_SETTER_ROLE, msg.sender);␊
+        }␊
+    ␊
+        function setURI(string memory newuri) public onlyRole(URI_SETTER_ROLE) {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        // The following functions are overrides required by Solidity.␊
+    ␊
+        function supportsInterface(bytes4 interfaceId)␊
+            public␊
+            view␊
+            override(ERC1155, AccessControl)␊
+            returns (bool)␊
+        {␊
+            return super.supportsInterface(interfaceId);␊
+        }␊
+    }␊
+    `
+
+## burnable
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol";␊
+    ␊
+    contract MyToken is ERC1155, Ownable, ERC1155Burnable {␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {}␊
+    ␊
+        function setURI(string memory newuri) public onlyOwner {␊
+            _setURI(newuri);␊
+        }␊
+    }␊
+    `
+
+## pausable
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    import "@openzeppelin/contracts/security/Pausable.sol";␊
+    ␊
+    contract MyToken is ERC1155, Ownable, Pausable {␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {}␊
+    ␊
+        function setURI(string memory newuri) public onlyOwner {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        function pause() public onlyOwner {␊
+            _pause();␊
+        }␊
+    ␊
+        function unpause() public onlyOwner {␊
+            _unpause();␊
+        }␊
+    ␊
+        function _beforeTokenTransfer(address operator, address from, address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            internal␊
+            whenNotPaused␊
+            override␊
+        {␊
+            super._beforeTokenTransfer(operator, from, to, ids, amounts, data);␊
+        }␊
+    }␊
+    `
+
+## mintable
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    ␊
+    contract MyToken is ERC1155, Ownable {␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {}␊
+    ␊
+        function setURI(string memory newuri) public onlyOwner {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        function mint(address account, uint256 id, uint256 amount, bytes memory data)␊
+            public␊
+            onlyOwner␊
+        {␊
+            _mint(account, id, amount, data);␊
+        }␊
+    ␊
+        function mintBatch(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            public␊
+            onlyOwner␊
+        {␊
+            _mintBatch(to, ids, amounts, data);␊
+        }␊
+    }␊
+    `
+
+## mintable + roles
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/AccessControl.sol";␊
+    ␊
+    contract MyToken is ERC1155, AccessControl {␊
+        bytes32 public constant URI_SETTER_ROLE = keccak256("URI_SETTER_ROLE");␊
+        bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
+    ␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {␊
+            _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
+            _grantRole(URI_SETTER_ROLE, msg.sender);␊
+            _grantRole(MINTER_ROLE, msg.sender);␊
+        }␊
+    ␊
+        function setURI(string memory newuri) public onlyRole(URI_SETTER_ROLE) {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        function mint(address account, uint256 id, uint256 amount, bytes memory data)␊
+            public␊
+            onlyRole(MINTER_ROLE)␊
+        {␊
+            _mint(account, id, amount, data);␊
+        }␊
+    ␊
+        function mintBatch(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            public␊
+            onlyRole(MINTER_ROLE)␊
+        {␊
+            _mintBatch(to, ids, amounts, data);␊
+        }␊
+    ␊
+        // The following functions are overrides required by Solidity.␊
+    ␊
+        function supportsInterface(bytes4 interfaceId)␊
+            public␊
+            view␊
+            override(ERC1155, AccessControl)␊
+            returns (bool)␊
+        {␊
+            return super.supportsInterface(interfaceId);␊
+        }␊
+    }␊
+    `
+
+## supply tracking
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";␊
+    import "@openzeppelin/contracts/access/Ownable.sol";␊
+    import "@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol";␊
+    ␊
+    contract MyToken is ERC1155, Ownable, ERC1155Supply {␊
+        constructor()␊
+            ERC1155("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/")␊
+        {}␊
+    ␊
+        function setURI(string memory newuri) public onlyOwner {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        // The following functions are overrides required by Solidity.␊
+    ␊
+        function _beforeTokenTransfer(address operator, address from, address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            internal␊
+            override(ERC1155, ERC1155Supply)␊
+        {␊
+            super._beforeTokenTransfer(operator, from, to, ids, amounts, data);␊
+        }␊
+    }␊
+    `
+
+## full upgradeable transparent
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
+    ␊
+    contract MyToken is Initializable, ERC1155Upgradeable, AccessControlUpgradeable, PausableUpgradeable, ERC1155BurnableUpgradeable {␊
+        bytes32 public constant URI_SETTER_ROLE = keccak256("URI_SETTER_ROLE");␊
+        bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");␊
+        bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
+    ␊
+        /// @custom:oz-upgrades-unsafe-allow constructor␊
+        constructor() {␊
+            _disableInitializers();␊
+        }␊
+    ␊
+        function initialize() initializer public {␊
+            __ERC1155_init("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/");␊
+            __AccessControl_init();␊
+            __Pausable_init();␊
+            __ERC1155Burnable_init();␊
+    ␊
+            _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
+            _grantRole(URI_SETTER_ROLE, msg.sender);␊
+            _grantRole(PAUSER_ROLE, msg.sender);␊
+            _grantRole(MINTER_ROLE, msg.sender);␊
+        }␊
+    ␊
+        function setURI(string memory newuri) public onlyRole(URI_SETTER_ROLE) {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        function pause() public onlyRole(PAUSER_ROLE) {␊
+            _pause();␊
+        }␊
+    ␊
+        function unpause() public onlyRole(PAUSER_ROLE) {␊
+            _unpause();␊
+        }␊
+    ␊
+        function mint(address account, uint256 id, uint256 amount, bytes memory data)␊
+            public␊
+            onlyRole(MINTER_ROLE)␊
+        {␊
+            _mint(account, id, amount, data);␊
+        }␊
+    ␊
+        function mintBatch(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            public␊
+            onlyRole(MINTER_ROLE)␊
+        {␊
+            _mintBatch(to, ids, amounts, data);␊
+        }␊
+    ␊
+        function _beforeTokenTransfer(address operator, address from, address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            internal␊
+            whenNotPaused␊
+            override␊
+        {␊
+            super._beforeTokenTransfer(operator, from, to, ids, amounts, data);␊
+        }␊
+    ␊
+        // The following functions are overrides required by Solidity.␊
+    ␊
+        function supportsInterface(bytes4 interfaceId)␊
+            public␊
+            view␊
+            override(ERC1155Upgradeable, AccessControlUpgradeable)␊
+            returns (bool)␊
+        {␊
+            return super.supportsInterface(interfaceId);␊
+        }␊
+    }␊
+    `
+
+## full upgradeable uups
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    pragma solidity ^0.8.4;␊
+    ␊
+    import "@openzeppelin/contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/token/ERC1155/extensions/ERC1155BurnableUpgradeable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
+    import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
+    ␊
+    contract MyToken is Initializable, ERC1155Upgradeable, AccessControlUpgradeable, PausableUpgradeable, ERC1155BurnableUpgradeable, UUPSUpgradeable {␊
+        bytes32 public constant URI_SETTER_ROLE = keccak256("URI_SETTER_ROLE");␊
+        bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");␊
+        bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
+        bytes32 public constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");␊
+    ␊
+        /// @custom:oz-upgrades-unsafe-allow constructor␊
+        constructor() {␊
+            _disableInitializers();␊
+        }␊
+    ␊
+        function initialize() initializer public {␊
+            __ERC1155_init("https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/");␊
+            __AccessControl_init();␊
+            __Pausable_init();␊
+            __ERC1155Burnable_init();␊
+            __UUPSUpgradeable_init();␊
+    ␊
+            _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
+            _grantRole(URI_SETTER_ROLE, msg.sender);␊
+            _grantRole(PAUSER_ROLE, msg.sender);␊
+            _grantRole(MINTER_ROLE, msg.sender);␊
+            _grantRole(UPGRADER_ROLE, msg.sender);␊
+        }␊
+    ␊
+        function setURI(string memory newuri) public onlyRole(URI_SETTER_ROLE) {␊
+            _setURI(newuri);␊
+        }␊
+    ␊
+        function pause() public onlyRole(PAUSER_ROLE) {␊
+            _pause();␊
+        }␊
+    ␊
+        function unpause() public onlyRole(PAUSER_ROLE) {␊
+            _unpause();␊
+        }␊
+    ␊
+        function mint(address account, uint256 id, uint256 amount, bytes memory data)␊
+            public␊
+            onlyRole(MINTER_ROLE)␊
+        {␊
+            _mint(account, id, amount, data);␊
+        }␊
+    ␊
+        function mintBatch(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            public␊
+            onlyRole(MINTER_ROLE)␊
+        {␊
+            _mintBatch(to, ids, amounts, data);␊
+        }␊
+    ␊
+        function _beforeTokenTransfer(address operator, address from, address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)␊
+            internal␊
+            whenNotPaused␊
+            override␊
+        {␊
+            super._beforeTokenTransfer(operator, from, to, ids, amounts, data);␊
+        }␊
+    ␊
+        function _authorizeUpgrade(address newImplementation)␊
+            internal␊
+            onlyRole(UPGRADER_ROLE)␊
+            override␊
+        {}␊
+    ␊
+        // The following functions are overrides required by Solidity.␊
+    ␊
+        function supportsInterface(bytes4 interfaceId)␊
+            public␊
+            view␊
+            override(ERC1155Upgradeable, AccessControlUpgradeable)␊
+            returns (bool)␊
+        {␊
+            return super.supportsInterface(interfaceId);␊
+        }␊
+    }␊
+    `

package/src/erc1155.ts

@@ -0,0 +1,160 @@
+import { Contract, ContractBuilder } from './contract';
+import { Access, setAccessControl } from './set-access-control';
+import { addPausable } from './add-pausable';
+import { supportsInterface } from './common-functions';
+import { defineFunctions } from './utils/define-functions';
+import { CommonOptions, withCommonDefaults, defaults as commonDefaults } from './common-options';
+import { setUpgradeable } from './set-upgradeable';
+import { setInfo } from './set-info';
+import { printContract } from './print';
+
+export interface ERC1155Options extends CommonOptions {
+  name: string;
+  uri: string;
+  burnable?: boolean;
+  pausable?: boolean;
+  mintable?: boolean;
+  supply?: boolean;
+}
+
+export const defaults: Required<ERC1155Options> = {
+  name: 'MyToken',
+  uri: '',
+  burnable: false,
+  pausable: false,
+  mintable: false,
+  supply: false,
+  access: commonDefaults.access,
+  upgradeable: commonDefaults.upgradeable,
+  info: commonDefaults.info
+} as const;
+
+function withDefaults(opts: ERC1155Options): Required<ERC1155Options> {
+  return {
+    ...opts,
+    ...withCommonDefaults(opts),
+    burnable: opts.burnable ?? defaults.burnable,
+    pausable: opts.pausable ?? defaults.pausable,
+    mintable: opts.mintable ?? defaults.mintable,
+    supply: opts.supply ?? defaults.supply,
+  };
+}
+
+export function printERC1155(opts: ERC1155Options = defaults): string {
+  return printContract(buildERC1155(opts));
+}
+
+export function buildERC1155(opts: ERC1155Options): Contract {
+  const allOpts = withDefaults(opts);
+
+  const c = new ContractBuilder(allOpts.name);
+
+  const { access, upgradeable, info } = allOpts;
+
+  addBase(c, allOpts.uri);
+  addSetUri(c, access);
+
+  if (allOpts.pausable) {
+    addPausable(c, access, [functions._beforeTokenTransfer]);
+  }
+
+  if (allOpts.burnable) {
+    addBurnable(c);
+  }
+
+  if (allOpts.mintable) {
+    addMintable(c, access);
+  }
+
+  if (allOpts.supply) {
+    addSupply(c);
+  }
+
+  setUpgradeable(c, upgradeable, access);
+
+  setInfo(c, info);
+
+  return c;
+}
+
+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);
+}
+
+function addBurnable(c: ContractBuilder) {
+  c.addParent({
+    name: 'ERC1155Burnable',
+    path: '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol',
+  });
+}
+
+function addMintable(c: ContractBuilder, access: Access) {
+  setAccessControl(c, functions.mint, access, 'MINTER');
+  setAccessControl(c, functions.mintBatch, access, '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) {
+  setAccessControl(c, functions.setURI, access, 'URI_SETTER');
+  c.addFunctionCode('_setURI(newuri);', functions.setURI);
+}
+
+function addSupply(c: ContractBuilder) {
+  c.addParent({
+    name: 'ERC1155Supply',
+    path: '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol',
+  });
+  c.addOverride('ERC1155Supply', functions._beforeTokenTransfer);
+}
+
+const functions = defineFunctions({
+  _beforeTokenTransfer: {
+    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' },
+    ],
+  },
+
+  setURI: {
+    kind: 'public' as const,
+    args: [
+      { name: 'newuri', type: 'string memory' },
+    ],
+  },
+
+  mint: {
+    kind: 'public' as const,
+    args: [
+      { name: 'account', type: 'address' },
+      { name: 'id', type: 'uint256' },
+      { name: 'amount', type: 'uint256' },
+      { name: 'data', type: 'bytes memory' },
+    ],
+  },
+
+  mintBatch: {
+    kind: 'public' as const,
+    args: [
+      { name: 'to', type: 'address' },
+      { name: 'ids', type: 'uint256[] memory' },
+      { name: 'amounts', type: 'uint256[] memory' },
+      { name: 'data', type: 'bytes memory' },
+    ],
+  },
+
+});