Skip to content

Commit e86f6c2

Browse files
authored
fix: small docs improvements (#74)
* fix: small docs improvements * fix: grammar
1 parent f771d1d commit e86f6c2

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

src/lib.rs

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
//! [`Trevm`] - a typestate interface to [`revm`].
22
//!
3-
//! Tevm provides a safe and low-overhead way to interact with the EVM. It is
3+
//! Trevm provides a safe and low-overhead way to interact with the EVM. It is
44
//! based on the [typestate pattern], which allows the compiler to enforce
55
//! correct usage of the EVM.
66
//!
7-
//! Tevm is NOT an EVM implementation. It is a thin wrapper around the EVM
7+
//! Trevm is NOT an EVM implementation. It is a thin wrapper around the EVM
88
//! provided by [`revm`].
99
//!
1010
//! [`Trevm`] models the EVM as a state machine with the following states:
@@ -40,7 +40,7 @@
4040
//!
4141
//! ```
4242
//! use revm::{EvmBuilder, db::InMemoryDB};
43-
//! use trevm::{TrevmBuilder, EvmErrored, Cfg, Block, Tx, };
43+
//! use trevm::{TrevmBuilder, EvmErrored, Cfg, Block, Tx};
4444
//!
4545
//! # fn t<C: Cfg, B: Block, T: Tx>(cfg: &C, block: &B, tx: &T)
4646
//! # -> Result<(), Box<dyn std::error::Error>> {
@@ -68,7 +68,7 @@
6868
//! `()` for `Ext`, unless specifically using an inspector or a customized EVM.
6969
//!
7070
//! To help you use concrete types, we provide the [`trevm_aliases`] macro. This
71-
//! macro generates type aliases for the Trevm states with a concrete `Ext` and
71+
//! macro generates type aliases for the Trevm states with concrete `Ext` and `Db` types.
7272
//!
7373
//! ```
7474
//! use trevm::trevm_aliases;
@@ -97,10 +97,10 @@
9797
//! requests by crediting accounts.
9898
//! - [`eip6110`] - Prague's [EIP-6110], which extracts deposit
9999
//! requests from the withdrawal contract events.
100-
//! - [`eip7002`] - Prague's [EIP-7002], which extracts withdrawal requestss
101-
//! from the system withdrwal contract state.
100+
//! - [`eip7002`] - Prague's [EIP-7002], which extracts withdrawal requests
101+
//! from the system withdrawal contract state.
102102
//! - [`eip7251`] - Prague's [EIP-7251], which extracts
103-
//! consolidation requestss from the system consolidation contract state.
103+
//! consolidation requests from the system consolidation contract state.
104104
//!
105105
//! The [`BlockDriver`] and [`ChainDriver`] trait methods take a mutable
106106
//! reference to allow the driver to accumulate information about the
@@ -287,7 +287,7 @@
287287
//!
288288
//! ## Happy Path Loop
289289
//!
290-
//! The most simple, straightforward application of Tevm is applying a
290+
//! The most simple, straightforward application of Trevm is applying a
291291
//! set of transaction to the EVM. This is done by following :
292292
//!
293293
//! ```none
@@ -339,6 +339,7 @@
339339
//! [crate readme]: https://github.com/init4tt/trevm
340340
//! [EIP-2537]: https://eips.ethereum.org/EIPS/eip-2537
341341
//! [EIP-2935]: https://eips.ethereum.org/EIPS/eip-2935
342+
//! [EIP-4788]: https://eips.ethereum.org/EIPS/eip-4788
342343
//! [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844
343344
//! [EIP-4895]: https://eips.ethereum.org/EIPS/eip-4895
344345
//! [EIP-6110]: https://eips.ethereum.org/EIPS/eip-6110

0 commit comments

Comments
 (0)