Merge pull request #351 from mintlayer/move-consensus-from-chainstate-to-separate-crate

Move the consensus related logic from chainstate to a separate crate

Author: stanislav-tkach

Cargo.lock

@@ -11,28 +11,29 @@ edition = "2021"
 
 [workspace]
 members = [
-  "common",        # everything else, until it's moved to another crate
-  "crypto",        # cryptographic primitives and their interfaces
-  "chainstate",    # code on chainstate of blocks and transactions
-  "script",        # bitcoin script and its interfaces
-  "logging",       # logging engine and its interfaces
-  "mempool",       # mempool interface and implementation
-  "p2p",           # p2p communication interfaces and protocols
-  "rpc",           # rpc abstraction and implementation
-  "serialization", # full featured serialization interfaces and implementations
-  "serialization/core",    # serialization core tools
-  "serialization/tagged",  # serialization for direct/tagged encoding style
-  "serialization/tagged/derive",  # direct/tagged encoding style derive macros
-  "storage",       # storage abstraction layer and its implementation
-  "storage/core",  # Core backend-agnostic storage abstraction
-  "storage/inmemory",      # In-memory storage backend implementation
-  "subsystem",     # Utilities for working with concurrent subsystems
-  "node",          # node executable
-  "wallet",        # wallet executable
-  "utils",         # various utilities
-  "utxo",          # utxo and related utilities (cache, undo, etc.)
-  "test",          # integration tests
-  "test-utils",    # various utilities for tests
+  "common",                       # Everything else, until it's moved to another crate.
+  "crypto",                       # Cryptographic primitives and their interfaces.
+  "consensus",                    # Consensus related logic.
+  "chainstate",                   # Code on chainstate of blocks and transactions.
+  "script",                       # Bitcoin script and its interfaces.
+  "logging",                      # Logging engine and its interfaces.
+  "mempool",                      # Mempool interface and implementation.
+  "p2p",                          # P2p communication interfaces and protocols.
+  "rpc",                          # Rpc abstraction and implementation.
+  "serialization",                # Full featured serialization interfaces and implementations.
+  "serialization/core",           # Serialization core tools.
+  "serialization/tagged",         # Serialization for direct/tagged encoding style.
+  "serialization/tagged/derive",  # direct/tagged encoding style derive macros.
+  "storage",                      # storage abstraction layer and its implementation.
+  "storage/core",                 # Core backend-agnostic storage abstraction.
+  "storage/inmemory",             # In-memory storage backend implementation.
+  "subsystem",                    # Utilities for working with concurrent subsystems.
+  "node",                         # Node executable.
+  "wallet",                       # Wallet executable.
+  "utils",                        # Various utilities.
+  "utxo",                         # Utxo and related utilities (cache, undo, etc.).
+  "test",                         # Integration tests.
+  "test-utils",                   # Various utilities for tests.
 ]
 
 default-members = [

Cargo.toml

@@ -15,14 +15,20 @@
 
 pub mod utxo_db;
 
-use chainstate_types::block_index::BlockIndex;
-use common::chain::transaction::{Transaction, TxMainChainIndex, TxMainChainPosition};
-use common::chain::{Block, GenBlock, OutPoint, OutPointSourceId};
-use common::primitives::{BlockHeight, Id, Idable};
+use chainstate_types::BlockIndex;
+use common::{
+    chain::{
+        transaction::{Transaction, TxMainChainIndex, TxMainChainPosition},
+        Block, GenBlock, OutPoint, OutPointSourceId,
+    },
+    primitives::{BlockHeight, Id, Idable},
+};
 use serialization::{Codec, Decode, DecodeAll, Encode};
 use storage::traits::{self, MapMut, MapRef, TransactionRo, TransactionRw};
-use utxo::utxo_storage::{UtxosStorageRead, UtxosStorageWrite};
-use utxo::{BlockUndo, Utxo};
+use utxo::{
+    utxo_storage::{UtxosStorageRead, UtxosStorageWrite},
+    BlockUndo, Utxo,
+};
 
 use crate::{BlockchainStorage, BlockchainStorageRead, BlockchainStorageWrite, Transactional};
 

chainstate-storage/src/internal/mod.rs

@@ -15,7 +15,7 @@
 
 //! Application-level interface for the persistent blockchain storage.
 
-use chainstate_types::block_index::BlockIndex;
+use chainstate_types::BlockIndex;
 use common::chain::transaction::{Transaction, TxMainChainIndex, TxMainChainPosition};
 use common::chain::OutPointSourceId;
 use common::chain::{Block, GenBlock};

chainstate-storage/src/lib.rs

@@ -15,14 +15,18 @@
 
 //! A mock version of the blockchain storage.
 
-use chainstate_types::block_index::BlockIndex;
-use common::chain::transaction::{
-    OutPointSourceId, Transaction, TxMainChainIndex, TxMainChainPosition,
+use chainstate_types::BlockIndex;
+use common::{
+    chain::{
+        transaction::{OutPointSourceId, Transaction, TxMainChainIndex, TxMainChainPosition},
+        Block, GenBlock, OutPoint,
+    },
+    primitives::{BlockHeight, Id},
+};
+use utxo::{
+    utxo_storage::{UtxosStorageRead, UtxosStorageWrite},
+    BlockUndo, Utxo,
 };
-use common::chain::{Block, GenBlock, OutPoint};
-use common::primitives::{BlockHeight, Id};
-use utxo::utxo_storage::{UtxosStorageRead, UtxosStorageWrite};
-use utxo::{BlockUndo, Utxo};
 
 mockall::mock! {
     /// A mock object for blockchain storage

chainstate-storage/src/mock.rs

@@ -0,0 +1,46 @@
+// Copyright (c) 2022 RBB S.r.l
+// [email protected]
+// SPDX-License-Identifier: MIT
+// Licensed under the MIT License;
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// https://github.com/mintlayer/mintlayer-core/blob/master/LICENSE
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use thiserror::Error;
+
+use common::{
+    chain::{Block, GenBlock},
+    primitives::{BlockHeight, Id},
+};
+
+#[derive(Error, Debug, PartialEq, Eq, Clone)]
+pub enum PropertyQueryError {
+    #[error("Blockchain storage error: {0}")]
+    StorageError(#[from] crate::storage_result::Error),
+    #[error("Best block not found")]
+    BestBlockNotFound,
+    #[error("Best block index not found")]
+    BestBlockIndexNotFound,
+    #[error("Block not found {0}")]
+    BlockNotFound(Id<Block>),
+    #[error("Previous block index not found {0}")]
+    PrevBlockIndexNotFound(Id<GenBlock>),
+    #[error("Block for height {0} not found")]
+    BlockForHeightNotFound(BlockHeight),
+    #[error("Provided an empty list")]
+    InvalidInputEmpty,
+    #[error("Invalid ancestor height: sought ancestor with height {ancestor_height} for block with height {block_height}")]
+    InvalidAncestorHeight {
+        block_height: BlockHeight,
+        ancestor_height: BlockHeight,
+    },
+    #[error("Genesis block has no header")]
+    GenesisHeaderRequested,
+}

chainstate-types/src/error.rs

@@ -13,13 +13,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use chainstate_types::block_index::BlockIndex;
-use common::chain::block::timestamp::BlockTimestamp;
-use common::chain::{GenBlock, Genesis};
-use common::primitives::{id::WithId, BlockHeight, Id, Idable};
-use common::Uint256;
 use std::sync::Arc;
 
+use common::{
+    chain::{block::timestamp::BlockTimestamp, GenBlock, Genesis},
+    primitives::{id::WithId, BlockHeight, Id, Idable},
+    Uint256,
+};
+
+use crate::block_index::BlockIndex;
+
 /// Generalized block index
 #[derive(Clone, Debug)]
 #[allow(clippy::large_enum_variant)]

chainstate/src/detail/gen_block_index.rs renamed to chainstate-types/src/gen_block_index.rs

@@ -13,7 +13,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-pub mod block_index;
-pub mod height_skip;
-pub mod locator;
 pub mod storage_result;
+
+pub use crate::{
+    block_index::BlockIndex, error::PropertyQueryError, gen_block_index::GenBlockIndex,
+    height_skip::get_skip_height, locator::Locator,
+};
+
+mod block_index;
+mod error;
+mod gen_block_index;
+mod height_skip;
+mod locator;

chainstate-types/src/lib.rs

@@ -17,12 +17,12 @@ serialization = {path = "../serialization"}
 subsystem = {path = '../subsystem'}
 utxo = {path = '../utxo'}
 utils = {path = '../utils'}
+consensus = {path = "../consensus"}
 
 async-trait = "0.1"
 hex = "0.4"
 itertools = "0.10"
 jsonrpsee = {version = "0.14", features = ["macros"]}
-num = "0.4.0"
 replace_with = "0.1"
 thiserror = "1.0"
 serde = { version = "1", features = ["derive"] }

chainstate/Cargo.toml

@@ -13,13 +13,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::BlockError;
+use consensus::{ConsensusPoWError, ConsensusVerificationError};
 
 use super::{
-    pow::error::ConsensusPoWError, transaction_verifier::error::ConnectTransactionError,
-    BlockSizeError, CheckBlockError, CheckBlockTransactionsError, ConsensusVerificationError,
-    OrphanCheckError,
+    transaction_verifier::error::ConnectTransactionError, BlockSizeError, CheckBlockError,
+    CheckBlockTransactionsError, OrphanCheckError,
 };
+use crate::BlockError;
 
 // TODO: use a ban_score macro in a form similar to thiserror::Error in order to define the ban score
 //       value of an error on the error enum arms instead of separately like in this file

chainstate/src/detail/ban_score.rs

@@ -13,10 +13,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use super::{consensus_validator::BlockIndexHandle, GenBlockIndex};
 use common::{chain::GenBlock, primitives::Id};
+use consensus::BlockIndexHandle;
 use logging::log;
 
+use super::GenBlockIndex;
+
 /// An iterator that starts at some block starting from a given it, and at every `next()` member call will provide the previous block index,
 /// The last viable block index is of the genesis block
 pub struct BlockIndexHistoryIterator<'a, H> {

chainstate/src/detail/block_index_history_iter.rs

@@ -15,12 +15,8 @@
 
 use std::{collections::BTreeSet, sync::Arc};
 
-use super::{
-    consensus_validator::TransactionIndexHandle, gen_block_index::GenBlockIndex,
-    median_time::calculate_median_time_past, time_getter::TimeGetterFn,
-};
 use chainstate_storage::{BlockchainStorageRead, BlockchainStorageWrite, TransactionRw};
-use chainstate_types::{block_index::BlockIndex, height_skip::get_skip_height};
+use chainstate_types::{get_skip_height, BlockIndex, GenBlockIndex, PropertyQueryError};
 use common::{
     chain::{
         block::{calculate_tx_merkle_root, calculate_witness_merkle_root, BlockHeader},
@@ -29,17 +25,17 @@ use common::{
     primitives::{BlockDistance, BlockHeight, Id, Idable},
     Uint256,
 };
+use consensus::{BlockIndexHandle, TransactionIndexHandle};
 use logging::log;
 use utils::ensure;
 
+use super::{median_time::calculate_median_time_past, time_getter::TimeGetterFn};
 use crate::{BlockError, BlockSource, ChainstateConfig};
 
 use super::{
-    consensus_validator::{self, BlockIndexHandle},
     orphan_blocks::{OrphanBlocks, OrphanBlocksMut},
     transaction_verifier::{BlockTransactableRef, TransactionVerifier},
     BlockSizeError, CheckBlockError, CheckBlockTransactionsError, OrphanCheckError,
-    PropertyQueryError,
 };
 
 pub(crate) struct ChainstateRef<'a, S, O> {
@@ -486,7 +482,7 @@ impl<'a, S: BlockchainStorageRead, O: OrphanBlocks> ChainstateRef<'a, S, O> {
     }
 
     pub fn check_block(&self, block: &Block) -> Result<(), CheckBlockError> {
-        consensus_validator::validate_consensus(self.chain_config, block.header(), self)
+        consensus::validate_consensus(self.chain_config, block.header(), self)
             .map_err(CheckBlockError::ConsensusVerificationFailed)?;
         self.check_block_detail(block)?;
         Ok(())