Benchmark info

zingolib/Cargo.toml

@@ -7,15 +7,16 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
+benchmarks = []
 ci = []
+darkside_tests = []
+default = ["sync"]
 deprecations = ["lightclient-deprecated"]
 lightclient-deprecated = []
-darkside_tests = []
+sync = ['dep:zingo-sync']
+tempfile = ["dep:tempfile"]
 test-elevation = ["portpicker", "testvectors", "tempfile", "tempdir"]
 testvectors = []
-tempfile = ["dep:tempfile"]
-default = ["sync"]
-sync = ['dep:zingo-sync']
 zaino-test = ['test-elevation']
 
 [dependencies]

zingolib/src/testutils.rs

@@ -31,6 +31,8 @@ use regtest::RegtestManager;
 use tokio::time::sleep;
 
 pub mod assertions;
+#[cfg(feature = "benchmarks")]
+pub mod benchmarks;
 pub mod chain_generics;
 pub mod fee_tables;
 /// TODO: Add Doc Comment Here!

zingolib/src/testutils/benchmarks.rs

@@ -0,0 +1,43 @@
+//! a benchmark is a measurement of how quickly zingo can sync.
+//! benchmarks need to take into account many factors
+
+use zcash_primitives::consensus::BlockHeight;
+
+/// all relevant data for a sync.
+/// this struct will convert to json to be saved
+/// todo: distinguish between raw json standard and zingo specific template, add Options
+pub struct SyncBenchmark {
+    network_info: NetworkInfo,
+    system_info: (),
+    account_info: AccountInfo,
+    client_info: ClientInfo,
+    /// /
+    final_time: u64,
+    /// /
+    final_height: BlockHeight,
+    /// /
+    sync_time: u64,
+    /// TODO should this be an alias?
+    synced_blocks: u32,
+}
+
+/// the connected server, indexer, and chain
+/// also, how fast is the network
+pub struct NetworkInfo {
+    url: Url,
+    chain_type: ChainType,
+    bandwidth: (),
+    latency: (),
+}
+/// the hardware and underlying system
+pub struct SystemInfo {}
+/// the account (wallet) being synced
+pub struct AccountInfo {
+    wallet_id: NetworkSeedVersion,
+    hdwallet_accounts: Option<u32>,
+}
+/// the software being used to sync
+pub struct ClientInfo {
+    client: String,
+    version: String,
+}