Merge pull request #46 from gavofyork/state

Removed need for mutation in State.
This commit is contained in:
Marek Kotewicz 2015-12-20 15:28:48 +01:00
commit 9700d02cbb
8 changed files with 250 additions and 110 deletions

View File

@ -41,10 +41,10 @@ impl Account {
} }
/// Create a new account with the given balance. /// Create a new account with the given balance.
pub fn new_basic(balance: U256) -> Account { pub fn new_basic(balance: U256, nonce: U256) -> Account {
Account { Account {
balance: balance, balance: balance,
nonce: U256::from(0u8), nonce: nonce,
storage_root: SHA3_NULL_RLP, storage_root: SHA3_NULL_RLP,
storage_overlay: RefCell::new(HashMap::new()), storage_overlay: RefCell::new(HashMap::new()),
code_hash: Some(SHA3_EMPTY), code_hash: Some(SHA3_EMPTY),

109
src/engine.rs Normal file
View File

@ -0,0 +1,109 @@
use util::uint::*;
use util::hash::*;
use util::bytes::*;
use util::semantic_version::*;
use header::Header;
use std::collections::hash_map::*;
use util::error::*;
/// Definition of the cost schedule and other parameterisations for the EVM.
pub struct EvmSchedule {
pub exceptional_failed_code_deposit: bool,
pub have_delegate_call: bool,
pub stack_limit: U256,
pub tier_step_gas: [U256; 8],
pub exp_gas: U256,
pub exp_byte_gas: U256,
pub sha3_gas: U256,
pub sha3_word_gas: U256,
pub sload_gas: U256,
pub sstore_set_gas: U256,
pub sstore_reset_gas: U256,
pub sstore_refund_gas: U256,
pub jumpdest_gas: U256,
pub log_gas: U256,
pub log_data_gas: U256,
pub log_topic_gas: U256,
pub create_gas: U256,
pub call_gas: U256,
pub call_stipend: U256,
pub call_value_transfer_gas: U256,
pub call_new_account_gas: U256,
pub suicide_refund_gas: U256,
pub memory_gas: U256,
pub quad_coeff_div: U256,
pub create_data_gas: U256,
pub tx_gas: U256,
pub tx_create_gas: U256,
pub tx_data_zero_gas: U256,
pub tx_data_non_zero_gas: U256,
pub copy_gas: U256,
}
/// Definition of a contract whose implementation is built-in.
pub struct Builtin {
/// The gas cost of running this built-in for the given size of input data.
pub cost: Box<Fn(usize) -> U256>, // TODO: U256 should be bignum.
/// Run this built-in function with the input being the first argument and the output
/// being placed into the second.
pub execute: Box<Fn(&[u8], &mut [u8])>,
}
/// Parameters for a block chain; includes both those intrinsic to the design of the
/// chain and those to be interpreted by the active chain engine.
pub struct Params {
/*
TODO: std::unordered_map<Address, PrecompiledContract> precompiled;
*/
pub block_reward: U256,
pub maximum_extra_data_size: U256,
pub account_start_nonce: U256,
pub evm_schedule: EvmSchedule,
pub builtins: HashMap<Address, Builtin>,
pub misc: HashMap<String, String>,
}
/// A consensus mechanism for the chain. Generally either proof-of-work or proof-of-stake-based.
/// Provides hooks into each of the major parts of block import.
pub trait Engine {
/// The name of this engine.
fn name(&self) -> &str;
/// The version of this engine. Should be of the form
fn version(&self) -> SemanticVersion { SemanticVersion::new(0, 0 ,0) }
/// The number of additional header fields required for this engine.
fn seal_fields(&self) -> u32 { 0 }
/// Default values of the additional fields RLP-encoded in a raw (non-list) harness.
fn seal_rlp(&self) -> Bytes { vec![] }
/// Additional engine-specific information for the user/developer concerning `header`.
fn extra_info(&self, _header: &Header) -> HashMap<String, String> { HashMap::new() }
/// Verify that `header` is valid.
/// `parent` (the parent header) and `block` (the header's full block) may be provided for additional
/// checks. Returns either a null `Ok` or a general error detailing the problem with import.
fn verify(&self, _header: &Header, _parent: Option<&Header>, _block: Option<&[u8]>) -> Result<(), EthcoreError> { Ok(()) }
/*
virtual void verify(Strictness _s, BlockHeader const& _bi, BlockHeader const& _parent = BlockHeader(), bytesConstRef _block = bytesConstRef()) const;
/// Additional verification for transactions in blocks.
virtual void verifyTransaction(ImportRequirements::value _ir, TransactionBase const& _t, BlockHeader const& _bi) const;
/// Don't forget to call Super::populateFromParent when subclassing & overriding.
virtual void populateFromParent(BlockHeader& _bi, BlockHeader const& _parent) const;
*/
/// Get the general parameters of the chain.
fn params(&self) -> &Params;
/// Set the general parameters of the chain.
fn set_params(&mut self, p: Params);
}
/// An engine which does not provide any consensus mechanism.
pub struct NullEngine {
params: Params,
}
impl Engine for NullEngine {
fn name(&self) -> &str { "NullEngine" }
fn params(&self) -> &Params { &self.params }
fn set_params(&mut self, params: Params) { self.params = params; }
}

24
src/env_info.rs Normal file
View File

@ -0,0 +1,24 @@
use util::uint::*;
use util::hash::*;
/// Simple vector of hashes, should be at most 256 items large, can be smaller if being used
/// for a block whose number is less than 257.
pub type LastHashes = Vec<H256>;
/// Information concerning the execution environment for a message-call/contract-creation.
pub struct EnvInfo {
/// The block number.
pub number: U256,
/// The block author.
pub author: Address,
/// The block timestamp.
pub timestamp: U256,
/// The block difficulty.
pub difficulty: U256,
/// The block gas limit.
pub gas_limit: U256,
/// The last 256 block hashes.
pub last_hashes: LastHashes,
/// The gas used.
pub gas_used: U256,
}

View File

@ -1,3 +1,5 @@
#![feature(cell_extras)]
//! Ethcore's ethereum implementation //! Ethcore's ethereum implementation
//! //!
//! ### Rust version //! ### Rust version
@ -82,10 +84,13 @@ pub use util::hash::*;
pub use util::uint::*; pub use util::uint::*;
pub use util::bytes::*; pub use util::bytes::*;
pub mod env_info;
pub mod engine;
pub mod state; pub mod state;
pub mod account; pub mod account;
pub mod blockheader; pub mod header;
pub mod transaction; pub mod transaction;
pub mod receipt;
pub mod networkparams; pub mod networkparams;
pub mod denominations; pub mod denominations;

6
src/receipt.rs Normal file
View File

@ -0,0 +1,6 @@
use util::hash::*;
pub struct Receipt {
// TODO
pub state_root: H256,
}

View File

@ -1,42 +1,29 @@
use std::cell::*;
use std::ops::*;
use std::collections::HashMap; use std::collections::HashMap;
use util::hash::*; use util::hash::*;
use util::hashdb::*; use util::hashdb::*;
use util::overlaydb::*; use util::overlaydb::*;
use util::trie::*; use util::trie::*;
use util::bytes::*;
use util::rlp::*; use util::rlp::*;
use util::uint::*; use util::uint::*;
//use std::cell::*;
//use std::ops::*;
use account::Account; use account::Account;
/* use transaction::Transaction;
enum ValueOrRef<'self, 'db: 'self> { use receipt::Receipt;
Value(OverlayDB), use env_info::EnvInfo;
Ref(&'db mut OverlayDB) use engine::Engine;
}
impl<'self, 'db> ValueOrRef<'self, 'db: 'self> { /// Information concerning the result of the `State::apply` operation.
pub fn get_mut(&mut self) -> &mut OverlayDB { pub struct ApplyResult; // TODO
match self {
Value(ref mut x) => x,
Ref(x) => x,
}
}
pub fn get(&self) -> &OverlayDB {
match self {
Value(ref x) => x,
Ref(x) => x,
}
}
}
*/
/// Representation of the entire state of all accounts in the system. /// Representation of the entire state of all accounts in the system.
pub struct State { pub struct State {
db: OverlayDB, db: OverlayDB,
root: H256, root: H256,
cache: HashMap<Address, Option<Account>>, cache: RefCell<HashMap<Address, Option<Account>>>,
_account_start_nonce: U256, account_start_nonce: U256,
} }
impl State { impl State {
@ -51,8 +38,8 @@ impl State {
State { State {
db: db, db: db,
root: root, root: root,
cache: HashMap::new(), cache: RefCell::new(HashMap::new()),
_account_start_nonce: account_start_nonce, account_start_nonce: account_start_nonce,
} }
} }
@ -66,8 +53,8 @@ impl State {
State { State {
db: db, db: db,
root: root, root: root,
cache: HashMap::new(), cache: RefCell::new(HashMap::new()),
_account_start_nonce: account_start_nonce, account_start_nonce: account_start_nonce,
} }
} }
@ -76,27 +63,41 @@ impl State {
Self::new(OverlayDB::new_temp(), U256::from(0u8)) Self::new(OverlayDB::new_temp(), U256::from(0u8))
} }
/// Return reference to root
pub fn root(&self) -> &H256 {
&self.root
}
/// Destroy the current object and return root and database. /// Destroy the current object and return root and database.
pub fn drop(self) -> (H256, OverlayDB) { pub fn drop(self) -> (H256, OverlayDB) {
(self.root, self.db) (self.root, self.db)
} }
/// Return reference to root
pub fn root(&self) -> &H256 {
&self.root
}
/// Expose the underlying database; good to use for calling `state.db().commit()`. /// Expose the underlying database; good to use for calling `state.db().commit()`.
pub fn db(&mut self) -> &mut OverlayDB { pub fn db(&mut self) -> &mut OverlayDB {
&mut self.db &mut self.db
} }
/// Get the balance of account `a`. /// Get the balance of account `a`.
// TODO: make immutable pub fn balance(&self, a: &Address) -> U256 {
pub fn balance(&mut self, a: &Address) -> U256 {
self.get(a, false).as_ref().map(|account| account.balance().clone()).unwrap_or(U256::from(0u8)) self.get(a, false).as_ref().map(|account| account.balance().clone()).unwrap_or(U256::from(0u8))
} }
/// Get the nonce of account `a`.
pub fn nonce(&self, a: &Address) -> U256 {
self.get(a, false).as_ref().map(|account| account.nonce().clone()).unwrap_or(U256::from(0u8))
}
/// Mutate storage of account `a` so that it is `value` for `key`.
pub fn storage_at(&self, a: &Address, key: &H256) -> H256 {
self.get(a, false).as_ref().map(|a|a.storage_at(&self.db, key)).unwrap_or(H256::new())
}
/// Mutate storage of account `a` so that it is `value` for `key`.
pub fn code(&self, a: &Address) -> Option<Vec<u8>> {
self.get(a, true).as_ref().map(|a|a.code().map(|x|x.to_vec())).unwrap_or(None)
}
/// Add `incr` to the balance of account `a`. /// Add `incr` to the balance of account `a`.
pub fn add_balance(&mut self, a: &Address, incr: &U256) { pub fn add_balance(&mut self, a: &Address, incr: &U256) {
self.require(a, false).add_balance(incr) self.require(a, false).add_balance(incr)
@ -107,10 +108,10 @@ impl State {
self.require(a, false).sub_balance(decr) self.require(a, false).sub_balance(decr)
} }
/// Get the nonce of account `a`. /// Subtracts `by` from the balance of `from` and adds it to that of `to`.
// TODO: make immutable pub fn transfer_balance(&mut self, from: &Address, to: &Address, by: &U256) {
pub fn nonce(&mut self, a: &Address) -> U256 { self.sub_balance(from, by);
self.get(a, false).as_ref().map(|account| account.nonce().clone()).unwrap_or(U256::from(0u8)) self.add_balance(to, by);
} }
/// Increment the nonce of account `a` by 1. /// Increment the nonce of account `a` by 1.
@ -118,23 +119,27 @@ impl State {
self.require(a, false).inc_nonce() self.require(a, false).inc_nonce()
} }
/// Mutate storage of account `a` so that it is `value` for `key`.
pub fn storage_at(&mut self, a: &Address, key: &H256) -> H256 {
self.ensure_cached(a, false);
self.try_get(a).map(|a|a.storage_at(&self.db, key)).unwrap_or(H256::new())
}
/// Mutate storage of account `a` so that it is `value` for `key`.
pub fn code(&mut self, a: &Address) -> Option<&[u8]> {
self.ensure_cached(a, true);
self.try_get(a).map(|a|a.code()).unwrap_or(None)
}
/// Mutate storage of account `a` so that it is `value` for `key`. /// Mutate storage of account `a` so that it is `value` for `key`.
pub fn set_storage(&mut self, a: &Address, key: H256, value: H256) { pub fn set_storage(&mut self, a: &Address, key: H256, value: H256) {
self.require(a, false).set_storage(key, value); self.require(a, false).set_storage(key, value);
} }
/// Mutate storage of account `a` so that it is `value` for `key`.
pub fn set_code(&mut self, a: &Address, code: Bytes) {
self.require_or_from(a, true, || Account::new_contract(U256::from(0u8))).set_code(code);
}
/// Execute a given transaction.
/// This will change the state accordingly.
pub fn apply(_env_info: &EnvInfo, _engine: &Engine, _t: &Transaction, _is_permanent: bool) -> (ApplyResult, Receipt) {
unimplemented!();
}
/// Convert into a JSON representation.
pub fn as_json(&self) -> String {
unimplemented!();
}
/// Commit accounts to TrieDBMut. This is similar to cpp-ethereum's dev::eth::commit. /// Commit accounts to TrieDBMut. This is similar to cpp-ethereum's dev::eth::commit.
/// `accounts` is mutable because we may need to commit the code or storage and record that. /// `accounts` is mutable because we may need to commit the code or storage and record that.
pub fn commit_into(db: &mut HashDB, mut root: H256, accounts: &mut HashMap<Address, Option<Account>>) -> H256 { pub fn commit_into(db: &mut HashDB, mut root: H256, accounts: &mut HashMap<Address, Option<Account>>) -> H256 {
@ -165,69 +170,49 @@ impl State {
/// Commits our cached account changes into the trie. /// Commits our cached account changes into the trie.
pub fn commit(&mut self) { pub fn commit(&mut self) {
let r = self.root.clone(); // would prefer not to do this, really. let r = self.root.clone(); // would prefer not to do this, really.
self.root = Self::commit_into(&mut self.db, r, &mut self.cache); self.root = Self::commit_into(&mut self.db, r, self.cache.borrow_mut().deref_mut());
}
/// Populate the state from `accounts`. Just uses `commit_into`.
pub fn populate_from(&mut self, _accounts: &mut HashMap<Address, Option<Account>>) {
unimplemented!();
} }
/// Pull account `a` in our cache from the trie DB and return it. /// Pull account `a` in our cache from the trie DB and return it.
/// `require_code` requires that the code be cached, too. /// `require_code` requires that the code be cached, too.
// TODO: make immutable through returning an Option<Ref<Account>> fn get(&self, a: &Address, require_code: bool) -> Ref<Option<Account>> {
fn get(&mut self, a: &Address, require_code: bool) -> Option<&Account> { self.cache.borrow_mut().entry(a.clone()).or_insert_with(||
self.ensure_cached(a, require_code); TrieDB::new(&self.db, &self.root).get(&a).map(|rlp| Account::from_rlp(rlp)));
self.try_get(a)
}
/// Return account `a` from our cache, or None if it doesn't exist in the cache or
/// the account is empty.
/// Call `ensure_cached` before if you want to avoid the "it doesn't exist in the cache"
/// possibility.
fn try_get(&self, a: &Address) -> Option<&Account> {
self.cache.get(a).map(|x| x.as_ref()).unwrap_or(None)
}
/// Ensure account `a` exists in our cache.
/// `require_code` requires that the code be cached, too.
fn ensure_cached(&mut self, a: &Address, require_code: bool) {
if self.cache.get(a).is_none() {
// load from trie.
let act = TrieDB::new(&self.db, &self.root).get(&a).map(|rlp| Account::from_rlp(rlp));
println!("Loaded {:?} from trie: {:?}", a, act);
self.cache.insert(a.clone(), act);
}
let db = &self.db;
if require_code { if require_code {
if let Some(ref mut account) = self.cache.get_mut(a).unwrap().as_mut() { if let Some(ref mut account) = self.cache.borrow_mut().get_mut(a).unwrap().as_mut() {
println!("Caching code"); account.cache_code(&self.db);
account.cache_code(db);
println!("Now: {:?}", account);
} }
} }
Ref::map(self.cache.borrow(), |m| m.get(a).unwrap())
} }
/// Pull account `a` in our cache from the trie DB. `require_code` requires that the code be cached, too. /// Pull account `a` in our cache from the trie DB. `require_code` requires that the code be cached, too.
/// `force_create` creates a new, empty basic account if there is not currently an active account. /// `force_create` creates a new, empty basic account if there is not currently an active account.
fn require(&mut self, a: &Address, require_code: bool) -> &mut Account { fn require(&self, a: &Address, require_code: bool) -> RefMut<Account> {
self.require_or_from(a, require_code, || Account::new_basic(U256::from(0u8))) self.require_or_from(a, require_code, || Account::new_basic(U256::from(0u8), self.account_start_nonce))
} }
/// Pull account `a` in our cache from the trie DB. `require_code` requires that the code be cached, too. /// Pull account `a` in our cache from the trie DB. `require_code` requires that the code be cached, too.
/// `force_create` creates a new, empty basic account if there is not currently an active account. /// `force_create` creates a new, empty basic account if there is not currently an active account.
fn require_or_from<F: FnOnce() -> Account>(&mut self, a: &Address, require_code: bool, default: F) -> &mut Account { fn require_or_from<F: FnOnce() -> Account>(&self, a: &Address, require_code: bool, default: F) -> RefMut<Account> {
if self.cache.get(a).is_none() { self.cache.borrow_mut().entry(a.clone()).or_insert_with(||
// load from trie. TrieDB::new(&self.db, &self.root).get(&a).map(|rlp| Account::from_rlp(rlp)));
self.cache.insert(a.clone(), TrieDB::new(&self.db, &self.root).get(&a).map(|rlp| Account::from_rlp(rlp))); if self.cache.borrow().get(a).unwrap().is_none() {
self.cache.borrow_mut().insert(a.clone(), Some(default()));
} }
if self.cache.get(a).unwrap().is_none() { let b = self.cache.borrow_mut();
self.cache.insert(a.clone(), Some(default())); RefMut::map(b, |m| m.get_mut(a).unwrap().as_mut().map(|account| {
}
let db = &self.db;
self.cache.get_mut(a).unwrap().as_mut().map(|account| {
if require_code { if require_code {
account.cache_code(db); account.cache_code(&self.db);
} }
account account
}).unwrap() }).unwrap())
} }
} }
@ -247,15 +232,16 @@ fn code_from_database() {
let a = Address::from_str("0000000000000000000000000000000000000000").unwrap(); let a = Address::from_str("0000000000000000000000000000000000000000").unwrap();
let (r, db) = { let (r, db) = {
let mut s = State::new_temp(); let mut s = State::new_temp();
s.require_or_from(&a, false, ||Account::new_contract(U256::from(42u32))).set_code(vec![1, 2, 3]); s.require_or_from(&a, false, ||Account::new_contract(U256::from(42u32)));
assert_eq!(s.code(&a), Some(&[1u8, 2, 3][..])); s.set_code(&a, vec![1, 2, 3]);
assert_eq!(s.code(&a), Some([1u8, 2, 3].to_vec()));
s.commit(); s.commit();
assert_eq!(s.code(&a), Some(&[1u8, 2, 3][..])); assert_eq!(s.code(&a), Some([1u8, 2, 3].to_vec()));
s.drop() s.drop()
}; };
let mut s = State::new_existing(db, r, U256::from(0u8)); let s = State::new_existing(db, r, U256::from(0u8));
assert_eq!(s.code(&a), Some(&[1u8, 2, 3][..])); assert_eq!(s.code(&a), Some([1u8, 2, 3].to_vec()));
} }
#[test] #[test]
@ -268,7 +254,7 @@ fn storage_at_from_database() {
s.drop() s.drop()
}; };
let mut s = State::new_existing(db, r, U256::from(0u8)); let s = State::new_existing(db, r, U256::from(0u8));
assert_eq!(s.storage_at(&a, &H256::from(&U256::from(01u64))), H256::from(&U256::from(69u64))); assert_eq!(s.storage_at(&a, &H256::from(&U256::from(01u64))), H256::from(&U256::from(69u64)));
} }
@ -284,7 +270,7 @@ fn get_from_database() {
s.drop() s.drop()
}; };
let mut s = State::new_existing(db, r, U256::from(0u8)); let s = State::new_existing(db, r, U256::from(0u8));
assert_eq!(s.balance(&a), U256::from(69u64)); assert_eq!(s.balance(&a), U256::from(69u64));
assert_eq!(s.nonce(&a), U256::from(1u64)); assert_eq!(s.nonce(&a), U256::from(1u64));
} }
@ -293,6 +279,7 @@ fn get_from_database() {
fn alter_balance() { fn alter_balance() {
let mut s = State::new_temp(); let mut s = State::new_temp();
let a = Address::from_str("0000000000000000000000000000000000000000").unwrap(); let a = Address::from_str("0000000000000000000000000000000000000000").unwrap();
let b = Address::from_str("0000000000000000000000000000000000000001").unwrap();
s.add_balance(&a, &U256::from(69u64)); s.add_balance(&a, &U256::from(69u64));
assert_eq!(s.balance(&a), U256::from(69u64)); assert_eq!(s.balance(&a), U256::from(69u64));
s.commit(); s.commit();
@ -301,6 +288,12 @@ fn alter_balance() {
assert_eq!(s.balance(&a), U256::from(27u64)); assert_eq!(s.balance(&a), U256::from(27u64));
s.commit(); s.commit();
assert_eq!(s.balance(&a), U256::from(27u64)); assert_eq!(s.balance(&a), U256::from(27u64));
s.transfer_balance(&a, &b, &U256::from(18u64));
assert_eq!(s.balance(&a), U256::from(9u64));
assert_eq!(s.balance(&b), U256::from(18u64));
s.commit();
assert_eq!(s.balance(&a), U256::from(9u64));
assert_eq!(s.balance(&b), U256::from(18u64));
} }
#[test] #[test]

View File

@ -3,20 +3,23 @@ use util::bytes::*;
use util::uint::*; use util::uint::*;
use util::rlp::*; use util::rlp::*;
/// A set of information describing an externally-originating message call
/// or contract creation operation.
pub struct Transaction { pub struct Transaction {
nonce: U256, nonce: U256,
gas_price: U256, gas_price: U256,
gas: U256, gas: U256,
receive_address: Option<Address>, to: Option<Address>,
value: U256, value: U256,
data: Bytes, data: Bytes,
} }
impl Transaction { impl Transaction {
/// Is this transaction meant to create a contract?
pub fn is_contract_creation(&self) -> bool { pub fn is_contract_creation(&self) -> bool {
self.receive_address.is_none() self.to.is_none()
} }
/// Is this transaction meant to send a message?
pub fn is_message_call(&self) -> bool { pub fn is_message_call(&self) -> bool {
!self.is_contract_creation() !self.is_contract_creation()
} }
@ -28,7 +31,7 @@ impl Encodable for Transaction {
self.nonce.encode(e); self.nonce.encode(e);
self.gas_price.encode(e); self.gas_price.encode(e);
self.gas.encode(e); self.gas.encode(e);
self.receive_address.encode(e); self.to.encode(e);
self.value.encode(e); self.value.encode(e);
self.data.encode(e); self.data.encode(e);
}) })
@ -36,14 +39,14 @@ impl Encodable for Transaction {
} }
impl Decodable for Transaction { impl Decodable for Transaction {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder { fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
let d = try!(decoder.as_list()); let d = try!(decoder.as_list());
let transaction = Transaction { let transaction = Transaction {
nonce: try!(Decodable::decode(&d[0])), nonce: try!(Decodable::decode(&d[0])),
gas_price: try!(Decodable::decode(&d[1])), gas_price: try!(Decodable::decode(&d[1])),
gas: try!(Decodable::decode(&d[2])), gas: try!(Decodable::decode(&d[2])),
receive_address: try!(Decodable::decode(&d[3])), to: try!(Decodable::decode(&d[3])),
value: try!(Decodable::decode(&d[4])), value: try!(Decodable::decode(&d[4])),
data: try!(Decodable::decode(&d[5])), data: try!(Decodable::decode(&d[5])),
}; };