mithril_common/test_utils/cardano_transactions_builder.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
use crate::entities::{BlockNumber, BlockRange, CardanoTransaction, SlotNumber};
/// Builder to easily build transactions with consistent values.
///
/// Note: the names generated for the transaction hashes and block hashes are not meaningful.
///
/// # Example 'build_transactions'
///
/// ```
/// use mithril_common::entities::{BlockNumber, CardanoTransaction, SlotNumber};
/// use mithril_common::test_utils::CardanoTransactionsBuilder;
///
/// let txs = CardanoTransactionsBuilder::new()
/// .max_transactions_per_block(3)
/// .blocks_per_block_range(2)
/// .build_transactions(8);
///
/// assert_eq!(8, txs.len());
/// assert_eq!(
/// vec![
/// CardanoTransaction::new("tx-hash-0-100", BlockNumber(0), SlotNumber(100), "block-hash-0"),
/// CardanoTransaction::new("tx-hash-0-101", BlockNumber(0), SlotNumber(101), "block-hash-0"),
/// CardanoTransaction::new("tx-hash-0-102", BlockNumber(0), SlotNumber(102), "block-hash-0"),
/// CardanoTransaction::new("tx-hash-1-103", BlockNumber(1), SlotNumber(103), "block-hash-1"),
/// CardanoTransaction::new("tx-hash-1-104", BlockNumber(1), SlotNumber(104), "block-hash-1"),
/// CardanoTransaction::new("tx-hash-1-105", BlockNumber(1), SlotNumber(105), "block-hash-1"),
/// CardanoTransaction::new("tx-hash-15-106", BlockNumber(15), SlotNumber(106), "block-hash-15"),
/// CardanoTransaction::new("tx-hash-15-107", BlockNumber(15), SlotNumber(107), "block-hash-15")
/// ],
/// txs
/// );
/// ```
///
/// # Example 'build_block_ranges'
///
/// ```
/// use mithril_common::entities::{BlockNumber, CardanoTransaction, SlotNumber};
/// use mithril_common::test_utils::CardanoTransactionsBuilder;
///
/// let txs = CardanoTransactionsBuilder::new()
/// .max_transactions_per_block(3)
/// .blocks_per_block_range(2)
/// .build_block_ranges(2);
///
/// assert_eq!(3 * 2 * 2, txs.len());
/// assert_eq!(
/// vec![
/// CardanoTransaction::new("tx-hash-0-100", BlockNumber(0), SlotNumber(100), "block-hash-0"),
/// CardanoTransaction::new("tx-hash-0-101", BlockNumber(0), SlotNumber(101), "block-hash-0"),
/// CardanoTransaction::new("tx-hash-0-102", BlockNumber(0), SlotNumber(102), "block-hash-0"),
/// CardanoTransaction::new("tx-hash-1-103", BlockNumber(1), SlotNumber(103), "block-hash-1"),
/// CardanoTransaction::new("tx-hash-1-104", BlockNumber(1), SlotNumber(104), "block-hash-1"),
/// CardanoTransaction::new("tx-hash-1-105", BlockNumber(1), SlotNumber(105), "block-hash-1"),
/// CardanoTransaction::new("tx-hash-15-106", BlockNumber(15), SlotNumber(106), "block-hash-15"),
/// CardanoTransaction::new("tx-hash-15-107", BlockNumber(15), SlotNumber(107), "block-hash-15"),
/// CardanoTransaction::new("tx-hash-15-108", BlockNumber(15), SlotNumber(108), "block-hash-15"),
/// CardanoTransaction::new("tx-hash-16-109", BlockNumber(16), SlotNumber(109), "block-hash-16"),
/// CardanoTransaction::new("tx-hash-16-110", BlockNumber(16), SlotNumber(110), "block-hash-16"),
/// CardanoTransaction::new("tx-hash-16-111", BlockNumber(16), SlotNumber(111), "block-hash-16"),
/// ],
/// txs
/// );
/// ```
pub struct CardanoTransactionsBuilder {
max_transactions_per_block: usize,
max_blocks_per_block_range: usize,
}
impl Default for CardanoTransactionsBuilder {
fn default() -> Self {
Self::new()
}
}
impl CardanoTransactionsBuilder {
/// [CardanoTransactionsBuilder] constructor.
pub fn new() -> Self {
Self {
max_transactions_per_block: 1,
max_blocks_per_block_range: 1,
}
}
/// Define how many transactions we generate in each block.
pub fn max_transactions_per_block(mut self, transactions_per_block: usize) -> Self {
self.max_transactions_per_block = transactions_per_block;
self
}
/// Define how many blocks we generate in each block_range.
/// If we set too many blocks for a block_range, this function panic.
pub fn blocks_per_block_range(mut self, blocks_per_block_range: usize) -> Self {
if blocks_per_block_range > *BlockRange::LENGTH as usize {
panic!(
"blocks_per_block_range should be less than {}",
BlockRange::LENGTH
);
}
self.max_blocks_per_block_range = blocks_per_block_range;
self
}
/// Build the number of transactions requested.
pub fn build_transactions(self, transactions_count: usize) -> Vec<CardanoTransaction> {
let mut transactions = Vec::new();
let first_transaction_number = 100;
for tx_index in 0..transactions_count {
let block_number = self.block_number_from_transaction_index(tx_index);
let slot_number = SlotNumber(tx_index as u64 + first_transaction_number);
transactions.push(self.create_transaction(slot_number, block_number))
}
transactions
}
/// Build a list of transactions to get the number of block range requested.
pub fn build_block_ranges(self, block_ranges_count: usize) -> Vec<CardanoTransaction> {
let nb_txs =
block_ranges_count * self.max_blocks_per_block_range * self.max_transactions_per_block;
self.build_transactions(nb_txs)
}
fn block_number_from_transaction_index(&self, tx_index: usize) -> BlockNumber {
let max_transactions_per_block_range =
self.max_transactions_per_block * self.max_blocks_per_block_range;
let index_block_range = tx_index / max_transactions_per_block_range;
let block_index_global = tx_index as u64 / self.max_transactions_per_block as u64;
let block_index_in_block_range =
block_index_global % self.max_blocks_per_block_range as u64;
index_block_range as u64 * BlockRange::LENGTH + block_index_in_block_range
}
/// Create a transaction with a given index and block number.
fn create_transaction(
&self,
slot_number: SlotNumber,
block_number: BlockNumber,
) -> CardanoTransaction {
CardanoTransaction::new(
format!("tx-hash-{}-{}", block_number, slot_number),
block_number,
slot_number,
format!("block-hash-{block_number}"),
)
}
}
#[cfg(test)]
mod test {
use std::collections::{HashMap, HashSet};
use super::*;
fn count_distinct_values<T, R>(list: &[T], extract_value: &dyn Fn(&T) -> R) -> usize
where
R: Eq + std::hash::Hash,
{
list.iter().map(extract_value).collect::<HashSet<R>>().len()
}
fn group_by<'a, T, R>(list: &'a [T], extract_value: &dyn Fn(&T) -> R) -> HashMap<R, Vec<&'a T>>
where
R: Eq + std::hash::Hash,
{
let mut grouped_by_block = HashMap::new();
for t in list {
grouped_by_block
.entry(extract_value(t))
.or_insert(Vec::new())
.push(t);
}
grouped_by_block
}
#[test]
fn return_given_number_of_transactions_with_distinct_values() {
let txs = CardanoTransactionsBuilder::new().build_transactions(3);
assert_eq!(txs.len(), 3);
assert_eq!(
3,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(3, count_distinct_values(&txs, &|t| t.block_number));
assert_eq!(3, count_distinct_values(&txs, &|t| t.slot_number));
assert_eq!(3, count_distinct_values(&txs, &|t| t.block_hash.clone()));
}
#[test]
fn return_all_transactions_in_same_block_when_ask_less_transactions_than_transactions_per_block(
) {
let txs = CardanoTransactionsBuilder::new()
.max_transactions_per_block(10)
.build_transactions(3);
assert_eq!(txs.len(), 3);
assert_eq!(
3,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(1, count_distinct_values(&txs, &|t| t.block_number));
assert_eq!(1, count_distinct_values(&txs, &|t| t.block_hash.clone()));
}
#[test]
fn return_no_more_transactions_in_a_same_block_than_number_per_block_requested() {
let txs = CardanoTransactionsBuilder::new()
.max_transactions_per_block(3)
.build_transactions(12);
assert_eq!(txs.len(), 12);
assert_eq!(
12,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(4, count_distinct_values(&txs, &|t| t.block_number));
assert_eq!(4, count_distinct_values(&txs, &|t| t.block_hash.clone()));
}
#[test]
fn only_the_last_block_is_not_full_when_we_can_not_fill_all_blocks() {
let txs = CardanoTransactionsBuilder::new()
.max_transactions_per_block(5)
.build_transactions(12);
assert_eq!(txs.len(), 12);
assert_eq!(
12,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(3, count_distinct_values(&txs, &|t| t.block_number));
let grouped_by_block = group_by(&txs, &|t| t.block_number);
let mut txs_per_block: Vec<_> = grouped_by_block.values().map(|v| v.len()).collect();
txs_per_block.sort();
assert_eq!(vec![2, 5, 5], txs_per_block);
}
#[test]
fn generate_one_block_range_return_one_transaction_by_default() {
let txs = CardanoTransactionsBuilder::new().build_block_ranges(1);
assert_eq!(txs.len(), 1);
}
#[test]
fn build_block_ranges_return_the_number_of_block_ranges_requested() {
let block_ranges = 3;
let txs = CardanoTransactionsBuilder::new().build_block_ranges(block_ranges);
assert_eq!(txs.len(), 3);
assert_eq!(
3,
count_distinct_values(&txs, &|t| BlockRange::start(t.block_number))
);
}
#[test]
fn build_block_ranges_return_many_transactions_per_block_when_requested() {
let txs = CardanoTransactionsBuilder::new()
.max_transactions_per_block(5)
.build_block_ranges(3);
assert_eq!(txs.len(), 3 * 5);
assert_eq!(
3 * 5,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(
3,
count_distinct_values(&txs, &|t| BlockRange::start(t.block_number))
);
assert_eq!(3, count_distinct_values(&txs, &|t| t.block_number));
assert_eq!(3, count_distinct_values(&txs, &|t| t.block_hash.clone()));
}
#[test]
fn build_block_ranges_with_many_blocks_per_block_ranges() {
let txs = CardanoTransactionsBuilder::new()
.max_transactions_per_block(5)
.blocks_per_block_range(2)
.build_block_ranges(3);
assert_eq!(txs.len(), 3 * 2 * 5);
assert_eq!(
3 * 2 * 5,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(
3,
count_distinct_values(&txs, &|t| BlockRange::start(t.block_number))
);
assert_eq!(3 * 2, count_distinct_values(&txs, &|t| t.block_number));
assert_eq!(
3 * 2,
count_distinct_values(&txs, &|t| t.block_hash.clone())
);
}
#[test]
fn build_transactions_with_many_blocks_per_block_ranges() {
let txs = CardanoTransactionsBuilder::new()
.max_transactions_per_block(5)
.blocks_per_block_range(2)
.build_transactions(18);
// block range 1 - block 0 - 1, 2, 3, 4, 5
// block range 1 - block 1 - 6, 7, 8, 7, 10
// block range 2 - block 15 - 11, 12, 13, 14, 15
// block range 2 - block 16 - 16, 17, 18
assert_eq!(txs.len(), 18);
assert_eq!(
18,
count_distinct_values(&txs, &|t| t.transaction_hash.clone())
);
assert_eq!(
2,
count_distinct_values(&txs, &|t| BlockRange::start(t.block_number))
);
assert_eq!(4, count_distinct_values(&txs, &|t| t.block_number));
assert_eq!(4, count_distinct_values(&txs, &|t| t.block_hash.clone()));
}
#[test]
#[should_panic]
fn should_panic_when_too_many_blocks_per_block_range() {
CardanoTransactionsBuilder::new().blocks_per_block_range(*BlockRange::LENGTH as usize + 1);
}
}