diff --git a/README.md b/README.md index 720d18d0d..6fab6d91d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ # What is Reth? What are its goals? -Reth (short for Rust Ethereum, [pronunciation](https://twitter.com/kelvinfichter/status/1597653609411268608)) is a new Ethereum full node implementation that is focused on being user-friendly, highly modular, as well as being fast and efficient. Reth is an Execution Layer (EL) and is compatible with all Ethereum Consensus Layer (CL) implementations that support the [Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine/specification.md). It is originally built and driven forward by [Paradigm](https://paradigm.xyz/), and is licensed under the Apache and MIT licenses. +Reth (short for Rust Ethereum, [pronunciation](https://twitter.com/kelvinfichter/status/1597653609411268608)) is a new Ethereum full node implementation that is focused on being user-friendly, highly modular, as well as being fast and efficient. Reth is an Execution Layer (EL) and is compatible with all Ethereum Consensus Layer (CL) implementations that support the [Engine API](https://github.com/ethereum/execution-apis/tree/6709c2a795b707202e93c4f2867fa0bf2640a84f/src/engine). It is originally built and driven forward by [Paradigm](https://paradigm.xyz/), and is licensed under the Apache and MIT licenses. As a full Ethereum node, Reth allows users to connect to the Ethereum network and interact with the Ethereum blockchain. This includes sending and receiving transactions/logs/traces, as well as accessing and interacting with smart contracts. Building a successful Ethereum node requires creating a high-quality implementation that is both secure and efficient, as well as being easy to use on consumer hardware. It also requires building a strong community of contributors who can help support and improve the software. diff --git a/crates/net/rpc-api/src/engine.rs b/crates/net/rpc-api/src/engine.rs index af0c098b4..59e8ea253 100644 --- a/crates/net/rpc-api/src/engine.rs +++ b/crates/net/rpc-api/src/engine.rs @@ -8,16 +8,16 @@ use reth_rpc_types::engine::{ #[cfg_attr(not(feature = "client"), rpc(server))] #[cfg_attr(feature = "client", rpc(server, client))] pub trait EngineApi { - /// See also + /// See also /// Caution: This should not accept the `withdrawals` field #[method(name = "engine_newPayloadV1")] async fn new_payload_v1(&self, payload: ExecutionPayload) -> Result; - /// See also + /// See also #[method(name = "engine_newPayloadV2")] async fn new_payload_v2(&self, payload: ExecutionPayload) -> Result; - /// See also + /// See also /// /// Caution: This should not accept the `withdrawals` field #[method(name = "engine_forkchoiceUpdatedV1")] @@ -27,7 +27,7 @@ pub trait EngineApi { payload_attributes: Option, ) -> Result; - /// See also + /// See also #[method(name = "engine_forkchoiceUpdatedV2")] async fn fork_choice_updated_v2( &self, @@ -35,17 +35,17 @@ pub trait EngineApi { payload_attributes: Option, ) -> Result; - /// See also + /// See also /// /// Caution: This should not return the `withdrawals` field #[method(name = "engine_getPayloadV1")] async fn get_payload_v1(&self, payload_id: H64) -> Result; - /// See also + /// See also #[method(name = "engine_getPayloadV2")] async fn get_payload_v2(&self, payload_id: H64) -> Result; - /// See also + /// See also #[method(name = "engine_exchangeTransitionConfigurationV1")] async fn exchange_transition_configuration( &self, diff --git a/crates/net/rpc-types/src/eth/engine.rs b/crates/net/rpc-types/src/eth/engine.rs index 68f257777..743dcbb93 100644 --- a/crates/net/rpc-types/src/eth/engine.rs +++ b/crates/net/rpc-types/src/eth/engine.rs @@ -1,4 +1,4 @@ -//! Engine API types: and following the execution spec +//! Engine API types: and following the execution specs #![allow(missing_docs)] @@ -7,7 +7,7 @@ use serde::{Deserialize, Serialize}; /// This structure maps on the ExecutionPayload structure of the beacon chain spec. /// -/// See also: +/// See also: #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ExecutionPayload { @@ -26,14 +26,14 @@ pub struct ExecutionPayload { pub block_hash: H256, pub transactions: Vec, /// Array of [`Withdrawal`] enabled with V2 - /// See + /// See #[serde(default, skip_serializing_if = "Option::is_none")] pub withdrawal: Option, } /// This structure maps onto the validator withdrawal object from the beacon chain spec. /// -/// See also: +/// See also: #[derive(Default, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct Withdrawal { @@ -64,7 +64,7 @@ pub struct PayloadAttributes { pub prev_randao: H256, pub suggested_fee_recipient: Address, /// Array of [`Withdrawal`] enabled with V2 - /// See + /// See #[serde(default, skip_serializing_if = "Option::is_none")] pub withdrawal: Option, }