Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
Bloxster committed Jan 4, 2025
1 parent e2f165d commit c2bedb9
Showing 8 changed files with 26 additions and 20 deletions.
4 changes: 4 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -5,3 +5,7 @@ description = "Erigon 3 documentation!"
language = "en"
multilingual = false
src = "src"

[output.html]
git-repository-url = "https://github.com/erigontech/docs"
edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
4 changes: 2 additions & 2 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -36,11 +36,11 @@
- [Lighthouse](advanced/lighthouse.md)
- [JWT secret](advanced/jwt.md)
- [Options](advanced/options.md)
- [RPC Daemon](advanced/rpc_daemon.md)
- [RPC Daemon](advanced/JSONRPC-daemon.md)
- [TxPool](advanced/txpool.md)
- [Sentry](advanced/sentry.md)
- [Downloader](advanced/downloader.md)
- [Running an Op-node](op-node.md)
- [Running an Op-node](advanced/op-node.md)
- [TLS Authentication](advanced/tls-authentication.md)
- [Perfomance Tricks](advanced/performance.md)

6 changes: 3 additions & 3 deletions src/about/contributing.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ Erigon is an open-source project that welcomes contributions from developers wor

### Programmer's Guide

Begin by exploring the comprehensive [Programmer's Guide](https://github.com/ledgerwatch/erigon/blob/devel/docs/programmers_guide/guide.md), which covers topics such as the Ethereum state structure, account contents, and account addressing mechanisms. This guide serves as a valuable resource, providing detailed information on Erigon's architecture, coding conventions, and development workflows related to managing and interacting with the Ethereum state.
Begin by exploring the comprehensive **[Programmer's Guide](https://github.com/ledgerwatch/erigon/blob/devel/docs/programmers_guide/guide.md)**, which covers topics such as the Ethereum state structure, account contents, and account addressing mechanisms. This guide serves as a valuable resource, providing detailed information on Erigon's architecture, coding conventions, and development workflows related to managing and interacting with the Ethereum state.

### Dive Deeper into the Architecture

@@ -22,7 +22,7 @@ Erigon introduces several innovative features that contributors may find interes

## Wiki

Visit also Erigon's [Wiki](https://github.com/ledgerwatch/erigon/wiki) to gain more important insights:
Visit also Erigon's **[Wiki](https://github.com/ledgerwatch/erigon/wiki)** to gain more important insights:
- Caplin downloader sync
- Choice of storage engine
- Consensus Engine separation
@@ -40,4 +40,4 @@ Visit also Erigon's [Wiki](https://github.com/ledgerwatch/erigon/wiki) to gain m

# Documentation

To contribute to this documentation, commit your change to the development branch on [Github](https://github.com/erigontech/docs/tree/development). You might want to run it locally to verify the output before committing, see how MdBook works [here](https://rust-lang.github.io/mdBook/index.html).
To contribute to this documentation, commit your change to the development branch on **[Github](https://github.com/erigontech/docs/tree/development)**. You might want to run it locally to verify the output before committing, see how MdBook works [here](https://rust-lang.github.io/mdBook/index.html).
2 changes: 1 addition & 1 deletion src/about/license.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# License

The Erigon 3 documentation © 2024 by Erigon contributors is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
The Erigon 3 Book © 2024 by Erigon contributors is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# RPC Daemon
*Remote Procedure Call*

13 changes: 13 additions & 0 deletions src/advanced/op-node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Running an Op-Node Alongside Erigon

To run an op-node alongside Erigon, follow these steps:

1. **Start Erigon with Caplin Enabled**:
If Caplin is running as the consensus layer (CL), use the `--caplin.blobs-immediate-backfill` flag to ensure the last 18 days of blobs are backfilled, which is critical for proper synchronization with the op-node, assuming you start from a snapshot.
```bash
./build/bin/erigon --caplin.blobs-immediate-backfill
```
2. **Run the Op-Node**:
Configure the op-node with the `--l1.trustrpc` flag to trust the Erigon RPC layer as the L1 node. This setup ensures smooth communication and synchronization.

This configuration enables the op-node to function effectively with Erigon serving as both the L1 node and the CL.
14 changes: 1 addition & 13 deletions src/op-node.md
Original file line number Diff line number Diff line change
@@ -1,13 +1 @@
# Running an Op-Node Alongside Erigon

To run an op-node alongside Erigon, follow these steps:

1. **Start Erigon with Caplin Enabled**:
If Caplin is running as the consensus layer (CL), use the `--caplin.blobs-immediate-backfill` flag to ensure the last 18 days of blobs are backfilled, which is critical for proper synchronization with the op-node, assuming you start from a snapshot.
```bash
./build/bin/erigon --caplin.blobs-immediate-backfill
```
2. **Run the Op-Node**:
Configure the op-node with the `--l1.trustrpc` flag to trust the Erigon RPC layer as the L1 node. This setup ensures smooth communication and synchronization.

This configuration enables the op-node to function effectively with Erigon serving as both the L1 node and the CL.
# Running an Op-node
2 changes: 1 addition & 1 deletion src/welcome.md
Original file line number Diff line number Diff line change
@@ -50,7 +50,7 @@ Erigon 3 also introduces changes to the release process, including:

# Known Issues

See <https://github.com/erigontech/erigon?tab=readme-ov-file#known-issues>.
See <https://github.com/erigontech/erigon?tab=readme-ov-file#known-issues>

# Contributing to this documentation

0 comments on commit c2bedb9

Please sign in to comment.