Skip to content

Commit 112d43b

Browse files
AlenarAlenar
committed
PR review: Style & naming fix from PR
1 parent afe0182 commit 112d43b

File tree

13 files changed

+86
-91
lines changed

13 files changed

+86
-91
lines changed

‎internal/mithril-persistence/src/sqlite/condition.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,6 @@ impl WhereCondition {
138138
}
139139

140140
/// Get all condition builder.
141-
///
142-
/// By default, nothing will be filtered out when using this condition. But you
143-
/// can override this behavior by implementing this trait for your type.
144141
pub trait GetAllCondition {
145142
/// Get the condition for a get all query.
146143
fn get_all_condition() -> WhereCondition {

‎mithril-aggregator/src/database/record/block_range_root.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ use crate::database::record::hydrator::try_to_u64;
1111
pub struct BlockRangeRootRecord {
1212
/// Range of block numbers covered
1313
pub range: BlockRange,
14-
/// Merkle root of the block range, computed from the list of all transactions that are
15-
/// included in the range
14+
/// Merkle root of the block range, computed from the list of included transactions
1615
pub merkle_root: MKTreeNode,
1716
}
1817

‎mithril-aggregator/src/database/record/interval_without_block_range_root.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use mithril_persistence::sqlite::{HydrationError, Projection, SqLiteEntity};
55

66
use crate::database::record::hydrator::try_to_u64;
77

8-
/// Interval of block numbers without block ranges root.
8+
/// Interval of block numbers (`[start, end[`) without block ranges root.
99
pub struct IntervalWithoutBlockRangeRootRecord {
1010
/// Start of the interval
1111
pub start: Option<BlockNumber>,

‎mithril-aggregator/src/database/repository/cardano_transaction_repository.rs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ impl CardanoTransactionRepository {
4444
}
4545

4646
/// Return all the [CardanoTransactionRecord]s in the database using chronological order.
47-
pub async fn get_transactions_between_blocks(
47+
pub async fn get_transactions_in_range_blocks(
4848
&self,
4949
range: Range<BlockNumber>,
5050
) -> StdResult<Vec<CardanoTransactionRecord>> {
@@ -118,7 +118,7 @@ impl CardanoTransactionRepository {
118118
}
119119

120120
/// Create new [BlockRangeRootRecord]s in the database.
121-
pub async fn create_block_ranges<T: Into<BlockRangeRootRecord>>(
121+
pub async fn create_block_range_roots<T: Into<BlockRangeRootRecord>>(
122122
&self,
123123
block_ranges: Vec<T>,
124124
) -> StdResult<Vec<BlockRangeRootRecord>> {
@@ -226,23 +226,23 @@ impl TransactionStore for CardanoTransactionRepository {
226226
}
227227
}
228228

229-
async fn get_transactions_between(
229+
async fn get_transactions_in_range(
230230
&self,
231231
range: Range<BlockNumber>,
232232
) -> StdResult<Vec<CardanoTransaction>> {
233-
self.get_transactions_between_blocks(range).await.map(|v| {
233+
self.get_transactions_in_range_blocks(range).await.map(|v| {
234234
v.into_iter()
235235
.map(|record| record.into())
236236
.collect::<Vec<CardanoTransaction>>()
237237
})
238238
}
239239

240-
async fn store_block_ranges(
240+
async fn store_block_range_roots(
241241
&self,
242242
block_ranges: Vec<(BlockRange, MKTreeNode)>,
243243
) -> StdResult<()> {
244244
if !block_ranges.is_empty() {
245-
self.create_block_ranges(block_ranges).await?;
245+
self.create_block_range_roots(block_ranges).await?;
246246
}
247247
Ok(())
248248
}
@@ -535,7 +535,7 @@ mod tests {
535535
}
536536

537537
#[tokio::test]
538-
async fn repository_get_transactions_between_blocks() {
538+
async fn repository_get_transactions_in_range_blocks() {
539539
let connection = Arc::new(cardano_tx_db_connection().unwrap());
540540
let repository = CardanoTransactionRepository::new(connection);
541541

@@ -550,23 +550,23 @@ mod tests {
550550
.unwrap();
551551

552552
{
553-
let transaction_result = repository.get_transactions_between(0..10).await.unwrap();
553+
let transaction_result = repository.get_transactions_in_range(0..10).await.unwrap();
554554
assert_eq!(Vec::<CardanoTransaction>::new(), transaction_result);
555555
}
556556
{
557-
let transaction_result = repository.get_transactions_between(13..21).await.unwrap();
557+
let transaction_result = repository.get_transactions_in_range(13..21).await.unwrap();
558558
assert_eq!(Vec::<CardanoTransaction>::new(), transaction_result);
559559
}
560560
{
561-
let transaction_result = repository.get_transactions_between(9..12).await.unwrap();
561+
let transaction_result = repository.get_transactions_in_range(9..12).await.unwrap();
562562
assert_eq!(transactions[0..=1].to_vec(), transaction_result);
563563
}
564564
{
565-
let transaction_result = repository.get_transactions_between(10..13).await.unwrap();
565+
let transaction_result = repository.get_transactions_in_range(10..13).await.unwrap();
566566
assert_eq!(transactions.clone(), transaction_result);
567567
}
568568
{
569-
let transaction_result = repository.get_transactions_between(11..14).await.unwrap();
569+
let transaction_result = repository.get_transactions_in_range(11..14).await.unwrap();
570570
assert_eq!(transactions[1..=2].to_vec(), transaction_result);
571571
}
572572
}
@@ -604,7 +604,7 @@ mod tests {
604604
// The last block range give the lower bound
605605
let last_block_range = BlockRange::from_block_number(0);
606606
repository
607-
.store_block_ranges(vec![(
607+
.store_block_range_roots(vec![(
608608
last_block_range.clone(),
609609
MKTreeNode::from_hex("AAAA").unwrap(),
610610
)])
@@ -631,7 +631,7 @@ mod tests {
631631

632632
let last_block_range = BlockRange::from_block_number(BlockRange::LENGTH * 10);
633633
repository
634-
.store_block_ranges(vec![(
634+
.store_block_range_roots(vec![(
635635
last_block_range.clone(),
636636
MKTreeNode::from_hex("AAAA").unwrap(),
637637
)])
@@ -672,7 +672,7 @@ mod tests {
672672
let repository = CardanoTransactionRepository::new(connection.clone());
673673

674674
repository
675-
.store_block_ranges(vec![
675+
.store_block_range_roots(vec![
676676
(
677677
BlockRange::from_block_number(0),
678678
MKTreeNode::from_hex("AAAA").unwrap(),
@@ -709,11 +709,11 @@ mod tests {
709709
let range = BlockRange::from_block_number(0);
710710

711711
repository
712-
.store_block_ranges(vec![(range.clone(), MKTreeNode::from_hex("AAAA").unwrap())])
712+
.store_block_range_roots(vec![(range.clone(), MKTreeNode::from_hex("AAAA").unwrap())])
713713
.await
714714
.unwrap();
715715
repository
716-
.store_block_ranges(vec![(range.clone(), MKTreeNode::from_hex("BBBB").unwrap())])
716+
.store_block_range_roots(vec![(range.clone(), MKTreeNode::from_hex("BBBB").unwrap())])
717717
.await
718718
.unwrap();
719719

‎mithril-aggregator/src/dependency_injection/builder.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ pub struct DependenciesBuilder {
136136
/// Cardano transactions store.
137137
pub transaction_store: Option<Arc<dyn TransactionStore>>,
138138

139-
/// Cardano transactions parser.
139+
/// Cardano block scanner.
140140
pub block_scanner: Option<Arc<dyn BlockScanner>>,
141141

142142
/// Immutable file digester service.
@@ -724,7 +724,7 @@ impl DependenciesBuilder {
724724
Ok(Arc::new(block_scanner))
725725
}
726726

727-
/// Transaction parser.
727+
/// Block scanner
728728
pub async fn get_block_scanner(&mut self) -> Result<Arc<dyn BlockScanner>> {
729729
if self.block_scanner.is_none() {
730730
self.block_scanner = Some(self.build_block_scanner().await?);
@@ -1198,7 +1198,7 @@ impl DependenciesBuilder {
11981198
signed_entity_storer: self.get_signed_entity_storer().await?,
11991199
signer_getter: self.get_signer_store().await?,
12001200
message_service: self.get_message_service().await?,
1201-
transaction_parser: self.get_block_scanner().await?,
1201+
block_scanner: self.get_block_scanner().await?,
12021202
transaction_store: self.get_transaction_store().await?,
12031203
prover_service: self.get_prover_service().await?,
12041204
};

‎mithril-aggregator/src/dependency_injection/containers.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ pub struct DependencyContainer {
8787
/// Cardano transactions store.
8888
pub transaction_store: Arc<dyn TransactionStore>,
8989

90-
/// Cardano transactions parser.
91-
pub transaction_parser: Arc<dyn BlockScanner>,
90+
/// Cardano block scanner.
91+
pub block_scanner: Arc<dyn BlockScanner>,
9292

9393
/// Immutable file observer service.
9494
pub immutable_file_observer: Arc<dyn ImmutableFileObserver>,

‎mithril-aggregator/src/services/cardano_transactions_importer.rs

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ pub trait TransactionStore: Send + Sync {
3232
&self,
3333
) -> StdResult<Option<Range<BlockNumber>>>;
3434

35-
/// Get transactions between two block numbers
36-
async fn get_transactions_between(
35+
/// Get transactions in an interval of blocks
36+
async fn get_transactions_in_range(
3737
&self,
3838
range: Range<BlockNumber>,
3939
) -> StdResult<Vec<CardanoTransaction>>;
4040

4141
/// Store list of block ranges with their corresponding merkle root
42-
async fn store_block_ranges(
42+
async fn store_block_range_roots(
4343
&self,
4444
block_ranges: Vec<(BlockRange, MKTreeNode)>,
4545
) -> StdResult<()>;
@@ -127,7 +127,7 @@ impl CardanoTransactionsImporter {
127127
.transaction_store
128128
.get_block_interval_without_block_range_root()
129129
.await?
130-
.map(|range| BlockRange::all_ranges_in(BlockRange::start(range.start)..range.end))
130+
.map(|range| BlockRange::all_block_ranges_in(BlockRange::start(range.start)..range.end))
131131
{
132132
// Everything is already computed
133133
None => return Ok(()),
@@ -147,7 +147,7 @@ impl CardanoTransactionsImporter {
147147
for block_range in block_ranges {
148148
let transactions = self
149149
.transaction_store
150-
.get_transactions_between(block_range.start..block_range.end)
150+
.get_transactions_in_range(block_range.start..block_range.end)
151151
.await?;
152152

153153
if transactions.is_empty() {
@@ -159,7 +159,7 @@ impl CardanoTransactionsImporter {
159159
}
160160

161161
self.transaction_store
162-
.store_block_ranges(block_ranges_with_merkle_root)
162+
.store_block_range_roots(block_ranges_with_merkle_root)
163163
.await
164164
}
165165
}
@@ -318,7 +318,7 @@ mod tests {
318318
}
319319

320320
#[tokio::test]
321-
async fn handle_gap_between_block_ranges() {
321+
async fn if_theres_gap_between_two_stored_block_ranges_it_can_still_compute_their_root() {
322322
let connection = cardano_tx_db_connection().unwrap();
323323
let repository = Arc::new(CardanoTransactionRepository::new(Arc::new(connection)));
324324

@@ -405,7 +405,7 @@ mod tests {
405405
}
406406

407407
#[tokio::test]
408-
async fn if_half_transactions_are_stored_the_other_half_is_parsed_and_stored() {
408+
async fn if_half_transactions_are_already_stored_the_other_half_is_parsed_and_stored() {
409409
let connection = cardano_tx_db_connection().unwrap();
410410
let repository = Arc::new(CardanoTransactionRepository::new(Arc::new(connection)));
411411

@@ -457,7 +457,7 @@ mod tests {
457457
let transactions = into_transactions(&blocks);
458458
repository.store_transactions(transactions).await.unwrap();
459459
repository
460-
.store_block_ranges(
460+
.store_block_range_roots(
461461
blocks[0..((BlockRange::LENGTH * 2) as usize)]
462462
.iter()
463463
.map(|b| {
@@ -509,8 +509,7 @@ mod tests {
509509
}
510510

511511
#[tokio::test]
512-
// async fn block_range_root_compute_work_on_block_range_starting_before_last_block_range_root_and_finishing_before_last_tx(
513-
async fn block_range_root_only_retrieve_only_strictly_required_transactions() {
512+
async fn block_range_root_retrieves_only_strictly_required_transactions() {
514513
fn transactions_for_block(range: Range<BlockNumber>) -> StdResult<Vec<CardanoTransaction>> {
515514
Ok(build_blocks(range.start, range.count() as BlockNumber)
516515
.iter()
@@ -528,7 +527,7 @@ mod tests {
528527
.returning(|| Ok(Some((BlockRange::LENGTH + 2)..(BlockRange::LENGTH * 5))))
529528
.once();
530529
store_mock
531-
.expect_get_transactions_between()
530+
.expect_get_transactions_in_range()
532531
// Lower bound should be the block number that start after the last known block range end
533532
//
534533
// if it's not a multiple of BlockRange::LENGTH, it should be the start block number
@@ -541,7 +540,9 @@ mod tests {
541540
expected_range.contains(&range.start) && expected_range.contains(&range.end)
542541
})
543542
.returning(transactions_for_block);
544-
store_mock.expect_store_block_ranges().returning(|_| Ok(()));
543+
store_mock
544+
.expect_store_block_range_roots()
545+
.returning(|_| Ok(()));
545546

546547
CardanoTransactionsImporter::new_for_test(
547548
Arc::new(MockBlockScannerImpl::new()),

‎mithril-common/src/cardano_block_scanner.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ pub trait BlockScanner: Sync + Send {
6262
) -> StdResult<Vec<ScannedBlock>>;
6363
}
6464

65-
/// Dumb transaction parser
65+
/// Dumb Block Scanner
6666
pub struct DumbBlockScanner {
6767
blocks: RwLock<Vec<ScannedBlock>>,
6868
}
@@ -161,7 +161,7 @@ impl ScannedBlock {
161161
}
162162
}
163163

164-
/// Cardano transaction parser
164+
/// Cardano block scanner
165165
pub struct CardanoBlockScanner {
166166
logger: Logger,
167167
/// When set to true, no error is returned in case of unparsable block, and an error log is written instead.

‎mithril-common/src/entities/block_range.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ impl BlockRange {
5858
Self::start_with_length(number, Self::LENGTH)
5959
}
6060

61-
/// Get all [BlockRange] contained in the given interval
62-
pub fn all_ranges_in(interval: Range<BlockNumber>) -> Vec<BlockRange> {
61+
/// Get all [BlockRange] strictly contained in the given interval
62+
pub fn all_block_ranges_in(interval: Range<BlockNumber>) -> Vec<BlockRange> {
6363
let all_numbers: Vec<BlockNumber> =
6464
interval.skip_while(|i| i % Self::LENGTH != 0).collect();
6565
all_numbers
@@ -213,29 +213,29 @@ mod tests {
213213
}
214214

215215
#[test]
216-
fn test_block_range_all_ranges_in() {
217-
assert_eq!(BlockRange::all_ranges_in(0..0), vec![]);
218-
assert_eq!(BlockRange::all_ranges_in(0..1), vec![]);
219-
assert_eq!(BlockRange::all_ranges_in(0..14), vec![]);
220-
assert_eq!(BlockRange::all_ranges_in(1..15), vec![]);
216+
fn test_block_range_all_block_ranges_in() {
217+
assert_eq!(BlockRange::all_block_ranges_in(0..0), vec![]);
218+
assert_eq!(BlockRange::all_block_ranges_in(0..1), vec![]);
219+
assert_eq!(BlockRange::all_block_ranges_in(0..14), vec![]);
220+
assert_eq!(BlockRange::all_block_ranges_in(1..15), vec![]);
221221
assert_eq!(
222-
BlockRange::all_ranges_in(0..15),
222+
BlockRange::all_block_ranges_in(0..15),
223223
vec![BlockRange::new(0, 15)]
224224
);
225225
assert_eq!(
226-
BlockRange::all_ranges_in(0..16),
226+
BlockRange::all_block_ranges_in(0..16),
227227
vec![BlockRange::new(0, 15)]
228228
);
229229
assert_eq!(
230-
BlockRange::all_ranges_in(14..30),
230+
BlockRange::all_block_ranges_in(14..30),
231231
vec![BlockRange::new(15, 30)]
232232
);
233233
assert_eq!(
234-
BlockRange::all_ranges_in(14..31),
234+
BlockRange::all_block_ranges_in(14..31),
235235
vec![BlockRange::new(15, 30)]
236236
);
237237
assert_eq!(
238-
BlockRange::all_ranges_in(14..61),
238+
BlockRange::all_block_ranges_in(14..61),
239239
vec![
240240
BlockRange::new(15, 30),
241241
BlockRange::new(30, 45),

0 commit comments

Comments
 (0)