@openzeppelin/wizard 0.1.1 → 0.2.0

package/src/erc1155.test.ts.md

@@ -1,432 +0,0 @@
-# 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);␊
-        }␊
-    }␊
-    `
-
-## 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
-
-    `// 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/erc20.test.ts

@@ -1,152 +0,0 @@
-import test from 'ava';
-import { erc20 } from '.';
-
-import { buildERC20, ERC20Options } from './erc20';
-import { printContract } from './print';
-
-function testERC20(title: string, opts: Partial<ERC20Options>) {
-  test(title, t => {
-    const c = buildERC20({
-      name: 'MyToken',
-      symbol: 'MTK',
-      ...opts,
-    });
-    t.snapshot(printContract(c));
-  });
-}
-
-/**
- * Tests external API for equivalence with internal API
- */
- function testAPIEquivalence(title: string, opts?: ERC20Options) {
-  test(title, t => {
-    t.is(erc20.print(opts), printContract(buildERC20({
-      name: 'MyToken',
-      symbol: 'MTK',
-      ...opts,
-    })));
-  });
-}
-
-testERC20('basic erc20', {});
-
-testERC20('erc20 with snapshots', {
-  snapshots: true,
-});
-
-testERC20('erc20 burnable', {
-  burnable: true,
-});
-
-testERC20('erc20 burnable with snapshots', {
-  burnable: true,
-  snapshots: true,
-});
-
-testERC20('erc20 pausable', {
-  pausable: true,
-  access: 'ownable',
-});
-
-testERC20('erc20 pausable with roles', {
-  pausable: true,
-  access: 'roles',
-});
-
-testERC20('erc20 burnable pausable', {
-  burnable: true,
-  pausable: true,
-});
-
-testERC20('erc20 burnable pausable with snapshots', {
-  burnable: true,
-  pausable: true,
-  snapshots: true,
-});
-
-testERC20('erc20 preminted', {
-  premint: '1000',
-});
-
-testERC20('erc20 premint of 0', {
-  premint: '0',
-});
-
-testERC20('erc20 mintable', {
-  mintable: true,
-  access: 'ownable',
-});
-
-testERC20('erc20 mintable with roles', {
-  mintable: true,
-  access: 'roles',
-});
-
-testERC20('erc20 permit', {
-  permit: true,
-});
-
-testERC20('erc20 votes', {
-  votes: true,
-});
-
-testERC20('erc20 flashmint', {
-  flashmint: true,
-});
-
-testERC20('erc20 full upgradeable transparent', {
-  premint: '2000',
-  access: 'roles',
-  burnable: true,
-  mintable: true,
-  pausable: true,
-  snapshots: true,
-  permit: true,
-  votes: true,
-  flashmint: true,
-  upgradeable: 'transparent',
-});
-
-testERC20('erc20 full upgradeable uups', {
-  premint: '2000',
-  access: 'roles',
-  burnable: true,
-  mintable: true,
-  pausable: true,
-  snapshots: true,
-  permit: true,
-  votes: true,
-  flashmint: true,
-  upgradeable: 'uups',
-});
-
-testAPIEquivalence('erc20 API default');
-
-testAPIEquivalence('erc20 API basic', { name: 'CustomToken', symbol: 'CTK' });
-
-testAPIEquivalence('erc20 API full upgradeable', {
-  name: 'CustomToken',
-  symbol: 'CTK',
-  premint: '2000',
-  access: 'roles',
-  burnable: true,
-  mintable: true,
-  pausable: true,
-  snapshots: true,
-  permit: true,
-  votes: true,
-  flashmint: true,
-  upgradeable: 'uups',
-});
-
-test('erc20 API assert defaults', async t => {
-  t.is(erc20.print(erc20.defaults), erc20.print());
-});
-
-test('erc20 API isAccessControlRequired', async t => {
-  t.is(erc20.isAccessControlRequired({ mintable: true }), true);
-  t.is(erc20.isAccessControlRequired({ pausable: true }), true);
-  t.is(erc20.isAccessControlRequired({ snapshots: true }), true);
-  t.is(erc20.isAccessControlRequired({ upgradeable: 'uups' }), true);
-  t.is(erc20.isAccessControlRequired({ upgradeable: 'transparent' }), false);
-});