176 lines
5.6 KiB
Rust
176 lines
5.6 KiB
Rust
use serde::{Deserialize, Serialize};
|
|
use solana_sdk::fee_calculator::FeeCalculator;
|
|
use solana_sdk::hash::Hash;
|
|
use solana_sdk::timing::timestamp;
|
|
use std::collections::HashMap;
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
|
|
struct HashAge {
|
|
fee_calculator: FeeCalculator,
|
|
hash_height: u64,
|
|
timestamp: u64,
|
|
}
|
|
|
|
/// Low memory overhead, so can be cloned for every checkpoint
|
|
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
|
|
pub struct BlockhashQueue {
|
|
/// updated whenever an hash is registered
|
|
hash_height: u64,
|
|
|
|
/// last hash to be registered
|
|
last_hash: Option<Hash>,
|
|
|
|
ages: HashMap<Hash, HashAge>,
|
|
|
|
/// hashes older than `max_age` will be dropped from the queue
|
|
max_age: usize,
|
|
}
|
|
|
|
impl BlockhashQueue {
|
|
pub fn new(max_age: usize) -> Self {
|
|
Self {
|
|
ages: HashMap::new(),
|
|
hash_height: 0,
|
|
last_hash: None,
|
|
max_age,
|
|
}
|
|
}
|
|
|
|
#[allow(dead_code)]
|
|
pub fn hash_height(&self) -> u64 {
|
|
self.hash_height
|
|
}
|
|
|
|
pub fn last_hash(&self) -> Hash {
|
|
self.last_hash.expect("no hash has been set")
|
|
}
|
|
|
|
pub fn get_fee_calculator(&self, hash: &Hash) -> Option<&FeeCalculator> {
|
|
self.ages.get(hash).map(|hash_age| &hash_age.fee_calculator)
|
|
}
|
|
|
|
/// Check if the age of the hash is within the max_age
|
|
/// return false for any hashes with an age above max_age
|
|
pub fn check_hash_age(&self, hash: &Hash, max_age: usize) -> bool {
|
|
let hash_age = self.ages.get(hash);
|
|
match hash_age {
|
|
Some(age) => self.hash_height - age.hash_height <= max_age as u64,
|
|
_ => false,
|
|
}
|
|
}
|
|
|
|
/// check if hash is valid
|
|
#[cfg(test)]
|
|
pub fn check_hash(&self, hash: Hash) -> bool {
|
|
self.ages.get(&hash).is_some()
|
|
}
|
|
|
|
pub fn genesis_hash(&mut self, hash: &Hash, fee_calculator: &FeeCalculator) {
|
|
self.ages.insert(
|
|
*hash,
|
|
HashAge {
|
|
fee_calculator: fee_calculator.clone(),
|
|
hash_height: 0,
|
|
timestamp: timestamp(),
|
|
},
|
|
);
|
|
|
|
self.last_hash = Some(*hash);
|
|
}
|
|
|
|
fn check_age(hash_height: u64, max_age: usize, age: &HashAge) -> bool {
|
|
hash_height - age.hash_height <= max_age as u64
|
|
}
|
|
|
|
pub fn register_hash(&mut self, hash: &Hash, fee_calculator: &FeeCalculator) {
|
|
self.hash_height += 1;
|
|
let hash_height = self.hash_height;
|
|
|
|
// this clean up can be deferred until sigs gets larger
|
|
// because we verify age.nth every place we check for validity
|
|
let max_age = self.max_age;
|
|
if self.ages.len() >= max_age {
|
|
self.ages
|
|
.retain(|_, age| Self::check_age(hash_height, max_age, age));
|
|
}
|
|
self.ages.insert(
|
|
*hash,
|
|
HashAge {
|
|
fee_calculator: fee_calculator.clone(),
|
|
hash_height,
|
|
timestamp: timestamp(),
|
|
},
|
|
);
|
|
|
|
self.last_hash = Some(*hash);
|
|
}
|
|
|
|
/// Maps a hash height to a timestamp
|
|
pub fn hash_height_to_timestamp(&self, hash_height: u64) -> Option<u64> {
|
|
for age in self.ages.values() {
|
|
if age.hash_height == hash_height {
|
|
return Some(age.timestamp);
|
|
}
|
|
}
|
|
None
|
|
}
|
|
|
|
pub fn get_recent_blockhashes(&self) -> impl Iterator<Item = (u64, &Hash)> {
|
|
(&self.ages).iter().map(|(k, v)| (v.hash_height, k))
|
|
}
|
|
}
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use bincode::serialize;
|
|
use solana_sdk::clock::MAX_RECENT_BLOCKHASHES;
|
|
use solana_sdk::hash::hash;
|
|
|
|
#[test]
|
|
fn test_register_hash() {
|
|
let last_hash = Hash::default();
|
|
let mut hash_queue = BlockhashQueue::new(100);
|
|
assert!(!hash_queue.check_hash(last_hash));
|
|
hash_queue.register_hash(&last_hash, &FeeCalculator::default());
|
|
assert!(hash_queue.check_hash(last_hash));
|
|
assert_eq!(hash_queue.hash_height(), 1);
|
|
}
|
|
#[test]
|
|
fn test_reject_old_last_hash() {
|
|
let mut hash_queue = BlockhashQueue::new(100);
|
|
let last_hash = hash(&serialize(&0).unwrap());
|
|
for i in 0..102 {
|
|
let last_hash = hash(&serialize(&i).unwrap());
|
|
hash_queue.register_hash(&last_hash, &FeeCalculator::default());
|
|
}
|
|
// Assert we're no longer able to use the oldest hash.
|
|
assert!(!hash_queue.check_hash(last_hash));
|
|
}
|
|
/// test that when max age is 0, that a valid last_hash still passes the age check
|
|
#[test]
|
|
fn test_queue_init_blockhash() {
|
|
let last_hash = Hash::default();
|
|
let mut hash_queue = BlockhashQueue::new(100);
|
|
hash_queue.register_hash(&last_hash, &FeeCalculator::default());
|
|
assert_eq!(last_hash, hash_queue.last_hash());
|
|
assert!(hash_queue.check_hash_age(&last_hash, 0));
|
|
}
|
|
|
|
#[test]
|
|
fn test_get_recent_blockhashes() {
|
|
let mut blockhash_queue = BlockhashQueue::new(MAX_RECENT_BLOCKHASHES);
|
|
let recent_blockhashes = blockhash_queue.get_recent_blockhashes();
|
|
// Sanity-check an empty BlockhashQueue
|
|
assert_eq!(recent_blockhashes.count(), 0);
|
|
for i in 0..MAX_RECENT_BLOCKHASHES {
|
|
let hash = hash(&serialize(&i).unwrap());
|
|
blockhash_queue.register_hash(&hash, &FeeCalculator::default());
|
|
}
|
|
let recent_blockhashes = blockhash_queue.get_recent_blockhashes();
|
|
// Verify that the returned hashes are most recent
|
|
for (_slot, hash) in recent_blockhashes {
|
|
assert!(blockhash_queue.check_hash_age(hash, MAX_RECENT_BLOCKHASHES));
|
|
}
|
|
}
|
|
}
|