feat(ci): add fmt workflow

.github/workflows/forge-ci.yml

@@ -0,0 +1,131 @@
+name: Forge CI to build, test and format
+
+on: 
+  pull_request:
+  push:
+    branches:
+      - main
+      - release/**
+    tags:
+      - "*"
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  setup:
+    uses: ./.github/workflows/foundry-setup.yml
+
+  build:
+    runs-on: ubuntu-latest
+    needs: setup
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Restore Foundry binaries cache
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ~/.foundry
+          key: ${{ needs.setup.outputs.key }}
+
+      - name: Build
+        run: forge build
+
+      - name: Add comment for build failure
+        if: failure()
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: 'The build has failed. Please check the logs.'
+            })
+
+      - name: Cache build artifacts (not binaries)
+        uses: actions/cache/save@v3
+        with:
+          path: |
+            ./out
+            ./cache
+            ./broadcast
+          key: ${{ runner.os }}-build-${{ github.sha }}
+
+  test:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Restore Foundry binaries cache
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ~/.foundry
+          key: ${{ needs.setup.outputs.key }}
+
+      - name: Restore build artifacts
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ./out
+            ./cache
+            ./broadcast
+          key: ${{ runner.os }}-build-${{ github.sha }}
+
+      - name: Run tests
+        run: forge test -vvv
+
+      - name: Add comment for test failure
+        if: failure()
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: 'The tests have failed. Please check the logs.'
+            })
+
+  fmt:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Restore Foundry binaries cache
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ~/.foundry
+          key: ${{ needs.setup.outputs.key }}
+
+      - name: Restore build artifacts
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ./out
+            ./cache
+            ./broadcast
+          key: ${{ runner.os }}-build-${{ github.sha }}
+
+      - name: Check formatting
+        run: forge fmt --check
+
+      - name: Add comment for format failure
+        if: failure()
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: 'The code is not formatted correctly. Please run `forge fmt` and push the changes.'
+            })

.github/workflows/foundry-setup.yml

@@ -0,0 +1,34 @@
+name: Foundry Setup
+
+on:
+  workflow_call:
+
+jobs:
+  pre-setup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set Foundry version
+        id: set-version
+        run: echo "FOUNDRY_VERSION=nightly-f625d0fa7c51e65b4bf1e8f7931cd1c6e2e285e9" >> "$GITHUB_ENV"
+
+  setup:
+    runs-on: ubuntu-latest
+    needs: pre-setup
+    outputs:
+      key: ${{ steps.set-key.outputs.key }}
+    steps:
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: ${{ env.FOUNDRY_VERSION }}
+      - name: Print forge version
+        run: forge --version
+      - name: Save Foundry cache
+        uses: actions/cache/save@v3
+        with:
+          path: |
+            ~/.foundry
+          key: ${{ runner.os }}-foundry-${{ env.FOUNDRY_VERSION }}
+      - name: Save key
+        id: set-key
+        run: echo "key=${{ runner.os }}-foundry-${{ env.FOUNDRY_VERSION }}" >> "$GITHUB_OUTPUT"

foundry.toml

@@ -10,5 +10,13 @@ evm_version = "paris"
 [rpc_endpoints]
 ethereum_local_rpc = "${ETHEREUM_LOCAL_RPC}"
 exocore_local_rpc = "${EXOCORE_LOCAL_RPC}"
-# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
 
+[fmt]
+ignore = ["src/libraries/Endian.sol"]
+# TODO: enable these after linter is merged
+# number_underscore = "thousands"
+# sort_imports = true
+# wrap_comments = true
+# single_line_statement_blocks = "multi"
+# contract_new_lines = true
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

script/10_DeployExocoreGatewayOnly.s.sol

@@ -3,14 +3,14 @@ pragma solidity ^0.8.19;
 import {ILayerZeroEndpointV2} from "@layerzero-v2/protocol/contracts/interfaces/ILayerZeroEndpointV2.sol";
 
 import {ProxyAdmin} from "@openzeppelin-contracts/contracts/proxy/transparent/ProxyAdmin.sol";
-import {TransparentUpgradeableProxy} from "@openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {TransparentUpgradeableProxy} from
+    "@openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 
 import {ExocoreGateway} from "../src/core/ExocoreGateway.sol";
 import "forge-std/Script.sol";
 import {BaseScript} from "./BaseScript.sol";
 
 contract DeployExocoreGatewayOnly is BaseScript {
-
     function setUp() public virtual override {
         // load keys
         super.setUp();
@@ -35,8 +35,7 @@ contract DeployExocoreGatewayOnly is BaseScript {
                         address(exocoreGatewayLogic),
                         address(exocoreProxyAdmin),
                         abi.encodeWithSelector(
-                            exocoreGatewayLogic.initialize.selector,
-                            payable(exocoreValidatorSet.addr)
+                            exocoreGatewayLogic.initialize.selector, payable(exocoreValidatorSet.addr)
                         )
                     )
                 )
@@ -52,10 +51,8 @@ contract DeployExocoreGatewayOnly is BaseScript {
             vm.serializeAddress(exocoreContracts, "exocoreGateway", address(exocoreGateway));
 
         string memory deployedContracts = "deployedContracts";
-        string memory finalJson =
-            vm.serializeString(deployedContracts, "exocore", exocoreContractsOutput);
+        string memory finalJson = vm.serializeString(deployedContracts, "exocore", exocoreContractsOutput);
 
         vm.writeJson(finalJson, "script/deployedExocoreGatewayOnly.json");
-
     }
-}
+}

script/11_SetPeers.s.sol

@@ -50,8 +50,7 @@ contract SetPeersAndUpgrade is BaseScript {
         uint256 i = 0;
         uint256 tries = 5;
         bool success;
-        while(i < tries) {
-
+        while (i < tries) {
             vm.selectFork(exocore);
             success = gateway.peers(clientChainId) == bootstrapAddr.toBytes32();
 
@@ -90,8 +89,8 @@ contract SetPeersAndUpgrade is BaseScript {
         console.log(
             "source .env && cast send --rpc-url $EXOCORE_TESETNET_RPC",
             exocoreGatewayAddr,
-            "\"markBootstrapOnAllChains()\"",
+            '"markBootstrapOnAllChains()"',
             "--private-key $TEST_ACCOUNT_THREE_PRIVATE_KEY"
         );
     }
-}
+}

script/12_RedeployClientChainGateway.s.sol

@@ -1,6 +1,7 @@
 pragma solidity ^0.8.19;
 
-import {TransparentUpgradeableProxy} from "@openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {TransparentUpgradeableProxy} from
+    "@openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 import {UpgradeableBeacon} from "@openzeppelin-contracts/contracts/proxy/beacon/UpgradeableBeacon.sol";
 
 import {Bootstrap} from "../src/core/Bootstrap.sol";
@@ -24,29 +25,19 @@ contract RedeployClientChainGateway is BaseScript {
         super.setUp();
         // load contracts
         string memory prerequisiteContracts = vm.readFile("script/deployedBootstrapOnly.json");
-        clientChainLzEndpoint = ILayerZeroEndpointV2(
-            stdJson.readAddress(prerequisiteContracts, ".clientChain.lzEndpoint")
-        );
+        clientChainLzEndpoint =
+            ILayerZeroEndpointV2(stdJson.readAddress(prerequisiteContracts, ".clientChain.lzEndpoint"));
         require(address(clientChainLzEndpoint) != address(0), "client chain l0 endpoint should not be empty");
-        beaconOracle = EigenLayerBeaconOracle(
-            stdJson.readAddress(prerequisiteContracts, ".clientChain.beaconOracle")
-        );
+        beaconOracle = EigenLayerBeaconOracle(stdJson.readAddress(prerequisiteContracts, ".clientChain.beaconOracle"));
         require(address(beaconOracle) != address(0), "beacon oracle should not be empty");
-        vaultBeacon = UpgradeableBeacon(
-            stdJson.readAddress(prerequisiteContracts, ".clientChain.vaultBeacon")
-        );
+        vaultBeacon = UpgradeableBeacon(stdJson.readAddress(prerequisiteContracts, ".clientChain.vaultBeacon"));
         require(address(vaultBeacon) != address(0), "vault beacon should not be empty");
-        capsuleBeacon = UpgradeableBeacon(
-            stdJson.readAddress(prerequisiteContracts, ".clientChain.capsuleBeacon")
-        );
+        capsuleBeacon = UpgradeableBeacon(stdJson.readAddress(prerequisiteContracts, ".clientChain.capsuleBeacon"));
         require(address(capsuleBeacon) != address(0), "capsule beacon should not be empty");
-        beaconProxyBytecode = BeaconProxyBytecode(
-            stdJson.readAddress(prerequisiteContracts, ".clientChain.beaconProxyBytecode")
-        );
+        beaconProxyBytecode =
+            BeaconProxyBytecode(stdJson.readAddress(prerequisiteContracts, ".clientChain.beaconProxyBytecode"));
         require(address(beaconProxyBytecode) != address(0), "beacon proxy bytecode should not be empty");
-        bootstrap = Bootstrap(
-            stdJson.readAddress(prerequisiteContracts, ".clientChain.bootstrap")
-        );
+        bootstrap = Bootstrap(stdJson.readAddress(prerequisiteContracts, ".clientChain.bootstrap"));
         require(address(bootstrap) != address(0), "bootstrap should not be empty");
         clientChain = vm.createSelectFork(clientChainRPCURL);
     }
@@ -64,25 +55,18 @@ contract RedeployClientChainGateway is BaseScript {
         );
         // then the client chain initialization
         address[] memory emptyList;
-        bytes memory initialization = abi.encodeWithSelector(
-            clientGatewayLogic.initialize.selector,
-            exocoreValidatorSet.addr,
-            emptyList
-        );
-        bootstrap.setClientChainGatewayLogic(
-            address(clientGatewayLogic),
-            initialization
-        );
+        bytes memory initialization =
+            abi.encodeWithSelector(clientGatewayLogic.initialize.selector, exocoreValidatorSet.addr, emptyList);
+        bootstrap.setClientChainGatewayLogic(address(clientGatewayLogic), initialization);
         vm.stopBroadcast();
 
         string memory clientChainContracts = "clientChainContracts";
         string memory clientChainContractsOutput =
             vm.serializeAddress(clientChainContracts, "clientGatewayLogic", address(clientGatewayLogic));
 
         string memory deployedContracts = "deployedContracts";
-        string memory finalJson =
-            vm.serializeString(deployedContracts, "clientChain", clientChainContractsOutput);
+        string memory finalJson = vm.serializeString(deployedContracts, "clientChain", clientChainContractsOutput);
 
         vm.writeJson(finalJson, "script/redeployClientChainGateway.json");
     }
-}
+}