-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 766532c 🚀
- Loading branch information
1 parent
41a618f
commit dc990dd
Showing
11 changed files
with
4,666 additions
and
551 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introdution","text":"<p>We continue to contribute public goods to help the Ethereum and Optimism community get better and better.</p>"},{"location":"#our-works","title":"Our Works","text":"<p>We have currently developed two important components of Optimism:</p> <p>Hildr is an optimism rollup client written in Java.</p> <p>Op-Besu is an optimism execution client written in Java, a fork of Besu.</p>"},{"location":"#our-vision","title":"Our Vision","text":"<p>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.</p>"},{"location":"#contract-us","title":"Contract Us","text":"<p>If you have any questions or suggestions, please feel free to contact us on github. We look forward to working with you to advance blockchain technology!</p>"},{"location":"start_hildr/","title":"Start Hildr","text":"<p>Hildr is an OP Stack rollup client written in Java 21. And follow the spec:</p> <p>Magi</p> <p>Op-node</p>"},{"location":"start_hildr/#run-on-optimism-sepolia","title":"Run on Optimism Sepolia","text":""},{"location":"start_hildr/#prerequisites","title":"Prerequisites","text":"<p>Java JDK 21+</p>"},{"location":"start_hildr/#download-jar","title":"Download jar","text":"<p>Download the Hildr jar.</p>"},{"location":"start_hildr/#run-a-node","title":"Run a node","text":"<pre><code>java --enable-preview \\\n-cp hildr-node.jar io.optimism.Hildr \\\n--network optimism-sepolia \\\n--jwt-secret ./jwt.hex \\\n--l1-rpc-url http://localhost:9545 \\\n--l1-ws-rpc-url ws://localhost:9546 \\\n--l1-beacon-url http://localhost:4000 \\\n--l2-rpc-url http://localhost:8545 \\\n--l2-engine-url http://localhost:8551 \\\n--rpc-port 11545 \\\n--log-level INFO \\ # can be either: \"DEBUG\",\"TRACE\",\"WARN\",\"ERROR\"\n--sync-mode full >l2-hildr-node.log 2>&1 &\n</code></pre>"},{"location":"start_hildr/#run-with-docker-on-optimism-sepolia","title":"Run with docker on Optimism Sepolia","text":""},{"location":"start_hildr/#pull-docker-image","title":"Pull docker image","text":"<pre><code>docker pull ghcr.io/optimism-java/hildr:latest\n</code></pre>"},{"location":"start_hildr/#run-a-node-with-docker","title":"Run a node with docker","text":"<pre><code>docker run -it -p 11545:11545 \\\n-v <you jwt secret>:/jwt/jwtsecret \\\nghcr.io/optimism-java/op-besu:latest -- \\\n--network optimism-sepolia \\ # can be either: \"optimism\",\"base\",\"base-sepolia\"\n--jwt-secret ./jwt.hex \\\n--l1-rpc-url http://localhost:9545 \\\n--l1-ws-rpc-url ws://localhost:9546 \\\n--l1-beacon-url http://localhost:4000 \\\n--l2-rpc-url http://localhost:8545 \\\n--l2-engine-url http://localhost:8551 \\\n--rpc-port 11545 \\\n--log-level INFO \\ # can be either: \"DEBUG\",\"TRACE\",\"WARN\",\"ERROR\"\n--sync-mode full\n</code></pre>"},{"location":"start_hildr/#run-on-other-network","title":"Run on other network","text":"<p>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:</p> <pre><code>--devnet\n--network=<rollup.json file>\n</code></pre>"},{"location":"start_op_besu/","title":"Start Op-Besu","text":"<p>A fork of Besu that supports the execution engine of OP stack. The document will introduce how to start a Op-Besu node using packaged binaries and Docker.</p>"},{"location":"start_op_besu/#run-on-optimism-sepolia","title":"Run on Optimism Sepolia","text":""},{"location":"start_op_besu/#prerequisites","title":"Prerequisites","text":"<p>Java JDK 21+</p>"},{"location":"start_op_besu/#install-from-packaged-binaries","title":"Install from packaged binaries","text":"<p>Download the Op Besu packaged binaires.</p> <p>Unpack the downloaded files and change into the <code>besu-<release></code> directory.</p>"},{"location":"start_op_besu/#run-a-node","title":"Run a node","text":"<pre><code>cd besu-<release> && \\\n./bin/besu \\\n--network=OP_SEPOLIA \\\n--p2p-enabled=false \\\n--discovery-enabled=false \\\n--data-path=<your data dir> \\\n--engine-rpc-enabled \\\n--engine-jwt-secret=<jwt secret file> \\\n--rpc-http-enabled \\\n--host-allowlist=* \\\n--engine-host-allowlist=* \\\n--logging=INFO \\\n--version-compatibility-protection=false\n</code></pre>"},{"location":"start_op_besu/#run-with-docker-on-optimism-sepolia","title":"Run with docker on Optimism Sepolia","text":""},{"location":"start_op_besu/#pull-docker-image","title":"Pull docker image","text":"<pre><code>docker pull docker pull ghcr.io/optimism-java/op-besu:latest\n</code></pre>"},{"location":"start_op_besu/#run-a-node-with-docker","title":"Run a node with docker","text":"<pre><code>docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \\\nghcr.io/optimism-java/op-besu:latest -- \\\n--network=OP_SEPOLIA \\\n--p2p-enabled=false \\\n--discovery-enabled=false \\\n--data-path=\"/data/\" \\\n--engine-rpc-enabled \\\n--engine-jwt-secret=\"/jwt/jwtsecret\" \\\n--rpc-http-enabled \\\n--host-allowlist=\"*\" \\\n--engine-host-allowlist=\"*\" \\\n--logging=INFO \\\n--version-compatibility-protection=false\n</code></pre> <p>docker run -it -p 8545:8545 -p 8551:8551 -v :/jwt/jwtsecret \\ 4b7ab2b50a39 \\ --network=OP_SEPOLIA \\ --p2p-enabled=false \\ --discovery-enabled=false \\ --engine-rpc-enabled \\ --engine-jwt-secret=\"/jwt/jwtsecret\" \\ --rpc-http-enabled \\ --host-allowlist=\"\" \\ --engine-host-allowlist=\"\" \\ --logging=INFO \\ --version-compatibility-protection=false"},{"location":"start_op_besu/#run-on-other-network","title":"Run on other network","text":"<p>If you want to run on the anyother network, you first need to prepare the genesis.json file, then remove the <code>network</code> parameter from the command line and add it as the <code>genesis-file</code> parameter:</p> <pre><code>--genesis-file=<devnet genesis file>\n</code></pre>"}]} | ||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introdution","text":"<p>We continue to contribute public goods to help the Ethereum and Optimism community get better and better.</p>"},{"location":"#our-works","title":"Our Works","text":"<p>We have currently developed two important components of Optimism:</p> <p>Hildr is an optimism rollup client written in Java.</p> <p>Op-Besu is an optimism execution client written in Java, a fork of Besu.</p>"},{"location":"#our-vision","title":"Our Vision","text":"<p>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.</p>"},{"location":"#contract-us","title":"Contract Us","text":"<p>If you have any questions or suggestions, please feel free to contact us on github. We look forward to working with you to advance blockchain technology!</p>"},{"location":"hildr/","title":"Hildr","text":"<p>Hildr is an OP Stack rollup client written in Java 21. And follow the spec:</p> <p>Magi</p> <p>Op-node</p>"},{"location":"hildr/use_docker/","title":"Use docker","text":"<p>You can use Docker to run Hildr as an Optimism CL node.</p>"},{"location":"hildr/use_docker/#pull-docker-image","title":"Pull docker image","text":"<pre><code>docker pull ghcr.io/optimism-java/hildr:latest\n</code></pre>"},{"location":"hildr/use_docker/#start-a-hildr-node","title":"Start a Hildr node","text":"op sepoliadevnet or other <pre><code>docker run -it -p 11545:11545 \\\n-v <you jwt secret>:/jwt/jwt.hex \\\nghcr.io/optimism-java/op-besu:latest -- \\\n--network optimism-sepolia \\ # can be either: \"optimism\",\"base\",\"base-sepolia\"\n--jwt-file /jwt/jwt.hex \\\n--l1-rpc-url http://localhost:9545 \\\n--l1-ws-rpc-url ws://localhost:9546 \\\n--l1-beacon-url http://localhost:4000 \\\n--l2-rpc-url http://localhost:8545 \\\n--l2-engine-url http://localhost:8551 \\\n--rpc-port 11545 \\\n--log-level INFO \\ # can be either: \"DEBUG\",\"TRACE\",\"WARN\",\"ERROR\"\n--sync-mode full\n</code></pre> <pre><code>docker run -it -p 11545:11545 \\\n-v <your jwt secret>:/jwt/jwt.hex \\\n-v <your rollup.json file>:/network-configs/rollup.json\nghcr.io/optimism-java/op-besu:latest -- \\\n--devnet \\\n--network=/network-configs/rollup.json \\\n--jwt-file /jwt/jwt.hex \\\n--l1-rpc-url http://localhost:9545 \\\n--l1-ws-rpc-url ws://localhost:9546 \\\n--l1-beacon-url http://localhost:4000 \\\n--l2-rpc-url http://localhost:8545 \\\n--l2-engine-url http://localhost:8551 \\\n--rpc-port 11545 \\\n--log-level INFO \\ # can be either: \"DEBUG\",\"TRACE\",\"WARN\",\"ERROR\"\n--sync-mode full\n</code></pre>"},{"location":"hildr/use_jar/","title":"Use the Hildr jar","text":""},{"location":"hildr/use_jar/#prerequisites","title":"Prerequisites","text":"<p>Java JDK 21+</p>"},{"location":"hildr/use_jar/#download-the-hildr-jar","title":"Download the Hildr jar","text":"<p>Download the Hildr jar.</p>"},{"location":"hildr/use_jar/#start-a-hildr-node","title":"Start a Hildr node","text":"op sepoliadevnet or other <pre><code>java --enable-preview \\\n-cp <the Hildr jar file> io.optimism.Hildr \\\n--network optimism-sepolia \\\n--jwt-secret ./jwt.hex \\\n--l1-rpc-url http://localhost:9545 \\\n--l1-ws-rpc-url ws://localhost:9546 \\\n--l1-beacon-url http://localhost:4000 \\\n--l2-rpc-url http://localhost:8545 \\\n--l2-engine-url http://localhost:8551 \\\n--rpc-port 11545 \\\n--log-level INFO \\ # can be either: \"DEBUG\",\"TRACE\",\"WARN\",\"ERROR\"\n--sync-mode full >l2-hildr-node.log 2>&1 &\n</code></pre> <pre><code>java --enable-preview \\\n-cp <the Hildr jar file> io.optimism.Hildr \\\n--devnet \\\n--network <rollup.json file> \\\n--jwt-secret ./jwt.hex \\\n--l1-rpc-url http://localhost:9545 \\\n--l1-ws-rpc-url ws://localhost:9546 \\\n--l1-beacon-url http://localhost:4000 \\\n--l2-rpc-url http://localhost:8545 \\\n--l2-engine-url http://localhost:8551 \\\n--rpc-port 11545 \\\n--log-level INFO \\ # can be either: \"DEBUG\",\"TRACE\",\"WARN\",\"ERROR\"\n--sync-mode full >l2-hildr-node.log 2>&1 &\n</code></pre>"},{"location":"op-besu/","title":"Op-Besu","text":"<p>Op-Besu is a fork of Besu that supports the execution engine of OP stack.</p>"},{"location":"op-besu/use_binaries/","title":"Use the packaged binaries","text":"<p>You can install the Op-besu or Op-geth client to run a Optimism EL node from a binary distribution.</p>"},{"location":"op-besu/use_binaries/#prerequisites","title":"Prerequisites","text":"<p>Java JDK 21+</p>"},{"location":"op-besu/use_binaries/#install-from-packaged-binaries","title":"Install from packaged binaries","text":"<p>Download the Op Besu packaged binaires.</p> <p>Unpack the downloaded files and change into the <code>op-besu-<release></code> directory.</p>"},{"location":"op-besu/use_binaries/#run-a-op-besu-node","title":"Run a Op-Besu node","text":"op sepoliadevnet or other <pre><code>cd op-besu-<release> && \\\n./bin/besu \\\n--network=OP_SEPOLIA \\\n--p2p-enabled=false \\\n--discovery-enabled=false \\\n--data-path=<your data dir> \\\n--engine-rpc-enabled \\\n--engine-jwt-secret=<jwt secret file> \\\n--rpc-http-enabled \\\n--host-allowlist=* \\\n--engine-host-allowlist=* \\\n--logging=INFO \\\n--version-compatibility-protection=false\n</code></pre> <pre><code>cd op-besu-<release> && \\\n./bin/besu \\\n--genesis-file=<devnet genesis file> \\\n--p2p-enabled=false \\\n--discovery-enabled=false \\\n--data-path=<your data dir> \\\n--engine-rpc-enabled \\\n--engine-jwt-secret=<jwt secret file> \\\n--rpc-http-enabled \\\n--host-allowlist=* \\\n--engine-host-allowlist=* \\\n--logging=INFO \\\n--version-compatibility-protection=false\n</code></pre>"},{"location":"op-besu/use_docker/","title":"Use docker","text":"<p>You can use Docker to run Op-Besu or Op-Geth as a Optimism EL node on the testnets.</p>"},{"location":"op-besu/use_docker/#prerequisites","title":"Prerequisites","text":"<p>Download and install Docker.</p>"},{"location":"op-besu/use_docker/#pull-docker-image","title":"Pull docker image","text":"<pre><code>docker pull docker pull ghcr.io/optimism-java/op-besu:latest\n</code></pre>"},{"location":"op-besu/use_docker/#start-a-op-besu-node","title":"Start a Op-Besu node","text":"op sepoliadevnet or other <pre><code>docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \\\nghcr.io/optimism-java/op-besu:latest -- \\\n--network=OP_SEPOLIA \\\n--p2p-enabled=false \\\n--discovery-enabled=false \\\n--data-path=\"/data/\" \\\n--engine-rpc-enabled \\\n--engine-jwt-secret=\"/jwt/jwtsecret\" \\\n--rpc-http-enabled \\\n--host-allowlist=\"*\" \\\n--engine-host-allowlist=\"*\" \\\n--logging=INFO \\\n--version-compatibility-protection=false\n</code></pre> <pre><code>docker run -it -p 8545:8545 -p 8551:8551 -v <you jwt secret>:/jwt/jwtsecret \\\nghcr.io/optimism-java/op-besu:latest -- \\\n--genesis-file=<devnet genesis file> \\\n--p2p-enabled=false \\\n--discovery-enabled=false \\\n--data-path=\"/data/\" \\\n--engine-rpc-enabled \\\n--engine-jwt-secret=\"/jwt/jwtsecret\" \\\n--rpc-http-enabled \\\n--host-allowlist=\"*\" \\\n--engine-host-allowlist=\"*\" \\\n--logging=INFO \\\n--version-compatibility-protection=false\n</code></pre>"}]} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.