Merge pull request #133 from mojtaba-eshghie/feat_issue_131

Feat: adding working Dockerfile and docker-compose.yml files #131

Dockerfile

@@ -0,0 +1,39 @@
+# Use a base image with the required GLIBC version
+FROM ubuntu:20.04
+
+# Install dependencies including git and python
+RUN apt-get update && apt-get install -y \
+    curl \
+    build-essential \
+    wget \
+    ca-certificates \
+    libssl-dev \
+    git \
+    python3 \
+    python3-distutils \
+    && curl -fsSL https://deb.nodesource.com/setup_16.x | bash - \
+    && apt-get install -y nodejs \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Foundry and Anvil
+RUN curl -L https://foundry.paradigm.xyz | bash \
+    && ~/.foundry/bin/foundryup
+
+# Set up environment variables for Foundry
+ENV PATH="/root/.foundry/bin:${PATH}"
+
+# Create and change to the app directory inside the container
+WORKDIR /usr/src/app
+
+# Copy package.json and package-lock.json
+COPY package*.json ./
+
+# Install Node.js dependencies
+RUN npm install
+
+# Copy the rest of the application code
+COPY . .
+
+# The command to keep the container running and allow for command execution
+CMD ["bash"]

README.md

@@ -6,6 +6,92 @@
 
 Smart contracts embody complex business processes that can be difficult to analyze statically. Therefore, we present HighGuard, a runtime monitoring tool that leverages business process specifications written in DCR graphs to provide runtime verification of smart contract execution. We demonstrate how HighGuard can detect and flag deviations from specified behaviors in smart contracts deployed in the Ethereum network without code instrumentation and any additional gas costs.
 
+## Installation
+
+### Manual Installation
+
+To manually install and run HighGuard, follow these steps:
+
+1. **Clone the repository:**
+
+   ```sh
+   git clone https://github.com/mojtaba-eshghie/HighGuard.git
+   cd highguard
+   ```
+
+2. **Install Node.js and npm:**
+
+   Ensure you have Node.js version 16.20.2 and npm version 8.19.4 installed. You can download and install Node.js from [Node.js official website](https://nodejs.org/).
+
+   Verify the installation:
+
+   ```sh
+   node --version
+   npm --version
+   ```
+
+3. **Install project dependencies:**
+
+   ```sh
+   npm install
+   ```
+
+4. **Install Foundry and Anvil:**
+
+   Follow the instructions to install Foundry from the [Foundry Book](https://book.getfoundry.sh/getting-started/installation).
+
+   ```sh
+   curl -L https://foundry.paradigm.xyz | bash
+   source ~/.bashrc
+   foundryup
+   ```
+
+5. **Run the CLI commands:**
+
+   You can now run the CLI commands as needed:
+
+   ```sh
+   pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-governance.yml
+   pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-escrow.yml
+   pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-multistageauction.yml
+   pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-prizedistribution.yml
+   pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-productorder.yml
+   ```
+
+### Docker Installation
+
+To build and run the project using Docker, follow these steps:
+
+1. **Clone the repository:**
+
+   ```sh
+   git clone https://github.com/mojtaba-eshghie/HighGuard.git
+   cd highguard
+   ```
+
+2. **Build the Docker image:**
+
+   ```sh
+   docker build -t HighGuard-cli-docker .
+   ```
+
+3. **Run the Docker container with specific commands:**
+
+   Replace the command as needed:
+
+   ```sh
+   docker run --rm -v $(pwd):/usr/src/app HighGuard-cli-docker bash -c "pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-governance.yml"
+   ```
+
+   Example commands:
+
+   ```sh
+   docker run --rm -v $(pwd):/usr/src/app HighGuard-cli-docker bash -c "pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-escrow.yml"
+   docker run --rm -v $(pwd):/usr/src/app HighGuard-cli-docker bash -c "pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-multistageauction.yml"
+   docker run --rm -v $(pwd):/usr/src/app HighGuard-cli-docker bash -c "pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-prizedistribution.yml"
+   docker run --rm -v $(pwd):/usr/src/app HighGuard-cli-docker bash -c "pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-productorder.yml"
+   ```
+
 ## Features
 
 ### Main Features
@@ -17,6 +103,7 @@ Smart contracts embody complex business processes that can be difficult to analy
 
 - Batteries included
 - Distributed logging
+<!--
 
 ## Installation
 
@@ -31,7 +118,7 @@ Run the `npm install` in the main repository directory and the following directo
 
 `server/monitor`
 
-`client`
+`client` -->
 
 ## Usage
 

docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.8'
+
+services:
+  node-cli:
+    build: .
+    volumes:
+      - .:/usr/src/app
+    working_dir: /usr/src/app
+    entrypoint: ["bash", "-c"]
+    command: "pkill anvil; node CI/run.js -t synthesized -e separate -v -c micro-configs/config-synthesized-governance.yml"

results/Governance-1.md

@@ -1,8 +1,7 @@
 | Activity ID | Time | Violation | Simulation |
 | --- | --- | --- | --- |
-| createProposal | 2024-06-22T16:41:24.970Z | false | 2015421 |
-| vote | 2024-06-22T16:41:35.069Z | true | 2015421 |
-| vote | 2024-06-22T16:41:35.542Z | false | 2015421 |
-| vote | 2024-06-22T16:41:36.034Z | false | 2015421 |
-| vote | 2024-06-22T16:41:36.558Z | false | 2015421 |
-| executeProposal | 2024-06-22T16:41:47.065Z | false | 2015421 |
+| createProposal | 2024-06-22T17:21:33.213Z | false | 2015422 |
+| vote | 2024-06-22T17:21:43.126Z | true | 2015422 |
+| vote | 2024-06-22T17:21:55.905Z | false | 2015422 |
+| vote | 2024-06-22T17:21:57.370Z | false | 2015422 |
+| vote | 2024-06-22T17:21:57.888Z | false | 2015422 |

results/Governance-2.md

@@ -0,0 +1,5 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:21:36.877Z | false | 2015423 |
+| vote | 2024-06-22T17:21:47.084Z | true | 2015423 |
+| vote | 2024-06-22T17:21:47.570Z | false | 2015423 |

results/Governance-3.md

@@ -0,0 +1,4 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:21:38.574Z | false | 2015424 |
+| executeProposal | 2024-06-22T17:21:54.535Z | true | 2015424 |

results/Governance-4.md

@@ -0,0 +1,5 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:21:53.262Z | false | 2015425 |
+| createProposal | 2024-06-22T17:22:03.573Z | true | 2015425 |
+| createProposal | 2024-06-22T17:22:16.006Z | true | 2015425 |

results/Governance-5.md

@@ -0,0 +1,4 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:21:55.923Z | false | 2015426 |
+| vote | 2024-06-22T17:22:12.413Z | true | 2015426 |

results/Governance-6.md

@@ -0,0 +1,4 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:22:10.585Z | false | 2015427 |
+| vote | 2024-06-22T17:22:12.298Z | true | 2015427 |

results/Governance-7.md

@@ -0,0 +1,3 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:22:14.704Z | false | 2015428 |

results/Governance-8.md

@@ -0,0 +1,3 @@
+| Activity ID | Time | Violation | Simulation |
+| --- | --- | --- | --- |
+| createProposal | 2024-06-22T17:22:17.503Z | false | 2015429 |