-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update site configuration and content (#453)
* Update site configuration and content * add redirects and rearrange how-tos * npm install * don't revert line breaks * fix linting errors * fix lint quotes * fix: fix lint prettier errors * Apply suggestions from code review Co-authored-by: Byron Gravenorst <50852695+bgravenorst@users.noreply.github.com> * font size / minor edits --------- Co-authored-by: Joshua Fernandes <joshua.fernandes@consensys.net> Co-authored-by: Byron Gravenorst <50852695+bgravenorst@users.noreply.github.com>
- Loading branch information
1 parent
f495c24
commit 54d33f6
Showing
73 changed files
with
19,029 additions
and
675 deletions.
There are no files selected for viewing
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 |
---|---|---|
|
@@ -20,3 +20,4 @@ yarn-debug.log* | |
yarn-error.log* | ||
.vercel | ||
.idea | ||
.yarn |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
10 changes: 6 additions & 4 deletions
10
docs/Concepts/ArchitectureOverview.md → docs/concepts/architecture.md
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,17 +1,19 @@ | ||
--- | ||
title: Architecture | ||
description: Teku architecture | ||
description: Learn about the Teku high-level architecture. | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Teku architecture | ||
|
||
The following diagram outlines the Teku high-level architecture. | ||
|
||
![Architecture](../images/Architecture.png) | ||
![Architecture](../images/architecture.png) | ||
|
||
Teku contains both a beacon node and validator client implementation. The beacon node is the primary link to the Beacon Chain. The validator client performs [validator duties](Proof-of-Stake.md). | ||
Teku contains both a beacon node and validator client implementation. | ||
The beacon node is the primary link to the Beacon Chain. | ||
The validator client performs [validator duties](proof-of-stake.md). | ||
|
||
You can [run the beacon node only](../HowTo/Get-Started/Run-Teku.md#start-the-beacon-node), or [run the beacon node and validator client](../HowTo/Get-Started/Run-Teku.md#start-the-clients-in-a-single-process). | ||
You can [run the beacon node only](../get-started/start-teku.md#start-the-beacon-node), or [run the beacon node and validator client](../get-started/start-teku.md#start-the-clients-in-a-single-process). | ||
|
||
Read more about the [Ethereum consensus client architecture](https://ethereum.org/en/developers/docs/nodes-and-clients/). For more information about the Teku architecture, contact us on [Teku Discord channel](https://discord.com/invite/consensys). |
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: Builder network and MEV-Boost | ||
description: Learn about external builders and MEV-Boost. | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Builder network and MEV-Boost | ||
|
||
[Consensus clients](merge.md#consensus-clients) are responsible for proposing | ||
blocks containing an execution payload obtained from their local | ||
[execution clients](merge.md#execution-clients) via the Engine API. | ||
|
||
A consensus client can optionally configure an external builder and delegate the | ||
execution payload construction to it, instead of using the execution client. | ||
|
||
## MEV-Boost | ||
|
||
The most common builder deployment is to run a specialized external software | ||
such as [MEV-Boost](https://github.com/flashbots/mev-boost). | ||
MEV-Boost works by requesting a payload proposal from several entities (called | ||
relays), and selecting the best bid in order to improve validator rewards and | ||
increase the maximal extractable value (MEV). | ||
|
||
Teku allows you to | ||
[configure the beacon node to use a builder network](../how-to/configure/builder-network.md) | ||
to generate execution payloads. | ||
In case of failures or non-timely responses, Teku falls back to the payload | ||
produced by the local execution client specified using | ||
[`--ee-endpoint`](../reference/cli/index.md#ee-endpoint). |
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
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: Peer-to-peer private key | ||
description: Learn about the peer-to-peer private key. | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Peer-to-peer private key | ||
|
||
The peer-to-peer (P2P) private key is used to identify the beacon node on the network and secures the information channel between nodes. | ||
|
||
When starting Teku, if the [`--p2p-private-key-file`](../reference/cli/index.md#p2p-private-key-file) option is not specified, and the `generated-node-key.dat` file does not exist in the node's data directory, Teku generates a P2P private key and writes it to the `generated-node-key.dat` file. | ||
|
||
If the `generated-node-key.dat` file exists in the data directory when starting Teku, the node starts using the private stored in the file. | ||
|
||
:::info | ||
|
||
The `generated-node-key.dat` file is stored by default in the `<data-beacon-path>/kvstore` directory, where `<data-beacon-path>` is specified using the [`--data-beacon-path`](../reference/cli/index.md#data-beacon-path) option. | ||
|
||
::: |
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
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
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
Oops, something went wrong.
54d33f6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
doc-teku – ./
doc-teku-infura-web.vercel.app
docs.teku.consensys.net
doc-teku-git-main-infura-web.vercel.app