/* This file is part of DarkFi (https://dark.fi)
*
* Copyright (C) 2020-2024 Dyne.org foundation
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*/
use std::sync::{Arc, Mutex};
use log::debug;
use sled::Transactional;
use darkfi_serial::{deserialize, serialize, Decodable};
use crate::{tx::Transaction, util::time::Timestamp, Error, Result};
/// Block related definitions and storage implementations
pub mod block_store;
pub use block_store::{Block, BlockDifficulty, BlockInfo, BlockStore, BlockStoreOverlay};
/// Header definition and storage implementation
pub mod header_store;
pub use header_store::{Header, HeaderStore, HeaderStoreOverlay};
/// Transactions related storage implementations
pub mod tx_store;
pub use tx_store::{TxStore, TxStoreOverlay};
/// Contracts and Wasm storage implementations
pub mod contract_store;
pub use contract_store::{ContractStore, ContractStoreOverlay};
/// Structure holding all sled trees that define the concept of Blockchain.
#[derive(Clone)]
pub struct Blockchain {
/// Main pointer to the sled db connection
pub sled_db: sled::Db,
/// Headers sled tree
pub headers: HeaderStore,
/// Blocks sled tree
pub blocks: BlockStore,
/// Transactions related sled trees
pub transactions: TxStore,
/// Contracts related sled trees
pub contracts: ContractStore,
}
impl Blockchain {
/// Instantiate a new `Blockchain` with the given `sled` database.
pub fn new(db: &sled::Db) -> Result {
let headers = HeaderStore::new(db)?;
let blocks = BlockStore::new(db)?;
let transactions = TxStore::new(db)?;
let contracts = ContractStore::new(db)?;
Ok(Self { sled_db: db.clone(), headers, blocks, transactions, contracts })
}
/// Insert a given [`BlockInfo`] into the blockchain database.
/// This functions wraps all the logic of separating the block into specific
/// data that can be fed into the different trees of the database.
/// Upon success, the functions returns the block hash that
/// were given and appended to the ledger.
pub fn add_block(&self, block: &BlockInfo) -> Result {
let mut trees = vec![];
let mut batches = vec![];
// Store header
let (headers_batch, _) = self.headers.insert_batch(&[block.header.clone()])?;
trees.push(self.headers.0.clone());
batches.push(headers_batch);
// Store block
let blk: Block = Block::from_block_info(block)?;
let (bocks_batch, block_hashes) = self.blocks.insert_batch(&[blk])?;
let block_hash = block_hashes[0];
let block_hash_vec = [block_hash];
trees.push(self.blocks.main.clone());
batches.push(bocks_batch);
// Store block order
let blocks_order_batch =
self.blocks.insert_batch_order(&[block.header.height], &block_hash_vec)?;
trees.push(self.blocks.order.clone());
batches.push(blocks_order_batch);
// Store transactions
let (txs_batch, txs_hashes) = self.transactions.insert_batch(&block.txs)?;
trees.push(self.transactions.main.clone());
batches.push(txs_batch);
// Store transactions_locations
let txs_locations_batch =
self.transactions.insert_batch_location(&txs_hashes, block.header.height)?;
trees.push(self.transactions.location.clone());
batches.push(txs_locations_batch);
// Perform an atomic transaction over the trees and apply the batches.
self.atomic_write(&trees, &batches)?;
Ok(block_hash)
}
/// Check if the given [`BlockInfo`] is in the database and all trees.
pub fn has_block(&self, block: &BlockInfo) -> Result {
let blockhash = match self.blocks.get_order(&[block.header.height], true) {
Ok(v) => v[0].unwrap(),
Err(_) => return Ok(false),
};
// Check if we have all transactions
let txs: Vec =
block.txs.iter().map(|x| blake3::hash(&serialize(x))).collect();
if self.transactions.get(&txs, true).is_err() {
return Ok(false)
}
// Check provided info produces the same hash
Ok(blockhash == block.hash()?)
}
/// Retrieve [`BlockInfo`]s by given hashes. Fails if any of them is not found.
pub fn get_blocks_by_hash(&self, hashes: &[blake3::Hash]) -> Result> {
let blocks = self.blocks.get(hashes, true)?;
let blocks: Vec = blocks.iter().map(|x| x.clone().unwrap()).collect();
let ret = self.get_blocks_infos(&blocks)?;
Ok(ret)
}
/// Retrieve all [`BlockInfo`] for given slice of [`Block`].
/// Fails if any of them is not found
fn get_blocks_infos(&self, blocks: &[Block]) -> Result> {
let mut ret = Vec::with_capacity(blocks.len());
for block in blocks {
let headers = self.headers.get(&[block.header], true)?;
// Since we used strict get, its safe to unwrap here
let header = headers[0].clone().unwrap();
let txs = self.transactions.get(&block.txs, true)?;
let txs = txs.iter().map(|x| x.clone().unwrap()).collect();
let info = BlockInfo::new(header, txs, block.signature);
ret.push(info);
}
Ok(ret)
}
/// Retrieve [`BlockInfo`]s by given heights. Does not fail if any of them are not found.
pub fn get_blocks_by_heights(&self, heights: &[u64]) -> Result> {
debug!(target: "blockchain", "get_blocks_by_heights(): {:?}", heights);
let blockhashes = self.blocks.get_order(heights, false)?;
let mut hashes = vec![];
for i in blockhashes.into_iter().flatten() {
hashes.push(i);
}
self.get_blocks_by_hash(&hashes)
}
/// Retrieve n blocks after given start block height.
pub fn get_blocks_after(&self, height: u64, n: u64) -> Result> {
debug!(target: "blockchain", "get_blocks_after(): {} -> {}", height, n);
let hashes = self.blocks.get_after(height, n)?;
self.get_blocks_by_hash(&hashes)
}
/// Retrieve stored blocks count
pub fn len(&self) -> usize {
self.blocks.len()
}
/// Retrieve stored txs count
pub fn txs_len(&self) -> usize {
self.transactions.len()
}
/// Check if blockchain contains any blocks
pub fn is_empty(&self) -> bool {
self.blocks.is_empty()
}
/// Retrieve genesis (first) block height and hash.
pub fn genesis(&self) -> Result<(u64, blake3::Hash)> {
self.blocks.get_first()
}
/// Retrieve genesis (first) block info.
pub fn genesis_block(&self) -> Result {
let (_, hash) = self.genesis()?;
Ok(self.get_blocks_by_hash(&[hash])?[0].clone())
}
/// Retrieve the last block height and hash.
pub fn last(&self) -> Result<(u64, blake3::Hash)> {
self.blocks.get_last()
}
/// Retrieve the last block info.
pub fn last_block(&self) -> Result {
let (_, hash) = self.last()?;
Ok(self.get_blocks_by_hash(&[hash])?[0].clone())
}
/// Retrieve the last block difficulty. If the tree is empty,
/// returns `BlockDifficulty::genesis` difficulty.
pub fn last_block_difficulty(&self) -> Result {
if let Some(found) = self.blocks.get_last_difficulty()? {
return Ok(found)
}
let genesis_block = self.genesis_block()?;
Ok(BlockDifficulty::genesis(genesis_block.header.timestamp))
}
/// Check if block order for the given height is in the database.
pub fn has_height(&self, height: u64) -> Result {
let vec = match self.blocks.get_order(&[height], true) {
Ok(v) => v,
Err(_) => return Ok(false),
};
Ok(!vec.is_empty())
}
/// Insert a given slice of pending transactions into the blockchain database.
/// On success, the function returns the transaction hashes in the same order
/// as the input transactions.
pub fn add_pending_txs(&self, txs: &[Transaction]) -> Result> {
let (txs_batch, txs_hashes) = self.transactions.insert_batch_pending(txs)?;
let txs_order_batch = self.transactions.insert_batch_pending_order(&txs_hashes)?;
// Perform an atomic transaction over the trees and apply the batches.
let trees = [self.transactions.pending.clone(), self.transactions.pending_order.clone()];
let batches = [txs_batch, txs_order_batch];
self.atomic_write(&trees, &batches)?;
Ok(txs_hashes)
}
/// Retrieve all transactions from the pending tx store.
/// Be careful as this will try to load everything in memory.
pub fn get_pending_txs(&self) -> Result> {
let txs = self.transactions.get_all_pending()?;
let indexes = self.transactions.get_all_pending_order()?;
if txs.len() != indexes.len() {
return Err(Error::InvalidInputLengths)
}
let mut ret = Vec::with_capacity(txs.len());
for index in indexes {
ret.push(txs.get(&index.1).unwrap().clone());
}
Ok(ret)
}
/// Remove a given slice of pending transactions from the blockchain database.
pub fn remove_pending_txs(&self, txs: &[Transaction]) -> Result<()> {
let txs_hashes: Vec =
txs.iter().map(|x| blake3::hash(&serialize(x))).collect();
let indexes = self.transactions.get_all_pending_order()?;
// We could do indexes.iter().map(|x| txs_hashes.contains(x.1)).collect.map(|x| x.0).collect
// but this is faster since we don't do the second iteration
let mut removed_indexes = vec![];
for index in indexes {
if txs_hashes.contains(&index.1) {
removed_indexes.push(index.0);
}
}
let txs_batch = self.transactions.remove_batch_pending(&txs_hashes);
let txs_order_batch = self.transactions.remove_batch_pending_order(&removed_indexes);
// Perform an atomic transaction over the trees and apply the batches.
let trees = [self.transactions.pending.clone(), self.transactions.pending_order.clone()];
let batches = [txs_batch, txs_order_batch];
self.atomic_write(&trees, &batches)?;
Ok(())
}
/// Auxiliary function to write to multiple trees completely atomic.
fn atomic_write(&self, trees: &[sled::Tree], batches: &[sled::Batch]) -> Result<()> {
if trees.len() != batches.len() {
return Err(Error::InvalidInputLengths)
}
trees.transaction(|trees| {
for (index, tree) in trees.iter().enumerate() {
tree.apply_batch(&batches[index])?;
}
Ok::<(), sled::transaction::ConflictableTransactionError>(())
})?;
Ok(())
}
/// Retrieve all blocks contained in the blockchain in order.
/// Be careful as this will try to load everything in memory.
pub fn get_all(&self) -> Result> {
let order = self.blocks.get_all_order()?;
let order: Vec = order.iter().map(|x| x.1).collect();
let blocks = self.get_blocks_by_hash(&order)?;
Ok(blocks)
}
}
/// Atomic pointer to sled db overlay.
pub type SledDbOverlayPtr = Arc>;
/// Atomic pointer to blockchain overlay.
pub type BlockchainOverlayPtr = Arc>;
/// Overlay structure over a [`Blockchain`] instance.
pub struct BlockchainOverlay {
/// Main [`sled_overlay::SledDbOverlay`] to the sled db connection
pub overlay: SledDbOverlayPtr,
/// Headers overlay
pub headers: HeaderStoreOverlay,
/// Blocks overlay
pub blocks: BlockStoreOverlay,
/// Transactions overlay
pub transactions: TxStoreOverlay,
/// Contract overlay
pub contracts: ContractStoreOverlay,
}
impl BlockchainOverlay {
/// Instantiate a new `BlockchainOverlay` over the given [`Blockchain`] instance.
pub fn new(blockchain: &Blockchain) -> Result {
let overlay = Arc::new(Mutex::new(sled_overlay::SledDbOverlay::new(&blockchain.sled_db)));
let headers = HeaderStoreOverlay::new(&overlay)?;
let blocks = BlockStoreOverlay::new(&overlay)?;
let transactions = TxStoreOverlay::new(&overlay)?;
let contracts = ContractStoreOverlay::new(&overlay)?;
Ok(Arc::new(Mutex::new(Self { overlay, headers, blocks, transactions, contracts })))
}
/// Check if blockchain contains any blocks
pub fn is_empty(&self) -> Result {
self.blocks.is_empty()
}
/// Retrieve the last block height and hash.
pub fn last(&self) -> Result<(u64, blake3::Hash)> {
self.blocks.get_last()
}
/// Retrieve the last block info.
pub fn last_block(&self) -> Result {
let (_, hash) = self.last()?;
Ok(self.get_blocks_by_hash(&[hash])?[0].clone())
}
/// Retrieve the last block height.
pub fn last_block_height(&self) -> Result {
Ok(self.last()?.0)
}
/// Retrieve the last block timestamp.
pub fn last_block_timestamp(&self) -> Result {
let (_, hash) = self.last()?;
Ok(self.get_blocks_by_hash(&[hash])?[0].header.timestamp)
}
/// Insert a given [`BlockInfo`] into the overlay.
/// This functions wraps all the logic of separating the block into specific
/// data that can be fed into the different trees of the overlay.
/// Upon success, the functions returns the block hash that
/// were given and appended to the overlay.
/// Since we are adding to the overlay, we don't need to exeucte
/// the writes atomically.
pub fn add_block(&self, block: &BlockInfo) -> Result {
// Store header
self.headers.insert(&[block.header.clone()])?;
// Store block
let blk: Block = Block::from_block_info(block)?;
let txs_hashes = blk.txs.clone();
let block_hash = self.blocks.insert(&[blk])?[0];
let block_hash_vec = [block_hash];
// Store block order
self.blocks.insert_order(&[block.header.height], &block_hash_vec)?;
// Store transactions
self.transactions.insert(&block.txs)?;
// Store transactions locations
self.transactions.insert_location(&txs_hashes, block.header.height)?;
Ok(block_hash)
}
/// Check if the given [`BlockInfo`] is in the database and all trees.
pub fn has_block(&self, block: &BlockInfo) -> Result {
let blockhash = match self.blocks.get_order(&[block.header.height], true) {
Ok(v) => v[0].unwrap(),
Err(_) => return Ok(false),
};
// Check if we have all transactions
let txs: Vec =
block.txs.iter().map(|x| blake3::hash(&serialize(x))).collect();
if self.transactions.get(&txs, true).is_err() {
return Ok(false)
}
// Check provided info produces the same hash
Ok(blockhash == block.hash()?)
}
/// Retrieve [`BlockInfo`]s by given hashes. Fails if any of them is not found.
pub fn get_blocks_by_hash(&self, hashes: &[blake3::Hash]) -> Result> {
let blocks = self.blocks.get(hashes, true)?;
let blocks: Vec = blocks.iter().map(|x| x.clone().unwrap()).collect();
let ret = self.get_blocks_infos(&blocks)?;
Ok(ret)
}
/// Retrieve all [`BlockInfo`] for given slice of [`Block`].
/// Fails if any of them is not found
fn get_blocks_infos(&self, blocks: &[Block]) -> Result> {
let mut ret = Vec::with_capacity(blocks.len());
for block in blocks {
let headers = self.headers.get(&[block.header], true)?;
// Since we used strict get, its safe to unwrap here
let header = headers[0].clone().unwrap();
let txs = self.transactions.get(&block.txs, true)?;
let txs = txs.iter().map(|x| x.clone().unwrap()).collect();
let info = BlockInfo::new(header, txs, block.signature);
ret.push(info);
}
Ok(ret)
}
/// Retrieve [`Block`]s by given hashes and return their transactions hashes.
pub fn get_blocks_txs_hashes(&self, hashes: &[blake3::Hash]) -> Result> {
let blocks = self.blocks.get(hashes, true)?;
let mut ret = vec![];
for block in blocks {
ret.extend_from_slice(&block.unwrap().txs);
}
Ok(ret)
}
/// Checkpoint overlay so we can revert to it, if needed.
pub fn checkpoint(&self) {
self.overlay.lock().unwrap().checkpoint();
}
/// Revert to current overlay checkpoint.
pub fn revert_to_checkpoint(&self) -> Result<()> {
self.overlay.lock().unwrap().revert_to_checkpoint()?;
Ok(())
}
/// Auxiliary function to create a full clone using SledDbOverlay::clone,
/// generating new pointers for the underlying overlays.
pub fn full_clone(&self) -> Result {
let overlay = Arc::new(Mutex::new(self.overlay.lock().unwrap().clone()));
let headers = HeaderStoreOverlay::new(&overlay)?;
let blocks = BlockStoreOverlay::new(&overlay)?;
let transactions = TxStoreOverlay::new(&overlay)?;
let contracts = ContractStoreOverlay::new(&overlay)?;
Ok(Arc::new(Mutex::new(Self { overlay, headers, blocks, transactions, contracts })))
}
}
/// Parse a sled record with a u64 keyin the form of a tuple (`key`, `value`).
pub fn parse_u64_key_record(record: (sled::IVec, sled::IVec)) -> Result<(u64, T)> {
let key_bytes: [u8; 8] = record.0.as_ref().try_into().unwrap();
let key = u64::from_be_bytes(key_bytes);
let value = deserialize(&record.1)?;
Ok((key, value))
}
/// Parse a sled record in the form of a tuple (`key`, `value`).
pub fn parse_record(
record: (sled::IVec, sled::IVec),
) -> Result<(T1, T2)> {
let key = deserialize(&record.0)?;
let value = deserialize(&record.1)?;
Ok((key, value))
}