From 1edfeb6893a4b053170886a026eb5742c5561fa6 Mon Sep 17 00:00:00 2001 From: Pana Date: Mon, 8 Apr 2024 20:56:55 +0800 Subject: [PATCH] Update documentation (#1275) * fix examples->generate_block_traces reuse TracerEip3155.gas_inspector issue * fmt code * clear the eip3155 tracer state so that it can be used in next transaction * print summary and clean state when create_end * update documentation * fix left nits * add cancun upgrade block number * remove outdated doc * remove outdated doc * remove empty file * TS is unit used to trigger the hardork --------- Co-authored-by: rakita --- crates/primitives/src/specification.rs | 2 +- crates/revm/src/frame/frame_or_result.rs | 0 crates/revm/src/frame/result.rs | 0 documentation/src/SUMMARY.md | 2 -- documentation/src/crates/primitives.md | 8 +------- documentation/src/crates/primitives/log.md | 2 ++ 6 files changed, 4 insertions(+), 10 deletions(-) delete mode 100644 crates/revm/src/frame/frame_or_result.rs delete mode 100644 crates/revm/src/frame/result.rs diff --git a/crates/primitives/src/specification.rs b/crates/primitives/src/specification.rs index c976702839..e106e8fd79 100644 --- a/crates/primitives/src/specification.rs +++ b/crates/primitives/src/specification.rs @@ -27,7 +27,7 @@ pub enum SpecId { GRAY_GLACIER = 14, // Gray Glacier 15050000 MERGE = 15, // Paris/Merge 15537394 (TTD: 58750000000000000000000) SHANGHAI = 16, // Shanghai 17034870 (TS: 1681338455) - CANCUN = 17, // Cancun TBD + CANCUN = 17, // Cancun 19426587 (TS: 1710338135) #[default] LATEST = u8::MAX, } diff --git a/crates/revm/src/frame/frame_or_result.rs b/crates/revm/src/frame/frame_or_result.rs deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/crates/revm/src/frame/result.rs b/crates/revm/src/frame/result.rs deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/documentation/src/SUMMARY.md b/documentation/src/SUMMARY.md index 05a9255851..d40b1b2b61 100644 --- a/documentation/src/SUMMARY.md +++ b/documentation/src/SUMMARY.md @@ -20,10 +20,8 @@ - [result](./crates/primitives/result.md) - [environment](./crates/primitives/environment.md) - [specifications](./crates/primitives/specifications.md) - - [bits](./crates/primitives/bits.md) - [bytecode](./crates/primitives/bytecode.md) - [constants](./crates/primitives/constants.md) - - [log](./crates/primitives/log.md) - [precompile](./crates/primitives/precompile.md) - [state](./crates/primitives/state.md) - [utils](./crates/primitives/utils.md) diff --git a/documentation/src/crates/primitives.md b/documentation/src/crates/primitives.md index bc058e5a1d..45d57594ef 100644 --- a/documentation/src/crates/primitives.md +++ b/documentation/src/crates/primitives.md @@ -6,12 +6,10 @@ It is set up to be compatible with environments that do not include Rust's stand ### Modules: -- [bits](./primitives/bits.md): This module provides types for handling specific sizes of byte arrays (Address and B256). - [bytecode](./primitives/bytecode.md): This module provides functionality related to EVM bytecode. - [constants](./primitives/constants.md): This module contains constant values used throughout the EVM implementation. - [db](./primitives/database.md): This module contains data structures and functions related to the EVM's database implementation. - [env](./primitives/environment.md): This module contains types and functions related to the EVM's environment, including block headers, and environment values. -- [log](./primitives/log.md): This module provides types and functionality for Ethereum logs. - [precompile](./primitives/precompile.md): This module contains types related to Ethereum's precompiled contracts. - [result](./primitives/result.md): This module provides types for representing execution results and errors in the EVM. - [specification](./primitives/specifications.md): This module defines types related to Ethereum specifications (also known as hard forks). @@ -30,10 +28,6 @@ It is set up to be compatible with environments that do not include Rust's stand - `ruint`: The ruint crate provides types and functions for big unsigned integer arithmetic. - `c-kzg`: A minimal implementation of the Polynomial Commitments API for EIP-4844, written in C. (With rust bindings) -### Type Aliases: - -- `Hash`: An alias for B256, typically used to represent 256-bit hashes or integer values in Ethereum. - ### Re-exported Types: - `Address`: A type representing a 160-bit (or 20-byte) array, typically used for Ethereum addresses. @@ -43,4 +37,4 @@ It is set up to be compatible with environments that do not include Rust's stand - `HashMap` and `HashSet`: High-performance hash map and hash set data structures from the hashbrown crate. Re-exported Modules: -All types, constants, and functions from the `bytecode`, `constants`, `env`, `log`, `precompile`, `result`, `specification`, `state`, `utilities`, `KzgSettings`, `EnvKzgSettings`, `trusted_setup_points` types and methods were all re-exported, allowing users to import these items directly from the `primitives` crate. +All types, constants, and functions from the `bytecode`, `constants`, `env`, `precompile`, `result`, `specification`, `state`, `utilities`, `KzgSettings`, `EnvKzgSettings`, `trusted_setup_points` types and methods were all re-exported, allowing users to import these items directly from the `primitives` crate. diff --git a/documentation/src/crates/primitives/log.md b/documentation/src/crates/primitives/log.md index 6bd7bcc1e9..accd1be6cc 100644 --- a/documentation/src/crates/primitives/log.md +++ b/documentation/src/crates/primitives/log.md @@ -1,5 +1,7 @@ # Log +> NOTE: This module's types have been replaced by [`alloy_primitives`](https://github.com/alloy-rs/core)'s `Log` and `LogData`. + This piece of Rust code defines a structure called Log which represents an Ethereum log entry. These logs are integral parts of the Ethereum network and are typically produced by smart contracts during execution. Each Log has three components: - `address`: This field represents the address of the log originator, typically the smart contract that generated the log. The `Address` data type signifies a 160-bit Ethereum address.