openethereum/crates/ethcore/src/machine/impls.rs

664 lines
23 KiB
Rust

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.
// OpenEthereum 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.
// OpenEthereum 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 OpenEthereum. If not, see <http://www.gnu.org/licenses/>.
//! Ethereum-like state machine definition.
use std::{
cmp::{self, max},
collections::{BTreeMap, HashMap},
sync::Arc,
};
use ethereum_types::{Address, H256, U256};
use types::{
header::Header,
transaction::{
self, SignedTransaction, TypedTransaction, UnverifiedTransaction, SYSTEM_ADDRESS,
UNSIGNED_SENDER,
},
BlockNumber,
};
use vm::{
AccessList, ActionParams, ActionValue, CallType, CreateContractAddress, EnvInfo, ParamsType,
Schedule,
};
use block::ExecutedBlock;
use builtin::Builtin;
use call_contract::CallContract;
use client::BlockInfo;
use error::Error;
use executive::Executive;
use spec::CommonParams;
use state::{CleanupMode, Substate};
use trace::{NoopTracer, NoopVMTracer};
use tx_filter::TransactionFilter;
/// Ethash-specific extensions.
#[derive(Debug, Clone)]
pub struct EthashExtensions {
/// Homestead transition block number.
pub homestead_transition: BlockNumber,
/// DAO hard-fork transition block (X).
pub dao_hardfork_transition: u64,
/// DAO hard-fork refund contract address (C).
pub dao_hardfork_beneficiary: Address,
/// DAO hard-fork DAO accounts list (L)
pub dao_hardfork_accounts: Vec<Address>,
}
impl From<::ethjson::spec::EthashParams> for EthashExtensions {
fn from(p: ::ethjson::spec::EthashParams) -> Self {
EthashExtensions {
homestead_transition: p.homestead_transition.map_or(0, Into::into),
dao_hardfork_transition: p
.dao_hardfork_transition
.map_or(u64::max_value(), Into::into),
dao_hardfork_beneficiary: p
.dao_hardfork_beneficiary
.map_or_else(Address::default, Into::into),
dao_hardfork_accounts: p
.dao_hardfork_accounts
.unwrap_or_else(Vec::new)
.into_iter()
.map(Into::into)
.collect(),
}
}
}
/// Special rules to be applied to the schedule.
pub type ScheduleCreationRules = dyn Fn(&mut Schedule, BlockNumber) + Sync + Send;
/// An ethereum-like state machine.
pub struct EthereumMachine {
params: CommonParams,
builtins: Arc<BTreeMap<Address, Builtin>>,
tx_filter: Option<Arc<TransactionFilter>>,
ethash_extensions: Option<EthashExtensions>,
schedule_rules: Option<Box<ScheduleCreationRules>>,
}
impl EthereumMachine {
/// Regular ethereum machine.
pub fn regular(params: CommonParams, builtins: BTreeMap<Address, Builtin>) -> EthereumMachine {
let tx_filter = TransactionFilter::from_params(&params).map(Arc::new);
EthereumMachine {
params: params,
builtins: Arc::new(builtins),
tx_filter: tx_filter,
ethash_extensions: None,
schedule_rules: None,
}
}
/// Ethereum machine with ethash extensions.
// TODO: either unify or specify to mainnet specifically and include other specific-chain HFs?
pub fn with_ethash_extensions(
params: CommonParams,
builtins: BTreeMap<Address, Builtin>,
extensions: EthashExtensions,
) -> EthereumMachine {
let mut machine = EthereumMachine::regular(params, builtins);
machine.ethash_extensions = Some(extensions);
machine
}
/// Attach special rules to the creation of schedule.
pub fn set_schedule_creation_rules(&mut self, rules: Box<ScheduleCreationRules>) {
self.schedule_rules = Some(rules);
}
/// Get a reference to the ethash-specific extensions.
pub fn ethash_extensions(&self) -> Option<&EthashExtensions> {
self.ethash_extensions.as_ref()
}
}
impl EthereumMachine {
/// Execute a call as the system address. Block environment information passed to the
/// VM is modified to have its gas limit bounded at the upper limit of possible used
/// gases including this system call, capped at the maximum value able to be
/// represented by U256. This system call modifies the block state, but discards other
/// information. If suicides, logs or refunds happen within the system call, they
/// will not be executed or recorded. Gas used by this system call will not be counted
/// on the block.
pub fn execute_as_system(
&self,
block: &mut ExecutedBlock,
contract_address: Address,
gas: U256,
data: Option<Vec<u8>>,
) -> Result<Vec<u8>, Error> {
let (code, code_hash) = {
let state = &block.state;
(
state.code(&contract_address)?,
state.code_hash(&contract_address)?,
)
};
self.execute_code_as_system(
block,
Some(contract_address),
code,
code_hash,
None,
gas,
data,
None,
)
}
/// Same as execute_as_system, but execute code directly. If contract address is None, use the null sender
/// address. If code is None, then this function has no effect. The call is executed without finalization, and does
/// not form a transaction.
pub fn execute_code_as_system(
&self,
block: &mut ExecutedBlock,
contract_address: Option<Address>,
code: Option<Arc<Vec<u8>>>,
code_hash: Option<H256>,
value: Option<ActionValue>,
gas: U256,
data: Option<Vec<u8>>,
call_type: Option<CallType>,
) -> Result<Vec<u8>, Error> {
let env_info = {
let mut env_info = block.env_info();
env_info.gas_limit = env_info.gas_used.saturating_add(gas);
env_info
};
let mut state = block.state_mut();
let params = ActionParams {
code_address: contract_address.unwrap_or(UNSIGNED_SENDER),
address: contract_address.unwrap_or(UNSIGNED_SENDER),
sender: SYSTEM_ADDRESS,
origin: SYSTEM_ADDRESS,
gas,
gas_price: 0.into(),
value: value.unwrap_or_else(|| ActionValue::Transfer(0.into())),
code,
code_hash,
data,
call_type: call_type.unwrap_or(CallType::Call),
params_type: ParamsType::Separate,
access_list: AccessList::default(),
};
let schedule = self.schedule(env_info.number);
let mut ex = Executive::new(&mut state, &env_info, self, &schedule);
let mut substate = Substate::new();
let res = ex
.call(params, &mut substate, &mut NoopTracer, &mut NoopVMTracer)
.map_err(|e| ::engines::EngineError::FailedSystemCall(format!("{}", e)))?;
let output = res.return_data.to_vec();
Ok(output)
}
/// Push last known block hash to the state.
fn push_last_hash(&self, block: &mut ExecutedBlock) -> Result<(), Error> {
let params = self.params();
if block.header.number() == params.eip210_transition {
let state = block.state_mut();
state.init_code(
&params.eip210_contract_address,
params.eip210_contract_code.clone(),
)?;
}
if block.header.number() >= params.eip210_transition {
let parent_hash = *block.header.parent_hash();
let _ = self.execute_as_system(
block,
params.eip210_contract_address,
params.eip210_contract_gas,
Some(parent_hash.as_bytes().to_vec()),
)?;
}
Ok(())
}
// t_nb 8.1.3 Logic to perform on a new block: updating last hashes and the DAO
/// fork, for ethash.
pub fn on_new_block(&self, block: &mut ExecutedBlock) -> Result<(), Error> {
self.push_last_hash(block)?;
if let Some(ref ethash_params) = self.ethash_extensions {
if block.header.number() == ethash_params.dao_hardfork_transition {
let state = block.state_mut();
for child in &ethash_params.dao_hardfork_accounts {
let beneficiary = &ethash_params.dao_hardfork_beneficiary;
state.balance(child).and_then(|b| {
state.transfer_balance(child, beneficiary, &b, CleanupMode::NoEmpty)
})?;
}
}
}
Ok(())
}
/// Populate a header's fields based on its parent's header.
/// Usually implements the chain scoring rule based on weight.
/// The gas floor target must not be lower than the engine's minimum gas limit.
pub fn populate_from_parent(
&self,
header: &mut Header,
parent: &Header,
gas_floor_target: U256,
gas_ceil_target: U256,
) {
header.set_difficulty(parent.difficulty().clone());
let gas_limit = parent.gas_limit() * self.schedule(header.number()).eip1559_gas_limit_bump;
assert!(!gas_limit.is_zero(), "Gas limit should be > 0");
let gas_limit_target = if self.schedule(header.number()).eip1559 {
gas_ceil_target
} else {
gas_floor_target
};
header.set_gas_limit({
let bound_divisor = self.params().gas_limit_bound_divisor;
if gas_limit < gas_limit_target {
cmp::min(gas_limit_target, gas_limit + gas_limit / bound_divisor - 1)
} else {
cmp::max(gas_limit_target, gas_limit - gas_limit / bound_divisor + 1)
}
});
if let Some(ref ethash_params) = self.ethash_extensions {
if header.number() >= ethash_params.dao_hardfork_transition
&& header.number() <= ethash_params.dao_hardfork_transition + 9
{
header.set_extra_data(b"dao-hard-fork"[..].to_owned());
}
}
}
/// Get the general parameters of the chain.
pub fn params(&self) -> &CommonParams {
&self.params
}
/// Get the EVM schedule for the given block number.
pub fn schedule(&self, block_number: BlockNumber) -> Schedule {
let mut schedule = match self.ethash_extensions {
None => self.params.schedule(block_number),
Some(ref ext) => {
if block_number < ext.homestead_transition {
Schedule::new_frontier()
} else {
self.params.schedule(block_number)
}
}
};
if let Some(ref rules) = self.schedule_rules {
(rules)(&mut schedule, block_number)
}
schedule
}
/// Builtin-contracts for the chain..
pub fn builtins(&self) -> &BTreeMap<Address, Builtin> {
&*self.builtins
}
/// Attempt to get a handle to a built-in contract.
/// Only returns references to activated built-ins.
// TODO: builtin contract routing - to do this properly, it will require removing the built-in configuration-reading logic
// from Spec into here and removing the Spec::builtins field.
pub fn builtin(&self, a: &Address, block_number: BlockNumber) -> Option<&Builtin> {
self.builtins().get(a).and_then(|b| {
if b.is_active(block_number) {
Some(b)
} else {
None
}
})
}
/// Some intrinsic operation parameters; by default they take their value from the `spec()`'s `engine_params`.
pub fn maximum_extra_data_size(&self) -> usize {
self.params().maximum_extra_data_size
}
/// The nonce with which accounts begin at given block.
pub fn account_start_nonce(&self, block: u64) -> U256 {
let params = self.params();
if block >= params.dust_protection_transition {
U256::from(params.nonce_cap_increment) * U256::from(block)
} else {
params.account_start_nonce
}
}
/// The network ID that transactions should be signed with.
pub fn signing_chain_id(&self, env_info: &EnvInfo) -> Option<u64> {
let params = self.params();
if env_info.number >= params.eip155_transition {
Some(params.chain_id)
} else {
None
}
}
/// Returns new contract address generation scheme at given block number.
pub fn create_address_scheme(&self, _number: BlockNumber) -> CreateContractAddress {
CreateContractAddress::FromSenderAndNonce
}
/// Verify a particular transaction is valid, regardless of order.
pub fn verify_transaction_unordered(
&self,
t: UnverifiedTransaction,
header: &Header,
) -> Result<SignedTransaction, transaction::Error> {
// ensure that the user was willing to at least pay the base fee
if t.tx().gas_price < header.base_fee().unwrap_or_default() && !t.is_service() {
return Err(transaction::Error::GasPriceLowerThanBaseFee {
gas_price: t.tx().gas_price,
base_fee: header.base_fee().unwrap_or_default(),
});
}
Ok(SignedTransaction::new(t)?)
}
/// Does basic verification of the transaction.
pub fn verify_transaction_basic(
&self,
t: &UnverifiedTransaction,
header: &Header,
) -> Result<(), transaction::Error> {
let check_low_s = match self.ethash_extensions {
Some(ref ext) => header.number() >= ext.homestead_transition,
None => true,
};
let chain_id = if header.number() < self.params().validate_chain_id_transition {
t.chain_id()
} else if header.number() >= self.params().eip155_transition {
Some(self.params().chain_id)
} else {
None
};
t.verify_basic(check_low_s, chain_id)?;
Ok(())
}
/// Does verification of the transaction against the parent state.
pub fn verify_transaction<C: BlockInfo + CallContract>(
&self,
t: &SignedTransaction,
parent: &Header,
client: &C,
) -> Result<(), transaction::Error> {
if let Some(ref filter) = self.tx_filter.as_ref() {
if !filter.transaction_allowed(&parent.hash(), parent.number() + 1, t, client) {
return Err(transaction::Error::NotAllowed.into());
}
}
Ok(())
}
/// Additional params.
pub fn additional_params(&self) -> HashMap<String, String> {
hash_map![
"registrar".to_owned() => format!("{:x}", self.params.registrar)
]
}
/// Performs pre-validation of RLP decoded transaction before other processing
pub fn decode_transaction(
&self,
transaction: &[u8],
schedule: &Schedule,
) -> Result<UnverifiedTransaction, transaction::Error> {
if transaction.len() > self.params().max_transaction_size {
debug!(
"Rejected oversized transaction of {} bytes",
transaction.len()
);
return Err(transaction::Error::TooBig);
}
let tx = TypedTransaction::decode(transaction)
.map_err(|e| transaction::Error::InvalidRlp(e.to_string()))?;
match tx.tx_type() {
transaction::TypedTxId::AccessList if !schedule.eip2930 => {
return Err(transaction::Error::TransactionTypeNotEnabled)
}
transaction::TypedTxId::EIP1559Transaction if !schedule.eip1559 => {
return Err(transaction::Error::TransactionTypeNotEnabled)
}
_ => (),
};
Ok(tx)
}
/// Calculates base fee for the block that should be mined next.
/// Base fee is calculated based on the parent header (last block in blockchain / best block).
///
/// Introduced by EIP1559 to support new market fee mechanism.
pub fn calc_base_fee(&self, parent: &Header) -> Option<U256> {
// Block eip1559_transition - 1 has base_fee = None
if parent.number() + 1 < self.params().eip1559_transition {
return None;
}
// Block eip1559_transition has base_fee = self.params().eip1559_base_fee_initial_value
if parent.number() + 1 == self.params().eip1559_transition {
return Some(self.params().eip1559_base_fee_initial_value);
}
// Block eip1559_transition + 1 has base_fee = calculated
let base_fee_denominator = match self.params().eip1559_base_fee_max_change_denominator {
None => panic!("Can't calculate base fee if base fee denominator does not exist."),
Some(denominator) if denominator == U256::from(0) => {
panic!("Can't calculate base fee if base fee denominator is zero.")
}
Some(denominator) => denominator,
};
let parent_base_fee = parent.base_fee().unwrap_or_default();
let parent_gas_target = parent.gas_limit() / self.params().eip1559_elasticity_multiplier;
if parent_gas_target == U256::zero() {
panic!("Can't calculate base fee if parent gas target is zero.");
}
if parent.gas_used() == &parent_gas_target {
Some(parent_base_fee)
} else if parent.gas_used() > &parent_gas_target {
let gas_used_delta = parent.gas_used() - parent_gas_target;
let base_fee_per_gas_delta = max(
parent_base_fee * gas_used_delta / parent_gas_target / base_fee_denominator,
U256::from(1),
);
Some(parent_base_fee + base_fee_per_gas_delta)
} else {
let gas_used_delta = parent_gas_target - parent.gas_used();
let base_fee_per_gas_delta =
parent_base_fee * gas_used_delta / parent_gas_target / base_fee_denominator;
Some(max(parent_base_fee - base_fee_per_gas_delta, U256::zero()))
}
}
}
/// Auxiliary data fetcher for an Ethereum machine. In Ethereum-like machines
/// there are two kinds of auxiliary data: bodies and receipts.
#[derive(Default, Clone)]
pub struct AuxiliaryData<'a> {
/// The full block bytes, including the header.
pub bytes: Option<&'a [u8]>,
/// The block receipts.
pub receipts: Option<&'a [::types::receipt::TypedReceipt]>,
}
/// Type alias for a function we can make calls through synchronously.
/// Returns the call result and state proof for each call.
pub type Call<'a> = dyn Fn(Address, Vec<u8>) -> Result<(Vec<u8>, Vec<Vec<u8>>), String> + 'a;
/// Request for auxiliary data of a block.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum AuxiliaryRequest {
/// Needs the body.
Body,
/// Needs the receipts.
Receipts,
/// Needs both body and receipts.
Both,
}
impl super::Machine for EthereumMachine {
type EngineClient = dyn crate::client::EngineClient;
type Error = Error;
fn balance(&self, live: &ExecutedBlock, address: &Address) -> Result<U256, Error> {
live.state.balance(address).map_err(Into::into)
}
fn add_balance(
&self,
live: &mut ExecutedBlock,
address: &Address,
amount: &U256,
) -> Result<(), Error> {
live.state_mut()
.add_balance(address, amount, CleanupMode::NoEmpty)
.map_err(Into::into)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ethereum::new_london_test_machine;
use ethereum_types::H160;
use std::str::FromStr;
fn get_default_ethash_extensions() -> EthashExtensions {
EthashExtensions {
homestead_transition: 1150000,
dao_hardfork_transition: u64::max_value(),
dao_hardfork_beneficiary: H160::from_str("0000000000000000000000000000000000000001")
.unwrap(),
dao_hardfork_accounts: Vec::new(),
}
}
#[test]
fn should_disallow_unsigned_transactions() {
let rlp = "ea80843b9aca0083015f90948921ebb5f79e9e3920abe571004d0b1d5119c154865af3107a400080038080";
let transaction: UnverifiedTransaction =
TypedTransaction::decode(&::rustc_hex::FromHex::from_hex(rlp).unwrap()).unwrap();
let spec = ::ethereum::new_ropsten_test();
let ethparams = get_default_ethash_extensions();
let machine = EthereumMachine::with_ethash_extensions(
spec.params().clone(),
Default::default(),
ethparams,
);
let mut header = ::types::header::Header::new();
header.set_number(15);
let res = machine.verify_transaction_basic(&transaction, &header);
assert_eq!(
res,
Err(transaction::Error::InvalidSignature(
"invalid EC signature".into()
))
);
}
#[test]
fn calculate_base_fee_success() {
let machine = new_london_test_machine();
let parent_base_fees = [
U256::from(1000000000),
U256::from(1000000000),
U256::from(1000000000),
U256::from(1072671875),
U256::from(1059263476),
U256::from(1049238967),
U256::from(1049238967),
U256::from(0),
U256::from(1),
U256::from(2),
];
let parent_gas_used = [
U256::from(10000000),
U256::from(10000000),
U256::from(10000000),
U256::from(9000000),
U256::from(10001000),
U256::from(0),
U256::from(10000000),
U256::from(10000000),
U256::from(10000000),
U256::from(10000000),
];
let parent_gas_limit = [
U256::from(10000000),
U256::from(12000000),
U256::from(14000000),
U256::from(10000000),
U256::from(14000000),
U256::from(2000000),
U256::from(18000000),
U256::from(18000000),
U256::from(18000000),
U256::from(18000000),
];
let expected_base_fee = [
U256::from(1125000000),
U256::from(1083333333),
U256::from(1053571428),
U256::from(1179939062),
U256::from(1116028649),
U256::from(918084097),
U256::from(1063811730),
U256::from(1),
U256::from(2),
U256::from(3),
];
for i in 0..parent_base_fees.len() {
let mut parent_header = Header::default();
parent_header.set_base_fee(Some(parent_base_fees[i]));
parent_header.set_gas_used(parent_gas_used[i]);
parent_header.set_gas_limit(parent_gas_limit[i]);
let base_fee = machine.calc_base_fee(&parent_header);
assert_eq!(expected_base_fee[i], base_fee.unwrap());
}
}
}