// Copyright 2017-2019 Parity Technologies (UK) Ltd. // This file is part of Substrate. // Substrate is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // Substrate 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 General Public License for more details. // You should have received a copy of the GNU General Public License // along with Substrate. If not, see . //! The Substrate runtime. This can be compiled with #[no_std], ready for Wasm. #![cfg_attr(not(feature = "std"), no_std)] #[cfg(feature = "std")] pub mod genesismap; pub mod system; use rstd::{prelude::*, marker::PhantomData}; use parity_codec::{Encode, Decode, Input}; use primitives::Blake2Hasher; use trie_db::{TrieMut, Trie}; use substrate_trie::{TrieDB, TrieDBMut, PrefixedMemoryDB}; use substrate_client::{ runtime_api as client_api, block_builder::api as block_builder_api, decl_runtime_apis, impl_runtime_apis, }; use runtime_primitives::{ ApplyResult, create_runtime_str, transaction_validity::TransactionValidity, traits::{ BlindCheckable, BlakeTwo256, Block as BlockT, Extrinsic as ExtrinsicT, GetNodeBlockType, GetRuntimeBlockType, Verify }, }; use runtime_version::RuntimeVersion; pub use primitives::hash::H256; use primitives::{sr25519, OpaqueMetadata}; #[cfg(any(feature = "std", test))] use runtime_version::NativeVersion; use inherents::{CheckInherentsResult, InherentData}; use cfg_if::cfg_if; pub use consensus_babe::AuthorityId; // Ensure Babe and Aura use the same crypto to simplify things a bit. pub type AuraId = AuthorityId; // Ensure Babe and Aura use the same crypto to simplify things a bit. pub type BabeId = AuthorityId; // Inlucde the WASM binary #[cfg(feature = "std")] include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs")); /// Test runtime version. pub const VERSION: RuntimeVersion = RuntimeVersion { spec_name: create_runtime_str!("test"), impl_name: create_runtime_str!("parity-test"), authoring_version: 1, spec_version: 1, impl_version: 1, apis: RUNTIME_API_VERSIONS, }; fn version() -> RuntimeVersion { VERSION } /// Native version. #[cfg(any(feature = "std", test))] pub fn native_version() -> NativeVersion { NativeVersion { runtime_version: VERSION, can_author_with: Default::default(), } } /// Calls in transactions. #[derive(Clone, PartialEq, Eq, Encode, Decode)] #[cfg_attr(feature = "std", derive(Debug))] pub struct Transfer { pub from: AccountId, pub to: AccountId, pub amount: u64, pub nonce: u64, } impl Transfer { /// Convert into a signed extrinsic. #[cfg(feature = "std")] pub fn into_signed_tx(self) -> Extrinsic { let signature = keyring::AccountKeyring::from_public(&self.from) .expect("Creates keyring from public key.").sign(&self.encode()).into(); Extrinsic::Transfer(self, signature) } } /// Extrinsic for test-runtime. #[derive(Clone, PartialEq, Eq, Encode, Decode)] #[cfg_attr(feature = "std", derive(Debug))] pub enum Extrinsic { AuthoritiesChange(Vec), Transfer(Transfer, AccountSignature), IncludeData(Vec), StorageChange(Vec, Option>), } #[cfg(feature = "std")] impl serde::Serialize for Extrinsic { fn serialize(&self, seq: S) -> Result where S: ::serde::Serializer { self.using_encoded(|bytes| seq.serialize_bytes(bytes)) } } impl BlindCheckable for Extrinsic { type Checked = Self; fn check(self) -> Result { match self { Extrinsic::AuthoritiesChange(new_auth) => Ok(Extrinsic::AuthoritiesChange(new_auth)), Extrinsic::Transfer(transfer, signature) => { if runtime_primitives::verify_encoded_lazy(&signature, &transfer, &transfer.from) { Ok(Extrinsic::Transfer(transfer, signature)) } else { Err(runtime_primitives::BAD_SIGNATURE) } }, Extrinsic::IncludeData(_) => Err(runtime_primitives::BAD_SIGNATURE), Extrinsic::StorageChange(key, value) => Ok(Extrinsic::StorageChange(key, value)), } } } impl ExtrinsicT for Extrinsic { fn is_signed(&self) -> Option { if let Extrinsic::IncludeData(_) = *self { Some(false) } else { Some(true) } } } impl Extrinsic { pub fn transfer(&self) -> &Transfer { match self { Extrinsic::Transfer(ref transfer, _) => transfer, _ => panic!("cannot convert to transfer ref"), } } } /// The signature type used by accounts/transactions. pub type AccountSignature = sr25519::Signature; /// An identifier for an account on this system. pub type AccountId = ::Signer; /// A simple hash type for all our hashing. pub type Hash = H256; /// The block number type used in this runtime. pub type BlockNumber = u64; /// Index of a transaction. pub type Index = u64; /// The item of a block digest. pub type DigestItem = runtime_primitives::generic::DigestItem; /// The digest of a block. pub type Digest = runtime_primitives::generic::Digest; /// A test block. pub type Block = runtime_primitives::generic::Block; /// A test block's header. pub type Header = runtime_primitives::generic::Header; /// Run whatever tests we have. pub fn run_tests(mut input: &[u8]) -> Vec { use runtime_io::print; print("run_tests..."); let block = Block::decode(&mut input).unwrap(); print("deserialized block."); let stxs = block.extrinsics.iter().map(Encode::encode).collect::>(); print("reserialized transactions."); [stxs.len() as u8].encode() } /// Changes trie configuration (optionally) used in tests. pub fn changes_trie_config() -> primitives::ChangesTrieConfiguration { primitives::ChangesTrieConfiguration { digest_interval: 4, digest_levels: 2, } } /// A type that can not be decoded. #[derive(PartialEq)] pub struct DecodeFails { _phantom: PhantomData, } impl Encode for DecodeFails { fn encode(&self) -> Vec { Vec::new() } } impl DecodeFails { /// Create a new instance. pub fn new() -> DecodeFails { DecodeFails { _phantom: Default::default(), } } } impl Decode for DecodeFails { fn decode(_: &mut I) -> Option { // decoding always fails None } } cfg_if! { if #[cfg(feature = "std")] { decl_runtime_apis! { #[api_version(2)] pub trait TestAPI { /// Return the balance of the given account id. fn balance_of(id: AccountId) -> u64; /// A benchmark function that adds one to the given value and returns the result. fn benchmark_add_one(val: &u64) -> u64; /// A benchmark function that adds one to each value in the given vector and returns the /// result. fn benchmark_vector_add_one(vec: &Vec) -> Vec; /// A function that always fails to convert a parameter between runtime and node. fn fail_convert_parameter(param: DecodeFails); /// A function that always fails to convert its return value between runtime and node. fn fail_convert_return_value() -> DecodeFails; /// A function for that the signature changed in version `2`. #[changed_in(2)] fn function_signature_changed() -> Vec; /// The new signature. fn function_signature_changed() -> u64; fn fail_on_native() -> u64; fn fail_on_wasm() -> u64; /// trie no_std testing fn use_trie() -> u64; fn benchmark_indirect_call() -> u64; fn benchmark_direct_call() -> u64; /// Returns the initialized block number. fn get_block_number() -> u64; /// Takes and returns the initialized block number. fn take_block_number() -> Option; /// Returns if no block was initialized. #[skip_initialize_block] fn without_initialize_block() -> bool; } } } else { decl_runtime_apis! { pub trait TestAPI { /// Return the balance of the given account id. fn balance_of(id: AccountId) -> u64; /// A benchmark function that adds one to the given value and returns the result. fn benchmark_add_one(val: &u64) -> u64; /// A benchmark function that adds one to each value in the given vector and returns the /// result. fn benchmark_vector_add_one(vec: &Vec) -> Vec; /// A function that always fails to convert a parameter between runtime and node. fn fail_convert_parameter(param: DecodeFails); /// A function that always fails to convert its return value between runtime and node. fn fail_convert_return_value() -> DecodeFails; /// In wasm we just emulate the old behavior. fn function_signature_changed() -> Vec; fn fail_on_native() -> u64; fn fail_on_wasm() -> u64; /// trie no_std testing fn use_trie() -> u64; fn benchmark_indirect_call() -> u64; fn benchmark_direct_call() -> u64; /// Returns the initialized block number. fn get_block_number() -> u64; /// Takes and returns the initialized block number. fn take_block_number() -> Option; /// Returns if no block was initialized. #[skip_initialize_block] fn without_initialize_block() -> bool; } } } } pub struct Runtime; impl GetNodeBlockType for Runtime { type NodeBlock = Block; } impl GetRuntimeBlockType for Runtime { type RuntimeBlock = Block; } /// Adds one to the given input and returns the final result. #[inline(never)] fn benchmark_add_one(i: u64) -> u64 { i + 1 } /// The `benchmark_add_one` function as function pointer. #[cfg(not(feature = "std"))] static BENCHMARK_ADD_ONE: runtime_io::ExchangeableFunction u64> = runtime_io::ExchangeableFunction::new(benchmark_add_one); fn code_using_trie() -> u64 { let pairs = [ (b"0103000000000000000464".to_vec(), b"0400000000".to_vec()), (b"0103000000000000000469".to_vec(), b"0401000000".to_vec()), ].to_vec(); let mut mdb = PrefixedMemoryDB::default(); let mut root = rstd::default::Default::default(); let _ = { let v = &pairs; let mut t = TrieDBMut::::new(&mut mdb, &mut root); for i in 0..v.len() { let key: &[u8]= &v[i].0; let val: &[u8] = &v[i].1; t.insert(key, val).expect("static input"); } t }; let trie = TrieDB::::new(&mdb, &root).expect("on memory with static content"); let iter = trie.iter().expect("static input"); let mut iter_pairs = Vec::new(); for pair in iter { let (key, value) = pair.expect("on memory with static content"); iter_pairs.push((key, value.to_vec())); } iter_pairs.len() as u64 } cfg_if! { if #[cfg(feature = "std")] { impl_runtime_apis! { impl client_api::Core for Runtime { fn version() -> RuntimeVersion { version() } fn execute_block(block: Block) { system::execute_block(block) } fn initialize_block(header: &::Header) { system::initialize_block(header) } } impl client_api::Metadata for Runtime { fn metadata() -> OpaqueMetadata { unimplemented!() } } impl client_api::TaggedTransactionQueue for Runtime { fn validate_transaction(utx: ::Extrinsic) -> TransactionValidity { if let Extrinsic::IncludeData(data) = utx { return TransactionValidity::Valid { priority: data.len() as u64, requires: vec![], provides: vec![data], longevity: 1, propagate: false, }; } system::validate_transaction(utx) } } impl block_builder_api::BlockBuilder for Runtime { fn apply_extrinsic(extrinsic: ::Extrinsic) -> ApplyResult { system::execute_transaction(extrinsic) } fn finalize_block() -> ::Header { system::finalize_block() } fn inherent_extrinsics(_data: InherentData) -> Vec<::Extrinsic> { vec![] } fn check_inherents(_block: Block, _data: InherentData) -> CheckInherentsResult { CheckInherentsResult::new() } fn random_seed() -> ::Hash { unimplemented!() } } impl self::TestAPI for Runtime { fn balance_of(id: AccountId) -> u64 { system::balance_of(id) } fn benchmark_add_one(val: &u64) -> u64 { val + 1 } fn benchmark_vector_add_one(vec: &Vec) -> Vec { let mut vec = vec.clone(); vec.iter_mut().for_each(|v| *v += 1); vec } fn fail_convert_parameter(_: DecodeFails) {} fn fail_convert_return_value() -> DecodeFails { DecodeFails::new() } fn function_signature_changed() -> u64 { 1 } fn fail_on_native() -> u64 { panic!("Failing because we are on native") } fn fail_on_wasm() -> u64 { 1 } fn use_trie() -> u64 { code_using_trie() } fn benchmark_indirect_call() -> u64 { let function = benchmark_add_one; (0..1000).fold(0, |p, i| p + function(i)) } fn benchmark_direct_call() -> u64 { (0..1000).fold(0, |p, i| p + benchmark_add_one(i)) } fn get_block_number() -> u64 { system::get_block_number().expect("Block number is initialized") } fn without_initialize_block() -> bool { system::get_block_number().is_none() } fn take_block_number() -> Option { system::take_block_number() } } impl consensus_aura::AuraApi for Runtime { fn slot_duration() -> u64 { 1 } fn authorities() -> Vec { system::authorities() } } impl consensus_babe::BabeApi for Runtime { fn startup_data() -> consensus_babe::BabeConfiguration { consensus_babe::BabeConfiguration { slot_duration: 1, expected_block_time: 1, threshold: std::u64::MAX, median_required_blocks: 100, } } fn authorities() -> Vec { system::authorities() } } impl offchain_primitives::OffchainWorkerApi for Runtime { fn offchain_worker(block: u64) { let ex = Extrinsic::IncludeData(block.encode()); runtime_io::submit_transaction(&ex).unwrap(); } } } } else { impl_runtime_apis! { impl client_api::Core for Runtime { fn version() -> RuntimeVersion { version() } fn execute_block(block: Block) { system::execute_block(block) } fn initialize_block(header: &::Header) { system::initialize_block(header) } } impl client_api::Metadata for Runtime { fn metadata() -> OpaqueMetadata { unimplemented!() } } impl client_api::TaggedTransactionQueue for Runtime { fn validate_transaction(utx: ::Extrinsic) -> TransactionValidity { if let Extrinsic::IncludeData(data) = utx { return TransactionValidity::Valid { priority: data.len() as u64, requires: vec![], provides: vec![data], longevity: 1, propagate: false, }; } system::validate_transaction(utx) } } impl block_builder_api::BlockBuilder for Runtime { fn apply_extrinsic(extrinsic: ::Extrinsic) -> ApplyResult { system::execute_transaction(extrinsic) } fn finalize_block() -> ::Header { system::finalize_block() } fn inherent_extrinsics(_data: InherentData) -> Vec<::Extrinsic> { vec![] } fn check_inherents(_block: Block, _data: InherentData) -> CheckInherentsResult { CheckInherentsResult::new() } fn random_seed() -> ::Hash { unimplemented!() } } impl self::TestAPI for Runtime { fn balance_of(id: AccountId) -> u64 { system::balance_of(id) } fn benchmark_add_one(val: &u64) -> u64 { val + 1 } fn benchmark_vector_add_one(vec: &Vec) -> Vec { let mut vec = vec.clone(); vec.iter_mut().for_each(|v| *v += 1); vec } fn fail_convert_parameter(_: DecodeFails) {} fn fail_convert_return_value() -> DecodeFails { DecodeFails::new() } fn function_signature_changed() -> Vec { let mut vec = Vec::new(); vec.push(1); vec.push(2); vec } fn fail_on_native() -> u64 { 1 } fn fail_on_wasm() -> u64 { panic!("Failing because we are on wasm") } fn use_trie() -> u64 { code_using_trie() } fn benchmark_indirect_call() -> u64 { (0..10000).fold(0, |p, i| p + BENCHMARK_ADD_ONE.get()(i)) } fn benchmark_direct_call() -> u64 { (0..10000).fold(0, |p, i| p + benchmark_add_one(i)) } fn get_block_number() -> u64 { system::get_block_number().expect("Block number is initialized") } fn without_initialize_block() -> bool { system::get_block_number().is_none() } fn take_block_number() -> Option { system::take_block_number() } } impl consensus_aura::AuraApi for Runtime { fn slot_duration() -> u64 { 1 } fn authorities() -> Vec { system::authorities() } } impl consensus_babe::BabeApi for Runtime { fn startup_data() -> consensus_babe::BabeConfiguration { consensus_babe::BabeConfiguration { median_required_blocks: 0, slot_duration: 1, expected_block_time: 1, threshold: core::u64::MAX, } } fn authorities() -> Vec { system::authorities() } } impl offchain_primitives::OffchainWorkerApi for Runtime { fn offchain_worker(block: u64) { let ex = Extrinsic::IncludeData(block.encode()); runtime_io::submit_transaction(&ex).unwrap() } } } } }