Improve encapsulation on ERC165 and update code style guide (OpenZepp…

…elin#1379) * use prefix underscore for internal state variables * make _supportedInterfaces private
Aniket-Engg · Oct 12, 2018 · 03dfb29 · 03dfb29
1 parent 9f82290
commit 03dfb29
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/CODE_STYLE.md b/CODE_STYLE.md
@@ -23,6 +23,7 @@ Any exception or additions specific to our project are documented below.
     ```
     contract TestContract {
       uint256 private _privateVar;
+      uint256 internal _internalVar;
     }
     ```
 

diff --git a/contracts/introspection/ERC165.sol b/contracts/introspection/ERC165.sol
@@ -18,7 +18,7 @@ contract ERC165 is IERC165 {
   /**
    * @dev a mapping of interface id to whether or not it's supported
    */
-  mapping(bytes4 => bool) internal _supportedInterfaces;
+  mapping(bytes4 => bool) private _supportedInterfaces;
 
   /**
    * @dev A contract implementing SupportsInterfaceWithLookup

diff --git a/contracts/mocks/ERC165/ERC165InterfacesSupported.sol b/contracts/mocks/ERC165/ERC165InterfacesSupported.sol
@@ -21,7 +21,7 @@ contract SupportsInterfaceWithLookupMock is IERC165 {
   /**
    * @dev a mapping of interface id to whether or not it's supported
    */
-  mapping(bytes4 => bool) internal supportedInterfaces;
+  mapping(bytes4 => bool) private _supportedInterfaces;
 
   /**
    * @dev A contract implementing SupportsInterfaceWithLookup
@@ -41,7 +41,7 @@ contract SupportsInterfaceWithLookupMock is IERC165 {
     view
     returns (bool)
   {
-    return supportedInterfaces[interfaceId];
+    return _supportedInterfaces[interfaceId];
   }
 
   /**
@@ -51,7 +51,7 @@ contract SupportsInterfaceWithLookupMock is IERC165 {
     internal
   {
     require(interfaceId != 0xffffffff);
-    supportedInterfaces[interfaceId] = true;
+    _supportedInterfaces[interfaceId] = true;
   }
 }
-Original file line number
+Diff line change
@@ Expand Up @@
         ```
         contract TestContract {
           uint256 private _privateVar;
+          uint256 internal _internalVar;
         }
         ```
@@ Expand Down @@