Skip to content

Commit 766532c

Browse files
thinkAfCodthinkAfCod
committed
modify struct
1 parent a35b5ce commit 766532c

File tree

9 files changed

+227
-147
lines changed

9 files changed

+227
-147
lines changed

‎docs/hildr/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Hildr
2+
Hildr is an OP Stack rollup client written in Java 21. And follow the [spec](https://github.com/ethereum-optimism/optimism/blob/develop/specs/rollup-node.md):
3+
4+
[Magi](https://github.com/a16z/magi)
5+
6+
[Op-node](https://github.com/ethereum-optimism/optimism/tree/develop/op-node)
7+
8+
9+
10+

‎docs/hildr/use_docker.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Use docker
2+
3+
You can use Docker to run [Hildr](https://github.com/optimism-java/hildr) as an Optimism CL node.
4+
5+
## Pull docker image
6+
7+
```shell
8+
docker pull ghcr.io/optimism-java/hildr:latest
9+
```
10+
11+
## Start a Hildr node
12+
13+
=== "op sepolia"
14+
```shell
15+
docker run -it -p 11545:11545 \
16+
-v <you jwt secret>:/jwt/jwt.hex \
17+
ghcr.io/optimism-java/op-besu:latest -- \
18+
--network optimism-sepolia \ # can be either: "optimism","base","base-sepolia"
19+
--jwt-file /jwt/jwt.hex \
20+
--l1-rpc-url http://localhost:9545 \
21+
--l1-ws-rpc-url ws://localhost:9546 \
22+
--l1-beacon-url http://localhost:4000 \
23+
--l2-rpc-url http://localhost:8545 \
24+
--l2-engine-url http://localhost:8551 \
25+
--rpc-port 11545 \
26+
--log-level INFO \ # can be either: "DEBUG","TRACE","WARN","ERROR"
27+
--sync-mode full
28+
```
29+
30+
=== "devnet or other"
31+
```shell
32+
docker run -it -p 11545:11545 \
33+
-v <your jwt secret>:/jwt/jwt.hex \
34+
-v <your rollup.json file>:/network-configs/rollup.json
35+
ghcr.io/optimism-java/op-besu:latest -- \
36+
--devnet \
37+
--network=/network-configs/rollup.json \
38+
--jwt-file /jwt/jwt.hex \
39+
--l1-rpc-url http://localhost:9545 \
40+
--l1-ws-rpc-url ws://localhost:9546 \
41+
--l1-beacon-url http://localhost:4000 \
42+
--l2-rpc-url http://localhost:8545 \
43+
--l2-engine-url http://localhost:8551 \
44+
--rpc-port 11545 \
45+
--log-level INFO \ # can be either: "DEBUG","TRACE","WARN","ERROR"
46+
--sync-mode full
47+
```

‎docs/hildr/use_jar.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Use the Hildr jar
2+
3+
## Prerequisites
4+
5+
6+
[Java JDK 21+](https://www.oracle.com/java/technologies/downloads/)
7+
8+
## Download the Hildr jar
9+
10+
Download the [Hildr jar](https://github.com/optimism-java/hildr/releases).
11+
12+
## Start a Hildr node
13+
14+
=== "op sepolia"
15+
16+
```shell
17+
java --enable-preview \
18+
-cp <the Hildr jar file> io.optimism.Hildr \
19+
--network optimism-sepolia \
20+
--jwt-secret ./jwt.hex \
21+
--l1-rpc-url http://localhost:9545 \
22+
--l1-ws-rpc-url ws://localhost:9546 \
23+
--l1-beacon-url http://localhost:4000 \
24+
--l2-rpc-url http://localhost:8545 \
25+
--l2-engine-url http://localhost:8551 \
26+
--rpc-port 11545 \
27+
--log-level INFO \ # can be either: "DEBUG","TRACE","WARN","ERROR"
28+
--sync-mode full >l2-hildr-node.log 2>&1 &
29+
```
30+
31+
=== "devnet or other"
32+
33+
```shell
34+
java --enable-preview \
35+
-cp <the Hildr jar file> io.optimism.Hildr \
36+
--devnet \
37+
--network <rollup.json file> \
38+
--jwt-secret ./jwt.hex \
39+
--l1-rpc-url http://localhost:9545 \
40+
--l1-ws-rpc-url ws://localhost:9546 \
41+
--l1-beacon-url http://localhost:4000 \
42+
--l2-rpc-url http://localhost:8545 \
43+
--l2-engine-url http://localhost:8551 \
44+
--rpc-port 11545 \
45+
--log-level INFO \ # can be either: "DEBUG","TRACE","WARN","ERROR"
46+
--sync-mode full >l2-hildr-node.log 2>&1 &
47+
```

‎docs/op-besu/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Op-Besu
2+
3+
[Op-Besu](https://github.com/optimism-java/op-besu) is a fork of [Besu](https://github.com/hyperledger/besu) that supports the [execution engine](https://github.com/ethereum-optimism/specs/blob/main/specs/fjord/exec-engine.md) of [OP stack](https://stack.optimism.io/).

‎docs/op-besu/use_binaries.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Use the packaged binaries
2+
3+
You can install the Op-besu or Op-geth client to run a Optimism EL node from a binary distribution.
4+
5+
## Prerequisites
6+
7+
[Java JDK 21+](https://www.oracle.com/java/technologies/downloads/)
8+
9+
## Install from packaged binaries
10+
11+
Download the Op Besu [packaged binaires](https://github.com/optimism-java/op-besu/releases).
12+
13+
Unpack the downloaded files and change into the `op-besu-<release>` directory.
14+
15+
## Run a Op-Besu node
16+
17+
=== "op sepolia"
18+
19+
```shell
20+
cd op-besu-<release> && \
21+
./bin/besu \
22+
--network=OP_SEPOLIA \
23+
--p2p-enabled=false \
24+
--discovery-enabled=false \
25+
--data-path=<your data dir> \
26+
--engine-rpc-enabled \
27+
--engine-jwt-secret=<jwt secret file> \
28+
--rpc-http-enabled \
29+
--host-allowlist=* \
30+
--engine-host-allowlist=* \
31+
--logging=INFO \
32+
--version-compatibility-protection=false
33+
```
34+
35+
=== "devnet or other"
36+
37+
```shell
38+
cd op-besu-<release> && \
39+
./bin/besu \
40+
--genesis-file=<devnet genesis file> \
41+
--p2p-enabled=false \
42+
--discovery-enabled=false \
43+
--data-path=<your data dir> \
44+
--engine-rpc-enabled \
45+
--engine-jwt-secret=<jwt secret file> \
46+
--rpc-http-enabled \
47+
--host-allowlist=* \
48+
--engine-host-allowlist=* \
49+
--logging=INFO \
50+
--version-compatibility-protection=false
51+
```

‎docs/op-besu/use_docker.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Use docker
2+
3+
You can use Docker to run [Op-Besu](https://github.com/optimism-java/op-besu) or [Op-Geth](https://github.com/ethereum-optimism/op-geth) as a Optimism EL node on the testnets.
4+
5+
## Prerequisites
6+
7+
Download and install [Docker](https://www.docker.com/products/docker-desktop).
8+
9+
## Pull docker image
10+
11+
```shell
12+
docker pull docker pull ghcr.io/optimism-java/op-besu:latest
13+
```
14+
15+
## Start a Op-Besu node
16+
17+
=== "op sepolia"
18+
```shell
19+
docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \
20+
ghcr.io/optimism-java/op-besu:latest -- \
21+
--network=OP_SEPOLIA \
22+
--p2p-enabled=false \
23+
--discovery-enabled=false \
24+
--data-path="/data/" \
25+
--engine-rpc-enabled \
26+
--engine-jwt-secret="/jwt/jwtsecret" \
27+
--rpc-http-enabled \
28+
--host-allowlist="*" \
29+
--engine-host-allowlist="*" \
30+
--logging=INFO \
31+
--version-compatibility-protection=false
32+
```
33+
34+
=== "devnet or other"
35+
```shell
36+
docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \
37+
ghcr.io/optimism-java/op-besu:latest -- \
38+
--genesis-file=<devnet genesis file> \
39+
--p2p-enabled=false \
40+
--discovery-enabled=false \
41+
--data-path="/data/" \
42+
--engine-rpc-enabled \
43+
--engine-jwt-secret="/jwt/jwtsecret" \
44+
--rpc-http-enabled \
45+
--host-allowlist="*" \
46+
--engine-host-allowlist="*" \
47+
--logging=INFO \
48+
--version-compatibility-protection=false
49+
```
50+

‎docs/start_hildr.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

‎docs/start_op_besu.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

‎mkdocs.yml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,29 @@ theme:
1313
palette:
1414
primary: red
1515
features:
16+
- announce.dismiss
1617
- content.code.copy
18+
- navigation.indexes
19+
- navigation.tabs
1720
icon:
1821
repo: fontawesome/brands/github
1922

23+
# Extensions
24+
markdown_extensions:
25+
- pymdownx.superfences
26+
- pymdownx.tabbed:
27+
alternate_style: true
28+
2029
# Page tree
2130
nav:
2231
- Home: index.md
23-
- Getting started:
24-
- Run Hildr: start_hildr.md
25-
- Run Op-Besu: start_op_besu.md
32+
- Hildr:
33+
- hildr/index.md
34+
- Run a Hildr node:
35+
- Use the jar: hildr/use_jar.md
36+
- Use docker: hildr/use_docker.md
37+
- Op-Besu:
38+
- op-besu/index.md
39+
- Run a Op-Besu node:
40+
- Use the packaged bianries: op-besu/use_binaries.md
41+
- Use Docker: op-besu/use_docker.md

0 commit comments

Comments
 (0)