chore: migrate to foundry (#24)

* chore: forge init

* forge install: forge-std

v1.6.0

* forge install: openzeppelin-contracts

v4.9.2

* chore: migrate to foundry

* chore: update README

* chore: add natspec for core contracts

* chore: fix README compile script

* fix: natspec and out/ folder

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on: workflow_dispatch
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -2,11 +2,7 @@ artifacts/
 bin/
 build/
 cache/
-deployments/hardhat/
-genfiles/
-failing_metadata/
-node_modules/
-typechain/
+out/
 
 *.pid
 *.log

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/openzeppelin/openzeppelin-contracts

README.md

@@ -40,21 +40,36 @@ The flow of the message and how it is transformed and relayed is detailed below:
 
 ![Illustration of ](https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyWOfgotvwuIBhzylK0ud%2Fuploads%2Fco073eKSrR7xUmhObi7v%2FMMA_Highlevel.png?alt=media&token=bff8ec55-c04f-4ab9-b362-caae601154db)
 
-## Development
-### Installation
-```
-npm i
-```
-### Compile
+## Local Development
+
+**Step 1:** Clone the repository
+
+```sh
+$   git clone https://github.com/MultiMessageAggregation/multibridge
 ```
-npx hardhat compile
+
+**note:** Please make sure [foundry](https://github.com/foundry-rs/foundry) is installed to proceed further.
+
+**Step 2:** Install required forge submodules 
+
+```sh
+$  forge install
 ```
-### Run test
-We use Hardhat to test MultiMessageSender and MultiMessageReceiver contracts on simple behaviors.
+
+**Step 3:** Compile
+
+```sh
+$  forge build
 ```
-npx hardhat test
+
+**Step 4:** Run Tests
+
+```sh
+$  forge test
 ```
 
+**note:** We use [pigeon](https://github.com/exp-table/pigeon/tree/docs) to simulate the cross-chain behavior on forked mainnets.
+
 ## Contribution guidelines
 Thank you for your interest in contributing to MMA! We welcome all contributions to make our project better!