Linting Enforcement on Periphery Contracts (#9)

* feat: bump & remove unused pkgs, add husky

* fix: yarn lock

* config: add to solhint

* style: fix linting issues

Author: jdubpark

.husky/pre-push

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint:sol:fix
+# recheck
+yarn solhint

.prettierrc

@@ -1,4 +1,5 @@
 {
+    "plugins": ["prettier-plugin-solidity"],
     "useTabs": false,
     "printWidth": 120,
     "trailingComma": "es5",
@@ -12,6 +13,12 @@
             "options": {
                 "tabWidth": 2
             }
+        },
+        {
+            "files": "*.sol",
+            "options": {
+                "singleQuote": false
+            }
         }
     ]
 }

.solhint.json

@@ -3,21 +3,23 @@
   "plugins": ["prettier"],
   "rules": {
     "code-complexity": ["error", 8],
-    "compiler-version": ["error", ">=0.8.19"],
+    "compiler-version": ["error", ">=0.8.23"],
     "const-name-snakecase": "off",
     "no-empty-blocks": "off",
     "constructor-syntax": "error",
     "func-visibility": ["error", { "ignoreConstructors": true }],
-    "modifier-name-mixedcase":  "error",
     "max-line-length": ["error", 120],
     "not-rely-on-time": "off",
     "reason-string": ["warn", { "maxLength": 64 }],
     "no-unused-import": "error",
-    "no-unused-vars": "error",
+    "no-unused-vars": "off",
     "no-inline-assembly": "off",
     "avoid-low-level-calls": "off",
     "no-global-import": "error",
     "prettier/prettier": "error",
-    "private-vars-leading-underscore": "off"
+    "private-vars-leading-underscore": "off",
+    "func-name-mixedcase": "off",
+    "var-name-mixedcase": "off",
+    "modifier-name-mixedcase": "off"
   }
 }

contracts/StoryProtocolGateway.sol

@@ -5,6 +5,7 @@ pragma solidity ^0.8.23;
 import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import { IERC721 } from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 import { IERC721 } from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+// solhint-disable-next-line max-line-length
 import { PILPolicy, PILPolicyFrameworkManager, RegisterPILPolicyParams } from "@storyprotocol/contracts/modules/licensing/PILPolicyFrameworkManager.sol";
 import { BaseModule } from "@storyprotocol/contracts/modules/BaseModule.sol";
 import { IPAssetRegistry } from "@storyprotocol/contracts/registries/IPAssetRegistry.sol";
@@ -224,15 +225,11 @@ contract StoryProtocolGateway is BaseModule, ERC721SPNFTFactory, IStoryProtocolG
         _setCustomIpMetadata(ipId, ipMetadata.customMetadata);
     }
 
-    // TODO: Implement the function once `IPolicyFrameworkManager` has `registerPolicy` function exposed.
-    // function createPolicy(address policyFrameworkManager, bytes memory policyData) external returns (uint256 policyId) {
-    //     policyId = IPolicyFrameworkManager(policyFrameworkManager).registerPolicy(policyData);
-    // }
-
     /// @notice Create a new policy to Licensing Module via the PIL Policy Framework Manager.
     /// @param pilPolicy The PIL policy to add to the Licensing Module.
     /// @param transferable Whether or not the license is transferable.
-    /// @param royaltyPolicy Address of a royalty policy contract (e.g. RoyaltyPolicyLAP) that will handle royalty payments.
+    /// @param royaltyPolicy Address of a royalty policy contract (e.g. RoyaltyPolicyLAP) that will handle royalty
+    /// payments.
     /// @param mintingFee Fee to be paid when minting a license.
     /// @param mintingFeeToken Token to be used to pay the minting fee.
     /// @return policyId The ID of the newly registered policy.
@@ -257,7 +254,8 @@ contract StoryProtocolGateway is BaseModule, ERC721SPNFTFactory, IStoryProtocolG
     /// @notice Add a PIL policy to an IPAsset. Create a new PIL policy if it doesn't exist.
     /// @param pilPolicy The PIL policy to add to the Licensing Module.
     /// @param transferable Whether or not the license is transferable.
-    /// @param royaltyPolicy Address of a royalty policy contract (e.g. RoyaltyPolicyLAP) that will handle royalty payments.
+    /// @param royaltyPolicy Address of a royalty policy contract (e.g. RoyaltyPolicyLAP) that will handle royalty
+    /// payments.
     /// @param mintingFee Fee to be paid when minting a license.
     /// @param mintingFeeToken Token to be used to pay the minting fee.
     /// @param ipId The address of the IP asset to add the policy to.
@@ -321,7 +319,8 @@ contract StoryProtocolGateway is BaseModule, ERC721SPNFTFactory, IStoryProtocolG
     /// @param amount The amount of licenses to mint.
     /// @param royaltyContext The bytes-encoded context for royalty policy to process.
     /// @param transferable Whether or not the license is transferable.
-    /// @param royaltyPolicy Address of a royalty policy contract (e.g. RoyaltyPolicyLAP) that will handle royalty payments.
+    /// @param royaltyPolicy Address of a royalty policy contract (e.g. RoyaltyPolicyLAP) that will handle royalty
+    /// payments.
     /// @param mintingFee Fee to be paid when minting a license.
     /// @param mintingFeeToken Token to be used to pay the minting fee.
     /// @return licenseId The ID of the minted license NFT.

contracts/interfaces/nft/IERC721SPNFT.sol

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity ^0.8.23;
 
-import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
 import { IStoryProtocolToken } from "../IStoryProtocolToken.sol";
 
 /// @title ERC-721 Story Protocol NFT Interface

package.json

@@ -8,26 +8,31 @@
     "test": "test"
   },
   "scripts": {
-    "lint": "npm run lint:solidity && npm run lint:javascript",
-    "lint:javascript": "eslint ./",
-    "lint:solidity": "solhint \"contracts/**/*.sol\" \"test/**/*.sol\"",
-    "test": "npx hardhat test"
+    "lint": "npm run lint:js && npm run lint:sol",
+    "lint:fix": "npm run lint:js:fix && npm run lint:sol:fix",
+    "lint:js": "prettier --log-level warn --ignore-path .gitignore '**/*.{js,ts}' --check && eslint --ignore-path .gitignore .",
+    "lint:js:fix": "prettier --log-level warn --ignore-path .gitignore '**/*.{js,ts}' --write && eslint --ignore-path .gitignore . --fix",
+    "lint:sol": "prettier --log-level warn --ignore-path .gitignore '{contracts,test}/**/*.sol' --check && solhint '{contracts,test}/**/*.sol'",
+    "lint:sol:fix": "prettier --log-level warn --ignore-path .gitignore '{contracts,test}/**/*.sol' --write",
+    "solhint": "solhint '{contracts,test}/**/*.sol'",
+    "test": "npx hardhat test",
+    "prepare": "husky install"
   },
   "author": "StoryProtocol",
   "license": "BUSL-1.1",
   "devDependencies": {
-    "chai": "^4.3.7",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.38.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "ethereum-waffle": "^4.0.10",
+    "chai": "^5.0.3",
+    "dotenv": "^16.4.1",
+    "eslint": "^8.56.0",
+    "eslint-plugin-prettier": "^5.1.3",
     "ethers": "^6.10.0",
+    "husky": "^9.0.11",
     "mocha": "^10.2.0",
-    "prettier": "2.8.7",
+    "prettier": "^3.0.0",
     "prettier-plugin-solidity": "^1.1.3",
-    "solhint": "^3.4.1",
-    "solhint-plugin-prettier": "^0.0.5",
-    "solidity-coverage": "^0.8.2",
+    "solhint": "^4.1.1",
+    "solhint-plugin-prettier": "^0.1.0",
+    "solidity-coverage": "^0.8.6",
     "ts-node": "^10.9.2",
     "typechain": "^8.3.2"
   },

remappings.txt

@@ -1,5 +1,4 @@
 @ensdomains/=node_modules/@ensdomains/
-@ethereum-waffle/=node_modules/@ethereum-waffle/
 @openzeppelin/=node_modules/@openzeppelin/
 @storyprotocol/=node_modules/@story-protocol/protocol-core/
 @storyprotocol-old/=node_modules/@storyprotocol/contracts-old/

test/StoryProtocolGateway.t.sol

@@ -4,20 +4,17 @@ pragma solidity ^0.8.23;
 import { MessageHashUtils } from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
 
 import { IPAssetRegistry } from "@storyprotocol/contracts/registries/IPAssetRegistry.sol";
-import { LicensingModule } from "@storyprotocol/contracts/modules/licensing/LicensingModule.sol";
 import { ILicensingModule } from "@storyprotocol/contracts/interfaces/modules/licensing/ILicensingModule.sol";
 import { IRoyaltyPolicyLAP } from "@storyprotocol/contracts/interfaces/modules/royalty/policies/IRoyaltyPolicyLAP.sol";
 import { AccessPermission } from "@storyprotocol/contracts/lib/AccessPermission.sol";
 import { MetaTx } from "@storyprotocol/contracts/lib/MetaTx.sol";
 import { ModuleRegistry } from "@storyprotocol/contracts/registries/ModuleRegistry.sol";
+// solhint-disable-next-line max-line-length
 import { PILPolicy, IPILPolicyFrameworkManager, RegisterPILPolicyParams } from "@storyprotocol/contracts/interfaces/modules/licensing/IPILPolicyFrameworkManager.sol";
-import { IP } from "@storyprotocol/contracts/lib/IP.sol";
 import { AccessController } from "@storyprotocol/contracts/AccessController.sol";
 import { Base64 } from "@openzeppelin/contracts/utils/Base64.sol";
 import { IPResolver } from "@storyprotocol/contracts/resolvers/IPResolver.sol";
-import { KeyValueResolver } from "@storyprotocol/contracts/resolvers/KeyValueResolver.sol";
 
-import { stdJson } from "forge-std/StdJson.sol";
 import { MockERC721Cloneable } from "./mocks/nft/MockERC721Cloneable.sol";
 import { StoryProtocolCoreAddressManager } from "script/utils/StoryProtocolCoreAddressManager.sol";
 import { ForkTest } from "./utils/Fork.t.sol";
@@ -29,7 +26,6 @@ import { StoryProtocolGateway } from "contracts/StoryProtocolGateway.sol";
 
 /// @title Story Protocol Gateway Test Contract
 contract StoryProtocolGatewayTest is ForkTest, StoryProtocolCoreAddressManager {
-
     MockERC721Cloneable internal externalNFT;
     IPAssetRegistry internal ipAssetRegistry;
     ILicensingModule internal licensingModule;
@@ -67,7 +63,7 @@ contract StoryProtocolGatewayTest is ForkTest, StoryProtocolCoreAddressManager {
     bytes internal emptyRoyaltyPolicyLAPInitParams;
 
     /// @notice The Story Protocol Gateway SUT.
-    StoryProtocolGateway public spg;
+    StoryProtocolGateway internal spg;
 
     function setUp() public virtual override(ForkTest) {
         _readStoryProtocolCoreAddresses();
@@ -173,6 +169,7 @@ contract StoryProtocolGatewayTest is ForkTest, StoryProtocolCoreAddressManager {
         assertEq(nft.name(), SPG_DEFAULT_NFT_NAME);
         assertEq(nft.symbol(), SPG_DEFAULT_NFT_SYMBOL);
 
+        /* solhint-disable */
         string memory uriEncoding = string(
             abi.encodePacked(
                 '{"description": "Test SPG contract", ',
@@ -181,6 +178,7 @@ contract StoryProtocolGatewayTest is ForkTest, StoryProtocolCoreAddressManager {
                 '"name": "SPG Default Collection"}'
             )
         );
+        /* solhint-enable */
         string memory expectedURI = string(
             abi.encodePacked(
                 "data:application/json;base64,",
@@ -219,7 +217,7 @@ contract StoryProtocolGatewayTest is ForkTest, StoryProtocolCoreAddressManager {
 
         address ipId = IPAssetRegistry(ipAssetRegistryAddr).ipId(block.chainid, address(externalNFT), 0);
 
-        uint deadline = block.timestamp + 1000;
+        uint256 deadline = block.timestamp + 1000;
         AccessPermission.Permission[] memory permissionList = new AccessPermission.Permission[](2);
         permissionList[0] = AccessPermission.Permission({
             ipAccount: ipId,
@@ -270,7 +268,7 @@ contract StoryProtocolGatewayTest is ForkTest, StoryProtocolCoreAddressManager {
     function _registerDerivativeIpWithSig(address ipId, Metadata.IPMetadata memory ipMetadata) internal {
         address derivativeIpId = IPAssetRegistry(ipAssetRegistryAddr).ipId(block.chainid, address(externalNFT), 1);
 
-        uint deadline = block.timestamp + 1000;
+        uint256 deadline = block.timestamp + 1000;
         AccessPermission.Permission[] memory permissionList = new AccessPermission.Permission[](2);
         permissionList[0] = AccessPermission.Permission({
             ipAccount: derivativeIpId,

test/mocks/MockStoryProtocolDrop.sol

@@ -1,15 +1,12 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity ^0.8.23;
 
-import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
-
 import { IStoryProtocolDrop } from "contracts/interfaces/IStoryProtocolDrop.sol";
 import { SPG } from "contracts/lib/SPG.sol";
 import { ERC721SPNFTFactory } from "contracts/nft/ERC721SPNFTFactory.sol";
 
 /// @title Mock Story Protocol Drop Contract
 contract MockStoryProtocolDrop is ERC721SPNFTFactory, IStoryProtocolDrop {
-
     /// @notice Keeps track of all created mints.
     mapping(address => SPG.MintSettings) public publicMints;
 
@@ -33,5 +30,4 @@ contract MockStoryProtocolDrop is ERC721SPNFTFactory, IStoryProtocolDrop {
     function getMintSettings(address ipCollection) public view returns (SPG.MintSettings memory) {
         return publicMints[ipCollection];
     }
-
 }

test/mocks/nft/MockERC721Cloneable.sol

@@ -5,12 +5,8 @@ import { ERC721Cloneable } from "contracts/nft/ERC721Cloneable.sol";
 
 /// @title Mock ERC721 Cloneable
 contract MockERC721Cloneable is ERC721Cloneable {
-
     /// @notice Initializes the mock ERC721 cloneable contract.
-    function initialize(
-        string memory tokenName,
-        string memory tokenSymbol
-    ) public initializer {
+    function initialize(string memory tokenName, string memory tokenSymbol) public initializer {
         __ERC721Cloneable_init(tokenName, tokenSymbol);
     }
 
@@ -30,4 +26,3 @@ contract MockERC721Cloneable is ERC721Cloneable {
         return "";
     }
 }
-

test/mocks/nft/MockERC721MetadataProvider.sol

@@ -3,11 +3,9 @@ pragma solidity ^0.8.23;
 
 import { IERC721MetadataProvider } from "contracts/interfaces/nft/IERC721MetadataProvider.sol";
 import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
-import { Errors } from "contracts/lib/Errors.sol";
 
 /// @title Mock ERC-721 Metadata Provider
 contract MockERC721MetadataProvider is IERC721MetadataProvider, Initializable {
-
     /// @dev Sample metadata schema that the provider requires for tokens.
     struct TokenMetadata {
         string url;
@@ -23,10 +21,10 @@ contract MockERC721MetadataProvider is IERC721MetadataProvider, Initializable {
     mapping(uint256 => bytes) internal _metadata;
 
     /// @dev Tracks the token associated with the metadata provider.
-    address _token;
-    
+    address internal _token;
+
     /// @dev Tracks the contract URL.
-    string _contractURL;
+    string internal _contractURL;
 
     /// @notice Initializes the metadata provider for the provided erc-721 token.
     /// @param tokenAddr The address of the ERC-721 metadata is being provided for.

test/mocks/nft/MockERC721Receiver.sol

@@ -1,14 +1,13 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity ^0.8.23;
 
-import '@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol';
+import { IERC721Receiver } from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
 import { Errors } from "contracts/lib/Errors.sol";
 
 /// @title Mock ERC-721 Receiver
 /// @notice This contract is used to test ERC-721 safe transfers.
 contract MockERC721Receiver is IERC721Receiver {
-
     /// @notice Custom event used to vet whether a receive was successful.
     event ERC721Received(address operator, address from, uint256 tokenId, bytes data);
 

test/mocks/nft/MockERC721SPNFT.sol

@@ -1,4 +1,3 @@
-
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity ^0.8.23;
 
@@ -10,7 +9,6 @@ import { SPG } from "contracts/lib/SPG.sol";
 
 /// @title Mock ERC721 Cloneable
 contract MockERC721SPNFT is IERC721SPNFT, ERC721Cloneable {
-
     /// @dev Gets the current metadata provider used for new NFTs in the collection.
     IERC721MetadataProvider internal _metadataProvider;
 
@@ -68,8 +66,5 @@ contract MockERC721SPNFT is IERC721SPNFT, ERC721Cloneable {
     }
 
     /// @notice Configures the minting settings for an ongoing Story Protocol mint.
-    function configureMint(
-        address spg,
-        SPG.MintSettings calldata mintSettings
-    ) external {}
+    function configureMint(address spg, SPG.MintSettings calldata mintSettings) external {}
 }

test/nft/erc721/ERC721Base.t.sol

@@ -4,20 +4,19 @@ pragma solidity ^0.8.23;
 import { IERC721 } from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
 import { MockERC721Receiver } from "test/mocks/nft/MockERC721Receiver.sol";
-import { BaseTest } from "test/utils/Base.t.sol";
 import { IERC721Receiver } from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 import { TransferHelper } from "./TransferHelper.sol";
 import { Errors } from "contracts/lib/Errors.sol";
 
 /// @title ERC721 Base Test Contract
 /// @notice Base contract for testing standard ERC721 functionality.
 abstract contract ERC721BaseTest is TransferHelper {
-
     // Expected return value by contract recipients for ERC-721 safe transfers.
-    bytes4 constant ERC721_RECEIVER_MAGIC_VALUE = bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"));
+    bytes4 internal constant ERC721_RECEIVER_MAGIC_VALUE =
+        bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"));
 
     /// @notice The ERC721 token contract SUT.
-    IERC721Metadata public token;
+    IERC721Metadata internal token;
 
     /// @notice Initializes the base ERC721 contract for testing.
     function setUp() public virtual override(TransferHelper) {
@@ -133,9 +132,8 @@ abstract contract ERC721BaseTest is TransferHelper {
     }
 
     /// @dev Gets the expected name for the ERC721 contract.
-    function _expectedName() internal virtual pure returns (string memory);
+    function _expectedName() internal pure virtual returns (string memory);
 
     /// @dev Gets the expected symbol for the ERC721 contract.
-    function _expectedSymbol() internal virtual pure returns (string memory);
-
+    function _expectedSymbol() internal pure virtual returns (string memory);
 }

test/nft/erc721/ERC721Cloneable.t.sol

@@ -8,7 +8,6 @@ import { Errors } from "contracts/lib/Errors.sol";
 
 /// @title ERC721 Cloneable Test Contract
 contract ERC721CloneableTest is ERC721BaseTest {
-
     string internal constant _NAME = "MOCK_NAME";
     string internal constant _SYMBOL = "MOCK_SYMBOL";
     MockERC721Cloneable public cloneable;
@@ -86,13 +85,12 @@ contract ERC721CloneableTest is ERC721BaseTest {
     }
 
     /// @dev Gets the expected name for the ERC721 contract.
-    function _expectedName() internal virtual pure override returns (string memory) {
+    function _expectedName() internal pure virtual override returns (string memory) {
         return _NAME;
     }
 
     /// @dev Gets the expected symbol for the ERC721 contract.
-    function _expectedSymbol() internal virtual pure override returns (string memory) {
+    function _expectedSymbol() internal pure virtual override returns (string memory) {
         return _SYMBOL;
     }
-
 }