// Copyright 2019 The Grin Developers // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // 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. //! Common test functions use self::chain::store::ChainStore; use self::chain::types::Tip; use self::core::core::hash::{Hash, Hashed}; use self::core::core::{Block, BlockHeader, BlockSums, Committed, KernelFeatures, Transaction}; use self::core::libtx; use self::keychain::{ExtKeychain, Keychain}; use self::pool::types::*; use self::pool::TransactionPool; use self::util::secp::pedersen::Commitment; use self::util::RwLock; use epic_chain as chain; use epic_core as core; use epic_keychain as keychain; use epic_pool as pool; use epic_util as util; use std::collections::HashSet; use std::fs; use std::sync::Arc; #[derive(Clone)] pub struct ChainAdapter { pub store: Arc>, pub utxo: Arc>>, } impl ChainAdapter { pub fn init(db_root: String) -> Result { let target_dir = format!("target/{}", db_root); let chain_store = ChainStore::new(&target_dir) .map_err(|e| format!("failed to init chain_store, {:?}", e))?; let store = Arc::new(RwLock::new(chain_store)); let utxo = Arc::new(RwLock::new(HashSet::new())); Ok(ChainAdapter { store, utxo }) } pub fn update_db_for_block(&self, block: &Block) { let header = &block.header; let tip = Tip::from_header(header); let s = self.store.write(); let batch = s.batch().unwrap(); batch.save_block_header(header).unwrap(); batch.save_body_head(&tip).unwrap(); // Retrieve previous block_sums from the db. let prev_sums = if let Ok(prev_sums) = batch.get_block_sums(&tip.prev_block_h) { prev_sums } else { BlockSums::default() }; // Overage is based purely on the new block. // Previous block_sums have taken all previous overage into account. let overage = header.overage(); // Offset on the other hand is the total kernel offset from the new block. let offset = header.total_kernel_offset(); // Verify the kernel sums for the block_sums with the new block applied. let (utxo_sum, kernel_sum) = (prev_sums, block as &dyn Committed) .verify_kernel_sums(overage, offset) .unwrap(); let block_sums = BlockSums { utxo_sum, kernel_sum, }; batch.save_block_sums(&header.hash(), &block_sums).unwrap(); batch.commit().unwrap(); { let mut utxo = self.utxo.write(); for x in block.inputs() { utxo.remove(&x.commitment()); } for x in block.outputs() { utxo.insert(x.commitment()); } } } } impl BlockChain for ChainAdapter { fn chain_head(&self) -> Result { let s = self.store.read(); s.head_header() .map_err(|_| PoolError::Other(format!("failed to get chain head"))) } fn get_block_header(&self, hash: &Hash) -> Result { let s = self.store.read(); s.get_block_header(hash) .map_err(|_| PoolError::Other(format!("failed to get block header"))) } fn get_block_sums(&self, hash: &Hash) -> Result { let s = self.store.read(); s.get_block_sums(hash) .map_err(|_| PoolError::Other(format!("failed to get block sums"))) } fn validate_tx(&self, tx: &Transaction) -> Result<(), pool::PoolError> { let utxo = self.utxo.read(); for x in tx.outputs() { if utxo.contains(&x.commitment()) { return Err(PoolError::Other(format!("output commitment not unique"))); } } for x in tx.inputs() { if !utxo.contains(&x.commitment()) { return Err(PoolError::Other(format!("not in utxo set"))); } } Ok(()) } // Mocking this check out for these tests. // We will test the Merkle proof verification logic elsewhere. fn verify_coinbase_maturity(&self, _tx: &Transaction) -> Result<(), PoolError> { Ok(()) } // Mocking this out for these tests. fn verify_tx_lock_height(&self, _tx: &Transaction) -> Result<(), PoolError> { Ok(()) } } pub fn test_setup(chain: Arc) -> TransactionPool { TransactionPool::new( PoolConfig { accept_fee_base: 0, max_pool_size: 50, max_stempool_size: 50, mineable_max_weight: 10_000, }, chain.clone(), Arc::new(NoopAdapter {}), ) } pub fn test_transaction_spending_coinbase( keychain: &K, header: &BlockHeader, output_values: Vec, ) -> Transaction where K: Keychain, { let output_sum = output_values.iter().sum::() as i64; let coinbase_reward: u64 = 60_000_000_000; let fees: i64 = coinbase_reward as i64 - output_sum; assert!(fees >= 0); let mut tx_elements = Vec::new(); // single input spending a single coinbase (deterministic key_id aka height) { let key_id = ExtKeychain::derive_key_id(1, header.height as u32, 0, 0, 0); tx_elements.push(libtx::build::coinbase_input(coinbase_reward, key_id)); } for output_value in output_values { let key_id = ExtKeychain::derive_key_id(1, output_value as u32, 0, 0, 0); tx_elements.push(libtx::build::output(output_value, key_id)); } libtx::build::transaction( KernelFeatures::Plain { fee: fees as u64 }, tx_elements, keychain, &libtx::ProofBuilder::new(keychain), ) .unwrap() } pub fn test_transaction( keychain: &K, input_values: Vec, output_values: Vec, ) -> Transaction where K: Keychain, { let input_sum = input_values.iter().sum::() as i64; let output_sum = output_values.iter().sum::() as i64; let fees: i64 = input_sum - output_sum; assert!(fees >= 0); let mut tx_elements = Vec::new(); for input_value in input_values { let key_id = ExtKeychain::derive_key_id(1, input_value as u32, 0, 0, 0); tx_elements.push(libtx::build::input(input_value, key_id)); } for output_value in output_values { let key_id = ExtKeychain::derive_key_id(1, output_value as u32, 0, 0, 0); tx_elements.push(libtx::build::output(output_value, key_id)); } libtx::build::transaction( KernelFeatures::Plain { fee: fees as u64 }, tx_elements, keychain, &libtx::ProofBuilder::new(keychain), ) .unwrap() } pub fn test_source() -> TxSource { TxSource::Broadcast } pub fn clean_output_dir(db_root: String) { if let Err(e) = fs::remove_dir_all(format!("target/{}", db_root)) { println!("cleaning output dir failed - {:?}", e) } }