fmt, gas benchmark (#122)

* fmt, gas benchmark

* fix workflow action

Author: jakeloo

.gas-snapshot

@@ -1,10 +1,10 @@
-CoreBenchmark:test_core_callCallbackFunction_required() (gas: 43107)
-CoreBenchmark:test_core_callFunction_callback_callbackFunctionRequired() (gas: 43392)
-CoreBenchmark:test_core_callFunction_notPermissionedDelegate() (gas: 36959)
-CoreBenchmark:test_core_callFunction_notPermissionedExternal() (gas: 36877)
-CoreBenchmark:test_deployCore() (gas: 2126555)
-CoreBenchmark:test_deployExtension() (gas: 322501)
-CoreBenchmark:test_extension_callFunction_notPermissionedDelegate() (gas: 29358)
-CoreBenchmark:test_extension_callFunction_notPermissionedExternal() (gas: 29378)
-CoreBenchmark:test_installExtension() (gas: 324348)
-CoreBenchmark:test_uninstallExtension() (gas: 62093)
+CoreBenchmark:test_core_callCallbackFunction_required() (gas: 46411)
+CoreBenchmark:test_core_callFunction_callback_callbackFunctionRequired() (gas: 44067)
+CoreBenchmark:test_core_callFunction_notPermissionedDelegate() (gas: 18029)
+CoreBenchmark:test_core_callFunction_notPermissionedExternal() (gas: 17985)
+CoreBenchmark:test_deployCore() (gas: 1920924)
+CoreBenchmark:test_deployExtension() (gas: 258057)
+CoreBenchmark:test_extension_callFunction_notPermissionedDelegate() (gas: 8294)
+CoreBenchmark:test_extension_callFunction_notPermissionedExternal() (gas: 8314)
+CoreBenchmark:test_installExtension() (gas: 330369)
+CoreBenchmark:test_uninstallExtension() (gas: 18385)

.github/workflows/benchmark.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: true
 
-    name: Foundry project
+    name: Foundry
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -41,5 +41,5 @@ jobs:
 
       - name: Create Forge Gas Report
         run: |
-          forge test --isolate --mp 'test/benchmark/*'
+          forge snapshot --diff --isolate --mp 'test/benchmark/*'
         id: benchmark

.github/workflows/formatter.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: true
 
-    name: Foundry project
+    name: Foundry
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: true
 
-    name: Foundry project
+    name: Foundry
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

foundry.toml

@@ -1,7 +1,6 @@
 [profile.default]
-#auto_detect_solc = false
-solc-version = "0.8.25"
-evm_version = "london"
+solc-version = "0.8.26"
+evm_version = "paris"
 optimizer = true
 optimizer_runs = 10000
 cache = true
@@ -16,4 +15,15 @@ gas_reports = [
 ]
 ignored_warnings_from = ["node_modules", "lib", "test"]
 
-# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
+[fmt]
+line_length = 120
+tab_width = 4
+sort_imports = true
+override_spacing = false
+bracket_spacing = false
+contract_new_lines = true
+single_line_statement_blocks = "multi"
+int_types = "long"
+quote_style = "double"
+number_underscore = "thousands"
+multiline_func_header = "attributes_first"

script/benchmark-ext/erc721/BenchmarkERC721.s.sol

@@ -1,12 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.13;
 
-import "forge-std/Script.sol";
 import {IERC721} from "./BenchmarkERC721Base.sol";
-import {BenchmarkERC721ThirdwebLegacy} from "./BenchmarkERC721ThirdwebLegacy.sol";
+
 import {BenchmarkERC721Manifold} from "./BenchmarkERC721Manifold.sol";
+import {BenchmarkERC721ThirdwebLegacy} from "./BenchmarkERC721ThirdwebLegacy.sol";
+import "forge-std/Script.sol";
 
 contract BenchmarkERC721 is Script {
+
     function benchmarkThirdwebLegacy() public {
         BenchmarkERC721ThirdwebLegacy benchmark = new BenchmarkERC721ThirdwebLegacy();
 
@@ -38,4 +40,5 @@ contract BenchmarkERC721 is Script {
         benchmarkThirdwebLegacy();
         benchmarkManifold();
     }
+
 }

script/benchmark-ext/erc721/BenchmarkERC721Base.sol

@@ -2,12 +2,15 @@
 pragma solidity ^0.8.24;
 
 interface IERC721 {
+
     function transferFrom(address from, address to, uint256 tokenId) external;
 
     function setApprovalForAll(address operator, bool _approved) external;
+
 }
 
 abstract contract BenchmarkERC721Base {
+
     // Step 1: Deploy a contract through factory or create
     // Step 2: Setup the collection with token URI
     // Step 3: Mint an NFT
@@ -27,4 +30,5 @@ abstract contract BenchmarkERC721Base {
     function mintBatchTokens(address contractAddress) external virtual;
 
     function transferTokenFrom(address contractAddress) external virtual;
+
 }

script/benchmark-ext/erc721/BenchmarkERC721Manifold.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.24;
 import "./BenchmarkERC721Base.sol";
 
 library StorageSlot {
+
     struct AddressSlot {
         address value;
     }
@@ -14,9 +15,11 @@ library StorageSlot {
             r.slot := slot
         }
     }
+
 }
 
 abstract contract Proxy {
+
     function _delegate(address implementation) internal virtual {
         assembly {
             calldatacopy(0, 0, calldatasize())
@@ -40,9 +43,11 @@ abstract contract Proxy {
     fallback() external payable virtual {
         _fallback();
     }
+
 }
 
 contract ERC721Creator is Proxy {
+
     constructor(string memory name, string memory symbol) {
         assert(_IMPLEMENTATION_SLOT == bytes32(uint256(keccak256("eip1967.proxy.implementation")) - 1));
         StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = 0x07aee92b7C5977F5EC15d20BaC713A21f72F287B;
@@ -61,19 +66,23 @@ contract ERC721Creator is Proxy {
     function _implementation() internal view override returns (address) {
         return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
     }
+
 }
 
 interface IManifoldNFT {
+
     function transferFrom(address from, address to, uint256 tokenId) external;
 
     function mintBase(address to, string calldata uri) external returns (uint256);
 
     function mintBaseBatch(address to, uint16 count) external returns (uint256[] memory);
 
     function mintBaseBatch(address to, string[] calldata uris) external returns (uint256[] memory);
+
 }
 
 contract BenchmarkERC721Manifold is BenchmarkERC721Base {
+
     function deployContract(
         address deployerAddress,
         string memory name,
@@ -102,4 +111,5 @@ contract BenchmarkERC721Manifold is BenchmarkERC721Base {
     function transferTokenFrom(address contractAddress) external override {
         IERC721(contractAddress).transferFrom(tx.origin, address(0xdead), 1);
     }
+
 }

script/benchmark-ext/erc721/BenchmarkERC721ThirdwebLegacy.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.24;
 import "./BenchmarkERC721Base.sol";
 
 interface IBenchmarkERC721 {
+
     function deployProxyByImplementation(address _implementation, bytes calldata _data, bytes32 _salt)
         external
         returns (address deployedProxy);
@@ -20,13 +21,17 @@ interface IBenchmarkERC721 {
         uint128 _platformFeeBps,
         address _platformFeeRecipient
     ) external;
+
 }
 
 interface IThirdwebNFT {
+
     function mintTo(address _to, string calldata _uri) external returns (uint256);
+
 }
 
 contract BenchmarkERC721ThirdwebLegacy is BenchmarkERC721Base {
+
     function deployContract(
         address deployerAddress,
         string memory name,
@@ -67,4 +72,5 @@ contract BenchmarkERC721ThirdwebLegacy is BenchmarkERC721Base {
     function transferTokenFrom(address contractAddress) external override {
         IERC721(contractAddress).transferFrom(tx.origin, address(0xdead), 0);
     }
+
 }

src/ModularCore.sol

@@ -2,9 +2,10 @@
 pragma solidity ^0.8.23;
 
 // Interface
+
+import {IInstallationCallback} from "./interface/IInstallationCallback.sol";
 import {IModularCore} from "./interface/IModularCore.sol";
 import {IModularExtension} from "./interface/IModularExtension.sol";
-import {IInstallationCallback} from "./interface/IInstallationCallback.sol";
 
 // Utils
 import {Role} from "./Role.sol";
@@ -13,6 +14,7 @@ import {EnumerableSetLib} from "@solady/utils/EnumerableSetLib.sol";
 import {ReentrancyGuard} from "@solady/utils/ReentrancyGuard.sol";
 
 abstract contract ModularCore is IModularCore, OwnableRoles, ReentrancyGuard {
+
     using EnumerableSetLib for EnumerableSetLib.AddressSet;
 
     /*//////////////////////////////////////////////////////////////
@@ -147,8 +149,12 @@ abstract contract ModularCore is IModularCore, OwnableRoles, ReentrancyGuard {
 
     /// @notice Returns whether a given interface is implemented by the contract.
     function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
-        if (interfaceId == 0xffffffff) return false;
-        if (supportedInterfaceRefCounter[interfaceId] > 0) return true;
+        if (interfaceId == 0xffffffff) {
+            return false;
+        }
+        if (supportedInterfaceRefCounter[interfaceId] > 0) {
+            return true;
+        }
         return false;
     }
 
@@ -158,8 +164,12 @@ abstract contract ModularCore is IModularCore, OwnableRoles, ReentrancyGuard {
 
     /// @notice Returns whether a given interface is implemented by the contract.
     function _supportsInterfaceViaExtensions(bytes4 interfaceId) internal view virtual returns (bool) {
-        if (interfaceId == 0xffffffff) return false;
-        if (supportedInterfaceRefCounter[interfaceId] > 0) return true;
+        if (interfaceId == 0xffffffff) {
+            return false;
+        }
+        if (supportedInterfaceRefCounter[interfaceId] > 0) {
+            return true;
+        }
         return false;
     }
 
@@ -208,7 +218,9 @@ abstract contract ModularCore is IModularCore, OwnableRoles, ReentrancyGuard {
                     break;
                 }
             }
-            if (!supported) revert CallbackFunctionNotSupported();
+            if (!supported) {
+                revert CallbackFunctionNotSupported();
+            }
 
             functionData_[callbackFunction.selector] =
                 InstalledFunction({implementation: _extension, permissionBits: 0, fnType: FunctionType.CALLBACK});
@@ -388,4 +400,5 @@ abstract contract ModularCore is IModularCore, OwnableRoles, ReentrancyGuard {
             }
         }
     }
+
 }