jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

add doc_markdown clippy lint (#8552)

Browse Source 
Co-authored-by: Alexey Shekhirin <a.shekhirin@gmail.com>
Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
This commit is contained in:
Thomas Coratger
2024-06-03 15:21:45 +02:00
committed by GitHub
parent 34af610b8e
commit 7c17c6e469
440 changed files with 2166 additions and 2145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/optimism/payload/src/builder.rs
View File

@ -39,7 +39,7 @@ pub struct OptimismPayloadBuilder<EvmConfig> {
}
impl<EvmConfig> OptimismPayloadBuilder<EvmConfig> {
/// OptimismPayloadBuilder constructor.
/// `OptimismPayloadBuilder` constructor.
pub const fn new(chain_spec: Arc<ChainSpec>, evm_config: EvmConfig) -> Self {
Self { compute_pending_block: true, chain_spec, evm_config }
}
@ -67,7 +67,7 @@ impl<EvmConfig> OptimismPayloadBuilder<EvmConfig> {
}
}
/// Implementation of the [PayloadBuilder] trait for [OptimismPayloadBuilder].
/// Implementation of the [`PayloadBuilder`] trait for [`OptimismPayloadBuilder`].
impl<Pool, Client, EvmConfig> PayloadBuilder<Pool, Client> for OptimismPayloadBuilder<EvmConfig>
where
Client: StateProviderFactory,

2
crates/optimism/payload/src/error.rs
View File

@ -4,7 +4,7 @@
#[derive(Debug, thiserror::Error)]
pub enum OptimismPayloadBuilderError {
/// Thrown when a transaction fails to convert to a
/// [reth_primitives::TransactionSignedEcRecovered].
/// [`reth_primitives::TransactionSignedEcRecovered`].
#[error("failed to convert deposit transaction to TransactionSignedEcRecovered")]
TransactionEcRecoverFailed,
/// Thrown when the L1 block info could not be parsed from the calldata of the

6
crates/optimism/payload/src/payload.rs
View File

@ -27,7 +27,7 @@ use std::sync::Arc;
pub struct OptimismPayloadBuilderAttributes {
/// Inner ethereum payload builder attributes
pub payload_attributes: EthPayloadBuilderAttributes,
/// NoTxPool option for the generated payload
/// `NoTxPool` option for the generated payload
pub no_tx_pool: bool,
/// Transactions for the generated payload
pub transactions: Vec<TransactionSigned>,
@ -41,7 +41,7 @@ impl PayloadBuilderAttributes for OptimismPayloadBuilderAttributes {
/// Creates a new payload builder for the given parent block and the attributes.
///
/// Derives the unique [PayloadId] for the given parent and attributes
/// Derives the unique [`PayloadId`] for the given parent and attributes
fn try_new(parent: B256, attributes: OptimismPayloadAttributes) -> Result<Self, Self::Error> {
let (id, transactions) = {
let transactions: Vec<_> = attributes
@ -298,7 +298,7 @@ impl From<OptimismBuiltPayload> for OptimismExecutionPayloadEnvelopeV4 {
}
}
/// Generates the payload id for the configured payload from the [OptimismPayloadAttributes].
/// Generates the payload id for the configured payload from the [`OptimismPayloadAttributes`].
///
/// Returns an 8-byte identifier by hashing the payload components with sha256 hash.
pub(crate) fn payload_id_optimism(