Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to run solidity tests. #2415

Merged
merged 1 commit into from
Dec 19, 2024
+6 −7
Merged

Update documentation to run solidity tests. #2415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ and robust infrastructure.
[Official Documentation](https://docs.espressosys.com/sequencer/espresso-sequencer-architecture/readme)

### Architecture
The diagram below shows how the Espresso Confirmation Layer fits into the rollup
centric Ethereum ecosystem. See [Architecture](./doc/architecture.md) for details.

![Architecture](./doc/espresso-overview.svg)
The diagram below shows how the Espresso Confirmation Layer fits into the rollup centric Ethereum ecosystem. See
[Architecture](./doc/architecture.md) for details.

![Architecture](./doc/espresso-overview.svg)

#### ZK rollups integration

Expand All @@ -43,9 +43,8 @@ a dockerized Espresso Sequencer network with an example Layer 2 rollup applicati

## Documentation

The rust code documentation can be found at
[sequencer.docs.espressosys.com](https://sequencer.docs.espressosys.com). Please note the disclaimer about API
stability at the end of the readme.
The rust code documentation can be found at [sequencer.docs.espressosys.com](https://sequencer.docs.espressosys.com).
Please note the disclaimer about API stability at the end of the readme.

To generate the documentation locally and view it in the browser, run

Expand Down Expand Up @@ -120,7 +119,7 @@ forge build
To run the tests

```shell
forge test
just sol-test
```

In order to avoid constant warnings about checksum mismatches with [svm-rs](https://github.com/roynalnaruto/svm-rs)
Expand Down
Loading