@openzeppelin/wizard 0.1.1 → 0.2.1

package/src/contract.test.ts

@@ -1,164 +0,0 @@
-import test from 'ava';
-
-import { ContractBuilder } from './contract';
-import { printContract } from './print';
-import { TAG_SECURITY_CONTACT } from './set-info';
-
-test('contract basics', t => {
-  const Foo = new ContractBuilder('Foo');
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with a parent', t => {
-  const Foo = new ContractBuilder('Foo');
-  const Bar = { name: 'Bar', path: './Bar.sol' };
-  Foo.addParent(Bar);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with two parents', t => {
-  const Foo = new ContractBuilder('Foo');
-  const Bar = { name: 'Bar', path: './Bar.sol' };
-  const Quux = { name: 'Quux', path: './Quux.sol' };
-  Foo.addParent(Bar);
-  Foo.addParent(Quux);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with a parent with parameters', t => {
-  const Foo = new ContractBuilder('Foo');
-  const Bar = { name: 'Bar', path: './Bar.sol' };
-  Foo.addParent(Bar, ["param1", "param2"]);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with two parents only one with parameters', t => {
-  const Foo = new ContractBuilder('Foo');
-  const Bar = { name: 'Bar', path: './Bar.sol' };
-  const Quux = { name: 'Quux', path: './Quux.sol' };
-  Foo.addParent(Bar, ["param1", "param2"]);
-  Foo.addParent(Quux);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with one override', t => {
-  const Foo = new ContractBuilder('Foo');
-  const _beforeTokenTransfer = {
-    name: '_beforeTokenTransfer',
-    kind: 'internal' as const,
-    args: [
-      { name: 'from', type: 'address' },
-      { name: 'to', type: 'address' },
-      { name: 'amount', type: 'uint256' },
-    ],
-  };
-  Foo.addOverride('ERC20', _beforeTokenTransfer);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with two overrides', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addOverride('ERC20', _beforeTokenTransfer);
-  Foo.addOverride('ERC20Snapshot', _beforeTokenTransfer);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with two different overrides', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addOverride('ERC20', _beforeTokenTransfer);
-  Foo.addOverride('OtherParent', _beforeTokenTransfer);
-  Foo.addOverride('ERC20', _otherFunction);
-  Foo.addOverride('OtherParent', _otherFunction);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with a modifier', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addModifier('whenNotPaused', _otherFunction);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with a modifier and override', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addModifier('whenNotPaused', _otherFunction);
-  Foo.addOverride('ERC20', _otherFunction);
-  Foo.addOverride('OtherParent', _otherFunction);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with constructor code', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addConstructorCode('_mint(msg.sender, 10 ether);');
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with constructor code and a parent', t => {
-  const Foo = new ContractBuilder('Foo');
-  const Bar = { name: 'Bar', path: './Bar.sol' };
-  Foo.addParent(Bar, ["param1", "param2"]);
-  Foo.addConstructorCode('_mint(msg.sender, 10 ether);');
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with function code', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addFunctionCode('_mint(msg.sender, 10 ether);', _otherFunction);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with overriden function with code', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addOverride('Bar', _otherFunction);
-  Foo.addFunctionCode('_mint(msg.sender, 10 ether);', _otherFunction);
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with one variable', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addVariable('uint value = 42;');
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with two variables', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addVariable('uint value = 42;');
-  Foo.addVariable('string name = "john";');
-  t.snapshot(printContract(Foo));
-});
-
-test('name with special characters', t => {
-  const Foo = new ContractBuilder('foo bar baz');
-  t.snapshot(printContract(Foo));
-});
-
-test('using for statement', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addUsing({
-    name: 'Counters',
-    path: './Counters.sol',
-  }, 'Counters.Counter');
-  t.snapshot(printContract(Foo));
-});
-
-test('contract with info', t => {
-  const Foo = new ContractBuilder('Foo');
-  Foo.addNatspecTag(TAG_SECURITY_CONTACT, 'security@example.com');
-  t.snapshot(printContract(Foo));
-});
-
-
-const _beforeTokenTransfer = {
-  name: '_beforeTokenTransfer',
-  kind: 'internal' as const,
-  args: [
-    { name: 'from', type: 'address' },
-    { name: 'to', type: 'address' },
-    { name: 'amount', type: 'uint256' },
-  ],
-};
-
-const _otherFunction = {
-  name: '_otherFunction',
-  kind: 'internal' as const,
-  args: [],
-};

package/src/contract.test.ts.md

@@ -1,272 +0,0 @@
-# Snapshot report for `src/contract.test.ts`
-
-The actual snapshot is saved in `contract.test.ts.snap`.
-
-Generated by [AVA](https://avajs.dev).
-
-## contract basics
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-    }␊
-    `
-
-## contract with a parent
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "./Bar.sol";␊
-    ␊
-    contract Foo is Bar {␊
-    }␊
-    `
-
-## contract with two parents
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "./Bar.sol";␊
-    import "./Quux.sol";␊
-    ␊
-    contract Foo is Bar, Quux {␊
-    }␊
-    `
-
-## contract with a parent with parameters
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "./Bar.sol";␊
-    ␊
-    contract Foo is Bar {␊
-        constructor() Bar("param1", "param2") {}␊
-    }␊
-    `
-
-## contract with two parents only one with parameters
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "./Bar.sol";␊
-    import "./Quux.sol";␊
-    ␊
-    contract Foo is Bar, Quux {␊
-        constructor() Bar("param1", "param2") {}␊
-    }␊
-    `
-
-## contract with one override
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-    }␊
-    `
-
-## contract with two overrides
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _beforeTokenTransfer(address from, address to, uint256 amount)␊
-            internal␊
-            override(ERC20, ERC20Snapshot)␊
-        {␊
-            super._beforeTokenTransfer(from, to, amount);␊
-        }␊
-    }␊
-    `
-
-## contract with two different overrides
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        // The following functions are overrides required by Solidity.␊
-    ␊
-        function _beforeTokenTransfer(address from, address to, uint256 amount)␊
-            internal␊
-            override(ERC20, OtherParent)␊
-        {␊
-            super._beforeTokenTransfer(from, to, amount);␊
-        }␊
-    ␊
-        function _otherFunction() internal override(ERC20, OtherParent) {␊
-            super._otherFunction();␊
-        }␊
-    }␊
-    `
-
-## contract with a modifier
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        function _otherFunction() internal whenNotPaused {}␊
-    }␊
-    `
-
-## contract with a modifier and override
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        function _otherFunction() internal whenNotPaused override(ERC20, OtherParent) {␊
-            super._otherFunction();␊
-        }␊
-    }␊
-    `
-
-## contract with constructor code
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        constructor() {␊
-            _mint(msg.sender, 10 ether);␊
-        }␊
-    }␊
-    `
-
-## contract with constructor code and a parent
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "./Bar.sol";␊
-    ␊
-    contract Foo is Bar {␊
-        constructor() Bar("param1", "param2") {␊
-            _mint(msg.sender, 10 ether);␊
-        }␊
-    }␊
-    `
-
-## contract with function code
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        function _otherFunction() internal {␊
-            _mint(msg.sender, 10 ether);␊
-        }␊
-    }␊
-    `
-
-## contract with overriden function with code
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        function _otherFunction() internal override {␊
-            _mint(msg.sender, 10 ether);␊
-            super._otherFunction();␊
-        }␊
-    }␊
-    `
-
-## contract with one variable
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        uint value = 42;␊
-    }␊
-    `
-
-## contract with two variables
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract Foo {␊
-        uint value = 42;␊
-        string name = "john";␊
-    }␊
-    `
-
-## name with special characters
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    contract FooBarBaz {␊
-    }␊
-    `
-
-## using for statement
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    import "./Counters.sol";␊
-    ␊
-    contract Foo {␊
-        using Counters for Counters.Counter;␊
-    }␊
-    `
-
-## contract with info
-
-> Snapshot 1
-
-    `// SPDX-License-Identifier: MIT␊
-    pragma solidity ^0.8.4;␊
-    ␊
-    /// @custom:security-contact security@example.com␊
-    contract Foo {␊
-    }␊
-    `

package/src/custom.test.ts

@@ -1,80 +0,0 @@
-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

@@ -1,154 +0,0 @@
-# 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␊
-        {}␊
-    }␊
-    `