fix: Slither Issues (#81)

* Clean up naming conventions * Fix boolean constants * Clean up linter warnings
Geo-Web-Project · Sep 1, 2022 · 2e0c21e · 2e0c21e
1 parent 20628c1
commit 2e0c21e
Show file tree

Hide file tree

Showing 31 changed files with 257 additions and 317 deletions.
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -1,12 +1,12 @@
-name: "CI"
+name: "Linter"
 on:
   push:
     branches: [main, develop]
   pull_request:
     branches: [main, develop]
 jobs:
   tests:
-    name: "Tests"
+    name: "Lint"
     runs-on: ubuntu-latest
     needs: []
     steps:

diff --git a/.solhint.json b/.solhint.json
@@ -3,6 +3,9 @@
   "extends": "solhint:recommended",
   "rules": {
     "prettier/prettier": "error",
-    "compiler-version": ["error", "^0.8.4"]
+    "compiler-version": ["error", "^0.8.4"],
+    "not-rely-on-time": "off",
+    "reason-string": ["warn", { "maxLength": 100 }],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
   }
 }
diff --git a/abi/contracts/pco-license/facets/CFABasePCOFacet.sol/CFABasePCOFacet.json b/abi/contracts/pco-license/facets/CFABasePCOFacet.sol/CFABasePCOFacet.json
@@ -117,12 +117,12 @@
       },
       {
         "internalType": "contract IERC721",
-        "name": "_license",
+        "name": "initLicense",
         "type": "address"
       },
       {
         "internalType": "uint256",
-        "name": "_licenseId",
+        "name": "initLicenseId",
         "type": "uint256"
       },
       {

diff --git a/abi/contracts/registry/facets/ERC721Facet.sol/ERC721Facet.json b/abi/contracts/registry/facets/ERC721Facet.sol/ERC721Facet.json
@@ -134,12 +134,12 @@
     "inputs": [
       {
         "internalType": "string",
-        "name": "_name",
+        "name": "initName",
         "type": "string"
       },
       {
         "internalType": "string",
-        "name": "_symbol",
+        "name": "initSymbol",
         "type": "string"
       }
     ],

diff --git a/abi/contracts/registry/facets/PCOLicenseClaimerFacet.sol/PCOLicenseClaimerFacet.json b/abi/contracts/registry/facets/PCOLicenseClaimerFacet.sol/PCOLicenseClaimerFacet.json
@@ -199,7 +199,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_auctionEnd",
+        "name": "auctionEnd",
         "type": "uint256"
       }
     ],
@@ -212,7 +212,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_auctionStart",
+        "name": "auctionStart",
         "type": "uint256"
       }
     ],
@@ -225,7 +225,7 @@
     "inputs": [
       {
         "internalType": "address",
-        "name": "_beacon",
+        "name": "beacon",
         "type": "address"
       }
     ],
@@ -238,7 +238,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_endingBid",
+        "name": "endingBid",
         "type": "uint256"
       }
     ],
@@ -251,7 +251,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_startingBid",
+        "name": "startingBid",
         "type": "uint256"
       }
     ],

diff --git a/abi/contracts/registry/libraries/LibGeoWebCoordinate.sol/LibGeoWebCoordinate.json b/abi/contracts/registry/libraries/LibGeoWebCoordinate.sol/LibGeoWebCoordinate.json
@@ -37,12 +37,12 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "i_x",
+        "name": "iX",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "i_y",
+        "name": "iY",
         "type": "uint256"
       },
       {
@@ -68,40 +68,40 @@
       },
       {
         "internalType": "uint256",
-        "name": "_i_x",
+        "name": "iX",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "_i_y",
+        "name": "iY",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "_i",
+        "name": "i",
         "type": "uint256"
       }
     ],
     "name": "traverse",
     "outputs": [
       {
         "internalType": "uint64",
-        "name": "destination",
+        "name": "",
         "type": "uint64"
       },
       {
         "internalType": "uint256",
-        "name": "i_x",
+        "name": "",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "i_y",
+        "name": "",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "i",
+        "name": "",
         "type": "uint256"
       }
     ],

diff --git a/abi/hardhat-diamond-abi/HardhatDiamondABI.sol/PCOLicenseDiamond.json b/abi/hardhat-diamond-abi/HardhatDiamondABI.sol/PCOLicenseDiamond.json
@@ -117,12 +117,12 @@
       },
       {
         "internalType": "contract IERC721",
-        "name": "_license",
+        "name": "initLicense",
         "type": "address"
       },
       {
         "internalType": "uint256",
-        "name": "_licenseId",
+        "name": "initLicenseId",
         "type": "uint256"
       },
       {

diff --git a/abi/hardhat-diamond-abi/HardhatDiamondABI.sol/RegistryDiamond.json b/abi/hardhat-diamond-abi/HardhatDiamondABI.sol/RegistryDiamond.json
@@ -134,12 +134,12 @@
     "inputs": [
       {
         "internalType": "string",
-        "name": "_name",
+        "name": "initName",
         "type": "string"
       },
       {
         "internalType": "string",
-        "name": "_symbol",
+        "name": "initSymbol",
         "type": "string"
       }
     ],
@@ -680,7 +680,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_auctionEnd",
+        "name": "auctionEnd",
         "type": "uint256"
       }
     ],
@@ -693,7 +693,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_auctionStart",
+        "name": "auctionStart",
         "type": "uint256"
       }
     ],
@@ -706,7 +706,7 @@
     "inputs": [
       {
         "internalType": "address",
-        "name": "_beacon",
+        "name": "beacon",
         "type": "address"
       }
     ],
@@ -719,7 +719,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_endingBid",
+        "name": "endingBid",
         "type": "uint256"
       }
     ],
@@ -732,7 +732,7 @@
     "inputs": [
       {
         "internalType": "uint256",
-        "name": "_startingBid",
+        "name": "startingBid",
         "type": "uint256"
       }
     ],

diff --git a/contracts/beacon-diamond/BeaconDiamond.sol b/contracts/beacon-diamond/BeaconDiamond.sol
@@ -20,6 +20,7 @@ contract BeaconDiamond {
 
     // Find facet for function that is called and execute the
     // function if a facet is found and return any value.
+    // solhint-disable-next-line no-complex-fallback
     fallback() external payable {
         LibBeaconDiamond.DiamondStorage storage ds = LibBeaconDiamond
             .diamondStorage();
@@ -28,6 +29,7 @@ contract BeaconDiamond {
         address facet = ds.beacon.facetAddress(msg.sig);
         require(facet != address(0), "Diamond: Function does not exist");
         // Execute external function from facet using delegatecall and return any value.
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             // copy function selector and any arguments
             calldatacopy(0, 0, calldatasize())
@@ -46,5 +48,6 @@ contract BeaconDiamond {
         }
     }
 
+    // solhint-disable-next-line no-empty-blocks
     receive() external payable {}
 }
diff --git a/contracts/beacon-diamond/libraries/LibBeaconDiamond.sol b/contracts/beacon-diamond/libraries/LibBeaconDiamond.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.4;
 import {IDiamondLoupe} from "hardhat-deploy/solc_0.8/diamond/interfaces/IDiamondLoupe.sol";
 
 library LibBeaconDiamond {
-    bytes32 constant STORAGE_POSITION =
+    bytes32 private constant STORAGE_POSITION =
         keccak256("diamond.standard.diamond.storage.LibBeaconDiamond");
 
     struct DiamondStorage {
@@ -18,6 +18,8 @@ library LibBeaconDiamond {
         returns (DiamondStorage storage ds)
     {
         bytes32 position = STORAGE_POSITION;
+
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             ds.slot := position
         }

diff --git a/contracts/pco-license/facets/CFABasePCOFacet.sol b/contracts/pco-license/facets/CFABasePCOFacet.sol
@@ -44,16 +44,16 @@ contract CFABasePCOFacet is IBasePCO, CFABasePCOFacetModifiers {
      *      - Must have payment token buffer deposited
      *      - Must have permissions to create flow for bidder
      * @param paramsStore Global store for parameters
-     * @param _license Underlying ERC721 license
-     * @param _licenseId Token ID of license
+     * @param initLicense Underlying ERC721 license
+     * @param initLicenseId Token ID of license
      * @param bidder Initial bidder
      * @param newContributionRate New contribution rate for bid
      * @param newForSalePrice Intented new for sale price. Must be within rounding bounds of newContributionRate
      */
     function initializeBid(
         IPCOLicenseParamsStore paramsStore,
-        IERC721 _license,
-        uint256 _licenseId,
+        IERC721 initLicense,
+        uint256 initLicenseId,
         address bidder,
         int96 newContributionRate,
         uint256 newForSalePrice
@@ -63,8 +63,8 @@ contract CFABasePCOFacet is IBasePCO, CFABasePCOFacetModifiers {
         LibCFABasePCO.DiamondStorage storage ds = LibCFABasePCO
             .diamondStorage();
         ds.paramsStore = paramsStore;
-        ds.license = _license;
-        ds.licenseId = _licenseId;
+        ds.license = initLicense;
+        ds.licenseId = initLicenseId;
 
         uint256 perSecondFeeNumerator = ds
             .paramsStore

diff --git a/contracts/pco-license/facets/CFAPenaltyBidFacet.sol b/contracts/pco-license/facets/CFAPenaltyBidFacet.sol
@@ -41,7 +41,7 @@ contract CFAPenaltyBidFacet is ICFABiddable, CFABasePCOFacetModifiers {
     modifier onlyIfPendingBid() {
         // Check if pending bid exists
         require(
-            this.hasPendingBid() == true,
+            this.hasPendingBid(),
             "CFAPenaltyBidFacet: Pending bid does not exist"
         );
         _;
@@ -50,7 +50,7 @@ contract CFAPenaltyBidFacet is ICFABiddable, CFABasePCOFacetModifiers {
     modifier onlyIfNotPendingBid() {
         // Check if pending bid exists
         require(
-            this.hasPendingBid() == false,
+            !this.hasPendingBid(),
             "CFAPenaltyBidFacet: Pending bid exists"
         );
         _;
@@ -64,7 +64,7 @@ contract CFAPenaltyBidFacet is ICFABiddable, CFABasePCOFacetModifiers {
             .diamondStorage();
 
         // Succeed if payer bid is not active
-        if (LibCFABasePCO._isPayerBidActive() == true) {
+        if (LibCFABasePCO._isPayerBidActive()) {
             uint256 bidPeriodLengthInSeconds = ds
                 .paramsStore
                 .getBidPeriodLengthInSeconds();
@@ -156,7 +156,7 @@ contract CFAPenaltyBidFacet is ICFABiddable, CFABasePCOFacetModifiers {
 
         // Check if pending bid exists
         require(
-            this.hasPendingBid() == false,
+            !this.hasPendingBid(),
             "CFAPenaltyBidFacet: Pending bid already exists"
         );
 

diff --git a/contracts/pco-license/libraries/LibCFABasePCO.sol b/contracts/pco-license/libraries/LibCFABasePCO.sol
@@ -10,13 +10,13 @@ library LibCFABasePCO {
     using CFAv1Library for CFAv1Library.InitData;
     using SafeERC20 for ISuperToken;
 
-    bytes32 constant STORAGE_POSITION =
+    bytes32 private constant STORAGE_POSITION =
         keccak256("diamond.standard.diamond.storage.LibBasePCO");
 
-    bytes32 constant STORAGE_POSITION_CUR_BID =
+    bytes32 private constant STORAGE_POSITION_CUR_BID =
         keccak256("diamond.standard.diamond.storage.LibBasePCO.currentBid");
 
-    bytes32 constant STORAGE_POSITION_CFA =
+    bytes32 private constant STORAGE_POSITION_CFA =
         keccak256("diamond.standard.diamond.storage.LibBasePCO.cfa");
 
     struct Bid {
@@ -56,6 +56,7 @@ library LibCFABasePCO {
         returns (DiamondStorage storage ds)
     {
         bytes32 position = STORAGE_POSITION;
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             ds.slot := position
         }
@@ -64,6 +65,7 @@ library LibCFABasePCO {
     /// @dev Store currentBid in separate position so struct is upgradeable
     function _currentBid() internal pure returns (Bid storage bid) {
         bytes32 position = STORAGE_POSITION_CUR_BID;
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             bid.slot := position
         }
@@ -72,6 +74,7 @@ library LibCFABasePCO {
     /// @dev Store cfa in separate position so struct is upgradeable
     function cfaStorage() internal pure returns (DiamondCFAStorage storage ds) {
         bytes32 position = STORAGE_POSITION_CFA;
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             ds.slot := position
         }