2020-09-22 14:53:52 +02:00
|
|
|
// Copyright 2015-2020 Parity Technologies (UK) Ltd.
|
|
|
|
// This file is part of OpenEthereum.
|
2017-09-26 14:19:08 +02:00
|
|
|
|
2020-09-22 14:53:52 +02:00
|
|
|
// OpenEthereum is free software: you can redistribute it and/or modify
|
2017-09-26 14:19:08 +02:00
|
|
|
// 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.
|
|
|
|
|
2020-09-22 14:53:52 +02:00
|
|
|
// OpenEthereum is distributed in the hope that it will be useful,
|
2017-09-26 14:19:08 +02:00
|
|
|
// 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
|
2020-09-22 14:53:52 +02:00
|
|
|
// along with OpenEthereum. If not, see <http://www.gnu.org/licenses/>.
|
2017-09-26 14:19:08 +02:00
|
|
|
|
|
|
|
//! Generalization of a state machine for a consensus engine.
|
|
|
|
//! This will define traits for the header, block, and state of a blockchain.
|
|
|
|
|
2019-03-13 11:36:13 +01:00
|
|
|
use block::ExecutedBlock;
|
|
|
|
use ethereum_types::{Address, U256};
|
2017-09-26 14:19:08 +02:00
|
|
|
|
|
|
|
/// Generalization of types surrounding blockchain-suitable state machines.
|
2019-03-14 11:28:15 +01:00
|
|
|
pub trait Machine: Send + Sync {
|
2017-09-26 14:19:08 +02:00
|
|
|
/// A handle to a blockchain client for this machine.
|
|
|
|
type EngineClient: ?Sized;
|
2020-08-05 06:08:03 +02:00
|
|
|
|
2017-09-26 14:19:08 +02:00
|
|
|
/// Errors which can occur when querying or interacting with the machine.
|
|
|
|
type Error;
|
2020-08-05 06:08:03 +02:00
|
|
|
|
2019-01-10 13:11:39 +01:00
|
|
|
/// Get the balance, in base units, associated with an account.
|
|
|
|
/// Extracts data from the live block.
|
2019-03-13 11:36:13 +01:00
|
|
|
fn balance(&self, live: &ExecutedBlock, address: &Address) -> Result<U256, Self::Error>;
|
2020-08-05 06:08:03 +02:00
|
|
|
|
2019-01-10 13:11:39 +01:00
|
|
|
/// Increment the balance of an account in the state of the live block.
|
2019-03-13 11:36:13 +01:00
|
|
|
fn add_balance(
|
|
|
|
&self,
|
|
|
|
live: &mut ExecutedBlock,
|
|
|
|
address: &Address,
|
|
|
|
amount: &U256,
|
|
|
|
) -> Result<(), Self::Error>;
|
2017-09-26 14:19:08 +02:00
|
|
|
}
|