Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gakonst authored Apr 23, 2024
1 parent 5f18f9a commit 70809cc
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
Tools built around the patched versions of forge and the solidity compiler from
[clabby/eip-3074-foundry], which support [EIP-3074] instructions.

We intend to further roll out Foundry patches to support other EVM modifications such as
new opcodes or precompiles.

## Docker image

The Docker image defined in this repo contains both the patched solc and forge
Expand All @@ -20,7 +23,7 @@ these arguments:
project of the script to execute.

There's a github actions workflow in this repo that builds and publishes the
image on each merge to main, it is availble at: `ghcr.io/fgimenez/eip3074-tools`
image on each merge to main, it is available at: `ghcr.io/paradigmxyz/foundry-alphanet`

### How to use
Containers created from this image should mount a local directory containing a
Expand All @@ -30,7 +33,7 @@ build a project, from the project root you can execute:
$ docker run --rm \
-v $(pwd):/app/foundry \
-u $(id -u):$(id -g) \
ghcr.io/fgimenez/eip3074-tools:latest \
ghcr.io/paradigmxyz/foundry-alphanet:latest \
--foundry-directory /app/foundry \
--foundry-command build
```
Expand All @@ -39,7 +42,7 @@ In this command:
container.
* `-u $(id -u):$(id -g)` makes sure that the files created will belong to the
same user executing the command.
* `ghcr.io/fgimenez/eip3074-tools:latest` is the image name
* `ghcr.io/paradigmxyz/foundry-alphanet:latest` is the image name
* `--foundry-directory /app/foundry` tells the entrypoint script to use
`/app/foundry` in the container as the foundry project directory.
* `--foundry-command build` tells the entrypoint script to use `build` as the
Expand All @@ -50,7 +53,7 @@ To run tests in a project, from the projects root:
$ docker run --rm \
-v $(pwd):/app/foundry \
-u $(id -u):$(id -g) \
ghcr.io/fgimenez/eip3074-tools:latest \
ghcr.io/paradigmxyz/foundry-alphanet:latest \
--foundry-directory /app/foundry \
--foundry-command "test -vvv"
```
Expand Down

0 comments on commit 70809cc

Please sign in to comment.