docs(): update README

This commit is contained in:
HAOYUatHZ
2023-09-02 15:08:37 +08:00
parent 237d048ce6
commit 82330621ce
2 changed files with 13 additions and 11 deletions

View File

@@ -1,6 +1,5 @@
.PHONY: lint docker clean bridge
.PHONY: mock_abi bridge_bins event_watcher gas_oracle rollup_relayer test lint clean docker
IMAGE_NAME=bridge
IMAGE_VERSION=latest
REPO_ROOT_DIR=./..

View File

@@ -2,11 +2,6 @@
This repo contains the Scroll bridge.
In addition, launching the bridge will launch a separate instance of l2geth, and sets up a communication channel
between the two, over JSON-RPC sockets.
Something we should pay attention is that all private keys inside sender instance cannot be duplicated.
## Dependency
+ install `abigen`
@@ -19,18 +14,26 @@ go install -v github.com/scroll-tech/go-ethereum/cmd/abigen
```bash
make clean
make bridge
make mock_abi
make bridge_bins
```
## Start
* use default ports and config.json
(Note: make sure you use different private keys for different senders in config.json.)
* use default ports and config.json.
```bash
./build/bin/bridge --http
./build/bin/event_watcher --http
./build/bin/gas_oracle --http
./build/bin/rollup_relayer --http
```
* use specified ports and config.json
```bash
./build/bin/bridge --config ./config.json --http --http.addr localhost --http.port 8290
./build/bin/event_watcher --config ./config.json --http --http.addr localhost --http.port 8290
./build/bin/gas_oracle --config ./config.json --http --http.addr localhost --http.port 8290
./build/bin/rollup_relayer --config ./config.json --http --http.addr localhost --http.port 8290
```