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

Jump to bottom

doc: improve rollup readme #917

Merged
merged 4 commits into from
Sep 2, 2023
Merged

doc: improve rollup readme #917

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1af8138
doc: Improve rollup readme
icemelon Sep 2, 2023
785d421
update README
0xmountaintop Sep 2, 2023
acf3af9
Merge remote-tracking branch 'origin/develop' into doc/rollup-readme
0xmountaintop Sep 2, 2023
4df4c0e
update README
0xmountaintop Sep 2, 2023
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
12 changes: 10 additions & 2 deletions rollup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# Rollup

This repo contains the Scroll rollup.
This directory contains the three essential rollup services for the Scroll chain:
- Event Watcher (<a href="./cmd/event_watcher/">event_watcher</a>): watches the events emitted from the L1 and L2 contracts and updates the event database.
- Gas Oracle (<a href="./cmd/gas_oracle/">gas_oracle</a>): monitors the L1 and L2 gas price and sends transactions to update the gas price oracle contracts on L1 and L2.
- Rollup Relayer (<a href="./cmd/rollup_relayer/">rollup_relayer</a>): consists of three components: chunk and batch proposer and a relayer.
- The chunk and batch proposer proposes new chunks and batches that sends Commit Transactions for data availability and Finalize Transactions for proof verification and state finalization.

## Dependency

+ install `abigen`
1. `abigen`

``` bash
go install -v github.com/scroll-tech/go-ethereum/cmd/abigen
```

2. `solc`

See https://docs.soliditylang.org/en/latest/installing-solidity.html

## Build

```bash
Expand Down
Loading