sp_runtime/generic/
block.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// 	http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Generic implementation of a block and associated items.
19
20#[cfg(feature = "std")]
21use std::fmt;
22
23#[cfg(feature = "serde")]
24use serde::{Deserialize, Serialize};
25
26use crate::{
27	codec::{Codec, Decode, Encode},
28	traits::{
29		self, Block as BlockT, Header as HeaderT, MaybeSerialize, MaybeSerializeDeserialize,
30		Member, NumberFor,
31	},
32	Justifications,
33};
34use alloc::vec::Vec;
35use sp_core::RuntimeDebug;
36
37/// Something to identify a block.
38#[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug)]
39pub enum BlockId<Block: BlockT> {
40	/// Identify by block header hash.
41	Hash(Block::Hash),
42	/// Identify by block number.
43	Number(NumberFor<Block>),
44}
45
46impl<Block: BlockT> BlockId<Block> {
47	/// Create a block ID from a hash.
48	pub const fn hash(hash: Block::Hash) -> Self {
49		BlockId::Hash(hash)
50	}
51
52	/// Create a block ID from a number.
53	pub const fn number(number: NumberFor<Block>) -> Self {
54		BlockId::Number(number)
55	}
56
57	/// Check if this block ID refers to the pre-genesis state.
58	pub fn is_pre_genesis(&self) -> bool {
59		match self {
60			BlockId::Hash(hash) => hash == &Default::default(),
61			BlockId::Number(_) => false,
62		}
63	}
64
65	/// Create a block ID for a pre-genesis state.
66	pub fn pre_genesis() -> Self {
67		BlockId::Hash(Default::default())
68	}
69}
70
71impl<Block: BlockT> Copy for BlockId<Block> {}
72
73#[cfg(feature = "std")]
74impl<Block: BlockT> fmt::Display for BlockId<Block> {
75	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
76		write!(f, "{:?}", self)
77	}
78}
79
80/// Abstraction over a substrate block.
81#[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug, scale_info::TypeInfo)]
82#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
83#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
84#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
85pub struct Block<Header, Extrinsic> {
86	/// The block header.
87	pub header: Header,
88	/// The accompanying extrinsics.
89	pub extrinsics: Vec<Extrinsic>,
90}
91
92impl<Header, Extrinsic> traits::HeaderProvider for Block<Header, Extrinsic>
93where
94	Header: HeaderT,
95{
96	type HeaderT = Header;
97}
98
99impl<Header, Extrinsic: MaybeSerialize> traits::Block for Block<Header, Extrinsic>
100where
101	Header: HeaderT + MaybeSerializeDeserialize,
102	Extrinsic: Member + Codec + traits::ExtrinsicLike,
103{
104	type Extrinsic = Extrinsic;
105	type Header = Header;
106	type Hash = <Self::Header as traits::Header>::Hash;
107
108	fn header(&self) -> &Self::Header {
109		&self.header
110	}
111	fn extrinsics(&self) -> &[Self::Extrinsic] {
112		&self.extrinsics[..]
113	}
114	fn deconstruct(self) -> (Self::Header, Vec<Self::Extrinsic>) {
115		(self.header, self.extrinsics)
116	}
117	fn new(header: Self::Header, extrinsics: Vec<Self::Extrinsic>) -> Self {
118		Block { header, extrinsics }
119	}
120	fn encode_from(header: &Self::Header, extrinsics: &[Self::Extrinsic]) -> Vec<u8> {
121		(header, extrinsics).encode()
122	}
123}
124
125/// Abstraction over a substrate block and justification.
126#[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug)]
127#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
128#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
129#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
130pub struct SignedBlock<Block> {
131	/// Full block.
132	pub block: Block,
133	/// Block justification.
134	pub justifications: Option<Justifications>,
135}
sp_runtime/generic/block.rs

sp_runtime/generic/
block.rs
