Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bloxster committed Oct 24, 2024
1 parent ce57210 commit d6f2252
Show file tree
Hide file tree
Showing 8 changed files with 38 additions and 25 deletions.
26 changes: 20 additions & 6 deletions src/advanced/block-prod.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,45 @@ How to propose and validate blockswith Erigon

Only remote miners are supported.

To enable, add --mine --miner.etherbase=... or --mine --miner.miner.sigkey=... flags.
To enable, add

Other supported options: --miner.extradata, --miner.notify, --miner.gaslimit, --miner.gasprice , --miner.gastarget
```bash
--mine --miner.etherbase=...
```
or

JSON-RPC supports methods: eth_coinbase , eth_hashrate, eth_mining, eth_getWork, eth_submitWork, eth_submitHashrate
```bash
--mine --miner.miner.sigkey=... flags
```

JSON-RPC supports websocket methods: newPendingTransaction
Other supported options: `--miner.extradata`, `--miner.notify`, `--miner.gaslimit`, `--miner.gasprice` , `--miner.gastarget`

More info here.
Using Caplin as validator
JSON-RPC supports methods: eth_coinbase , eth_hashrate, eth_mining, eth_getWork, eth_submitWork, eth_submitHashrate

JSON-RPC supports websocket methods: newPendingTransaction

# Using Caplin as validator

Only Lighthouse, Lodestar and Teku are supported as Validator Clients.

To enable block production and Caplin's beacon API when using Caplin as the Consensus Layer (CL) engine, the flag --beacon.api must be added. For example:

```bash
--beacon.api=beacon,builder,config,debug,node,validator,lighthouse
```

Enabling the Beacon API will lead to a 6 GB higher RAM usage.

For example, if you want to run Erigon + Caplin as a validator here following is the Erigon command:

```bash
./build/bin/erigon --internalcl --chain=holesky --prune=hrtc --beacon.api=beacon,builder,config,debug,node,validator,lighthouse
```

While here the command for Lighthouse would look like*:

```bash
lighthouse validator_client --network holesky --beacon-nodes http://localhost:5555
```

*For adding validators and specific command syntax, refer to the documentation of your chosen Validator Client.
16 changes: 3 additions & 13 deletions src/advanced/caplin.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
# Caplin

Caplin's Erigon 3 represents a major breakthrough in Ethereum infrastructure, offering unparalleled performance, efficiency, and reliability. Its innovative all-in-one design and disk-saving features make it an attractive solution for developers, users, and the broader Ethereum ecosystem.
Caplin, the novel embedded Consensus Layer, brings unparalleled performance, efficiency, and reliability to Ethereum infrastructure. Its innovative design minimize disk usage, enabling faster transaction processing and a more secure network.

The main reason for developing a new consensus layer is to improve the node architecture by overcoming the limitation of Engine API. For example, the Engine API sends data one block at a time, while Erigon is designed to handle many blocks at once and needs to sort and process data efficiently. Therefore, it would be better for Erigon to handle the blocks independently instead of relying on the Engine API.
By integrating the consensus layer into the EVM-node, Caplin eliminates the need for separate disk storage, reducing overall system complexity and improving overall efficiency. OtterSync, a new syncing algorithm, further enhances performance by shifting 98% of the computation to network bandwidth, reducing sync times and improving chain tip performance, disk footprint, and decentralization.

**Strengths and Performances:**

* Thanks to Caplin, Erigon 3 is the world's first all-in-one EVM-node on the efficient software frontier;
* The integration of a consensus layer within the EVM-node enables faster and more efficient transaction processing, ensuring a more secure and reliable network.
* Caplin's all-in-one design allows for seamless integration with existing Ethereum infrastructure, making it an attractive solution for developers and users seeking to upgrade their experience.

**Disk-Saving Features:**

* Caplin's Erigon 3 (Alpha 1) boasts a unique consensus layer design that minimizes disk usage, resulting in significant storage space savings.
* This innovative approach enables Caplin to optimize its EVM-node, ensuring that it can handle increased transaction volumes while maintaining minimal disk usage.
* By integrating the consensus layer into the EVM-node, Caplin eliminates the need for separate disk storage, reducing overall system complexity and improving overall efficiency.
<img class="center" src="/images/ottersync.png" alt="Ottersync">

# Caplin Usage

Expand Down
2 changes: 1 addition & 1 deletion src/advanced/consensus_layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Historically, an Execution Layer (EL) client alone was enough to run a full Ethe

The execution client listens to new transactions, executes them in the Ethereum Virtual Machine (EVM), and holds the latest state and database of all current Ethereum data.

The consensus client, also known as the *Beacon Node* or *CL client*, implements tShe Proof-of-Stake consensus algorithm, which enables the network to achieve agreement based on validated data from the execution client. Both clients work together to keep track of the head of the Ethereum chain and allow users to interact with the Ethereum network.
The consensus client, also known as the *Beacon Node* or *CL client*, implements the Proof-of-Stake consensus algorithm, which enables the network to achieve agreement based on validated data from the execution client. Both clients work together to keep track of the head of the Ethereum chain and allow users to interact with the Ethereum network.

<div class="warning">
By default, Erigon is configured to run with Caplin, the embedded Consensus Layer.
Expand Down
8 changes: 8 additions & 0 deletions src/advanced/lighthouse.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# Lighthouse

Lighthouse is another popular client that combined with Erigon can be used for block building.

Documentation can be found here: <https://lighthouse-book.sigmaprime.io>

The basic steps to run Erigon together with Lighthouse are:
1. Install and run Erigon. Erigon will automatically create a JWT secret.
2. Install and run Lighthouse, pointing to JWT secret created by Erigon.
8 changes: 4 additions & 4 deletions src/basic/wallet
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ To configure your local Metamask wallet (browser extension):
* Click **Add network**
* A new browser tab will open, displaying various fields to fill out. Complete the fields with the proper information, in this example for Ethereum network:
* **Network Name**: `Ethereum on E3` (or any name of your choice)
* **Chain ID**: 1 for chain ID parameter see [Supported Networks](/basic/networks.md)
* **New RPC URL**: http://127.0.0.1:8545
**Currency Symbol**: ETH
**Block Explorer URL**: https://www.etherscan.io (or any explorer of your choice)
* **Chain ID**: `1` for chain ID parameter see [Supported Networks](/basic/networks.md)
* **New RPC URL**: `http://127.0.0.1:8545`
* **Currency Symbol**: `ETH`
* **Block Explorer URL**: `https://www.etherscan.io` (or any explorer of your choice)

After performing the above steps, you will be able to see the custom network the next time you access the network selector.

Binary file added src/images/ottersync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ General Info
* The Docker image is now compatible with multiple platforms: Linux (amd64, v2) and arm64. It's built on top of Alpine 3.20.2;
* All build flags now passed to the release workflow — so, user can see previously missed build info in our released binaries (as well as in docker images) and also better build optimization expected;
* With recent updates, all build configurations are now included in the release process. This provides users with more comprehensive build information for both binaries and Docker images, along with enhanced build optimizations..
* Images are stored at <https://hub.docker.com/r/erigontech/erigon>

## Download and start Erigon in Docker

Expand Down
2 changes: 1 addition & 1 deletion src/installation/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The basic Erigon configuration is suitable for most users just wanting to run a node. For building the latest stable release use the following command:

```bash
git clone --branch v3.0.0-alpha4 --single-branch https://github.com/erigontech/erigon.git
git clone --branch v3.0.0-alpha5 --single-branch https://github.com/erigontech/erigon.git
cd erigon
make erigon
```
Expand Down

0 comments on commit d6f2252

Please sign in to comment.