comments and diff

Author: wlawt

crates/audit/tests/integration_tests.rs

@@ -5,7 +5,7 @@ use tips_audit::{
     storage::{BundleEventS3Reader, S3EventReaderWriter},
     types::{BundleEvent, DropReason},
 };
-use tips_core::test_utils::create_test_bundle;
+use tips_core::test_utils::create_bundle_from_txn_data;
 use uuid::Uuid;
 mod common;
 use common::TestHarness;
@@ -23,7 +23,7 @@ async fn test_kafka_publisher_s3_archiver_integration()
     let test_events = vec![
         BundleEvent::Received {
             bundle_id: test_bundle_id,
-            bundle: Box::new(create_test_bundle(vec![], None, None, None)),
+            bundle: Box::new(create_bundle_from_txn_data()),
         },
         BundleEvent::Dropped {
             bundle_id: test_bundle_id,

crates/audit/tests/s3_test.rs

@@ -10,8 +10,7 @@ use uuid::Uuid;
 
 mod common;
 use common::TestHarness;
-use tips_core::test_utils::TXN_HASH;
-use tips_core::test_utils::create_bundle_from_txn_data;
+use tips_core::test_utils::{TXN_HASH, create_bundle_from_txn_data};
 
 fn create_test_event(key: &str, timestamp: i64, bundle_event: BundleEvent) -> Event {
     Event {

crates/core/src/types.rs

@@ -11,6 +11,7 @@ use uuid::Uuid;
 /// Block time in microseconds
 pub const BLOCK_TIME: u128 = 2_000_000;
 
+/// `Bundle` is the type that mirrors `EthSendBundle` and is used for the API.
 #[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
 pub struct Bundle {
@@ -57,6 +58,7 @@ pub struct Bundle {
     pub dropping_tx_hashes: Vec<TxHash>,
 }
 
+/// `ParsedBundle` is the type that contains utility methods for the `Bundle` type.
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
 pub struct ParsedBundle {
     pub txs: Vec<Recovered<OpTxEnvelope>>,
@@ -129,6 +131,7 @@ pub struct CancelBundle {
     pub replacement_uuid: String,
 }
 
+/// `AcceptedBundle` is the type that is sent over the wire.
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct AcceptedBundle {
     pub uuid: Uuid,