Struct basic_authority::BasicAuthority

pub struct BasicAuthority { /* fields omitted */ }

Engine using BasicAuthority, trivial proof-of-authority consensus.

Implementations

impl BasicAuthority

pub fn new(our_params: BasicAuthorityParams, mashina: Machine) -> Self

Create a new instance of BasicAuthority engine

Trait Implementations

impl Engine for BasicAuthority

fn name(&self) -> &str

The name of this engine.

fn mashina(&self) -> &Machine

Get access to the underlying state mashina.

fn seal_fields(&self, _header: &Header) -> usize

The number of additional header fields required for this engine.

fn sealing_state(&self) -> SealingState

Returns the engine’s current sealing state.

fn generate_seal(&self, block: &ExecutedBlock, _parent: &Header) -> Seal

Attempt to seal the block internally.

fn verify_local_seal(&self, _header: &Header) -> Result<(), Error>

Verify a locally-generated seal of a header.

fn verify_block_external(&self, header: &Header) -> Result<(), Error>

Phase 4 verification. Verify block header against potentially external data. Should only be called when register_client has been called previously.

fn genesis_epoch_data(
    &self,
    header: &Header,
    call: &Call<'_>
) -> Result<Vec<u8>, String>

Genesis epoch data.

fn signals_epoch_end(
    &self,
    _header: &Header,
    _auxiliary: AuxiliaryData<'_>
) -> EpochChange

Whether an epoch change is signalled at the given header but will require finality. If a change can be enacted immediately then return No from this function but Yes from is_epoch_end.

fn is_epoch_end(
    &self,
    chain_head: &Header,
    _finalized: &[H256],
    _chain: &Headers<'_, Header>,
    _transition_store: &PendingTransitionStore<'_>
) -> Option<Vec<u8>>

Whether a block is the end of an epoch.

fn is_epoch_end_light(
    &self,
    chain_head: &Header,
    chain: &Headers<'_, Header>,
    transition_store: &PendingTransitionStore<'_>
) -> Option<Vec<u8>>

Whether a block is the end of an epoch.

fn epoch_verifier<'a>(
    &self,
    header: &Header,
    proof: &'a [u8]
) -> ConstructedVerifier<'a>

Create an epoch verifier from validation proof and a flag indicating whether finality is required.

fn set_signer(&self, signer: Option<Box<dyn EngineSigner>>)

Register a component which signs consensus messages.

fn sign(&self, hash: H256) -> Result<Signature, Error>

Sign using the EngineSigner, to be used for consensus tx signing.

fn register_client(&self, client: Weak<dyn EngineClient>)

Add Client which can be used for sealing, potentially querying the state and sending messages.

fn params(&self) -> &CommonParams

Get the general parameters of the chain.

pub fn extra_info(&self, _header: &Header) -> BTreeMap<String, String>

Additional engine-specific information for the user/developer concerning header.

pub fn maximum_uncle_count(&self, _block: u64) -> usize

Maximum number of uncles a block is allowed to declare.

pub fn maximum_gas_limit(&self) -> Option<U256>

Optional maximum gas limit.

pub fn on_new_block(
    &self,
    _block: &mut ExecutedBlock,
    _epoch_begin: bool
) -> Result<(), VapcoreError>

Block transformation functions, before the transactions. epoch_begin set to true if this block kicks off an epoch.

pub fn on_close_block(
    &self,
    _block: &mut ExecutedBlock,
    _parent_header: &Header
) -> Result<(), VapcoreError>

Block transformation functions, after the transactions.

pub fn on_seal_block(
    &self,
    _block: &mut ExecutedBlock
) -> Result<(), VapcoreError>

Allow mutating the header during seal generation. Currently only used by Clique.

pub fn generate_engine_transactions(
    &self,
    _block: &ExecutedBlock
) -> Result<Vec<SignedTransaction, Global>, VapcoreError>

Returns a list of transactions for a new block if we are the author.

pub fn should_reseal_on_update(&self) -> bool

Called in miner.chain_new_blocks if the engine wishes to update_sealing after a block was recently sealed.

pub fn verify_block_basic(&self, _header: &Header) -> Result<(), VapcoreError>

Phase 1 quick block verification. Only does checks that are cheap. Returns either a null Ok or a general error detailing the problem with import. The verification module can optionally avoid checking the seal (check_seal), if seal verification is disabled this method won’t be called.

pub fn verify_block_unordered(
    &self,
    _header: &Header
) -> Result<(), VapcoreError>

Phase 2 verification. Perform costly checks such as transaction signatures. Returns either a null Ok or a general error detailing the problem with import. The verification module can optionally avoid checking the seal (check_seal), if seal verification is disabled this method won’t be called.

pub fn verify_block_family(
    &self,
    _header: &Header,
    _parent: &Header
) -> Result<(), VapcoreError>

Phase 3 verification. Check block information against parent. Returns either a null Ok or a general error detailing the problem with import.

pub fn populate_from_parent(&self, _header: &mut Header, _parent: &Header)

Populate a header’s fields based on its parent’s header. Usually implements the chain scoring rule based on weight.

pub fn handle_message(&self, _message: &[u8]) -> Result<(), EngineError>

Handle any potential consensus messages; updating consensus state and potentially issuing a new one.

pub fn step(&self)

Trigger next step of the consensus engine.

pub fn snapshot_mode(&self) -> Snapshotting

Snapshot mode for the engine: Unsupported, PoW or PoA

pub fn open_block_header_timestamp(&self, parent_timestamp: u64) -> u64

Return a new open block header timestamp based on the parent timestamp.

pub fn is_timestamp_valid(
    &self,
    header_timestamp: u64,
    parent_timestamp: u64
) -> bool

Check whether the parent timestamp is valid.

pub fn ancestry_actions(
    &self,
    _header: &Header,
    _ancestry: &mut dyn Iterator<Item = ExtendedHeader>
) -> Vec<AncestryAction, Global>

Gather all ancestry actions. Called at the last stage when a block is committed. The Engine must guarantee that the ancestry exists.

pub fn executive_author(&self, header: &Header) -> Result<H160, VapcoreError>

Returns author should used when executing tx’s for this block.

pub fn gas_limit_override(&self, _header: &Header) -> Option<U256>

Overrides the block gas limit. Whenever this returns Some for a header, the next block’s gas limit must be exactly that value.

pub fn schedule(&self, block_number: u64) -> Schedule

Get the VVM schedule for the given block number.

pub fn builtins(&self) -> &BTreeMap<H160, Builtin>

Builtin-contracts for the chain..

pub fn builtin(&self, a: &H160, block_number: u64) -> Option<&Builtin>

Attempt to get a handle to a built-in contract. Only returns references to activated built-ins.

pub fn maximum_extra_data_size(&self) -> usize

Some intrinsic operation parameters; by default they take their value from the spec()’s engine_params.

pub fn account_start_nonce(&self, block: u64) -> U256

The nonce with which accounts begin at given block.

pub fn signing_chain_id(&self, env_info: &EnvInfo) -> Option<u64>

The network ID that transactions should be signed with.

pub fn verify_transaction_basic(
    &self,
    t: &UnverifiedTransaction,
    header: &Header
) -> Result<(), Error>

Perform basic/cheap transaction verification.

pub fn decode_transaction(
    &self,
    transaction: &[u8]
) -> Result<UnverifiedTransaction, Error>

Performs pre-validation of RLP decoded transaction before other processing

pub fn min_gas_limit(&self) -> U256

The configured minimum gas limit.