[ARC-204] set up CI for contracts (#2)

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+## What's new in this PR?
+
+In bullet point format, please describe what's new in this PR.
+
+## Why?
+
+What problem does this solve?
+Why is this important?
+What's the context?

nest/.github/workflows/test.yml → .github/workflows/continuous-integration.yml

@@ -1,6 +1,12 @@
-name: test
+name: Continuous Integration
 
-on: workflow_dispatch
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 env:
   FOUNDRY_PROFILE: ci
@@ -10,7 +16,7 @@ jobs:
     strategy:
       fail-fast: true
 
-    name: Foundry project
+    name: Build and Test Contracts
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -28,7 +34,12 @@ jobs:
           forge build --sizes
         id: build
 
-      - name: Run Forge tests
+      - name: Run Forge format
         run: |
-          forge test -vvv
-        id: test
+          forge fmt
+        id: format
+
+      # - name: Run Forge tests
+      #   run: |
+      #     forge test -vvv
+      #   id: test

foundry-template/.gitignore

@@ -0,0 +1,15 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/*/18230/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env

foundry-template/README.md

@@ -0,0 +1,9 @@
+## Foundry Template Setup
+
+Copy this folder to start a new Foundry project, then run the following to initialize the submodules:
+
+```bash
+$ forge install foundry-rs/forge-std
+$ forge install OpenZeppelin/openzeppelin-foundry-upgrades
+$ forge install OpenZeppelin/openzeppelin-contracts-upgradeable
+```

foundry-template/foundry.toml

@@ -0,0 +1,26 @@
+[profile.default]
+solc = "0.8.25"
+evm_version = "cancun"
+src = "src"
+out = "out"
+libs = ["lib"]
+ffi = true
+ast = true
+build_info = true
+extra_output = ["storageLayout"]
+
+[fmt]
+single_line_statement_blocks = "multi"
+multiline_func_header = "params_first"
+sort_imports = true
+contract_new_lines = true
+bracket_spacing = true
+int_types = "long"
+quote_style = "double"
+number_underscore = "thousands"
+wrap_comments = true
+
+remappings = [
+  "@openzeppelin/contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts/",
+  "@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
+]

nest/.gitignore

@@ -5,6 +5,7 @@ out/
 # Ignores development broadcast logs
 !/broadcast
 /broadcast/*/31337/
+/broadcast/*/18230/
 /broadcast/**/dry-run/
 
 # Docs

nest/foundry.toml

@@ -1,6 +1,26 @@
 [profile.default]
+solc = "0.8.25"
+evm_version = "cancun"
 src = "src"
 out = "out"
 libs = ["lib"]
+ffi = true
+ast = true
+build_info = true
+extra_output = ["storageLayout"]
 
-# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
+[fmt]
+single_line_statement_blocks = "multi"
+multiline_func_header = "params_first"
+sort_imports = true
+contract_new_lines = true
+bracket_spacing = true
+int_types = "long"
+quote_style = "double"
+number_underscore = "thousands"
+wrap_comments = true
+
+remappings = [
+  "@openzeppelin/contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts/",
+  "@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
+]