Skip to content

Commit

Permalink
chore: markups
Browse files Browse the repository at this point in the history
  • Loading branch information
0xaatif committed Sep 11, 2024
1 parent ab5c74e commit c86f69f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
7 changes: 3 additions & 4 deletions trace_decoder/src/interface.rs
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,12 @@ pub struct TxnTrace {
#[serde(skip_serializing_if = "Option::is_none")]
pub nonce: Option<U256>,

/// <code>[hash](keccak_hash)([Address])</code> of storages read by the
/// transaction.
/// <code>hash([Address])</code> of storages read by the transaction.
#[serde(default, skip_serializing_if = "BTreeSet::is_empty")]
pub storage_read: BTreeSet<H256>,

/// <code>[hash](keccak_hash)([Address])</code> of storages written by the
/// transaction, with their new value.
/// <code>hash([Address])</code> of storages written by the transaction,
/// with their new value.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub storage_written: BTreeMap<H256, U256>,

Expand Down
5 changes: 1 addition & 4 deletions trace_decoder/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! An _Ethereum Node_[^1] executes _transactions_ in _blocks_.
//! An _Ethereum Node_ executes _transactions_ in _blocks_.
//!
//! Execution mutates two key data structures:
//! - [The state trie](https://ethereum.org/en/developers/docs/data-structures-and-encoding/patricia-merkle-trie/#state-trie).
Expand Down Expand Up @@ -31,9 +31,6 @@
//! (since prover performance is sensitive to the size of the trie).
//! The prover can therefore prove each batch of transactions independently.
//!
//! [^1]: In our stack, this is [a fork of erigon](https://github.com/0xPolygonZero/erigon),
//! which exposes more information over RPC.
//!
//! # Non-goals
//! - Performance - this will never be the bottleneck in any proving stack.
//! - Robustness - this library depends on other libraries that are not robust,
Expand Down

0 comments on commit c86f69f

Please sign in to comment.