Skip to content

Commit b93a6f2

Browse files
authored
chore: docs nits (#2292)
* chore: docs cleanup * chore: few docs
1 parent 0abc5a7 commit b93a6f2

File tree

5 files changed

+13
-15
lines changed

5 files changed

+13
-15
lines changed

book/src/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can use REVM in two main ways:
77
1. Run regular Ethereum transactions using a Execution API
88
2. Create your own custom version of the EVM (for Layer 2 solutions or other chains) using EVM framework
99

10-
To see usage examples you can check the [examples folder](https://github.com/bluealloy/revm/tree/ main/examples). Other than documentation, examples are main resource to see and learn about Revm.
10+
To see usage examples you can check the [examples folder](https://github.com/bluealloy/revm/tree/main/examples). Other than documentation, examples are main resource to see and learn about Revm.
1111

1212
The main `revm` library combines all crates into one package and reexports them, standalone library are useful if there is need to import functionality with smaller scope. You can see overview of revm crates in [crates folder](https://github.com/bluealloy/revm/tree/main/crates).
1313

book/src/awesome.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,12 @@ A curated list of excellent Revm-related resources. Feel free to contribute to t
3535
- [**Revmc:**](https://github.com/paradigmxyz/revmc) JIT and AOT compiler for the Ethereum Virtual Machine, leveraging Revm.
3636
- [**Risc0-ethereum**](https://github.com/risc0/risc0-ethereum) is a zero-knowledge verifiable general computing platform, with Ethereum integration
3737
- [**Kona**](https://github.com/op-rs/kona) is a suite of portable implementations of the OP Stack rollup state transition, namely the derivation pipeline and the block execution logic.
38+
- [**mevlog-rs**](https://github.com/pawurb/mevlog-rs): Rust-based CLI tool for querying and monitoring Ethereum blockchain transactions, with flexible filtering and EVM tracing capabilities. It's a tool for MEV searchers who prefer command-line workflows over web-based explorers.
3839

3940

4041
#### Tutorials
4142
- (**MyEvm**)
4243
- **Revm is All You Need:** Guide on building simulated blockchain environments. Link: https://medium.com/@solidquant/revm-is-all-you-need-e01b5b0421e4
4344
- [**Uniswap Swap Example:**](https://github.com/bluealloy/revm/tree/main/examples/uniswap_get_reserves) Demonstrates a USDC swap on Uniswap V2.evm is available in the [awesome-revm](./awesome.md) section o
44-
- [**revm-by-example:**](https://github.com/Cionn3/revm-by-example) Practical examples using the Rust Ethereum Virtual Machine.
45+
- [**revm-by-example:**](https://github.com/Cionn3/revm-by-example) Practical examples using the Rust Ethereum Virtual Machine.
46+
- How to Discover long-tail MEV Strategies using Revm: https://pawelurbanek.com/long-tail-mev-revm

book/src/contact.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
1313

1414
### Security
1515

16-
If there is security question/findings please contact me directly on email at`[email protected]` or on keybase [@draganrakita](https://keybase.io/draganrakita/).
16+
If there is security question/findings please contact me directly on email at`[email protected]` or on keybase `@draganrakita`
1717

crates/database/src/states/state.rs

-3
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,6 @@ impl<DB: Database> State<DB> {
8787
///
8888
/// Update will create transitions for all accounts that are updated.
8989
///
90-
/// Like [CacheAccount::increment_balance], this assumes that incremented balances are not
91-
/// zero, and will not overflow once incremented.
92-
///
9390
/// If using this to implement withdrawals, zero balances must be filtered out before calling this function.
9491
pub fn increment_balances(
9592
&mut self,

examples/README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# examples:
2-
* block_traces:
3-
* contract_deployment:
4-
* database_components:
5-
* uniswap_get_reserves:
6-
* uniswap_v2_usdc_swap:
7-
* erc20_gas:
8-
* my_evm:
9-
* custom_opcodes:
10-
* #cheatcode_inspector:
2+
* `contract_deployment`: Example of deployment of the contract from solidity compilation and calling deployed contract.
3+
* `my_evm`: Example and tutorial on how to create your custom evm.
4+
* `erc20_gas`: Example of custom EVM that uses ERC20 token to pay for Gas.
5+
* `uniswap_get_reserves`: Example of using alloy to fetch state and sol! to call a function of the contract.
6+
* `uniswap_v2_usdc_swap`: Similar to `uniswap_get_reserves` with more examples of usage.
7+
* `block_traces`: Uses Alloy to fetch blocks transaction and state from provider to execute full block. It uses Eip3155 opcode tracer and saves output to the file.
8+
* `custom_opcodes`: Example of introducing a custom instruction to the mainnet Evm.
9+
* `database_components`: Example of decouples Database in `State` and `BlockHash` and how to use it inside Revm.

0 commit comments

Comments
 (0)