305 lines
10 KiB
Rust
305 lines
10 KiB
Rust
#[allow(deprecated)]
|
|
use solana_sdk::sysvar::recent_blockhashes;
|
|
use {
|
|
serde::{Deserialize, Serialize},
|
|
solana_sdk::{
|
|
clock::MAX_RECENT_BLOCKHASHES, fee_calculator::FeeCalculator, hash::Hash, timing::timestamp,
|
|
},
|
|
std::collections::HashMap,
|
|
};
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize, AbiExample)]
|
|
struct HashAge {
|
|
fee_calculator: FeeCalculator,
|
|
hash_height: u64,
|
|
timestamp: u64,
|
|
}
|
|
|
|
/// Low memory overhead, so can be cloned for every checkpoint
|
|
#[frozen_abi(digest = "J1fGiMHyiKEBcWE6mfm7grAEGJgYEaVLzcrNZvd37iA2")]
|
|
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, AbiExample)]
|
|
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 Default for BlockhashQueue {
|
|
fn default() -> Self {
|
|
Self::new(MAX_RECENT_BLOCKHASHES)
|
|
}
|
|
}
|
|
|
|
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_lamports_per_signature(&self, hash: &Hash) -> Option<u64> {
|
|
self.ages
|
|
.get(hash)
|
|
.map(|hash_age| hash_age.fee_calculator.lamports_per_signature)
|
|
}
|
|
|
|
/// Check if the age of the hash is within the max_age
|
|
/// return false for any hashes with an age above max_age
|
|
/// return None for any hashes that were not found
|
|
pub fn check_hash_age(&self, hash: &Hash, max_age: usize) -> Option<bool> {
|
|
self.ages
|
|
.get(hash)
|
|
.map(|age| self.hash_height - age.hash_height <= max_age as u64)
|
|
}
|
|
|
|
pub fn get_hash_age(&self, hash: &Hash) -> Option<u64> {
|
|
self.ages
|
|
.get(hash)
|
|
.map(|age| self.hash_height - age.hash_height)
|
|
}
|
|
|
|
/// check if hash is valid
|
|
pub fn check_hash(&self, hash: &Hash) -> bool {
|
|
self.ages.get(hash).is_some()
|
|
}
|
|
|
|
pub fn genesis_hash(&mut self, hash: &Hash, lamports_per_signature: u64) {
|
|
self.ages.insert(
|
|
*hash,
|
|
HashAge {
|
|
fee_calculator: FeeCalculator::new(lamports_per_signature),
|
|
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, lamports_per_signature: u64) {
|
|
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: FeeCalculator::new(lamports_per_signature),
|
|
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
|
|
}
|
|
|
|
#[deprecated(
|
|
since = "1.9.0",
|
|
note = "Please do not use, will no longer be available in the future"
|
|
)]
|
|
#[allow(deprecated)]
|
|
pub fn get_recent_blockhashes(&self) -> impl Iterator<Item = recent_blockhashes::IterItem> {
|
|
(self.ages).iter().map(|(k, v)| {
|
|
recent_blockhashes::IterItem(v.hash_height, k, v.fee_calculator.lamports_per_signature)
|
|
})
|
|
}
|
|
|
|
pub(crate) fn get_max_age(&self) -> usize {
|
|
self.max_age
|
|
}
|
|
}
|
|
#[cfg(test)]
|
|
mod tests {
|
|
#[allow(deprecated)]
|
|
use solana_sdk::sysvar::recent_blockhashes::IterItem;
|
|
use {
|
|
super::*,
|
|
bincode::serialize,
|
|
solana_sdk::{clock::MAX_RECENT_BLOCKHASHES, 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, 0);
|
|
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, 0);
|
|
}
|
|
// Assert we're no longer able to use the oldest hash.
|
|
assert!(!hash_queue.check_hash(&last_hash));
|
|
assert_eq!(None, hash_queue.check_hash_age(&last_hash, 0));
|
|
|
|
// Assert we are not able to use the oldest remaining hash.
|
|
let last_valid_hash = hash(&serialize(&1).unwrap());
|
|
assert!(hash_queue.check_hash(&last_valid_hash));
|
|
assert_eq!(Some(false), hash_queue.check_hash_age(&last_valid_hash, 0));
|
|
}
|
|
|
|
/// 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, 0);
|
|
assert_eq!(last_hash, hash_queue.last_hash());
|
|
assert_eq!(Some(true), hash_queue.check_hash_age(&last_hash, 0));
|
|
}
|
|
|
|
#[test]
|
|
fn test_get_recent_blockhashes() {
|
|
let mut blockhash_queue = BlockhashQueue::new(MAX_RECENT_BLOCKHASHES);
|
|
#[allow(deprecated)]
|
|
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, 0);
|
|
}
|
|
#[allow(deprecated)]
|
|
let recent_blockhashes = blockhash_queue.get_recent_blockhashes();
|
|
// Verify that the returned hashes are most recent
|
|
#[allow(deprecated)]
|
|
for IterItem(_slot, hash, _lamports_per_signature) in recent_blockhashes {
|
|
assert_eq!(
|
|
Some(true),
|
|
blockhash_queue.check_hash_age(hash, MAX_RECENT_BLOCKHASHES)
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_len() {
|
|
const MAX_AGE: usize = 10;
|
|
let mut hash_queue = BlockhashQueue::new(MAX_AGE);
|
|
assert_eq!(hash_queue.ages.len(), 0);
|
|
|
|
for _ in 0..MAX_AGE {
|
|
hash_queue.register_hash(&Hash::new_unique(), 0);
|
|
}
|
|
assert_eq!(hash_queue.ages.len(), MAX_AGE);
|
|
|
|
// Show that the queue actually holds one more entry than the max age.
|
|
// This is because the most recent hash is considered to have an age of 0,
|
|
// which is likely the result of an unintentional off-by-one error in the past.
|
|
hash_queue.register_hash(&Hash::new_unique(), 0);
|
|
assert_eq!(hash_queue.ages.len(), MAX_AGE + 1);
|
|
|
|
// Ensure that no additional entries beyond `MAX_AGE + 1` are added
|
|
hash_queue.register_hash(&Hash::new_unique(), 0);
|
|
assert_eq!(hash_queue.ages.len(), MAX_AGE + 1);
|
|
}
|
|
|
|
#[test]
|
|
fn test_get_hash_age() {
|
|
const MAX_AGE: usize = 10;
|
|
let mut hash_list: Vec<Hash> = Vec::new();
|
|
hash_list.resize_with(MAX_AGE + 1, Hash::new_unique);
|
|
|
|
let mut hash_queue = BlockhashQueue::new(MAX_AGE);
|
|
for hash in &hash_list {
|
|
assert!(hash_queue.get_hash_age(hash).is_none());
|
|
}
|
|
|
|
for hash in &hash_list {
|
|
hash_queue.register_hash(hash, 0);
|
|
}
|
|
|
|
// Note that the "age" of a hash in the queue is 0-indexed. So when processing
|
|
// transactions in block 50, the hash for block 49 has an age of 0 despite
|
|
// being one block in the past.
|
|
for (age, hash) in hash_list.iter().rev().enumerate() {
|
|
assert_eq!(hash_queue.get_hash_age(hash), Some(age as u64));
|
|
}
|
|
|
|
// When the oldest hash is popped, it should no longer return a hash age
|
|
hash_queue.register_hash(&Hash::new_unique(), 0);
|
|
assert!(hash_queue.get_hash_age(&hash_list[0]).is_none());
|
|
}
|
|
|
|
#[test]
|
|
fn test_check_hash_age() {
|
|
const MAX_AGE: usize = 10;
|
|
let mut hash_list: Vec<Hash> = Vec::new();
|
|
hash_list.resize_with(MAX_AGE + 1, Hash::new_unique);
|
|
|
|
let mut hash_queue = BlockhashQueue::new(MAX_AGE);
|
|
for hash in &hash_list {
|
|
assert!(hash_queue.check_hash_age(hash, MAX_AGE).is_none());
|
|
}
|
|
|
|
for hash in &hash_list {
|
|
hash_queue.register_hash(hash, 0);
|
|
}
|
|
|
|
// Note that the "age" of a hash in the queue is 0-indexed. So when checking
|
|
// the age of a hash is within max age, the hash from 11 slots ago is considered
|
|
// to be within the max age of 10.
|
|
for hash in &hash_list {
|
|
assert_eq!(hash_queue.check_hash_age(hash, MAX_AGE), Some(true));
|
|
}
|
|
|
|
// When max age is 0, the most recent blockhash is still considered valid
|
|
assert_eq!(
|
|
hash_queue.check_hash_age(&hash_list[MAX_AGE], 0),
|
|
Some(true)
|
|
);
|
|
|
|
// Just because a hash is in the queue, doesn't mean it's valid for max age
|
|
assert_eq!(
|
|
hash_queue.check_hash_age(&hash_list[0], MAX_AGE - 1),
|
|
Some(false)
|
|
);
|
|
}
|
|
}
|