Skip to content

Commit

Permalink
docs(rollup): improve readme (#917)
Browse files Browse the repository at this point in the history
Co-authored-by: HAOYUatHZ <haoyu@protonmail.com>
  • Loading branch information
icemelon and 0xmountaintop authored Sep 2, 2023
1 parent 8699a22 commit a2fe246
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions rollup/README.md
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

0 comments on commit a2fe246

Please sign in to comment.