Skip to content

Commit 1302e00

Browse files
committed
Fix cargo doc warnings
1 parent 454dc3f commit 1302e00

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

crates/edr_eth/src/transaction/request.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ use crate::{signature::SignatureError, transaction::SignedTransaction, Address,
1717
///
1818
/// Its variants correspond to specific allowed transactions:
1919
/// 1. Legacy (pre-EIP2718) [`LegacyTransactionRequest`]
20-
/// 2. EIP2930 (state access lists) [`EIP2930TransactionRequest`]
21-
/// 3. EIP1559 [`EIP1559TransactionRequest`]
20+
/// 2. EIP2930 (state access lists) [`Eip2930TransactionRequest`]
21+
/// 3. EIP1559 [`Eip1559TransactionRequest`]
2222
#[derive(Debug, Clone, Eq, PartialEq)]
2323
pub enum TransactionRequest {
2424
/// A legacy transaction request

crates/edr_evm/src/blockchain/forked.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ pub enum CreationError {
5555
},
5656
}
5757

58-
/// Error type for [`RemoteBlockchain`].
58+
/// Error type for `RemoteBlockchain`.
5959
#[derive(Debug, thiserror::Error)]
6060
pub enum ForkedBlockchainError {
6161
/// Remote block creation error

crates/edr_evm/src/transaction.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ where
5353
}
5454
}
5555

56-
/// An error that occurred while trying to construct a [`PendingTransaction`].
56+
/// An error that occurred while trying to construct an [`ExecutableTransaction`].
5757
#[derive(Debug, thiserror::Error)]
5858
pub enum TransactionCreationError {
5959
/// Creating contract without any data.

crates/edr_evm/src/transaction/executable.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ pub struct ExecutableTransaction {
3131
}
3232

3333
impl ExecutableTransaction {
34-
/// Create a [`PendingTransaction`] by attempting to validate and recover
34+
/// Create an [`ExecutableTransaction`] by attempting to validate and recover
3535
/// the caller address of the provided transaction.
3636
pub fn new(
3737
spec_id: SpecId,
@@ -44,7 +44,7 @@ impl ExecutableTransaction {
4444
Self::with_caller(spec_id, transaction, caller)
4545
}
4646

47-
/// Creates a [`PendingTransaction`] with the provided transaction and
47+
/// Creates an [`ExecutableTransaction`] with the provided transaction and
4848
/// caller address.
4949
pub fn with_caller(
5050
spec_id: SpecId,
@@ -69,7 +69,7 @@ impl ExecutableTransaction {
6969
})
7070
}
7171

72-
/// Returns the [`PendingTransaction`]'s caller.
72+
/// Returns the [`ExecutableTransaction`]'s caller.
7373
pub fn caller(&self) -> &Address {
7474
&self.caller
7575
}

crates/edr_provider/src/error.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ pub enum ProviderError<LoggerErrorT> {
6666
latest_block_number: u64,
6767
},
6868
/// The block tag is not allowed in pre-merge hardforks.
69-
/// https://github.com/NomicFoundation/hardhat/blob/b84baf2d9f5d3ea897c06e0ecd5e7084780d8b6c/packages/hardhat-core/src/internal/hardhat-network/provider/modules/eth.ts#L1820
69+
/// <https://github.com/NomicFoundation/hardhat/blob/b84baf2d9f5d3ea897c06e0ecd5e7084780d8b6c/packages/hardhat-core/src/internal/hardhat-network/provider/modules/eth.ts#L1820>
7070
#[error("The '{block_tag}' block tag is not allowed in pre-merge hardforks. You are using the '{spec:?}' hardfork.")]
7171
InvalidBlockTag { block_tag: BlockTag, spec: SpecId },
7272
/// Invalid chain ID
@@ -158,7 +158,7 @@ pub enum ProviderError<LoggerErrorT> {
158158
#[error(transparent)]
159159
TransactionCreationError(#[from] TransactionCreationError),
160160
/// `eth_sendTransaction` failed and
161-
/// [`ProviderConfig::bail_on_call_failure`] was enabled
161+
/// [`crate::config::ProviderConfig::bail_on_call_failure`] was enabled
162162
#[error(transparent)]
163163
TransactionFailed(#[from] TransactionFailureWithTraces),
164164
/// Failed to convert an integer type
@@ -305,7 +305,7 @@ impl std::fmt::Display for TransactionFailureWithTraces {
305305
}
306306
}
307307

308-
/// Wrapper around [`revm_primitives::Halt`] to convert error messages to match
308+
/// Wrapper around [`ExecutionResult::Halt`] to convert error messages to match
309309
/// Hardhat.
310310
#[derive(Clone, Debug, thiserror::Error, serde::Serialize)]
311311
#[serde(rename_all = "camelCase")]

0 commit comments

Comments
 (0)