From a2fe246551d7de38873d515025574d74d56c2692 Mon Sep 17 00:00:00 2001 From: Haichen Shen Date: Sat, 2 Sep 2023 23:23:17 +0800 Subject: [PATCH] docs(rollup): improve readme (#917) Co-authored-by: HAOYUatHZ --- rollup/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/rollup/README.md b/rollup/README.md index 584327b762..031ba6edcb 100644 --- a/rollup/README.md +++ b/rollup/README.md @@ -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 (event_watcher): watches the events emitted from the L1 and L2 contracts and updates the event database. +- Gas Oracle (gas_oracle): monitors the L1 and L2 gas price and sends transactions to update the gas price oracle contracts on L1 and L2. +- Rollup Relayer (rollup_relayer): 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