2020-06-15 14:41:26 -07:00
|
|
|
//! The primary implementation of the `zebra_state::Service` built upon sled
|
2020-09-09 23:07:47 -07:00
|
|
|
|
2020-10-24 17:09:50 -07:00
|
|
|
use std::{collections::HashMap, convert::TryInto, sync::Arc};
|
2020-09-09 23:07:47 -07:00
|
|
|
|
2020-10-07 20:07:32 -07:00
|
|
|
use tracing::trace;
|
2020-06-15 14:41:26 -07:00
|
|
|
use zebra_chain::{
|
2020-09-10 10:19:45 -07:00
|
|
|
block::{self, Block},
|
2020-10-12 14:08:23 -07:00
|
|
|
parameters::{Network, GENESIS_PREVIOUS_BLOCK_HASH},
|
2020-06-15 14:41:26 -07:00
|
|
|
};
|
2020-10-14 14:06:32 -07:00
|
|
|
use zebra_chain::{
|
|
|
|
serialization::{ZcashDeserialize, ZcashSerialize},
|
|
|
|
transparent,
|
|
|
|
};
|
2020-06-15 14:41:26 -07:00
|
|
|
|
2020-09-10 10:19:45 -07:00
|
|
|
use crate::{BoxError, Config, HashOrHeight, QueuedBlock};
|
2020-09-09 21:15:08 -07:00
|
|
|
|
2020-09-10 14:16:39 -07:00
|
|
|
/// The finalized part of the chain state, stored in sled.
|
|
|
|
///
|
|
|
|
/// This structure has two categories of methods:
|
|
|
|
///
|
|
|
|
/// - *synchronous* methods that perform writes to the sled state;
|
|
|
|
/// - *asynchronous* methods that perform reads.
|
|
|
|
///
|
|
|
|
/// For more on this distinction, see RFC5. The synchronous methods are
|
2020-09-24 15:46:04 -07:00
|
|
|
/// implemented as ordinary methods on the [`FinalizedState`]. The asynchronous
|
2020-09-10 14:16:39 -07:00
|
|
|
/// methods are not implemented using `async fn`, but using normal methods that
|
|
|
|
/// return `impl Future<Output = ...>`. This allows them to move data (e.g.,
|
|
|
|
/// clones of handles for [`sled::Tree`]s) into the futures they return.
|
|
|
|
///
|
|
|
|
/// This means that the returned futures have a `'static` lifetime and don't
|
2020-09-24 15:46:04 -07:00
|
|
|
/// borrow any resources from the [`FinalizedState`], and the actual database work is
|
2020-09-10 14:16:39 -07:00
|
|
|
/// performed asynchronously when the returned future is polled, not while it is
|
|
|
|
/// created. This is analogous to the way [`tower::Service::call`] works.
|
2020-09-24 15:46:04 -07:00
|
|
|
pub struct FinalizedState {
|
2020-09-09 23:07:47 -07:00
|
|
|
/// Queued blocks that arrived out of order, indexed by their parent block hash.
|
|
|
|
queued_by_prev_hash: HashMap<block::Hash, QueuedBlock>,
|
|
|
|
|
2020-09-09 21:15:08 -07:00
|
|
|
hash_by_height: sled::Tree,
|
|
|
|
height_by_hash: sled::Tree,
|
|
|
|
block_by_height: sled::Tree,
|
|
|
|
// tx_by_hash: sled::Tree,
|
2020-10-14 14:06:32 -07:00
|
|
|
utxo_by_outpoint: sled::Tree,
|
2020-09-09 21:15:08 -07:00
|
|
|
// sprout_nullifiers: sled::Tree,
|
|
|
|
// sapling_nullifiers: sled::Tree,
|
|
|
|
// sprout_anchors: sled::Tree,
|
|
|
|
// sapling_anchors: sled::Tree,
|
2020-06-15 14:41:26 -07:00
|
|
|
}
|
|
|
|
|
2020-10-14 14:06:32 -07:00
|
|
|
/// Helper trait for inserting (Key, Value) pairs into sled when both the key and
|
|
|
|
/// value implement ZcashSerialize.
|
|
|
|
trait SledSerialize {
|
|
|
|
/// Serialize and insert the given key and value into a sled tree.
|
|
|
|
fn zs_insert<K, V>(
|
|
|
|
&self,
|
|
|
|
key: &K,
|
|
|
|
value: &V,
|
|
|
|
) -> Result<(), sled::transaction::UnabortableTransactionError>
|
|
|
|
where
|
|
|
|
K: ZcashSerialize,
|
|
|
|
V: ZcashSerialize;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Helper trait for retrieving values from sled trees when the key and value
|
|
|
|
/// implement ZcashSerialize/ZcashDeserialize.
|
|
|
|
trait SledDeserialize {
|
|
|
|
/// Serialize the given key and use that to get and deserialize the
|
|
|
|
/// corresponding value from a sled tree, if it is present.
|
|
|
|
fn zs_get<K, V>(&self, key: &K) -> Result<Option<V>, BoxError>
|
|
|
|
where
|
|
|
|
K: ZcashSerialize,
|
|
|
|
V: ZcashDeserialize;
|
|
|
|
}
|
|
|
|
|
|
|
|
impl SledSerialize for sled::transaction::TransactionalTree {
|
|
|
|
fn zs_insert<K, V>(
|
|
|
|
&self,
|
|
|
|
key: &K,
|
|
|
|
value: &V,
|
|
|
|
) -> Result<(), sled::transaction::UnabortableTransactionError>
|
|
|
|
where
|
|
|
|
K: ZcashSerialize,
|
|
|
|
V: ZcashSerialize,
|
|
|
|
{
|
|
|
|
let key_bytes = key
|
|
|
|
.zcash_serialize_to_vec()
|
|
|
|
.expect("serializing into a vec won't fail");
|
|
|
|
|
|
|
|
let value_bytes = value
|
|
|
|
.zcash_serialize_to_vec()
|
|
|
|
.expect("serializing into a vec won't fail");
|
|
|
|
|
|
|
|
self.insert(key_bytes, value_bytes)?;
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl SledDeserialize for sled::Tree {
|
|
|
|
fn zs_get<K, V>(&self, key: &K) -> Result<Option<V>, BoxError>
|
|
|
|
where
|
|
|
|
K: ZcashSerialize,
|
|
|
|
V: ZcashDeserialize,
|
|
|
|
{
|
|
|
|
let key_bytes = key
|
|
|
|
.zcash_serialize_to_vec()
|
|
|
|
.expect("serializing into a vec won't fail");
|
|
|
|
|
|
|
|
let value_bytes = self.get(&key_bytes)?;
|
|
|
|
|
|
|
|
let value = value_bytes
|
|
|
|
.as_deref()
|
|
|
|
.map(ZcashDeserialize::zcash_deserialize)
|
|
|
|
.transpose()?;
|
|
|
|
|
|
|
|
Ok(value)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-24 15:46:04 -07:00
|
|
|
impl FinalizedState {
|
2020-09-09 21:15:08 -07:00
|
|
|
pub fn new(config: &Config, network: Network) -> Self {
|
|
|
|
let db = config.sled_config(network).open().unwrap();
|
2020-06-15 14:41:26 -07:00
|
|
|
|
|
|
|
Self {
|
2020-09-09 23:07:47 -07:00
|
|
|
queued_by_prev_hash: HashMap::new(),
|
2020-09-09 21:15:08 -07:00
|
|
|
hash_by_height: db.open_tree(b"hash_by_height").unwrap(),
|
|
|
|
height_by_hash: db.open_tree(b"height_by_hash").unwrap(),
|
|
|
|
block_by_height: db.open_tree(b"block_by_height").unwrap(),
|
|
|
|
// tx_by_hash: db.open_tree(b"tx_by_hash").unwrap(),
|
2020-10-14 14:06:32 -07:00
|
|
|
utxo_by_outpoint: db.open_tree(b"utxo_by_outpoint").unwrap(),
|
2020-09-09 21:15:08 -07:00
|
|
|
// sprout_nullifiers: db.open_tree(b"sprout_nullifiers").unwrap(),
|
|
|
|
// sapling_nullifiers: db.open_tree(b"sapling_nullifiers").unwrap(),
|
2020-06-15 14:41:26 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-09 23:07:47 -07:00
|
|
|
/// Queue a finalized block to be committed to the state.
|
2020-09-10 14:16:39 -07:00
|
|
|
///
|
2020-09-10 14:42:20 -07:00
|
|
|
/// After queueing a finalized block, this method checks whether the newly
|
|
|
|
/// queued block (and any of its descendants) can be committed to the state.
|
2020-10-07 20:07:32 -07:00
|
|
|
pub fn queue_and_commit_finalized_blocks(&mut self, queued_block: QueuedBlock) {
|
2020-09-09 23:07:47 -07:00
|
|
|
let prev_hash = queued_block.block.header.previous_block_hash;
|
|
|
|
self.queued_by_prev_hash.insert(prev_hash, queued_block);
|
|
|
|
|
2020-10-07 20:07:32 -07:00
|
|
|
while let Some(queued_block) = self.queued_by_prev_hash.remove(&self.finalized_tip_hash()) {
|
2020-10-09 18:49:44 -07:00
|
|
|
let height = queued_block
|
|
|
|
.block
|
|
|
|
.coinbase_height()
|
|
|
|
.expect("valid blocks must have a height");
|
|
|
|
self.commit_finalized(queued_block);
|
|
|
|
metrics::counter!("state.committed.block.count", 1);
|
|
|
|
metrics::gauge!("state.committed.block.height", height.0 as _);
|
2020-09-09 23:07:47 -07:00
|
|
|
}
|
2020-10-09 18:49:44 -07:00
|
|
|
|
|
|
|
metrics::gauge!(
|
|
|
|
"state.queued.block.count",
|
|
|
|
self.queued_by_prev_hash.len() as _
|
|
|
|
);
|
2020-09-09 23:07:47 -07:00
|
|
|
}
|
|
|
|
|
2020-10-07 20:07:32 -07:00
|
|
|
/// Returns the hash of the current finalized tip block.
|
|
|
|
pub fn finalized_tip_hash(&self) -> block::Hash {
|
2020-10-24 17:09:50 -07:00
|
|
|
self.tip()
|
2020-10-07 20:07:32 -07:00
|
|
|
.expect("inability to look up tip is unrecoverable")
|
|
|
|
.map(|(_, hash)| hash)
|
|
|
|
// if the state is empty, return the genesis previous block hash
|
2020-10-12 14:08:23 -07:00
|
|
|
.unwrap_or(GENESIS_PREVIOUS_BLOCK_HASH)
|
2020-10-07 20:07:32 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the height of the current finalized tip block.
|
|
|
|
pub fn finalized_tip_height(&self) -> Option<block::Height> {
|
2020-10-24 17:09:50 -07:00
|
|
|
self.tip()
|
2020-10-07 20:07:32 -07:00
|
|
|
.expect("inability to look up tip is unrecoverable")
|
|
|
|
.map(|(height, _)| height)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Immediately commit `block` to the finalized state.
|
|
|
|
pub fn commit_finalized_direct(&mut self, block: Arc<Block>) -> Result<block::Hash, BoxError> {
|
|
|
|
use sled::Transactional;
|
2020-09-09 23:07:47 -07:00
|
|
|
|
2020-09-11 12:56:32 -07:00
|
|
|
let height = block
|
|
|
|
.coinbase_height()
|
|
|
|
.expect("finalized blocks are valid and have a coinbase height");
|
2020-09-09 21:15:08 -07:00
|
|
|
let height_bytes = height.0.to_be_bytes();
|
2020-08-15 23:20:01 -07:00
|
|
|
let hash = block.hash();
|
2020-06-15 14:41:26 -07:00
|
|
|
|
2020-10-07 20:07:32 -07:00
|
|
|
trace!(?height, "Finalized block");
|
|
|
|
|
|
|
|
(
|
2020-09-09 21:15:08 -07:00
|
|
|
&self.hash_by_height,
|
|
|
|
&self.height_by_hash,
|
|
|
|
&self.block_by_height,
|
2020-10-14 14:06:32 -07:00
|
|
|
&self.utxo_by_outpoint,
|
2020-09-09 21:15:08 -07:00
|
|
|
)
|
2020-10-14 14:06:32 -07:00
|
|
|
.transaction(
|
|
|
|
move |(hash_by_height, height_by_hash, block_by_height, utxo_by_outpoint)| {
|
|
|
|
// TODO: do serialization above
|
|
|
|
// for some reason this wouldn't move into the closure (??)
|
|
|
|
let block_bytes = block
|
|
|
|
.zcash_serialize_to_vec()
|
|
|
|
.expect("zcash_serialize_to_vec has wrong return type");
|
|
|
|
|
|
|
|
// TODO: check highest entry of hash_by_height as in RFC
|
|
|
|
|
|
|
|
hash_by_height.insert(&height_bytes, &hash.0)?;
|
|
|
|
height_by_hash.insert(&hash.0, &height_bytes)?;
|
|
|
|
block_by_height.insert(&height_bytes, block_bytes)?;
|
|
|
|
// tx_by_hash
|
|
|
|
|
|
|
|
for transaction in block.transactions.iter() {
|
|
|
|
let transaction_hash = transaction.hash();
|
|
|
|
for (index, output) in transaction.outputs().iter().enumerate() {
|
|
|
|
let outpoint = transparent::OutPoint {
|
|
|
|
hash: transaction_hash,
|
|
|
|
index: index as _,
|
|
|
|
};
|
|
|
|
|
|
|
|
utxo_by_outpoint.zs_insert(&outpoint, output)?;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// sprout_nullifiers
|
|
|
|
// sapling_nullifiers
|
|
|
|
|
|
|
|
// for some reason type inference fails here
|
|
|
|
Ok::<_, sled::transaction::ConflictableTransactionError>(hash)
|
|
|
|
},
|
|
|
|
)
|
2020-10-07 20:07:32 -07:00
|
|
|
.map_err(Into::into)
|
|
|
|
}
|
2020-09-01 18:20:32 -07:00
|
|
|
|
2020-10-07 20:07:32 -07:00
|
|
|
/// Commit a finalized block to the state.
|
|
|
|
///
|
|
|
|
/// It's the caller's responsibility to ensure that blocks are committed in
|
|
|
|
/// order. This function is called by [`queue`], which ensures order.
|
|
|
|
/// It is intentionally not exposed as part of the public API of the
|
|
|
|
/// [`FinalizedState`].
|
|
|
|
fn commit_finalized(&mut self, queued_block: QueuedBlock) {
|
|
|
|
let QueuedBlock { block, rsp_tx } = queued_block;
|
|
|
|
let result = self.commit_finalized_direct(block);
|
2020-10-09 01:37:24 -07:00
|
|
|
let _ = rsp_tx.send(result.map_err(Into::into));
|
2020-06-15 14:41:26 -07:00
|
|
|
}
|
|
|
|
|
2020-09-09 21:15:08 -07:00
|
|
|
// TODO: this impl works only during checkpointing, it needs to be rewritten
|
2020-10-24 17:09:50 -07:00
|
|
|
pub fn block_locator(&self) -> Result<Vec<block::Hash>, BoxError> {
|
|
|
|
let (tip_height, _) = match self.tip()? {
|
|
|
|
Some(height) => height,
|
|
|
|
None => return Ok(Vec::new()),
|
|
|
|
};
|
|
|
|
|
|
|
|
let heights = crate::util::block_locator_heights(tip_height);
|
|
|
|
let mut hashes = Vec::with_capacity(heights.len());
|
|
|
|
for height in heights {
|
|
|
|
if let Some(bytes) = self.hash_by_height.get(&height.0.to_be_bytes())? {
|
|
|
|
let hash = block::Hash(bytes.as_ref().try_into().unwrap());
|
|
|
|
hashes.push(hash)
|
2020-09-09 21:15:08 -07:00
|
|
|
}
|
2020-06-15 14:41:26 -07:00
|
|
|
}
|
2020-10-24 17:09:50 -07:00
|
|
|
Ok(hashes)
|
2020-06-15 14:41:26 -07:00
|
|
|
}
|
|
|
|
|
2020-10-24 17:09:50 -07:00
|
|
|
pub fn tip(&self) -> Result<Option<(block::Height, block::Hash)>, BoxError> {
|
|
|
|
Ok(self.hash_by_height.iter().rev().next().transpose()?.map(
|
|
|
|
|(height_bytes, hash_bytes)| {
|
|
|
|
let height = block::Height(u32::from_be_bytes(
|
|
|
|
height_bytes.as_ref().try_into().unwrap(),
|
|
|
|
));
|
|
|
|
let hash = block::Hash(hash_bytes.as_ref().try_into().unwrap());
|
|
|
|
(height, hash)
|
|
|
|
},
|
|
|
|
))
|
2020-07-30 16:21:54 -07:00
|
|
|
}
|
|
|
|
|
2020-10-24 17:09:50 -07:00
|
|
|
pub fn depth(&self, hash: block::Hash) -> Result<Option<u32>, BoxError> {
|
|
|
|
let height = match self.height_by_hash.get(&hash.0)? {
|
|
|
|
Some(bytes) => block::Height(u32::from_be_bytes(bytes.as_ref().try_into().unwrap())),
|
|
|
|
None => return Ok(None),
|
|
|
|
};
|
2020-06-15 14:41:26 -07:00
|
|
|
|
2020-10-24 17:09:50 -07:00
|
|
|
let (tip_height, _) = self.tip()?.expect("tip must exist");
|
|
|
|
|
|
|
|
Ok(Some(tip_height.0 - height.0))
|
|
|
|
}
|
2020-06-22 19:24:53 -07:00
|
|
|
|
2020-10-24 17:09:50 -07:00
|
|
|
pub fn block(&self, hash_or_height: HashOrHeight) -> Result<Option<Arc<Block>>, BoxError> {
|
|
|
|
let height = match hash_or_height {
|
|
|
|
HashOrHeight::Height(height) => height,
|
|
|
|
HashOrHeight::Hash(hash) => match self.height_by_hash.get(&hash.0)? {
|
2020-09-09 21:15:08 -07:00
|
|
|
Some(bytes) => {
|
|
|
|
block::Height(u32::from_be_bytes(bytes.as_ref().try_into().unwrap()))
|
|
|
|
}
|
|
|
|
None => return Ok(None),
|
2020-10-24 17:09:50 -07:00
|
|
|
},
|
|
|
|
};
|
2020-06-22 19:24:53 -07:00
|
|
|
|
2020-10-24 17:09:50 -07:00
|
|
|
match self.block_by_height.get(&height.0.to_be_bytes())? {
|
|
|
|
Some(bytes) => Ok(Some(Arc::<Block>::zcash_deserialize(bytes.as_ref())?)),
|
|
|
|
None => Ok(None),
|
2020-09-10 10:19:45 -07:00
|
|
|
}
|
|
|
|
}
|
2020-10-14 14:06:32 -07:00
|
|
|
|
|
|
|
/// Returns the `transparent::Output` pointed to by the given
|
|
|
|
/// `transparent::OutPoint` if it is present.
|
|
|
|
pub fn utxo(
|
|
|
|
&self,
|
|
|
|
outpoint: &transparent::OutPoint,
|
|
|
|
) -> Result<Option<transparent::Output>, BoxError> {
|
|
|
|
self.utxo_by_outpoint.zs_get(outpoint)
|
|
|
|
}
|
2020-10-26 13:54:19 -07:00
|
|
|
|
|
|
|
/// Returns the finalized hash for a given `block::Height` if it is present.
|
|
|
|
pub fn get_hash(&self, height: block::Height) -> Option<block::Hash> {
|
|
|
|
self.hash_by_height
|
|
|
|
.get(&height.0.to_be_bytes())
|
|
|
|
.expect("expected that sled errors would not occur")
|
|
|
|
.map(|bytes| block::Hash(bytes.as_ref().try_into().unwrap()))
|
|
|
|
}
|
2020-07-30 16:21:54 -07:00
|
|
|
}
|