Struct darkfi::validator::Validator

pub struct Validator {
    pub blockchain: Blockchain,
    pub consensus: Consensus,
    pub synced: RwLock<bool>,
    pub verify_fees: bool,
}

This struct represents a DarkFi validator node.

Fields

blockchain: Blockchain

Canonical (finalized) blockchain

consensus: Consensus

Hot/Live data used by the consensus algorithm

synced: RwLock<bool>

Flag signalling node has finished initial sync

verify_fees: bool

Flag to enable tx fee verification

Implementations

impl Validator

pub async fn new(db: &Db, config: ValidatorConfig) -> Result<ValidatorPtr>

pub async fn calculate_gas( &self, tx: &Transaction, verify_fee: bool, ) -> Result<u64>

Auxiliary function to compute provided transaction’s total gas, against current best fork. The function takes a boolean called verify_fee to overwrite the nodes configured verify_fees flag.

pub async fn append_tx(&self, tx: &Transaction, write: bool) -> Result<()>

The node retrieves a transaction, validates its state transition, and appends it to the pending txs store.

pub async fn purge_pending_txs(&self) -> Result<()>

The node removes invalid transactions from the pending txs store.

pub async fn append_proposal(&self, proposal: &Proposal) -> Result<()>

The node locks its consensus state and tries to append provided proposal.

pub async fn finalization(&self) -> Result<Vec<BlockInfo>>

The node checks if best fork can be finalized. If proposals can be finalized, node appends them to canonical, and resets the current forks.

pub async fn add_checkpoint_blocks( &self, blocks: &[BlockInfo], headers: &[HeaderHash], ) -> Result<()>

Apply provided set of BlockInfo without doing formal verification. A set of [’HeaderHash`] is also provided, to verify that the provided block hash matches the expected header one. Note: this function should only be used for blocks received using a checkpoint, since in that case we enforce the node to follow the sequence, assuming they all its blocks are valid. Additionally, it will update any forks to a single empty one, holding the updated module.

pub async fn add_test_blocks(&self, blocks: &[BlockInfo]) -> Result<()>

Validate a set of BlockInfo in sequence and apply them if all are valid. Note: this function should only be used in tests when we don’t want to perform consensus logic.

pub async fn add_test_transactions( &self, txs: &[Transaction], verifying_block_height: u32, block_target: u32, write: bool, verify_fees: bool, ) -> Result<(u64, u64)>

Validate a set of Transaction in sequence and apply them if all are valid. In case any of the transactions fail, they will be returned to the caller. The function takes a boolean called write which tells it to actually write the state transitions to the database, and a boolean called verify_fees to overwrite the nodes configured verify_fees flag.

Returns the total gas used and total paid fees for the given transactions. Note: this function should only be used in tests.

pub async fn add_test_producer_transaction( &self, tx: &Transaction, verifying_block_height: u32, block_target: u32, write: bool, ) -> Result<()>

Validate a producer Transaction and apply it if valid. In case the transactions fail, ir will be returned to the caller. The function takes a boolean called write which tells it to actually write the state transitions to the database. This should be only used for test purposes.

pub async fn validate_blockchain( &self, pow_target: u32, pow_fixed_difficulty: Option<BigUint>, ) -> Result<()>

Retrieve all existing blocks and try to apply them to an in memory overlay to verify their correctness. Be careful as this will try to load everything in memory.

pub async fn best_fork_next_block_height(&self) -> Result<u32>

Auxiliary function to retrieve current best fork next block height.