Skip to content

Commit 269dc25

Browse files
authored
Merge pull request #16109 from pete-vielhaber/patch-2
docs: minor-styling
2 parents b5eb00d + b2c4dff commit 269dc25

File tree

6 files changed

+34
-39
lines changed

6 files changed

+34
-39
lines changed

public/content/developers/docs/evm/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ _Diagrams adapted from [Ethereum EVM illustrated](https://takenobu-hs.github.io/
5656

5757
All implementations of the EVM must adhere to the specification described in the Ethereum Yellowpaper.
5858

59-
Over Ethereum's nine year history, the EVM has undergone several revisions, and there are several implementations of the EVM in various programming languages.
59+
Over Ethereum's ten year history, the EVM has undergone several revisions, and there are several implementations of the EVM in various programming languages.
6060

6161
[Ethereum execution clients](/developers/docs/nodes-and-clients/#execution-clients) include an EVM implementation. Additionally, there are multiple standalone implementations, including:
6262

public/content/developers/docs/gas/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The total fee would now be equal to:
4646

4747
where the `base fee` is a value set by the protocol and the `priority fee` is a value set by the user as a tip to the validator.
4848

49-
i.e. `21,000 * (10 + 2) = 252,000 gwei` (0.000252 ETH).
49+
e.g., `21,000 * (10 + 2) = 252,000 gwei` (0.000252 ETH).
5050

5151
When Jordan sends the money, 1.000252 ETH will be deducted from Jordan's account. Taylor will be credited 1.0000 ETH. The validator receives the tip of 0.000042 ETH. The `base fee` of 0.00021 ETH is burned.
5252

@@ -89,7 +89,9 @@ To execute a transaction on the network, users can specify a maximum limit they
8989

9090
### Block size {#block-size}
9191

92-
Each block has a target size of 15 million gas, but the size of blocks will increase or decrease in accordance with network demand, up until the block limit of 30 million gas (2x the target block size). The protocol achieves an equilibrium block size of 15 million on average through the process of _tâtonnement_. This means if the block size is greater than the target block size, the protocol will increase the base fee for the following block. Similarly, the protocol will decrease the base fee if the block size is less than the target block size. The amount by which the base fee is adjusted is proportional to how far the current block size is from the target. [More on blocks](/developers/docs/blocks/).
92+
Each block has a target size of 15 million gas, but the size of blocks will increase or decrease in accordance with network demand, up until the block limit of 30 million gas (2x the target block size). The protocol achieves an equilibrium block size of 15 million on average through the process of _tâtonnement_. This means if the block size is greater than the target block size, the protocol will increase the base fee for the following block. Similarly, the protocol will decrease the base fee if the block size is less than the target block size. The amount by which the base fee is adjusted is proportional to how far the current block size is from the target.
93+
94+
[More on blocks](/developers/docs/blocks/)
9395

9496
### Calculating gas fees in practice {#calculating-fees-in-practice}
9597

@@ -99,7 +101,7 @@ You can explicitly state how much you are willing to pay to get your transaction
99101

100102
In short, gas fees help keep the Ethereum network secure. By requiring a fee for every computation executed on the network, we prevent bad actors from spamming the network. In order to avoid accidental or hostile infinite loops or other computational wastage in code, each transaction is required to set a limit to how many computational steps of code execution it can use. The fundamental unit of computation is "gas".
101103

102-
Although a transaction includes a limit, any gas not used in a transaction is returned to the user (i.e. `max fee - (base fee + tip)` is returned).
104+
Although a transaction includes a limit, any gas not used in a transaction is returned to the user (e.g., `max fee - (base fee + tip)` is returned).
103105

104106
![Diagram showing how unused gas is refunded](../transactions/gas-tx.png)
105107
_Diagram adapted from [Ethereum EVM illustrated](https://takenobu-hs.github.io/downloads/ethereum_evm_illustrated.pdf)_
@@ -118,7 +120,9 @@ High gas fees are due to the popularity of Ethereum. If there's too much demand,
118120

119121
The Ethereum [scalability upgrades](/roadmap/) should ultimately address some of the gas fee issues, which will, in turn, enable the platform to process thousands of transactions per second and scale globally.
120122

121-
Layer 2 scaling is a primary initiative to greatly improve gas costs, user experience and scalability. [More on layer 2 scaling](/developers/docs/scaling/#layer-2-scaling).
123+
Layer 2 scaling is a primary initiative to greatly improve gas costs, user experience and scalability.
124+
125+
[More on layer 2 scaling](/developers/docs/scaling/#layer-2-scaling)
122126

123127
## Monitoring gas fees {#monitoring-gas-fees}
124128

public/content/developers/docs/nodes-and-clients/client-diversity/index.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ _Diagram data from [ethernodes.org](https://ethernodes.org) and [clientdiversity
4646

4747
The two pie charts above show snapshots of the current client diversity for the execution and consensus layers (at time of writing in January 2022). The execution layer is overwhelmingly dominated by [Geth](https://geth.ethereum.org/), with [Open Ethereum](https://openethereum.github.io/) a distant second, [Erigon](https://github.com/ledgerwatch/erigon) third and [Nethermind](https://nethermind.io/) fourth, with other clients comprising less than 1 % of the network. The most commonly used client on the consensus layer - [Prysm](https://prysmaticlabs.com/#projects) - is not as dominant as Geth but still represents over 60% of the network. [Lighthouse](https://lighthouse.sigmaprime.io/) and [Teku](https://consensys.net/knowledge-base/ethereum-2/teku/) make up ~20% and ~14% respectively, and other clients are rarely used.
4848

49-
The execution layer data were obtained from [Ethernodes](https://ethernodes.org) on 23-Jan-2022. Data for consensus clients was obtained from [Michael Sproul](https://github.com/sigp/blockprint). Consensus client data is more difficult to obtain because the consensus layer clients do not always have unambiguous traces that can be used to identify them. The data was generated using a classification algorithm that sometimes confuses some of the minority clients (see [here](https://twitter.com/sproulM_/status/1440512518242197516) for more details). In the diagram above, these ambiguous classifications are treated with an either/or label (e.g. Nimbus/Teku). Nevertheless, it is clear that the majority of the network is running Prysm. The data is a snapshot over a fixed set of blocks (in this case Beacon blocks in slots 2048001 to 2164916) and Prysm's dominance has sometimes been higher, exceeding 68%. Despite only being snapshots, the values in the diagram provide a good general sense of the current state of client diversity.
49+
The execution layer data were obtained from [Ethernodes](https://ethernodes.org) on 23-Jan-2022. Data for consensus clients was obtained from [Michael Sproul](https://github.com/sigp/blockprint). Consensus client data is more difficult to obtain because the consensus layer clients do not always have unambiguous traces that can be used to identify them. The data was generated using a classification algorithm that sometimes confuses some of the minority clients (see [here](https://twitter.com/sproulM_/status/1440512518242197516) for more details). In the diagram above, these ambiguous classifications are treated with an either/or label (e.g., Nimbus/Teku). Nevertheless, it is clear that the majority of the network is running Prysm. The data is a snapshot over a fixed set of blocks (in this case Beacon blocks in slots 2048001 to 2164916) and Prysm's dominance has sometimes been higher, exceeding 68%. Despite only being snapshots, the values in the diagram provide a good general sense of the current state of client diversity.
5050

5151
Up to date client diversity data for the consensus layer is now available at [clientdiversity.org](https://clientdiversity.org/).
5252

@@ -60,29 +60,20 @@ Addressing client diversity requires more than individual users to choose minori
6060

6161
### Execution clients {#execution-clients}
6262

63-
[Besu](https://www.hyperledger.org/use/besu)
64-
65-
[Nethermind](https://downloads.nethermind.io/)
66-
67-
[Erigon](https://github.com/ledgerwatch/erigon)
68-
69-
[Go-Ethereum](https://geth.ethereum.org/)
70-
71-
[Reth](https://reth.rs/)
63+
- [Besu](https://www.hyperledger.org/use/besu)
64+
- [Nethermind](https://downloads.nethermind.io/)
65+
- [Erigon](https://github.com/ledgerwatch/erigon)
66+
- [Go-Ethereum](https://geth.ethereum.org/)
67+
- [Reth](https://reth.rs/)
7268

7369
### Consensus clients {#consensus-clients}
7470

75-
[Nimbus](https://nimbus.team/)
76-
77-
[Lighthouse](https://github.com/sigp/lighthouse)
78-
79-
[Teku](https://consensys.net/knowledge-base/ethereum-2/teku/)
80-
81-
[Lodestar](https://github.com/ChainSafe/lodestar)
82-
83-
[Prysm](https://prysm.offchainlabs.com/docs/)
84-
85-
[Grandine](https://docs.grandine.io/)
71+
- [Nimbus](https://nimbus.team/)
72+
- [Lighthouse](https://github.com/sigp/lighthouse)
73+
- [Teku](https://consensys.io/teku)
74+
- [Lodestar](https://github.com/ChainSafe/lodestar)
75+
- [Prysm](https://prysm.offchainlabs.com/docs/)
76+
- [Grandine](https://docs.grandine.io/)
8677

8778
Technical users can help accelerate this process by writing more tutorials and documentation for minority clients and encouraging their node-operating peers to migrate away from the dominant clients. Guides for switching to a minority consensus client are available on [clientdiversity.org](https://clientdiversity.org/).
8879

public/content/developers/docs/nodes-and-clients/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Documentation can be found in [Lighthouse Book](https://lighthouse-book.sigmapri
214214

215215
Lodestar is a production-ready consensus client implementation written in Typescript under the LGPL-3.0 license. It is maintained by ChainSafe Systems and is the newest of the consensus clients for solo-stakers, developers and researchers. Lodestar consists of a beacon node and validator client powered by JavaScript implementations of Ethereum protocols. Lodestar aims to improve Ethereum usability with light clients, expand accessibility to a larger group of developers and further contribute to ecosystem diversity.
216216

217-
More information can be found on our [Lodestar website](https://lodestar.chainsafe.io/)
217+
More information can be found on the [Lodestar website](https://lodestar.chainsafe.io/)
218218

219219
### Nimbus {#nimbus}
220220

0 commit comments

Comments
 (0)