Skip to content

Commit 02200c0

Browse files
committed
github page initial
1 parent 7fff7b6 commit 02200c0

File tree

8 files changed

+268
-2
lines changed

8 files changed

+268
-2
lines changed

.github/workflows/deploy.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: write
8+
pages: write
9+
id-token: write
10+
jobs:
11+
deploy:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
submodules: recursive
18+
- name: Set up Python runtime
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: 3.x
22+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
23+
- uses: actions/cache@v4
24+
with:
25+
key: mkdocs-material-${{ env.cache_id }}
26+
path: .cache
27+
restore-keys: |
28+
mkdocs-material-
29+
- run: pip install mkdocs-material
30+
- run: mkdocs build --clean
31+
- name: Upload to Github Pages
32+
uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: site
35+
- name: Deploy to GitHub Pages
36+
uses: actions/deploy-pages@v4
37+
- name: Save build cache
38+
uses: actions/cache/save@v4
39+
with:
40+
key: mkdocs-material-${{ env.cache_id }}
41+
path: .cache

.gitignore

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Dependencies
2+
node_modules
3+
__pycache__
4+
venv
5+
.venv
6+
7+
# Build files
8+
build
9+
site
10+
11+
# Distribution files
12+
dist
13+
mkdocs_material.egg-info
14+
15+
# Caches and logs
16+
*.cpuprofile
17+
*.log
18+
*.tsbuildinfo
19+
.cache
20+
.eslintcache
21+
__pycache__
22+
23+
# Examples
24+
example
25+
example.zip
26+
27+
# -----------------------------------------------------------------------------
28+
# General
29+
# -----------------------------------------------------------------------------
30+
31+
# Never ignore .gitkeep files
32+
!**/.gitkeep
33+
34+
# macOS internals
35+
.DS_Store
36+
37+
# Temporary files
38+
TODO
39+
tmp
40+
41+
# IDEs & Editors
42+
.idea

README.md

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

docs/assets/images/image.png

11.6 KB
Loading

docs/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Introdution
2+
We continue to contribute public goods to help the Ethereum and Optimism community get better and better.
3+
4+
## Our Works
5+
We have currently developed two important components of Optimism:
6+
7+
[Hildr](https://github.com/optimism-java/hildr) is an optimism rollup client written in Java.
8+
9+
[Op-Besu](https://github.com/optimism-java/op-besu) is an optimism execution client written in Java, a fork of [Besu](https://github.com/hyperledger/besu).
10+
11+
12+
## Our Vision
13+
We hope that through our efforts, Ethereum and the Optimism chain will become more accessible and user-friendly, promoting the widespread adoption of blockchain technology.
14+
15+
## Contract Us
16+
If you have any questions or suggestions, please feel free to contact us on [github](https://github.com/optimism-java). We look forward to working with you to advance blockchain technology!

docs/start_hildr.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Start 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+
## Run on Optimism Sepolia
9+
10+
### Prerequisites
11+
12+
[Java JDK 21+](https://www.oracle.com/java/technologies/downloads/)
13+
14+
### Download jar
15+
16+
Download the [Hildr jar](https://github.com/optimism-java/hildr/releases).
17+
18+
### Run a node
19+
20+
```shell
21+
java --enable-preview \
22+
-cp hildr-node.jar io.optimism.Hildr \
23+
--network optimism-sepolia \
24+
--jwt-secret ./jwt.hex \
25+
--l1-rpc-url http://localhost:9545 \
26+
--l1-ws-rpc-url ws://localhost:9546 \
27+
--l1-beacon-url http://localhost:4000 \
28+
--l2-rpc-url http://localhost:8545 \
29+
--l2-engine-url http://localhost:8551 \
30+
--rpc-port 11545 \
31+
--log-level INFO \ # can be either: "DEBUG","TRACE","WARN","ERROR"
32+
--sync-mode full >l2-hildr-node.log 2>&1 &
33+
```
34+
35+
## Run with docker on Optimism Sepolia
36+
37+
### Pull docker image
38+
39+
```shell
40+
docker pull ghcr.io/optimism-java/hildr:latest
41+
```
42+
### Run a node with docker
43+
44+
```shell
45+
docker run -it -p 11545:11545 \
46+
-v <you jwt secret>:/jwt/jwtsecret \
47+
ghcr.io/optimism-java/op-besu:latest -- \
48+
--network optimism-sepolia \ # can be either: "optimism","base","base-sepolia"
49+
--jwt-secret ./jwt.hex \
50+
--l1-rpc-url http://localhost:9545 \
51+
--l1-ws-rpc-url ws://localhost:9546 \
52+
--l1-beacon-url http://localhost:4000 \
53+
--l2-rpc-url http://localhost:8545 \
54+
--l2-engine-url http://localhost:8551 \
55+
--rpc-port 11545 \
56+
--log-level INFO \ # can be either: "DEBUG","TRACE","WARN","ERROR"
57+
--sync-mode full
58+
```
59+
60+
### Run on other network
61+
62+
If you want to run on the anyother network, you need to prepare the configuration file rollup.json, then add a devnet option, and finally modify the network value to the path of the rollup.json file:
63+
```shell
64+
--devnet
65+
--network=<rollup.json file>
66+
```
67+

docs/start_op_besu.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Start Op-Besu
2+
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/).
3+
The document will introduce how to start a Op-Besu node using packaged binaries and Docker.
4+
5+
## Run on Optimism Sepolia
6+
7+
### Prerequisites
8+
9+
[Java JDK 21+](https://www.oracle.com/java/technologies/downloads/)
10+
11+
### Install from packaged binaries
12+
13+
Download the Op Besu [packaged binaires](https://github.com/optimism-java/op-besu/releases).
14+
15+
Unpack the downloaded files and change into the `besu-<release>` directory.
16+
17+
### Run a node
18+
```shell
19+
cd besu-<release> && \
20+
./bin/besu \
21+
--network=OP_SEPOLIA \
22+
--p2p-enabled=false \
23+
--discovery-enabled=false \
24+
--data-path=<your data dir> \
25+
--engine-rpc-enabled \
26+
--engine-jwt-secret=<jwt secret file> \
27+
--rpc-http-enabled \
28+
--host-allowlist=* \
29+
--engine-host-allowlist=* \
30+
--logging=INFO \
31+
--version-compatibility-protection=false
32+
```
33+
34+
## Run with docker on Optimism Sepolia
35+
36+
### Pull docker image
37+
38+
```shell
39+
docker pull docker pull ghcr.io/optimism-java/op-besu:latest
40+
```
41+
### Run a node with docker
42+
43+
```shell
44+
docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \
45+
ghcr.io/optimism-java/op-besu:latest -- \
46+
--network=OP_SEPOLIA \
47+
--p2p-enabled=false \
48+
--discovery-enabled=false \
49+
--data-path="/data/" \
50+
--engine-rpc-enabled \
51+
--engine-jwt-secret="/jwt/jwtsecret" \
52+
--rpc-http-enabled \
53+
--host-allowlist="*" \
54+
--engine-host-allowlist="*" \
55+
--logging=INFO \
56+
--version-compatibility-protection=false
57+
```
58+
docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \
59+
4b7ab2b50a39 \
60+
--network=OP_SEPOLIA \
61+
--p2p-enabled=false \
62+
--discovery-enabled=false \
63+
--engine-rpc-enabled \
64+
--engine-jwt-secret="/jwt/jwtsecret" \
65+
--rpc-http-enabled \
66+
--host-allowlist="*" \
67+
--engine-host-allowlist="*" \
68+
--logging=INFO \
69+
--version-compatibility-protection=false
70+
71+
## Run on other network
72+
73+
If you want to run on the anyother network, you first need to prepare the genesis.json file, then remove the `network` parameter from the command line and add it as the `genesis-file` parameter:
74+
75+
```shell
76+
--genesis-file=<devnet genesis file>
77+
```

mkdocs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
site_name: Optimism Java
2+
site_url: https://optimism-java.github.io
3+
4+
# Repository
5+
repo_url: https://github.com/optimism-java
6+
repo_name: OP-Java
7+
8+
9+
# Configuration
10+
theme:
11+
name: material
12+
logo: assets/images/image.png
13+
palette:
14+
primary: red
15+
features:
16+
- content.code.copy
17+
icon:
18+
repo: fontawesome/brands/github
19+
20+
# Page tree
21+
nav:
22+
- Home: index.md
23+
- Getting started:
24+
- Run Hildr: start_hildr.md
25+
- Run Op-Besu: start_op_besu.md

0 commit comments

Comments
 (0)