Skip to content

Commit

Permalink
chore(docs): add doc aliases for Tx prefixed names (#649)
Browse files Browse the repository at this point in the history
add doc aliases
  • Loading branch information
zerosnacks authored Jun 6, 2024
1 parent bf965fd commit 5ef8d4c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
3 changes: 3 additions & 0 deletions crates/primitives/src/aliases.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,15 @@ pub type BlockHash = B256;
pub type BlockNumber = u64;

/// A transaction hash is a keccak hash of an RLP encoded signed transaction.
#[doc(alias = "TransactionHash")]
pub type TxHash = B256;

/// The sequence number of all existing transactions.
#[doc(alias = "TransactionNumber")]
pub type TxNumber = u64;

/// The index of transaction in a block.
#[doc(alias = "TransactionIndex")]
pub type TxIndex = u64;

/// Chain identifier type (introduced in EIP-155).
Expand Down
1 change: 1 addition & 0 deletions crates/primitives/src/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use alloy_rlp::{Buf, BufMut, Decodable, Encodable, EMPTY_STRING_CODE};
/// contract creation.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
#[cfg_attr(feature = "arbitrary", derive(derive_arbitrary::Arbitrary, proptest_derive::Arbitrary))]
#[doc(alias = "TransactionKind")]
pub enum TxKind {
/// A transaction that creates a contract.
#[default]
Expand Down

0 comments on commit 5ef8d4c

Please sign in to comment.