mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 09:17:58 +00:00
Sergei Pepyakin
68351da29b
* Remove superflous errors from the system module * Rename and document InclusionOutcome * Rename InclusionError * Remove unused inclusion errors. I left the enumeration though since other elements might be used some day. * Rename and document DispatchOutcome * Apply suggestions from code review Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * TransactionValidityError instead of InclusionError * Rename InclusionOutcome to ApplyExtrinsicResult * Update docs. * Update lib.rs should be → is * Bump the block builder API version. * Fix the should_return_runtime_version test * Clean the evidence
74 lines
2.8 KiB
Rust
74 lines
2.8 KiB
Rust
// Copyright 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 <http://www.gnu.org/licenses/>.
|
|
|
|
//! The block builder runtime api.
|
|
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
|
|
use sr_primitives::{traits::Block as BlockT, ApplyExtrinsicResult};
|
|
|
|
use inherents::{InherentData, CheckInherentsResult};
|
|
|
|
/// Definitions for supporting the older version of API: v3
|
|
///
|
|
/// These definitions are taken from the 2c58e30246a029b53d51e5b24c31974ac539ee8b git revision.
|
|
#[deprecated(note = "These definitions here are only for compatibility reasons")]
|
|
pub mod compatability_v3 {
|
|
use sr_primitives::{DispatchOutcome, transaction_validity};
|
|
use codec::{Encode, Decode};
|
|
|
|
#[derive(Eq, PartialEq, Clone, Copy, Decode, Encode, Debug)]
|
|
pub enum ApplyError {
|
|
NoPermission,
|
|
BadState,
|
|
Validity(transaction_validity::TransactionValidityError),
|
|
}
|
|
|
|
// `ApplyOutcome` was renamed to `DispatchOutcome` with the layout preserved.
|
|
pub type ApplyResult = Result<DispatchOutcome, ApplyError>;
|
|
}
|
|
|
|
sr_api::decl_runtime_apis! {
|
|
/// The `BlockBuilder` api trait that provides the required functionality for building a block.
|
|
#[api_version(4)]
|
|
pub trait BlockBuilder {
|
|
/// Compatibility version of `apply_extrinsic` for v3.
|
|
///
|
|
/// Only the return type is changed.
|
|
#[changed_in(4)]
|
|
#[allow(deprecated)]
|
|
fn apply_extrinsic(extrinsic: <Block as BlockT>::Extrinsic)
|
|
-> self::compatability_v3::ApplyResult;
|
|
|
|
/// Apply the given extrinsic.
|
|
///
|
|
/// Returns an inclusion outcome which specifies if this extrinsic is included in
|
|
/// this block or not.
|
|
fn apply_extrinsic(extrinsic: <Block as BlockT>::Extrinsic) -> ApplyExtrinsicResult;
|
|
/// Finish the current block.
|
|
#[renamed("finalise_block", 3)]
|
|
fn finalize_block() -> <Block as BlockT>::Header;
|
|
/// Generate inherent extrinsics. The inherent data will vary from chain to chain.
|
|
fn inherent_extrinsics(
|
|
inherent: InherentData,
|
|
) -> rstd::vec::Vec<<Block as BlockT>::Extrinsic>;
|
|
/// Check that the inherents are valid. The inherent data will vary from chain to chain.
|
|
fn check_inherents(block: Block, data: InherentData) -> CheckInherentsResult;
|
|
/// Generate a random seed.
|
|
fn random_seed() -> <Block as BlockT>::Hash;
|
|
}
|
|
}
|