Skip to content

Commit 686b3c8

Browse files
authored
docs(evm): clarify executable tx parts (#362)
1 parent db97017 commit 686b3c8

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

crates/evm/src/block/mod.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ impl<T> Default for BlockExecutionResult<T> {
5555
/// Helper trait to encapsulate requirements for a type to be used as input for [`BlockExecutor`].
5656
///
5757
/// This trait combines the requirements for a transaction to be executable by a block executor:
58-
/// - Must be convertible to the EVM's transaction environment
58+
/// - Must be convertible to the EVM's transaction environment, such as revm's
59+
/// [`TxEnv`](revm::context::TxEnv)
5960
/// - Must provide access to the transaction and signer via [`RecoveredTx`]
6061
///
6162
/// The trait ensures that the block executor can both execute the transaction in the EVM
@@ -72,7 +73,8 @@ pub trait ExecutableTxParts<TxEnv, T> {
7273
/// The recovered transaction accessor type.
7374
type Recovered: RecoveredTx<T>;
7475

75-
/// Converts the transaction to an executable environment and a recovered transaction itself.
76+
/// Converts the transaction into the executable transaction environment (`TxEnv`) and the
77+
/// original recovered transaction.
7678
fn into_parts(self) -> (TxEnv, Self::Recovered);
7779
}
7880

0 commit comments

Comments
 (0)