use crate::{ account::Account, declare_sysvar_id, fee_calculator::FeeCalculator, hash::{hash, Hash}, sysvar::Sysvar, }; use std::{cmp::Ordering, collections::BinaryHeap, iter::FromIterator, ops::Deref}; pub const MAX_ENTRIES: usize = 150; declare_sysvar_id!( "SysvarRecentB1ockHashes11111111111111111111", RecentBlockhashes ); #[repr(C)] #[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)] pub struct Entry { pub blockhash: Hash, pub fee_calculator: FeeCalculator, } impl Entry { pub fn new(blockhash: &Hash, fee_calculator: &FeeCalculator) -> Self { Self { blockhash: *blockhash, fee_calculator: fee_calculator.clone(), } } } #[derive(Clone, Debug)] pub struct IterItem<'a>(pub u64, pub &'a Hash, pub &'a FeeCalculator); impl<'a> Eq for IterItem<'a> {} impl<'a> PartialEq for IterItem<'a> { fn eq(&self, other: &Self) -> bool { self.0 == other.0 } } impl<'a> Ord for IterItem<'a> { fn cmp(&self, other: &Self) -> Ordering { self.0.cmp(&other.0) } } impl<'a> PartialOrd for IterItem<'a> { fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } #[repr(C)] #[derive(Serialize, Deserialize, Clone, Debug, PartialEq)] pub struct RecentBlockhashes(Vec); impl Default for RecentBlockhashes { fn default() -> Self { Self(Vec::with_capacity(MAX_ENTRIES)) } } impl<'a> FromIterator> for RecentBlockhashes { fn from_iter(iter: I) -> Self where I: IntoIterator>, { let mut new = Self::default(); for i in iter { new.0.push(Entry::new(i.1, i.2)) } new } } // This is cherry-picked from HEAD of rust-lang's master (ref1) because it's // a nightly-only experimental API. // (binary_heap_into_iter_sorted [rustc issue #59278]) // Remove this and use the standard API once BinaryHeap::into_iter_sorted (ref2) // is stabilized. // ref1: https://github.com/rust-lang/rust/blob/2f688ac602d50129388bb2a5519942049096cbff/src/liballoc/collections/binary_heap.rs#L1149 // ref2: https://doc.rust-lang.org/std/collections/struct.BinaryHeap.html#into_iter_sorted.v #[derive(Clone, Debug)] pub struct IntoIterSorted { inner: BinaryHeap, } impl Iterator for IntoIterSorted { type Item = T; #[inline] fn next(&mut self) -> Option { self.inner.pop() } #[inline] fn size_hint(&self) -> (usize, Option) { let exact = self.inner.len(); (exact, Some(exact)) } } impl Sysvar for RecentBlockhashes { fn size_of() -> usize { // hard-coded so that we don't have to construct an empty 6008 // golden, update if MAX_ENTRIES changes } } impl Deref for RecentBlockhashes { type Target = Vec; fn deref(&self) -> &Self::Target { &self.0 } } pub fn create_account(lamports: u64) -> Account { RecentBlockhashes::default().create_account(lamports) } pub fn update_account<'a, I>(account: &mut Account, recent_blockhash_iter: I) -> Option<()> where I: IntoIterator>, { let sorted = BinaryHeap::from_iter(recent_blockhash_iter); let sorted_iter = IntoIterSorted { inner: sorted }; let recent_blockhash_iter = sorted_iter.take(MAX_ENTRIES); let recent_blockhashes = RecentBlockhashes::from_iter(recent_blockhash_iter); recent_blockhashes.to_account(account) } pub fn create_account_with_data<'a, I>(lamports: u64, recent_blockhash_iter: I) -> Account where I: IntoIterator>, { let mut account = create_account(lamports); update_account(&mut account, recent_blockhash_iter).unwrap(); account } pub fn create_test_recent_blockhashes(start: usize) -> RecentBlockhashes { let blocks: Vec<_> = (start..start + MAX_ENTRIES) .map(|i| { ( i as u64, hash(&bincode::serialize(&i).unwrap()), FeeCalculator::new(i as u64 * 100), ) }) .collect(); let bhq: Vec<_> = blocks .iter() .map(|(i, hash, fee_calc)| IterItem(*i, hash, fee_calc)) .collect(); RecentBlockhashes::from_iter(bhq.into_iter()) } #[cfg(test)] mod tests { use super::*; use crate::{clock::MAX_PROCESSING_AGE, hash::HASH_BYTES}; use rand::seq::SliceRandom; use rand::thread_rng; #[test] #[allow(clippy::assertions_on_constants)] fn test_sysvar_can_hold_all_active_blockhashes() { // Ensure we can still hold all of the active entries in `BlockhashQueue` assert!(MAX_PROCESSING_AGE <= MAX_ENTRIES); } #[test] fn test_size_of() { let entry = Entry::new(&Hash::default(), &FeeCalculator::default()); assert_eq!( bincode::serialized_size(&RecentBlockhashes(vec![entry; MAX_ENTRIES])).unwrap() as usize, RecentBlockhashes::size_of() ); } #[test] fn test_create_account_empty() { let account = create_account_with_data(42, vec![].into_iter()); let recent_blockhashes = RecentBlockhashes::from_account(&account).unwrap(); assert_eq!(recent_blockhashes, RecentBlockhashes::default()); } #[test] fn test_create_account_full() { let def_hash = Hash::default(); let def_fees = FeeCalculator::default(); let account = create_account_with_data( 42, vec![IterItem(0u64, &def_hash, &def_fees); MAX_ENTRIES].into_iter(), ); let recent_blockhashes = RecentBlockhashes::from_account(&account).unwrap(); assert_eq!(recent_blockhashes.len(), MAX_ENTRIES); } #[test] fn test_create_account_truncate() { let def_hash = Hash::default(); let def_fees = FeeCalculator::default(); let account = create_account_with_data( 42, vec![IterItem(0u64, &def_hash, &def_fees); MAX_ENTRIES + 1].into_iter(), ); let recent_blockhashes = RecentBlockhashes::from_account(&account).unwrap(); assert_eq!(recent_blockhashes.len(), MAX_ENTRIES); } #[test] fn test_create_account_unsorted() { let def_fees = FeeCalculator::default(); let mut unsorted_blocks: Vec<_> = (0..MAX_ENTRIES) .map(|i| { (i as u64, { // create hash with visibly recognizable ordering let mut h = [0; HASH_BYTES]; h[HASH_BYTES - 1] = i as u8; Hash::new(&h) }) }) .collect(); unsorted_blocks.shuffle(&mut thread_rng()); let account = create_account_with_data( 42, unsorted_blocks .iter() .map(|(i, hash)| IterItem(*i, hash, &def_fees)), ); let recent_blockhashes = RecentBlockhashes::from_account(&account).unwrap(); let mut unsorted_recent_blockhashes: Vec<_> = unsorted_blocks .iter() .map(|(i, hash)| IterItem(*i, hash, &def_fees)) .collect(); unsorted_recent_blockhashes.sort(); unsorted_recent_blockhashes.reverse(); let expected_recent_blockhashes: Vec<_> = (unsorted_recent_blockhashes .into_iter() .map(|IterItem(_, b, f)| Entry::new(b, f))) .collect(); assert_eq!(*recent_blockhashes, expected_recent_blockhashes); } }