refactor(tx-cache): rename types for clarity (#194)

* refactor(tx-cache): rename types for clarity

Rename tx-cache types to remove redundant TxCache prefix and improve naming:

- TxCacheBundle → CachedBundle
- TxCacheBundlesResponse → BundleList
- TxCacheSendBundleResponse → BundleReceipt
- TxCacheTransactionsResponse → TransactionList
- TxCacheSendTransactionResponse → TransactionReceipt
- TxCacheOrdersResponse → OrderList
- TxCacheSendOrderResponse → OrderReceipt

Deleted TxCacheBundleResponse as it was just a wrapper around CachedBundle.

All old type names are preserved as deprecated type aliases for
backwards compatibility.

Closes ENG-1569

* fix: correct deprecated since version to 0.16.0

Addresses review feedback from @prestwich - the deprecated type alias
annotations incorrectly used 0.2.0 instead of the current workspace version.

* refactor(tx-cache): rename Receipt to Response

Address PR #194 review feedback from Evalir: rename all *Receipt types
to *Response to avoid confusion with Ethereum's transaction receipt concept.

Changes:
- BundleReceipt → BundleResponse
- TransactionReceipt → TransactionResponse
- OrderReceipt → OrderResponse

Deprecated type aliases are added for backwards compatibility, pointing
old names (including the old TxCacheSend* types and *Receipt types) to
the new *Response types.

Author: init4samwise

crates/orders/src/impls/tx_cache.rs

@@ -2,7 +2,7 @@ use crate::{BundleSubmitter, OrderSource, OrderSubmitter};
 use futures_util::future::Either;
 use futures_util::stream::{self, Stream, StreamExt};
 use signet_bundle::SignetEthBundle;
-use signet_tx_cache::{types::TxCacheSendBundleResponse, TxCache, TxCacheError};
+use signet_tx_cache::{types::BundleResponse, TxCache, TxCacheError};
 use signet_types::SignedOrder;
 
 impl OrderSubmitter for TxCache {
@@ -34,7 +34,7 @@ impl OrderSource for TxCache {
 }
 
 impl BundleSubmitter for TxCache {
-    type Response = TxCacheSendBundleResponse;
+    type Response = BundleResponse;
     type Error = TxCacheError;
 
     async fn submit_bundle(&self, bundle: SignetEthBundle) -> Result<Self::Response, Self::Error> {

crates/tx-cache/src/client.rs

@@ -1,7 +1,7 @@
 use crate::error::Result;
 use crate::types::{
-    CacheObject, CacheResponse, OrderKey, TxCacheOrdersResponse, TxCacheSendBundleResponse,
-    TxCacheSendTransactionResponse, TxCacheTransactionsResponse, TxKey,
+    BundleResponse, CacheObject, CacheResponse, OrderKey, OrderList, TransactionList,
+    TransactionResponse, TxKey,
 };
 use alloy::consensus::TxEnvelope;
 use serde::{de::DeserializeOwned, Serialize};
@@ -145,18 +145,15 @@ impl TxCache {
     ///
     /// # Returns
     ///
-    /// A [`TxCacheSendTransactionResponse`] containing the transaction's cache
+    /// A [`TransactionResponse`] containing the transaction's cache
     /// identifier on success.
     ///
     /// # Errors
     ///
     /// Returns an error if the request fails or the transaction cache rejects
     /// the transaction.
     #[instrument(skip_all)]
-    pub async fn forward_raw_transaction(
-        &self,
-        tx: TxEnvelope,
-    ) -> Result<TxCacheSendTransactionResponse> {
+    pub async fn forward_raw_transaction(&self, tx: TxEnvelope) -> Result<TransactionResponse> {
         self.forward_inner(TRANSACTIONS, tx).await
     }
 
@@ -172,18 +169,15 @@ impl TxCache {
     ///
     /// # Returns
     ///
-    /// A [`TxCacheSendBundleResponse`] containing the bundle's cache identifier
+    /// A [`BundleResponse`] containing the bundle's cache identifier
     /// (UUID) on success.
     ///
     /// # Errors
     ///
     /// Returns an error if the request fails or the transaction cache rejects
     /// the bundle.
     #[instrument(skip_all)]
-    pub async fn forward_bundle(
-        &self,
-        bundle: SignetEthBundle,
-    ) -> Result<TxCacheSendBundleResponse> {
+    pub async fn forward_bundle(&self, bundle: SignetEthBundle) -> Result<BundleResponse> {
         self.forward_inner(BUNDLES, bundle).await
     }
 
@@ -219,7 +213,7 @@ impl TxCache {
     ///
     /// # Returns
     ///
-    /// A [`CacheResponse`] containing a [`TxCacheTransactionsResponse`] with
+    /// A [`CacheResponse`] containing a [`TransactionList`] with
     /// the transactions and pagination information. If more transactions are
     /// available, the response will contain a key to fetch the next page.
     ///
@@ -230,7 +224,7 @@ impl TxCache {
     pub async fn get_transactions(
         &self,
         query: Option<TxKey>,
-    ) -> Result<CacheResponse<TxCacheTransactionsResponse>> {
+    ) -> Result<CacheResponse<TransactionList>> {
         self.get_inner(TRANSACTIONS, query).await
     }
 
@@ -248,18 +242,15 @@ impl TxCache {
     ///
     /// # Returns
     ///
-    /// A [`CacheResponse`] containing a [`TxCacheOrdersResponse`] with the
+    /// A [`CacheResponse`] containing an [`OrderList`] with the
     /// orders and pagination information. If more orders are available, the
     /// response will contain a key to fetch the next page.
     ///
     /// # Errors
     ///
     /// Returns an error if the request fails or the response cannot be parsed.
     #[instrument(skip_all)]
-    pub async fn get_orders(
-        &self,
-        query: Option<OrderKey>,
-    ) -> Result<CacheResponse<TxCacheOrdersResponse>> {
+    pub async fn get_orders(&self, query: Option<OrderKey>) -> Result<CacheResponse<OrderList>> {
         self.get_inner(ORDERS, query).await
     }
 }