Rewrite initcode script, add filters for artifact jsons (#98)

* Rewrite initcode script, add filters for artifact jsons

* Add additional compilation settings to deployers

* add briefcase ci verification

---------

Co-authored-by: Stephan Stürz <stuerz@protonmail.com>

Author: gretzke

.github/workflows/verify-briefcase.yaml

@@ -0,0 +1,29 @@
+name: Verify Briefcase
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  verify-briefcase:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: stable
+
+      - name: Compile Briefcase
+        run: |
+          forge --version
+          forge install
+          ./script/util/create_briefcase.sh

CONTRIBUTING.md

@@ -118,6 +118,10 @@ library <ContractName>Deployer {
      *
      * @notice This initcode is generated from the following contract:
      * - Source Contract: src/pkgs/<package-name>/src/<contract-name>.sol
+     * - solc: 0.X.X
+     * - optimizer_runs: <optimizer_runs>
+     * - via_ir: true/false
+     * - evm_version: <evm_version>
      */
     function initcode() internal pure returns (bytes memory) {
         return hex'';
@@ -127,7 +131,7 @@ library <ContractName>Deployer {
 
 The deploy function can run arbitrary logic to deploy the contract, e.g., deploying via create, create2, using a factory, or a proxy. The deployer function should return the address and interface of the deployed contract so it can be called in subsequent steps.
 
-After creating the deployer file, it's important to update the `Source Contract` path in the comment above the `initcode` function. This ensures that the correct contract is used for the initcode.
+After creating the deployer file, it's important to update the `Source Contract` path in the comment above the `initcode` function. This ensures that the correct contract is used for the initcode. Additionally, the `solc` version, `optimizer_runs`, `via_ir`, and `evm_version` should be specified. These additional fields are used as safeguards to ensure that the correct initcode is inserted into the deployer file.
 
 Finally, run `./script/util/create_briefcase.sh` to generate the initcode for the deployer and populate the bytecode in the initcode function.
 

ISSUES.md

@@ -15,11 +15,3 @@
     - _Example_: [NonfungibleTokenPositionDescriptor](./src/briefcase/deployers/v3-periphery/NonfungibleTokenPositionDescriptorDeployer.sol)
   - **Expected behavior**: Foundry should be able to recognize that the placeholders in the bytecode have been replaced by the actual library address and match the bytecode correctly to the contract name.
   - **Workaround**: Generate the deployment logs manually after the deployment is complete using the `deploy-cli`.
-
-## Solidity issues
-
-- Compilation error when compiling the `PoolManager` contract
-  - **Description**: When compiling with compilation restrictions enabled, the `PoolManager` contract fails to compile. The Solidity issue can be tracked [here](https://github.com/ethereum/solidity/issues/15582).
-  - **Impact**: The `PoolManager` contract cannot be compiled.
-  - **Expected behavior**: The `PoolManager` contract should be compiled successfully.
-  - **Workaround**: v4-core is imported as a library and imported in a [helper file](./src/helper/PoolManagerImport.sol) in order to generate the required bytecode. As the code is not expected to change, this temporary workaround should not cause any disruptions.

foundry.toml

@@ -36,6 +36,7 @@ additional_compiler_profiles = [
   { name = "v3-periphery-default", optimizer_runs = 1000000, evm_version = "istanbul", via_ir = false },
   { name = "permit2", optimizer_runs = 1000000, via_ir = true },
   { name = "uniswapx", optimizer_runs = 1000000, via_ir = false },
+  { name = "util-contracts", optimizer_runs = 200, via_ir = false, evm_version = "paris" },
 ]
 
 compilation_restrictions = [
@@ -65,6 +66,8 @@ compilation_restrictions = [
   { paths = "src/pkgs/swap-router-contracts/contracts/**", version = "0.7.6", via_ir = false, optimizer_runs = 1000000 },
   # X
   { paths = "src/pkgs/uniswapx/src/base/BlockNumberish.sol", version = "0.8.24" },
+  # util-contracts: util-contracts specifies shanghai fork, but it was only supported from 0.8.20 onwards, so paris is the correct evm version
+  { paths = "src/pkgs/util-contracts/src/**", version = "=0.8.19", optimizer_runs = 200, via_ir = false, evm_version = "paris" },
   # Briefcase
   { paths = "src/briefcase/protocols/v2-periphery/libraries/UniswapV2Library.sol", version = "<0.8.0" },
   { paths = "src/briefcase/protocols/lib-external/solidity-lib/**", version = "<0.8.0" },

script/util/create_briefcase.sh

@@ -51,7 +51,11 @@ forge clean
 forge build
 
 echo "Inserting current initcode into deployers"
-python3 script/util/insert_initcode.py "src/briefcase/deployers" "out" 
+if ! python3 script/util/insert_initcode.py "src/briefcase/deployers" "out"; then
+  rm -rf "$tmp_dir"
+  forge fmt "src/briefcase"
+  exit 1
+fi
 
 rm -rf "$tmp_dir"
 forge fmt "src/briefcase"