Skip to content

Commit

Permalink
Merge pull request #175 from wolfcito/feat/dockerize-supersim-setup
Browse files Browse the repository at this point in the history
feat: Dockerfile has been added along with the required documentation
  • Loading branch information
tremarkley authored Oct 2, 2024
2 parents e31f905 + d739c34 commit c0b0b85
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
FROM golang:1.22

RUN apt-get update && apt-get install -y curl git

WORKDIR /app

RUN curl -L https://foundry.paradigm.xyz | bash

ENV PATH="/root/.foundry/bin:${PATH}"

RUN foundryup

COPY . .

RUN go mod tidy

RUN go build -o supersim cmd/main.go

CMD ["./supersim"]
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,31 @@ L2s: Predeploy Contracts Spec ( https://specs.optimism.io/protocol/predeploys.ht
- L1StandardBridge: 0x2D8543c236a4d626f54B51Fa8bc229a257C5143E
```


### 4. Start testing multichain features πŸš€

Some examples below!

## πŸ‹ Running with Docker

To simplify the process, you can now run Supersim using Docker. This approach ensures a consistent development environment without needing to install dependencies on your local machine. Here are the steps:

### 1. Build the Docker image
```bash
docker build -t supersim .
```

### 2. Run Supersim in Docker
```bash
docker run --rm -it --network host supersim:latest
```

This setup encapsulates Supersim in a container, isolating it from the host system. This ensures a clean, conflict-free environment and provides an added layer of security by reducing the application's permissions on the host.
### 3. Start testing multichain features πŸš€
Some examples below!
## πŸ”€ First steps
### Example A: (L1 to L2) Deposit ETH from the L1 into the L2
Expand Down

0 comments on commit c0b0b85

Please sign in to comment.