From 5ef8d4cb300b65c37ba41e56a817309af2ed3b46 Mon Sep 17 00:00:00 2001
From: zerosnacks <95942363+zerosnacks@users.noreply.github.com>
Date: Thu, 6 Jun 2024 22:22:17 +0200
Subject: [PATCH] chore(docs): add doc aliases for `Tx` prefixed names (#649)

add doc aliases
---
 crates/primitives/src/aliases.rs | 3 +++
 crates/primitives/src/common.rs  | 1 +
 2 files changed, 4 insertions(+)

diff --git a/crates/primitives/src/aliases.rs b/crates/primitives/src/aliases.rs
index 42a64c30c..7b4f5c383 100644
--- a/crates/primitives/src/aliases.rs
+++ b/crates/primitives/src/aliases.rs
@@ -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).
diff --git a/crates/primitives/src/common.rs b/crates/primitives/src/common.rs
index 8064144f5..13b358d14 100644
--- a/crates/primitives/src/common.rs
+++ b/crates/primitives/src/common.rs
@@ -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]