Skip to content

Commit

Permalink
Merge pull request #1917 from input-output-hk/jpraynaud/1840-enhance-…
Browse files Browse the repository at this point in the history 
…cardano-transactions-rollbacks

Enhance Cardano transactions rollbacks
  • Loading branch information
@jpraynaud
jpraynaud committed Sep 11, 2024
2 parents aff35a8 + 9eae92d commit f083934
Show file tree
Hide file tree
Showing 11 changed files with 239 additions and 67 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ As a minor extension, we have adopted a slightly different versioning convention

- Support infinite preloading of Cardano transactions in signer.

- Fix Cardano transactions rollbacks creating panics in signer and aggregator.

- **UNSTABLE** Cardano stake distribution certification:

- Implement the signable and artifact builders for the signed entity type `CardanoStakeDistribution`.
Expand Down
8 changes: 4 additions & 4 deletions Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/mithril-persistence/Cargo.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mithril-persistence"
version = "0.2.25"
version = "0.2.26"
description = "Common types, interfaces, and utilities to persist data for Mithril nodes."
authors = { workspace = true }
edition = { workspace = true }
Expand Down
119 changes: 83 additions & 36 deletions ...nal/mithril-persistence/src/database/query/cardano_transaction/get_cardano_transaction.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ impl GetCardanoTransactionQuery {
Self { condition }
}

pub fn by_slot_number(slot_number: SlotNumber) -> Self {
pub fn with_highest_block_number_below_slot_number(slot_number: SlotNumber) -> Self {
Self {
condition: WhereCondition::new(
"slot_number = ?*",
"block_number = (select max(block_number) from cardano_tx where slot_number <= ?*)",
vec![Value::Integer(*slot_number as i64)],
),
}
Expand Down Expand Up @@ -120,6 +120,18 @@ mod tests {
.unwrap();
}

fn transaction_record(
block_number: BlockNumber,
slot_number: SlotNumber,
) -> CardanoTransactionRecord {
CardanoTransactionRecord::new(
format!("tx-hash-{}", slot_number),
block_number,
slot_number,
format!("block-hash-{}", block_number),
)
}

#[test]
fn with_highest_block_number() {
let connection = cardano_tx_db_connection().unwrap();
Expand All @@ -132,30 +144,10 @@ mod tests {
insert_transactions(
&connection,
vec![
CardanoTransactionRecord::new(
"tx-hash-0",
BlockNumber(10),
SlotNumber(50),
"block-hash-10",
),
CardanoTransactionRecord::new(
"tx-hash-1",
BlockNumber(10),
SlotNumber(51),
"block-hash-10",
),
CardanoTransactionRecord::new(
"tx-hash-2",
BlockNumber(11),
SlotNumber(54),
"block-hash-11",
),
CardanoTransactionRecord::new(
"tx-hash-3",
BlockNumber(11),
SlotNumber(55),
"block-hash-11",
),
transaction_record(BlockNumber(10), SlotNumber(50)),
transaction_record(BlockNumber(10), SlotNumber(51)),
transaction_record(BlockNumber(11), SlotNumber(54)),
transaction_record(BlockNumber(11), SlotNumber(55)),
],
);

Expand All @@ -164,19 +156,74 @@ mod tests {
.unwrap();
assert_eq!(
vec![
CardanoTransactionRecord::new(
"tx-hash-2",
BlockNumber(11),
SlotNumber(54),
"block-hash-11"
transaction_record(BlockNumber(11), SlotNumber(54)),
transaction_record(BlockNumber(11), SlotNumber(55)),
],
records
);
}

#[test]
fn with_highest_block_number_below_slot_number() {
let connection = cardano_tx_db_connection().unwrap();

let cursor = connection
.fetch(
GetCardanoTransactionQuery::with_highest_block_number_below_slot_number(
SlotNumber(51),
),
CardanoTransactionRecord::new(
"tx-hash-3",
BlockNumber(11),
SlotNumber(55),
"block-hash-11"
)
.unwrap();
assert_eq!(0, cursor.count());

insert_transactions(
&connection,
vec![transaction_record(BlockNumber(2), SlotNumber(5))],
);

let records: Vec<CardanoTransactionRecord> = connection
.fetch_collect(
GetCardanoTransactionQuery::with_highest_block_number_below_slot_number(
SlotNumber(5),
),
)
.unwrap();
assert_eq!(
vec![transaction_record(BlockNumber(2), SlotNumber(5)),],
records
);

insert_transactions(
&connection,
vec![
transaction_record(BlockNumber(10), SlotNumber(50)),
transaction_record(BlockNumber(11), SlotNumber(51)),
transaction_record(BlockNumber(14), SlotNumber(54)),
transaction_record(BlockNumber(15), SlotNumber(55)),
],
);

let records: Vec<CardanoTransactionRecord> = connection
.fetch_collect(
GetCardanoTransactionQuery::with_highest_block_number_below_slot_number(
SlotNumber(53),
),
)
.unwrap();
assert_eq!(
vec![transaction_record(BlockNumber(11), SlotNumber(51)),],
records
);

let records: Vec<CardanoTransactionRecord> = connection
.fetch_collect(
GetCardanoTransactionQuery::with_highest_block_number_below_slot_number(
SlotNumber(54),
),
)
.unwrap();
assert_eq!(
vec![transaction_record(BlockNumber(14), SlotNumber(54)),],
records
);
}
Expand Down
137 changes: 130 additions & 7 deletions internal/mithril-persistence/src/database/repository/cardano_transaction_repository.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,13 @@ impl CardanoTransactionRepository {
Ok(())
}

/// Get the block number for a given slot number
pub async fn get_block_number_by_slot_number(
/// Get the closest block number above a given slot number
pub async fn get_closest_block_number_above_slot_number(
&self,
slot_number: SlotNumber,
) -> StdResult<Option<BlockNumber>> {
let query = GetCardanoTransactionQuery::by_slot_number(slot_number);
let query =
GetCardanoTransactionQuery::with_highest_block_number_below_slot_number(slot_number);
let record = self.connection_pool.connection()?.fetch_first(query)?;

Ok(record.map(|r| r.block_number))
Expand Down Expand Up @@ -277,7 +278,7 @@ impl CardanoTransactionRepository {
///
/// * Remove transactions with block number strictly greater than the given block number
/// * Remove block range roots that have lower bound range strictly above the given block number
pub async fn remove_rolled_back_transactions_and_block_range(
pub async fn remove_rolled_back_transactions_and_block_range_by_block_number(
&self,
block_number: BlockNumber,
) -> StdResult<()> {
Expand All @@ -293,6 +294,25 @@ impl CardanoTransactionRepository {

Ok(())
}

/// Remove transactions and block range roots that are in a rolled-back fork
///
/// * Remove transactions with closest block number strictly greater than the given slot number if exists
/// * Remove block range roots that have lower bound range strictly above the aforementioned block number
pub async fn remove_rolled_back_transactions_and_block_range_by_slot_number(
&self,
slot_number: SlotNumber,
) -> StdResult<()> {
if let Some(block_number) = self
.get_closest_block_number_above_slot_number(slot_number)
.await?
{
self.remove_rolled_back_transactions_and_block_range_by_block_number(block_number)
.await?;
}

Ok(())
}
}

#[async_trait]
Expand Down Expand Up @@ -910,7 +930,7 @@ mod tests {
}

#[tokio::test]
async fn repository_get_block_number_by_slot_number() {
async fn repository_get_closest_block_number_by_slot_number() {
let connection = cardano_tx_db_connection().unwrap();
let repository = CardanoTransactionRepository::new(Arc::new(
SqliteConnectionPool::build_from_connection(connection),
Expand All @@ -927,7 +947,7 @@ mod tests {
.unwrap();

let transaction_block_number_retrieved = repository
.get_block_number_by_slot_number(SlotNumber(500))
.get_closest_block_number_above_slot_number(SlotNumber(500))
.await
.unwrap();

Expand Down Expand Up @@ -1215,10 +1235,113 @@ mod tests {
.unwrap();

repository
.remove_rolled_back_transactions_and_block_range(BlockRange::LENGTH * 3)
.remove_rolled_back_transactions_and_block_range_by_block_number(BlockRange::LENGTH * 3)
.await
.unwrap();
assert_eq!(2, repository.get_all_transactions().await.unwrap().len());
assert_eq!(2, repository.get_all_block_range_root().unwrap().len());
}

#[tokio::test]
async fn remove_rolled_back_transactions_and_block_range_by_slot_number() {
fn transaction_record(
block_number: BlockNumber,
slot_number: SlotNumber,
tx_hash: &str,
) -> CardanoTransactionRecord {
CardanoTransactionRecord::new(
tx_hash,
block_number,
slot_number,
format!("block-hash-{}", block_number),
)
}

let repository = CardanoTransactionRepository::new(Arc::new(
SqliteConnectionPool::build(1, cardano_tx_db_connection).unwrap(),
));

repository
.create_transactions(vec![
transaction_record(BlockNumber(10), SlotNumber(50), "tx-hash-1"),
transaction_record(BlockNumber(11), SlotNumber(51), "tx-hash-2"),
transaction_record(BlockNumber(13), SlotNumber(52), "tx-hash-3"),
transaction_record(BlockNumber(13), SlotNumber(52), "tx-hash-4"),
transaction_record(BlockNumber(101), SlotNumber(100), "tx-hash-5"),
transaction_record(BlockNumber(202), SlotNumber(200), "tx-hash-56"),
])
.await
.unwrap();

{
repository
.remove_rolled_back_transactions_and_block_range_by_slot_number(SlotNumber(110))
.await
.expect("Failed to remove rolled back transactions");

let transactions = repository
.get_all()
.await
.unwrap()
.into_iter()
.map(|v| v.into())
.collect::<Vec<_>>();
assert_eq!(
vec![
transaction_record(BlockNumber(10), SlotNumber(50), "tx-hash-1"),
transaction_record(BlockNumber(11), SlotNumber(51), "tx-hash-2"),
transaction_record(BlockNumber(13), SlotNumber(52), "tx-hash-3"),
transaction_record(BlockNumber(13), SlotNumber(52), "tx-hash-4"),
transaction_record(BlockNumber(101), SlotNumber(100), "tx-hash-5"),
],
transactions
);
}

{
repository
.remove_rolled_back_transactions_and_block_range_by_slot_number(SlotNumber(53))
.await
.expect("Failed to remove rolled back transactions");

let transactions = repository
.get_all()
.await
.unwrap()
.into_iter()
.map(|v| v.into())
.collect::<Vec<_>>();
assert_eq!(
vec![
transaction_record(BlockNumber(10), SlotNumber(50), "tx-hash-1"),
transaction_record(BlockNumber(11), SlotNumber(51), "tx-hash-2"),
transaction_record(BlockNumber(13), SlotNumber(52), "tx-hash-3"),
transaction_record(BlockNumber(13), SlotNumber(52), "tx-hash-4"),
],
transactions
);
}

{
repository
.remove_rolled_back_transactions_and_block_range_by_slot_number(SlotNumber(51))
.await
.expect("Failed to remove rolled back transactions");

let transactions = repository
.get_all()
.await
.unwrap()
.into_iter()
.map(|v| v.into())
.collect::<Vec<_>>();
assert_eq!(
vec![
transaction_record(BlockNumber(10), SlotNumber(50), "tx-hash-1"),
transaction_record(BlockNumber(11), SlotNumber(51), "tx-hash-2"),
],
transactions
);
}
}
}
Loading

0 comments on commit f083934

Please sign in to comment.