Skip to content

Commit 223a2d6

Browse files
authored
fix: Documentation Corrections and Clarifications (#1962)
* Update precompile.md * Update builder.md * Update kzg.md
1 parent 6f3d9f8 commit 223a2d6

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

documentation/src/crates/precompile.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The `precompile` crate contains the implementation of the Ethereum precompile opcodes in the EVM.
44
Precompiles are a shortcut to execute a function implemented by the EVM itself, rather than an actual contract.
55
Precompiled contracts are essentially predefined smart contracts on Ethereum, residing at hardcoded addresses and used for computationally heavy operations that are cheaper when implemented this way.
6-
There are 6 precompiles implemented in REVM, and they are: `blake2`, `bn128` curve, `identity`, `secp256k1`, `modexp`, and `sha256` and `ripemd160` hash functions.
6+
There are 7 precompiles implemented in REVM, and they are: `blake2`, `bn128` curve, `identity`, `secp256k1`, `modexp`, and `sha256` and `ripemd160` hash functions.
77

88
### Modules:
99

documentation/src/crates/primitives/kzg.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# KZG
22

3-
With the introduction of [EIP4844](https://eips.ethereum.org/EIPS/eip-4844), this use of blobs for a more efficient short term storage is employed, the validity of this blob stored in the consensus layer is verified using the `Point Evaluation` pre-compile, a fancy way of verifying that and evaluation at a given point of a committed polynomial is valid, in a much more bigger scale, implies that `Data is Available`.
3+
With the introduction of [EIP4844](https://eips.ethereum.org/EIPS/eip-4844), this use of blobs for a more efficient short term storage is employed, the validity of this blob stored in the consensus layer is verified using the `Point Evaluation` pre-compile, a fancy way of verifying that and evaluation at a given point of a committed polynomial is valid, on a much bigger scale, implies that `Data is Available`.
44

55
This module houses;
66

documentation/src/crates/revm/builder.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ The builder creates or modifies the EVM and applies different handlers.
44
It allows setting external context and registering handler custom logic.
55

66
The revm `Evm` consists of `Context` and `Handler`.
7-
`Context` is additionally split between `EvmContext` (contains generic `Database`) and `External` context (generic without restrain).
7+
`Context` is additionally split between `EvmContext` (contains generic `Database`) and `External` context (generic without restraint).
88
Read [evm](./evm.md) for more information on the internals.
99

1010
The `Builder` ties dependencies between generic `Database`, `External` context and `Spec`.
11-
It allows handle registers to be added that implement logic on those generics.
11+
It allows handler registers to be added that implement logic on those generics.
1212
As they are interconnected, setting `Database` or `ExternalContext` resets handle registers, so builder stages are introduced to mitigate those misuses.
1313

1414
Simple example of using `EvmBuilder`:
@@ -28,7 +28,7 @@ There are two builder stages that are used to mitigate potential misuse of the b
2828
- `SetGenericStage`: Initial stage that allows setting the database and external context.
2929
- `HandlerStage`: Allows setting the handler registers but is explicit about setting new generic type as it will void the handler registers.
3030

31-
Functions from one stage are just renamed functions from other stage, it is made so that user is more aware of what underlying function does.
31+
Functions from one stage are just renamed functions from other stage, it is made so that the user is more aware of what underlying function does.
3232
For example, in `SettingDbStage` we have `with_db` function while in `HandlerStage` we have `reset_handler_with_db`, both of them set the database but the latter also resets the handler.
3333
There are multiple functions that are common to both stages such as `build`.
3434

@@ -164,7 +164,7 @@ fn main() {
164164
## Appending handler registers
165165

166166
Handler registers are simple functions that allow modifying the `Handler` logic by replacing the handler functions.
167-
They are used to add custom logic to the evm execution but as they are free to modify the `Handler` in any form they want.
167+
They are used to add custom logic to the evm execution but they are free to modify the `Handler` in any form they want.
168168
There may be conflicts if handlers that override the same function are added.
169169

170170
The most common use case for adding new logic to `Handler` is `Inspector` that is used to inspect the execution of the evm.

0 commit comments

Comments
 (0)