Merge pull request #65 from nisedo/dev-rename-util-files-to-match-contracts

Fix #43: Rename util files to match contract names

Author: nisedo

README.md

@@ -491,7 +491,7 @@ Run the test suite using `echidna . --contract CryticABDKMath64x64Harness --seq-
 
 # Helper functions
 
-The repository provides a collection of functions and events meant to simplify the debugging and testing of assertions in Echidna. Commonly used functions, such as integer clamping or logging for different types are available in [contracts/util/PropertiesHelper.sol](contracts/util/PropertiesHelper.sol).
+The repository provides a collection of functions and events meant to simplify the debugging and testing of assertions in Echidna. Commonly used functions, such as integer clamping or logging for different types are available in [contracts/util/PropertiesAsserts.sol](contracts/util/PropertiesAsserts.sol).
 
 Available helpers:
 
@@ -508,7 +508,7 @@ Log a value for debugging. When the assertion is violated, the value of `someVal
 ```solidity
 pragma solidity ^0.8.0;
 
-import "@crytic/properties/contracts/util/PropertiesHelper.sol";
+import "@crytic/properties/contracts/util/PropertiesAsserts.sol";
 
 contract TestProperties is PropertiesAsserts {
   // ...
@@ -536,7 +536,7 @@ Assert equality, and log violations:
 ```solidity
 pragma solidity ^0.8.0;
 
-import "@crytic/properties/contracts/util/PropertiesHelper.sol";
+import "@crytic/properties/contracts/util/PropertiesAsserts.sol";
 
 contract TestProperties is PropertiesAsserts {
   // ...
@@ -564,7 +564,7 @@ Assure that a function's fuzzed parameter is in a certain range:
 ```solidity
 pragma solidity ^0.8.0;
 
-import "@crytic/properties/contracts/util/PropertiesHelper.sol";
+import "@crytic/properties/contracts/util/PropertiesAsserts.sol";
 
 contract TestProperties is PropertiesAsserts {
   int256 constant MAX_VALUE = 2 ** 160;
@@ -584,7 +584,7 @@ contract TestProperties is PropertiesAsserts {
 
 # HEVM cheat codes support
 
-Since version 2.0.5, Echidna supports [HEVM cheat codes](https://hevm.dev/std-test-tutorial.html#supported-cheat-codes). This repository contains a [`Hevm.sol`](contracts/util/Hevm.sol) contract that exposes cheat codes for easy integration into contracts under test.
+Since version 2.0.5, Echidna supports [HEVM cheat codes](https://hevm.dev/std-test-tutorial.html#supported-cheat-codes). This repository contains a [`IHevm.sol`](contracts/util/IHevm.sol) contract that exposes cheat codes for easy integration into contracts under test.
 
 Cheat codes should be used with care, since they can alter the execution environment in ways that are not expected, and may introduce false positives or false negatives.
 
@@ -595,7 +595,7 @@ Use `prank` to simulate a call from a different `msg.sender`:
 ```solidity
 pragma solidity ^0.8.0;
 
-import "@crytic/properties/contracts/util/Hevm.sol";
+import "@crytic/properties/contracts/util/IHevm.sol";
 
 contract TestProperties {
   // ...

contracts/ERC20/external/properties/ERC20ExternalPausableProperties.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.0;
 
 import "../util/ERC20ExternalTestBase.sol";
-import "../../../util/Hevm.sol";
+import "../../../util/IHevm.sol";
 
 abstract contract CryticERC20ExternalPausableProperties is
     CryticERC20ExternalTestBase

contracts/ERC20/external/util/ERC20ExternalTestBase.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 pragma solidity ^0.8.0;
 
-import "../../../util/PropertiesHelper.sol";
+import "../../../util/PropertiesAsserts.sol";
 import "./ITokenMock.sol";
 import "../../../util/PropertiesConstants.sol";
 

contracts/ERC20/internal/util/ERC20TestBase.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "../../../util/PropertiesConstants.sol";
-import "../../../util/PropertiesHelper.sol";
+import "../../../util/PropertiesAsserts.sol";
 
 abstract contract CryticERC20Base is
     ERC20,

contracts/ERC4626/util/Actor.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import {IERC4626} from "../../util/IERC4626.sol";
 import {TestERC20Token} from "../util/TestERC20Token.sol";
-import {PropertiesAsserts} from "../../util/PropertiesHelper.sol";
+import {PropertiesAsserts} from "../../util/PropertiesAsserts.sol";
 
 /// @notice This contract has two purposes:
 ///  1. Act as a proxy for performing vault deposits/withdraws (since we don't have vm.prank)

contracts/ERC4626/util/ERC4626PropertyTestBase.sol

@@ -5,7 +5,7 @@ import {IERC20} from "../../util/IERC20.sol";
 import {IERC4626} from "../../util/IERC4626.sol";
 import {TestERC20Token} from "./TestERC20Token.sol";
 import {Actor} from "../util/Actor.sol";
-import {PropertiesAsserts} from "../../util/PropertiesHelper.sol";
+import {PropertiesAsserts} from "../../util/PropertiesAsserts.sol";
 import {RedemptionProxy} from "./RedemptionProxy.sol";
 
 /// @notice This contract is used as a base contract for all 4626 property tests.

contracts/ERC721/external/properties/ERC721ExternalBasicProperties.sol

@@ -2,36 +2,49 @@
 pragma solidity ^0.8.13;
 
 import "../util/ERC721ExternalTestBase.sol";
-import "../../../util/Hevm.sol";
+import "../../../util/IHevm.sol";
 
-abstract contract CryticERC721ExternalBasicProperties is CryticERC721ExternalTestBase {
+abstract contract CryticERC721ExternalBasicProperties is
+    CryticERC721ExternalTestBase
+{
     using Address for address;
 
     ////////////////////////////////////////
     // Properties
 
     // Querying the balance of address(0) should throw
-    function test_ERC721_external_balanceOfZeroAddressMustRevert() public virtual {
+    function test_ERC721_external_balanceOfZeroAddressMustRevert()
+        public
+        virtual
+    {
         token.balanceOf(address(0));
         assertWithMsg(false, "address(0) balance query should have reverted");
     }
 
     // Querying the owner of an invalid token should throw
-    function test_ERC721_external_ownerOfInvalidTokenMustRevert() public virtual {
+    function test_ERC721_external_ownerOfInvalidTokenMustRevert()
+        public
+        virtual
+    {
         token.ownerOf(type(uint256).max);
         assertWithMsg(false, "Invalid token owner query should have reverted");
     }
 
     // Approving an invalid token should throw
-    function test_ERC721_external_approvingInvalidTokenMustRevert() public virtual {
+    function test_ERC721_external_approvingInvalidTokenMustRevert()
+        public
+        virtual
+    {
         token.approve(address(0), type(uint256).max);
         assertWithMsg(false, "Approving an invalid token should have reverted");
     }
 
     // transferFrom a token that the caller is not approved for should revert
-    function test_ERC721_external_transferFromNotApproved(address target) public virtual {
+    function test_ERC721_external_transferFromNotApproved(
+        address target
+    ) public virtual {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0);        
+        require(selfBalance > 0);
         require(target != address(this));
         require(target != msg.sender);
         uint tokenId = token.tokenOfOwnerByIndex(msg.sender, 0);
@@ -44,9 +57,11 @@ abstract contract CryticERC721ExternalBasicProperties is CryticERC721ExternalTes
     }
 
     // transferFrom should reset approval for that token
-    function test_ERC721_external_transferFromResetApproval(address target) public virtual {
+    function test_ERC721_external_transferFromResetApproval(
+        address target
+    ) public virtual {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0);  
+        require(selfBalance > 0);
         require(target != address(this));
         require(target != msg.sender);
         require(target != address(0));
@@ -56,39 +71,50 @@ abstract contract CryticERC721ExternalBasicProperties is CryticERC721ExternalTes
         hevm.prank(msg.sender);
         token.approve(address(this), tokenId);
         token.transferFrom(msg.sender, target, tokenId);
-        
+
         address approved = token.getApproved(tokenId);
         assertWithMsg(approved == address(0), "Approval was not reset");
     }
 
     // transferFrom correctly updates owner
-    function test_ERC721_external_transferFromUpdatesOwner(address target) public virtual {
+    function test_ERC721_external_transferFromUpdatesOwner(
+        address target
+    ) public virtual {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0);  
+        require(selfBalance > 0);
         require(target != address(this));
         require(target != msg.sender);
         require(target != address(0));
         uint tokenId = token.tokenOfOwnerByIndex(msg.sender, 0);
 
         hevm.prank(msg.sender);
         try token.transferFrom(msg.sender, target, tokenId) {
-            assertWithMsg(token.ownerOf(tokenId) == target, "Token owner not updated");
+            assertWithMsg(
+                token.ownerOf(tokenId) == target,
+                "Token owner not updated"
+            );
         } catch {
             assertWithMsg(false, "transferFrom unexpectedly reverted");
         }
     }
 
     // transfer from zero address should revert
-    function test_ERC721_external_transferFromZeroAddress(address target, uint256 tokenId) public virtual {
+    function test_ERC721_external_transferFromZeroAddress(
+        address target,
+        uint256 tokenId
+    ) public virtual {
         token.transferFrom(address(0), target, tokenId);
 
-        assertWithMsg(false, "transferFrom does not revert when `from` is the zero-address");
+        assertWithMsg(
+            false,
+            "transferFrom does not revert when `from` is the zero-address"
+        );
     }
 
     // Transfers to the zero address should revert
     function test_ERC721_external_transferToZeroAddress() public virtual {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0); 
+        require(selfBalance > 0);
         uint tokenId = token.tokenOfOwnerByIndex(msg.sender, 0);
 
         hevm.prank(msg.sender);
@@ -100,42 +126,63 @@ abstract contract CryticERC721ExternalBasicProperties is CryticERC721ExternalTes
     // Transfers to self should not break accounting
     function test_ERC721_external_transferFromSelf() public virtual {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0); 
+        require(selfBalance > 0);
         uint tokenId = token.tokenOfOwnerByIndex(msg.sender, 0);
         hevm.prank(msg.sender);
 
         try token.transferFrom(msg.sender, msg.sender, tokenId) {
-            assertWithMsg(token.ownerOf(tokenId) == msg.sender, "Self transfer changes owner");
-            assertEq(token.balanceOf(msg.sender), selfBalance, "Self transfer breaks accounting");
+            assertWithMsg(
+                token.ownerOf(tokenId) == msg.sender,
+                "Self transfer changes owner"
+            );
+            assertEq(
+                token.balanceOf(msg.sender),
+                selfBalance,
+                "Self transfer breaks accounting"
+            );
         } catch {
             assertWithMsg(false, "transferFrom unexpectedly reverted");
         }
-
     }
 
     // Transfer to self reset approval
-    function test_ERC721_external_transferFromSelfResetsApproval() public virtual {
+    function test_ERC721_external_transferFromSelfResetsApproval()
+        public
+        virtual
+    {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0); 
+        require(selfBalance > 0);
         uint tokenId = token.tokenOfOwnerByIndex(msg.sender, 0);
         require(token.ownerOf(tokenId) == msg.sender);
 
         hevm.prank(msg.sender);
         token.approve(address(this), tokenId);
 
         token.transferFrom(msg.sender, msg.sender, tokenId);
-        assertWithMsg(token.getApproved(tokenId) == address(0), "Self transfer does not reset approvals");
+        assertWithMsg(
+            token.getApproved(tokenId) == address(0),
+            "Self transfer does not reset approvals"
+        );
     }
 
     // safeTransferFrom reverts if receiver does not implement the callback
-    function test_ERC721_external_safeTransferFromRevertsOnNoncontractReceiver() public virtual {
+    function test_ERC721_external_safeTransferFromRevertsOnNoncontractReceiver()
+        public
+        virtual
+    {
         uint256 selfBalance = token.balanceOf(msg.sender);
-        require(selfBalance > 0); 
+        require(selfBalance > 0);
         uint tokenId = token.tokenOfOwnerByIndex(msg.sender, 0);
         hevm.prank(msg.sender);
 
-        token.safeTransferFrom(msg.sender, address(mockUnsafeReceiver), tokenId);
-        assertWithMsg(false, "safeTransferFrom does not revert if receiver does not implement ERC721.onERC721Received");
+        token.safeTransferFrom(
+            msg.sender,
+            address(mockUnsafeReceiver),
+            tokenId
+        );
+        assertWithMsg(
+            false,
+            "safeTransferFrom does not revert if receiver does not implement ERC721.onERC721Received"
+        );
     }
-
 }

contracts/ERC721/external/properties/ERC721ExternalBurnableProperties.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.13;
 
 import "../util/ERC721ExternalTestBase.sol";
-import "../../../util/Hevm.sol";
+import "../../../util/IHevm.sol";
 
 abstract contract CryticERC721ExternalBurnableProperties is
     CryticERC721ExternalTestBase

contracts/ERC721/external/util/ERC721ExternalTestBase.sol

@@ -1,20 +1,19 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 pragma solidity ^0.8.0;
 
-import "../../../util/PropertiesHelper.sol";
+import "../../../util/PropertiesAsserts.sol";
 import "../../util/IERC721Internal.sol";
 import "../../../util/PropertiesConstants.sol";
 import "@openzeppelin/contracts/utils/Address.sol";
 import {MockReceiver} from "./MockReceiver.sol";
 
-
-abstract contract CryticERC721ExternalTestBase is PropertiesAsserts, PropertiesConstants {
-
+abstract contract CryticERC721ExternalTestBase is
+    PropertiesAsserts,
+    PropertiesConstants
+{
     IERC721Internal public token;
     MockReceiver public mockSafeReceiver;
     MockReceiver public mockUnsafeReceiver;
 
-    constructor() {
-    }
-
+    constructor() {}
 }

contracts/ERC721/internal/util/ERC721TestBase.sol

@@ -4,33 +4,34 @@ pragma solidity ^0.8.0;
 import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
 import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
 import "../../../util/PropertiesConstants.sol";
-import "../../../util/PropertiesHelper.sol";
+import "../../../util/PropertiesAsserts.sol";
 import {MockReceiver} from "./MockReceiver.sol";
-import "../../../util/Hevm.sol";
-
-abstract contract CryticERC721TestBase is ERC721, ERC721Enumerable, PropertiesAsserts, PropertiesConstants {
+import "../../../util/IHevm.sol";
 
+abstract contract CryticERC721TestBase is
+    ERC721,
+    ERC721Enumerable,
+    PropertiesAsserts,
+    PropertiesConstants
+{
     // Is the contract allowed to change its total supply?
     bool isMintableOrBurnable;
     MockReceiver safeReceiver;
     MockReceiver unsafeReceiver;
 
     // The following functions are overrides required by Solidity.
-    function _beforeTokenTransfer(address from, address to, uint256 tokenId, uint256 batchSize)
-        internal
-        virtual
-        override(ERC721, ERC721Enumerable)
-    {
+    function _beforeTokenTransfer(
+        address from,
+        address to,
+        uint256 tokenId,
+        uint256 batchSize
+    ) internal virtual override(ERC721, ERC721Enumerable) {
         super._beforeTokenTransfer(from, to, tokenId, batchSize);
     }
 
-    function supportsInterface(bytes4 interfaceId)
-        public
-        view
-        virtual
-        override(ERC721, ERC721Enumerable)
-        returns (bool)
-    {
+    function supportsInterface(
+        bytes4 interfaceId
+    ) public view virtual override(ERC721, ERC721Enumerable) returns (bool) {
         return super.supportsInterface(interfaceId);
     }
 }