@openzeppelin/wizard 0.1.1 → 0.2.1

package/src/erc721.test.ts.md

@@ -1,517 +0,0 @@
-# Snapshot report for `src/erc721.test.ts`
-
-The actual snapshot is saved in `erc721.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/ERC721/ERC721.sol";␊
-    ␊
-    contract MyToken is ERC721 {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    }␊
-    `
-
-## base uri
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    ␊
-    contract MyToken is ERC721 {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        function _baseURI() internal pure override returns (string memory) {␊
-            return "https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/";␊
-        }␊
-    }␊
-    `
-
-## enumerable
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";␊
-    ␊
-    contract MyToken is ERC721, ERC721Enumerable {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _beforeTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            override(ERC721, ERC721Enumerable)␊
-        {␊
-            super._beforeTokenTransfer(from, to, tokenId);␊
-        }␊
-    ␊
-        function supportsInterface(bytes4 interfaceId)␊
-            public␊
-            view␊
-            override(ERC721, ERC721Enumerable)␊
-            returns (bool)␊
-        {␊
-            return super.supportsInterface(interfaceId);␊
-        }␊
-    }␊
-    `
-
-## uri storage
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";␊
-    ␊
-    contract MyToken is ERC721, ERC721URIStorage {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _burn(uint256 tokenId) internal override(ERC721, ERC721URIStorage) {␊
-            super._burn(tokenId);␊
-        }␊
-    ␊
-        function tokenURI(uint256 tokenId)␊
-            public␊
-            view␊
-            override(ERC721, ERC721URIStorage)␊
-            returns (string memory)␊
-        {␊
-            return super.tokenURI(tokenId);␊
-        }␊
-    }␊
-    `
-
-## mintable + uri storage
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";␊
-    import "@openzeppelin/contracts/access/Ownable.sol";␊
-    ␊
-    contract MyToken is ERC721, ERC721URIStorage, Ownable {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        function safeMint(address to, uint256 tokenId, string memory uri)␊
-            public␊
-            onlyOwner␊
-        {␊
-            _safeMint(to, tokenId);␊
-            _setTokenURI(tokenId, uri);␊
-        }␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _burn(uint256 tokenId) internal override(ERC721, ERC721URIStorage) {␊
-            super._burn(tokenId);␊
-        }␊
-    ␊
-        function tokenURI(uint256 tokenId)␊
-            public␊
-            view␊
-            override(ERC721, ERC721URIStorage)␊
-            returns (string memory)␊
-        {␊
-            return super.tokenURI(tokenId);␊
-        }␊
-    }␊
-    `
-
-## mintable + uri storage + incremental
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";␊
-    import "@openzeppelin/contracts/access/Ownable.sol";␊
-    import "@openzeppelin/contracts/utils/Counters.sol";␊
-    ␊
-    contract MyToken is ERC721, ERC721URIStorage, Ownable {␊
-        using Counters for Counters.Counter;␊
-    ␊
-        Counters.Counter private _tokenIdCounter;␊
-    ␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        function safeMint(address to, string memory uri) public onlyOwner {␊
-            uint256 tokenId = _tokenIdCounter.current();␊
-            _tokenIdCounter.increment();␊
-            _safeMint(to, tokenId);␊
-            _setTokenURI(tokenId, uri);␊
-        }␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _burn(uint256 tokenId) internal override(ERC721, ERC721URIStorage) {␊
-            super._burn(tokenId);␊
-        }␊
-    ␊
-        function tokenURI(uint256 tokenId)␊
-            public␊
-            view␊
-            override(ERC721, ERC721URIStorage)␊
-            returns (string memory)␊
-        {␊
-            return super.tokenURI(tokenId);␊
-        }␊
-    }␊
-    `
-
-## burnable
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Burnable.sol";␊
-    ␊
-    contract MyToken is ERC721, ERC721Burnable {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    }␊
-    `
-
-## burnable + uri storage
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Burnable.sol";␊
-    ␊
-    contract MyToken is ERC721, ERC721URIStorage, ERC721Burnable {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _burn(uint256 tokenId) internal override(ERC721, ERC721URIStorage) {␊
-            super._burn(tokenId);␊
-        }␊
-    ␊
-        function tokenURI(uint256 tokenId)␊
-            public␊
-            view␊
-            override(ERC721, ERC721URIStorage)␊
-            returns (string memory)␊
-        {␊
-            return super.tokenURI(tokenId);␊
-        }␊
-    }␊
-    `
-
-## pausable
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/security/Pausable.sol";␊
-    import "@openzeppelin/contracts/access/Ownable.sol";␊
-    ␊
-    contract MyToken is ERC721, Pausable, Ownable {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        function pause() public onlyOwner {␊
-            _pause();␊
-        }␊
-    ␊
-        function unpause() public onlyOwner {␊
-            _unpause();␊
-        }␊
-    ␊
-        function _beforeTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            whenNotPaused␊
-            override␊
-        {␊
-            super._beforeTokenTransfer(from, to, tokenId);␊
-        }␊
-    }␊
-    `
-
-## mintable
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/access/Ownable.sol";␊
-    ␊
-    contract MyToken is ERC721, Ownable {␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        function safeMint(address to, uint256 tokenId) public onlyOwner {␊
-            _safeMint(to, tokenId);␊
-        }␊
-    }␊
-    `
-
-## mintable + roles
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/access/AccessControl.sol";␊
-    ␊
-    contract MyToken is ERC721, AccessControl {␊
-        bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");␊
-    ␊
-        constructor() ERC721("MyToken", "MTK") {␊
-            _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);␊
-            _grantRole(MINTER_ROLE, msg.sender);␊
-        }␊
-    ␊
-        function safeMint(address to, uint256 tokenId) public onlyRole(MINTER_ROLE) {␊
-            _safeMint(to, tokenId);␊
-        }␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function supportsInterface(bytes4 interfaceId)␊
-            public␊
-            view␊
-            override(ERC721, AccessControl)␊
-            returns (bool)␊
-        {␊
-            return super.supportsInterface(interfaceId);␊
-        }␊
-    }␊
-    `
-
-## mintable + incremental
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/access/Ownable.sol";␊
-    import "@openzeppelin/contracts/utils/Counters.sol";␊
-    ␊
-    contract MyToken is ERC721, Ownable {␊
-        using Counters for Counters.Counter;␊
-    ␊
-        Counters.Counter private _tokenIdCounter;␊
-    ␊
-        constructor() ERC721("MyToken", "MTK") {}␊
-    ␊
-        function safeMint(address to) public onlyOwner {␊
-            uint256 tokenId = _tokenIdCounter.current();␊
-            _tokenIdCounter.increment();␊
-            _safeMint(to, tokenId);␊
-        }␊
-    }␊
-    `
-
-## votes
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts/token/ERC721/ERC721.sol";␊
-    import "@openzeppelin/contracts/utils/cryptography/draft-EIP712.sol";␊
-    import "@openzeppelin/contracts/token/ERC721/extensions/draft-ERC721Votes.sol";␊
-    ␊
-    contract MyToken is ERC721, EIP712, ERC721Votes {␊
-        constructor() ERC721("MyToken", "MTK") EIP712("MyToken", "1") {}␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _afterTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            override(ERC721, ERC721Votes)␊
-        {␊
-            super._afterTokenTransfer(from, to, tokenId);␊
-        }␊
-    }␊
-    `
-
-## full upgradeable transparent
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721EnumerableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721BurnableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/utils/cryptography/draft-EIP712Upgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/draft-ERC721VotesUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
-    ␊
-    contract MyToken is Initializable, ERC721Upgradeable, ERC721EnumerableUpgradeable, PausableUpgradeable, OwnableUpgradeable, ERC721BurnableUpgradeable, EIP712Upgradeable, ERC721VotesUpgradeable {␊
-        /// @custom:oz-upgrades-unsafe-allow constructor␊
-        constructor() {␊
-            _disableInitializers();␊
-        }␊
-    ␊
-        function initialize() initializer public {␊
-            __ERC721_init("MyToken", "MTK");␊
-            __ERC721Enumerable_init();␊
-            __Pausable_init();␊
-            __Ownable_init();␊
-            __ERC721Burnable_init();␊
-            __EIP712_init("MyToken", "1");␊
-            __ERC721Votes_init();␊
-        }␊
-    ␊
-        function pause() public onlyOwner {␊
-            _pause();␊
-        }␊
-    ␊
-        function unpause() public onlyOwner {␊
-            _unpause();␊
-        }␊
-    ␊
-        function safeMint(address to, uint256 tokenId) public onlyOwner {␊
-            _safeMint(to, tokenId);␊
-        }␊
-    ␊
-        function _beforeTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            whenNotPaused␊
-            override(ERC721Upgradeable, ERC721EnumerableUpgradeable)␊
-        {␊
-            super._beforeTokenTransfer(from, to, tokenId);␊
-        }␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _afterTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            override(ERC721Upgradeable, ERC721VotesUpgradeable)␊
-        {␊
-            super._afterTokenTransfer(from, to, tokenId);␊
-        }␊
-    ␊
-        function supportsInterface(bytes4 interfaceId)␊
-            public␊
-            view␊
-            override(ERC721Upgradeable, ERC721EnumerableUpgradeable)␊
-            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/ERC721/ERC721Upgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721EnumerableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721BurnableUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/utils/cryptography/draft-EIP712Upgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/draft-ERC721VotesUpgradeable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";␊
-    import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";␊
-    ␊
-    contract MyToken is Initializable, ERC721Upgradeable, ERC721EnumerableUpgradeable, PausableUpgradeable, OwnableUpgradeable, ERC721BurnableUpgradeable, EIP712Upgradeable, ERC721VotesUpgradeable, UUPSUpgradeable {␊
-        /// @custom:oz-upgrades-unsafe-allow constructor␊
-        constructor() {␊
-            _disableInitializers();␊
-        }␊
-    ␊
-        function initialize() initializer public {␊
-            __ERC721_init("MyToken", "MTK");␊
-            __ERC721Enumerable_init();␊
-            __Pausable_init();␊
-            __Ownable_init();␊
-            __ERC721Burnable_init();␊
-            __EIP712_init("MyToken", "1");␊
-            __ERC721Votes_init();␊
-            __UUPSUpgradeable_init();␊
-        }␊
-    ␊
-        function pause() public onlyOwner {␊
-            _pause();␊
-        }␊
-    ␊
-        function unpause() public onlyOwner {␊
-            _unpause();␊
-        }␊
-    ␊
-        function safeMint(address to, uint256 tokenId) public onlyOwner {␊
-            _safeMint(to, tokenId);␊
-        }␊
-    ␊
-        function _beforeTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            whenNotPaused␊
-            override(ERC721Upgradeable, ERC721EnumerableUpgradeable)␊
-        {␊
-            super._beforeTokenTransfer(from, to, tokenId);␊
-        }␊
-    ␊
-        function _authorizeUpgrade(address newImplementation)␊
-            internal␊
-            onlyOwner␊
-            override␊
-        {}␊
-    ␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _afterTokenTransfer(address from, address to, uint256 tokenId)␊
-            internal␊
-            override(ERC721Upgradeable, ERC721VotesUpgradeable)␊
-        {␊
-            super._afterTokenTransfer(from, to, tokenId);␊
-        }␊
-    ␊
-        function supportsInterface(bytes4 interfaceId)␊
-            public␊
-            view␊
-            override(ERC721Upgradeable, ERC721EnumerableUpgradeable)␊
-            returns (bool)␊
-        {␊
-            return super.supportsInterface(interfaceId);␊
-        }␊
-    }␊
-    `

package/src/governor.test.ts

@@ -1,125 +0,0 @@
-import test from 'ava';
-import { governor } from '.';
-
-import { buildGovernor, GovernorOptions } from './governor';
-import { printContract } from './print';
-
-function testGovernor(title: string, opts: Partial<GovernorOptions>) {
-  test(title, t => {
-    const c = buildGovernor({
-      name: 'MyGovernor',
-      delay: '1 week',
-      period: '1 week',
-      settings: false,
-      ...opts,
-    });
-    t.snapshot(printContract(c));
-  });
-}
-
-/**
- * Tests external API for equivalence with internal API
- */
- function testAPIEquivalence(title: string, opts?: GovernorOptions) {
-  test(title, t => {
-    t.is(governor.print(opts), printContract(buildGovernor({
-      name: 'MyGovernor',
-      delay: '1 block',
-      period: '1 week',
-      ...opts,
-    })));
-  });
-}
-
-testGovernor('governor with proposal threshold', {
-  proposalThreshold: '1',
-});
-
-testGovernor('governor with custom block time', {
-  blockTime: 6,
-});
-
-testGovernor('governor with custom decimals', {
-  decimals: 6,
-  proposalThreshold: '1',
-  quorumMode: 'absolute',
-  quorumAbsolute: '1',
-});
-
-testGovernor('governor with 0 decimals', {
-  decimals: 0,
-  proposalThreshold: '1',
-  quorumMode: 'absolute',
-  quorumAbsolute: '1',
-});
-
-testGovernor('governor with settings', {
-  settings: true,
-  proposalThreshold: '1',
-});
-
-testGovernor('governor with bravo', {
-  bravo: true,
-});
-
-testGovernor('governor with erc20votes', {
-  votes: 'erc20votes',
-});
-
-testGovernor('governor with erc721votes', {
-  votes: 'erc721votes',
-});
-
-testGovernor('governor with erc721votes omit decimals', {
-  votes: 'erc721votes',
-  decimals: 6,
-  proposalThreshold: '1',
-  quorumMode: 'absolute',
-  quorumAbsolute: '5',
-});
-
-testGovernor('governor with erc721votes settings omit decimals', {
-  votes: 'erc721votes',
-  decimals: 6,
-  proposalThreshold: '10',
-  settings: true,
-});
-
-testGovernor('governor with comp', {
-  votes: 'comp',
-  quorumMode: 'absolute',
-  quorumAbsolute: '1',
-});
-
-testGovernor('governor with percent quorum', {
-  quorumMode: 'percent',
-  quorumPercent: 6,
-});
-
-testGovernor('governor with fractional percent quorum', {
-  quorumMode: 'percent',
-  quorumPercent: 0.5,
-});
-
-testGovernor('governor with openzeppelin timelock', {
-  timelock: 'openzeppelin',
-});
-
-testGovernor('governor with compound timelock', {
-  timelock: 'compound',
-});
-
-testAPIEquivalence('API default');
-
-testAPIEquivalence('API basic', { name: 'CustomGovernor', delay: '2 weeks', period: '2 week' });
-
-testAPIEquivalence('API basic upgradeable', { name: 'CustomGovernor', delay: '2 weeks', period: '2 week', upgradeable: 'uups' });
-
-test('API assert defaults', async t => {
-  t.is(governor.print(governor.defaults), governor.print());
-});
-
-test('API isAccessControlRequired', async t => {
-  t.is(governor.isAccessControlRequired({ upgradeable: 'uups' }), true);
-  t.is(governor.isAccessControlRequired({}), false);
-});