style: [v0.8-develop] linter and fmt update (#98)

erc6900 · Jul 26, 2024 · 1f43a23 · 1f43a23
1 parent 39d327e
commit 1f43a23
Show file tree

Hide file tree

Showing 41 changed files with 208 additions and 176 deletions.
diff --git a/foundry.toml b/foundry.toml
@@ -47,6 +47,9 @@ depth = 32
 [fmt]
 line_length = 115
 wrap_comments = true
+sort_imports = true
+number_underscore = "thousands"
+int_types = "long"
 
 [rpc_endpoints]
 mainnet = "${RPC_URL_MAINNET}"

diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   },
   "scripts": {
     "lint": "pnpm lint:src && pnpm lint:test",
-    "lint:src": "solhint -c .solhint-src.json './src/**/*.sol'",
-    "lint:test": "solhint -c .solhint-test.json './test/**/*.sol'"
+    "lint:src": "solhint --max-warnings 0 -c .solhint-src.json './src/**/*.sol'",
+    "lint:test": "solhint --max-warnings 0 -c .solhint-test.json './test/**/*.sol'"
   }
 }
diff --git a/src/account/AccountLoupe.sol b/src/account/AccountLoupe.sol
@@ -2,11 +2,12 @@
 pragma solidity ^0.8.25;
 
 import {UUPSUpgradeable} from "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+
 import {EnumerableMap} from "@openzeppelin/contracts/utils/structs/EnumerableMap.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
-import {IAccountLoupe, ExecutionHook} from "../interfaces/IAccountLoupe.sol";
-import {PluginEntity, IPluginManager} from "../interfaces/IPluginManager.sol";
+import {ExecutionHook, IAccountLoupe} from "../interfaces/IAccountLoupe.sol";
+import {IPluginManager, PluginEntity} from "../interfaces/IPluginManager.sol";
 import {IStandardExecutor} from "../interfaces/IStandardExecutor.sol";
 import {getAccountStorage, toExecutionHook, toSelector} from "./AccountStorage.sol";
 

diff --git a/src/account/AccountStorage.sol b/src/account/AccountStorage.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 import {EnumerableMap} from "@openzeppelin/contracts/utils/structs/EnumerableMap.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
 import {ExecutionHook} from "../interfaces/IAccountLoupe.sol";
 import {PluginEntity} from "../interfaces/IPluginManager.sol";

diff --git a/src/account/PluginManager2.sol b/src/account/PluginManager2.sol
@@ -3,12 +3,13 @@ pragma solidity ^0.8.25;
 
 import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
-import {IPlugin} from "../interfaces/IPlugin.sol";
-import {PluginEntity, ValidationConfig} from "../interfaces/IPluginManager.sol";
 import {PluginEntityLib} from "../helpers/PluginEntityLib.sol";
 import {ValidationConfigLib} from "../helpers/ValidationConfigLib.sol";
-import {ValidationData, getAccountStorage, toSetValue} from "./AccountStorage.sol";
+
 import {ExecutionHook} from "../interfaces/IAccountLoupe.sol";
+import {IPlugin} from "../interfaces/IPlugin.sol";
+import {PluginEntity, ValidationConfig} from "../interfaces/IPluginManager.sol";
+import {ValidationData, getAccountStorage, toSetValue} from "./AccountStorage.sol";
 
 // Temporary additional functions for a user-controlled install flow for validation functions.
 abstract contract PluginManager2 {

diff --git a/src/account/PluginManagerInternals.sol b/src/account/PluginManagerInternals.sol
@@ -2,15 +2,16 @@
 pragma solidity ^0.8.25;
 
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+
 import {EnumerableMap} from "@openzeppelin/contracts/utils/structs/EnumerableMap.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
+import {KnownSelectors} from "../helpers/KnownSelectors.sol";
 import {PluginEntityLib} from "../helpers/PluginEntityLib.sol";
-import {IPlugin, ManifestExecutionHook, ManifestValidation, PluginManifest} from "../interfaces/IPlugin.sol";
 import {ExecutionHook} from "../interfaces/IAccountLoupe.sol";
-import {PluginEntity, IPluginManager} from "../interfaces/IPluginManager.sol";
-import {KnownSelectors} from "../helpers/KnownSelectors.sol";
-import {AccountStorage, getAccountStorage, SelectorData, toSetValue} from "./AccountStorage.sol";
+import {IPlugin, ManifestExecutionHook, ManifestValidation, PluginManifest} from "../interfaces/IPlugin.sol";
+import {IPluginManager, PluginEntity} from "../interfaces/IPluginManager.sol";
+import {AccountStorage, SelectorData, getAccountStorage, toSetValue} from "./AccountStorage.sol";
 
 abstract contract PluginManagerInternals is IPluginManager {
     using EnumerableSet for EnumerableSet.Bytes32Set;

diff --git a/src/account/UpgradeableModularAccount.sol b/src/account/UpgradeableModularAccount.sol
@@ -2,30 +2,35 @@
 pragma solidity ^0.8.25;
 
 import {BaseAccount} from "@eth-infinitism/account-abstraction/core/BaseAccount.sol";
+
+import {IAccountExecute} from "@eth-infinitism/account-abstraction/interfaces/IAccountExecute.sol";
 import {IEntryPoint} from "@eth-infinitism/account-abstraction/interfaces/IEntryPoint.sol";
 import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
-import {IAccountExecute} from "@eth-infinitism/account-abstraction/interfaces/IAccountExecute.sol";
+
+import {IERC1271} from "@openzeppelin/contracts/interfaces/IERC1271.sol";
 import {UUPSUpgradeable} from "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-import {IERC1271} from "@openzeppelin/contracts/interfaces/IERC1271.sol";
 import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
 import {PluginEntityLib} from "../helpers/PluginEntityLib.sol";
-import {ValidationConfigLib} from "../helpers/ValidationConfigLib.sol";
+
 import {SparseCalldataSegmentLib} from "../helpers/SparseCalldataSegmentLib.sol";
+import {ValidationConfigLib} from "../helpers/ValidationConfigLib.sol";
 import {_coalescePreValidation, _coalesceValidation} from "../helpers/ValidationResHelpers.sol";
+
+import {IExecutionHook} from "../interfaces/IExecutionHook.sol";
 import {IPlugin, PluginManifest} from "../interfaces/IPlugin.sol";
+import {IPluginManager, PluginEntity, ValidationConfig} from "../interfaces/IPluginManager.sol";
+import {Call, IStandardExecutor} from "../interfaces/IStandardExecutor.sol";
 import {IValidation} from "../interfaces/IValidation.sol";
 import {IValidationHook} from "../interfaces/IValidationHook.sol";
-import {IExecutionHook} from "../interfaces/IExecutionHook.sol";
-import {PluginEntity, IPluginManager, ValidationConfig} from "../interfaces/IPluginManager.sol";
-import {IStandardExecutor, Call} from "../interfaces/IStandardExecutor.sol";
 import {AccountExecutor} from "./AccountExecutor.sol";
 import {AccountLoupe} from "./AccountLoupe.sol";
-import {AccountStorage, getAccountStorage, toSetValue, toExecutionHook} from "./AccountStorage.sol";
+import {AccountStorage, getAccountStorage, toExecutionHook, toSetValue} from "./AccountStorage.sol";
 import {AccountStorageInitializable} from "./AccountStorageInitializable.sol";
-import {PluginManagerInternals} from "./PluginManagerInternals.sol";
+
 import {PluginManager2} from "./PluginManager2.sol";
+import {PluginManagerInternals} from "./PluginManagerInternals.sol";
 
 contract UpgradeableModularAccount is
     AccountExecutor,

diff --git a/src/helpers/KnownSelectors.sol b/src/helpers/KnownSelectors.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-import {UUPSUpgradeable} from "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
 import {IAccount} from "@eth-infinitism/account-abstraction/interfaces/IAccount.sol";
 import {IAggregator} from "@eth-infinitism/account-abstraction/interfaces/IAggregator.sol";
 import {IPaymaster} from "@eth-infinitism/account-abstraction/interfaces/IPaymaster.sol";
+import {UUPSUpgradeable} from "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 import {IAccountLoupe} from "../interfaces/IAccountLoupe.sol";
 import {IExecutionHook} from "../interfaces/IExecutionHook.sol";

diff --git a/src/plugins/BasePlugin.sol b/src/plugins/BasePlugin.sol
@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
-import {ERC165, IERC165} from "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 import {IAccountExecute} from "@eth-infinitism/account-abstraction/interfaces/IAccountExecute.sol";
 import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
+import {ERC165, IERC165} from "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 
 import {IPlugin} from "../interfaces/IPlugin.sol";
 

diff --git a/src/plugins/ERC20TokenLimitPlugin.sol b/src/plugins/ERC20TokenLimitPlugin.sol
@@ -1,20 +1,22 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
-import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
 import {UserOperationLib} from "@eth-infinitism/account-abstraction/core/UserOperationLib.sol";
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
+
 import {
-    SetValue,
     AssociatedLinkedListSet,
-    AssociatedLinkedListSetLib
+    AssociatedLinkedListSetLib,
+    SetValue
 } from "@modular-account-libs/libraries/AssociatedLinkedListSetLib.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
+import {IExecutionHook} from "../interfaces/IExecutionHook.sol";
 import {PluginManifest, PluginMetadata} from "../interfaces/IPlugin.sol";
-import {IStandardExecutor, Call} from "../interfaces/IStandardExecutor.sol";
 import {IPlugin} from "../interfaces/IPlugin.sol";
-import {IExecutionHook} from "../interfaces/IExecutionHook.sol";
+import {Call, IStandardExecutor} from "../interfaces/IStandardExecutor.sol";
+
 import {BasePlugin, IERC165} from "./BasePlugin.sol";
 
 /// @title ERC20 Token Limit Plugin

diff --git a/src/plugins/NativeTokenLimitPlugin.sol b/src/plugins/NativeTokenLimitPlugin.sol
@@ -1,14 +1,15 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
-import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
 import {UserOperationLib} from "@eth-infinitism/account-abstraction/core/UserOperationLib.sol";
+import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
 import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
+import {IExecutionHook} from "../interfaces/IExecutionHook.sol";
 import {PluginManifest, PluginMetadata} from "../interfaces/IPlugin.sol";
-import {IStandardExecutor, Call} from "../interfaces/IStandardExecutor.sol";
 import {IPlugin} from "../interfaces/IPlugin.sol";
-import {IExecutionHook} from "../interfaces/IExecutionHook.sol";
+import {Call, IStandardExecutor} from "../interfaces/IStandardExecutor.sol";
+
 import {IValidationHook} from "../interfaces/IValidationHook.sol";
 import {BasePlugin, IERC165} from "./BasePlugin.sol";
 

diff --git a/src/plugins/TokenReceiverPlugin.sol b/src/plugins/TokenReceiverPlugin.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
-import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 import {IERC1155Receiver} from "@openzeppelin/contracts/interfaces/IERC1155Receiver.sol";
+import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
 import {IPlugin, ManifestExecutionFunction, PluginManifest, PluginMetadata} from "../interfaces/IPlugin.sol";
 import {BasePlugin} from "./BasePlugin.sol";
@@ -12,9 +12,9 @@ import {BasePlugin} from "./BasePlugin.sol";
 /// @notice This plugin allows modular accounts to receive various types of tokens by implementing
 /// required token receiver interfaces.
 contract TokenReceiverPlugin is BasePlugin, IERC721Receiver, IERC1155Receiver {
-    string public constant NAME = "Token Receiver Plugin";
-    string public constant VERSION = "1.0.0";
-    string public constant AUTHOR = "ERC-6900 Authors";
+    string internal constant _NAME = "Token Receiver Plugin";
+    string internal constant _VERSION = "1.0.0";
+    string internal constant _AUTHOR = "ERC-6900 Authors";
 
     // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
     // ┃    Execution functions    ┃
@@ -85,9 +85,9 @@ contract TokenReceiverPlugin is BasePlugin, IERC721Receiver, IERC1155Receiver {
     /// @inheritdoc IPlugin
     function pluginMetadata() external pure virtual override returns (PluginMetadata memory) {
         PluginMetadata memory metadata;
-        metadata.name = NAME;
-        metadata.version = VERSION;
-        metadata.author = AUTHOR;
+        metadata.name = _NAME;
+        metadata.version = _VERSION;
+        metadata.author = _AUTHOR;
         return metadata;
     }
 }
diff --git a/src/plugins/validation/SingleSignerValidation.sol b/src/plugins/validation/SingleSignerValidation.sol
@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.25;
 
+import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
 import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
-import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
 import {SignatureChecker} from "@openzeppelin/contracts/utils/cryptography/SignatureChecker.sol";
 
 import {IPlugin, PluginManifest, PluginMetadata} from "../../interfaces/IPlugin.sol";
@@ -28,9 +28,9 @@ contract SingleSignerValidation is ISingleSignerValidation, BasePlugin {
     using ECDSA for bytes32;
     using MessageHashUtils for bytes32;
 
-    string public constant NAME = "SingleSigner Validation";
-    string public constant VERSION = "1.0.0";
-    string public constant AUTHOR = "ERC-6900 Authors";
+    string internal constant _NAME = "SingleSigner Validation";
+    string internal constant _VERSION = "1.0.0";
+    string internal constant _AUTHOR = "ERC-6900 Authors";
 
     uint256 internal constant _SIG_VALIDATION_PASSED = 0;
     uint256 internal constant _SIG_VALIDATION_FAILED = 1;
@@ -41,35 +41,11 @@ contract SingleSignerValidation is ISingleSignerValidation, BasePlugin {
 
     mapping(uint32 entityId => mapping(address account => address)) public signer;
 
-    /// @inheritdoc ISingleSignerValidation
-    function signerOf(uint32 entityId, address account) external view returns (address) {
-        return signer[entityId][account];
-    }
-
     /// @inheritdoc ISingleSignerValidation
     function transferSigner(uint32 entityId, address newSigner) external {
         _transferSigner(entityId, newSigner);
     }
 
-    // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-    // ┃    Plugin interface functions    ┃
-    // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-
-    /// @inheritdoc IPlugin
-    function pluginManifest() external pure override returns (PluginManifest memory) {
-        PluginManifest memory manifest;
-        return manifest;
-    }
-
-    /// @inheritdoc IPlugin
-    function pluginMetadata() external pure virtual override returns (PluginMetadata memory) {
-        PluginMetadata memory metadata;
-        metadata.name = NAME;
-        metadata.version = VERSION;
-        metadata.author = AUTHOR;
-        return metadata;
-    }
-
     /// @inheritdoc IPlugin
     function onInstall(bytes calldata data) external override {
         (uint32 entityId, address newSigner) = abi.decode(data, (uint32, address));
@@ -83,6 +59,11 @@ contract SingleSignerValidation is ISingleSignerValidation, BasePlugin {
         _transferSigner(abi.decode(data, (uint32)), address(0));
     }
 
+    /// @inheritdoc ISingleSignerValidation
+    function signerOf(uint32 entityId, address account) external view returns (address) {
+        return signer[entityId][account];
+    }
+
     /// @inheritdoc IValidation
     function validateUserOp(uint32 entityId, PackedUserOperation calldata userOp, bytes32 userOpHash)
         external
@@ -133,6 +114,25 @@ contract SingleSignerValidation is ISingleSignerValidation, BasePlugin {
         return _1271_INVALID;
     }
 
+    // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+    // ┃    Plugin interface functions    ┃
+    // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+    /// @inheritdoc IPlugin
+    function pluginManifest() external pure override returns (PluginManifest memory) {
+        PluginManifest memory manifest;
+        return manifest;
+    }
+
+    /// @inheritdoc IPlugin
+    function pluginMetadata() external pure virtual override returns (PluginMetadata memory) {
+        PluginMetadata memory metadata;
+        metadata.name = _NAME;
+        metadata.version = _VERSION;
+        metadata.author = _AUTHOR;
+        return metadata;
+    }
+
     // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
     // ┃    Internal / Private functions    ┃
     // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

diff --git a/src/samples/permissionhooks/AllowlistPlugin.sol b/src/samples/permissionhooks/AllowlistPlugin.sol
@@ -3,9 +3,10 @@ pragma solidity ^0.8.25;
 
 import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
 
-import {PluginMetadata, PluginManifest} from "../../interfaces/IPlugin.sol";
+import {PluginManifest, PluginMetadata} from "../../interfaces/IPlugin.sol";
+
+import {Call, IStandardExecutor} from "../../interfaces/IStandardExecutor.sol";
 import {IValidationHook} from "../../interfaces/IValidationHook.sol";
-import {IStandardExecutor, Call} from "../../interfaces/IStandardExecutor.sol";
 import {BasePlugin} from "../../plugins/BasePlugin.sol";
 
 contract AllowlistPlugin is IValidationHook, BasePlugin {

diff --git a/test/account/AccountExecHooks.t.sol b/test/account/AccountExecHooks.t.sol
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.19;
 
+import {IExecutionHook} from "../../src/interfaces/IExecutionHook.sol";
 import {
     IPlugin,
-    ManifestExecutionHook,
     ManifestExecutionFunction,
+    ManifestExecutionHook,
     PluginManifest
 } from "../../src/interfaces/IPlugin.sol";
-import {IExecutionHook} from "../../src/interfaces/IExecutionHook.sol";
 
 import {MockPlugin} from "../mocks/MockPlugin.sol";
 import {AccountTestBase} from "../utils/AccountTestBase.sol";

diff --git a/test/account/AccountReturnData.t.sol b/test/account/AccountReturnData.t.sol
@@ -6,8 +6,8 @@ import {Call} from "../../src/interfaces/IStandardExecutor.sol";
 
 import {
     RegularResultContract,
-    ResultCreatorPlugin,
-    ResultConsumerPlugin
+    ResultConsumerPlugin,
+    ResultCreatorPlugin
 } from "../mocks/plugins/ReturnDataPluginMocks.sol";
 import {AccountTestBase} from "../utils/AccountTestBase.sol";
 import {TEST_DEFAULT_VALIDATION_ENTITY_ID} from "../utils/TestConstants.sol";

diff --git a/test/account/DirectCallsFromPlugin.t.sol b/test/account/DirectCallsFromPlugin.t.sol
@@ -1,11 +1,11 @@
 pragma solidity ^0.8.19;
 
-import {DirectCallPlugin} from "../mocks/plugins/DirectCallPlugin.sol";
-import {ExecutionHook} from "../../src/interfaces/IAccountLoupe.sol";
-import {IStandardExecutor, Call} from "../../src/interfaces/IStandardExecutor.sol";
-import {PluginEntityLib, PluginEntity} from "../../src/helpers/PluginEntityLib.sol";
-import {ValidationConfig, ValidationConfigLib} from "../../src/helpers/ValidationConfigLib.sol";
 import {UpgradeableModularAccount} from "../../src/account/UpgradeableModularAccount.sol";
+import {PluginEntity, PluginEntityLib} from "../../src/helpers/PluginEntityLib.sol";
+import {ValidationConfig, ValidationConfigLib} from "../../src/helpers/ValidationConfigLib.sol";
+import {ExecutionHook} from "../../src/interfaces/IAccountLoupe.sol";
+import {Call, IStandardExecutor} from "../../src/interfaces/IStandardExecutor.sol";
+import {DirectCallPlugin} from "../mocks/plugins/DirectCallPlugin.sol";
 
 import {AccountTestBase} from "../utils/AccountTestBase.sol";