1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
// This file is part of Substrate. // Copyright (C) 2017-2021 Parity Technologies (UK) Ltd. // SPDX-License-Identifier: Apache-2.0 // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Version module for the Substrate runtime; Provides a function that returns the runtime version. #![cfg_attr(not(feature = "std"), no_std)] #[cfg(feature = "std")] use serde::{Deserialize, Serialize}; #[cfg(feature = "std")] use std::collections::HashSet; #[cfg(feature = "std")] use std::fmt; use codec::{Decode, Encode}; pub use sp_runtime::create_runtime_str; use sp_runtime::RuntimeString; #[doc(hidden)] pub use sp_std; #[cfg(feature = "std")] use sp_runtime::{generic::BlockId, traits::Block as BlockT}; #[cfg(feature = "std")] pub mod embed; /// An attribute that accepts a version declaration of a runtime and generates a custom wasm /// section with the equivalent contents. /// /// The custom section allows to read the version of the runtime without having to execute any /// code. Instead, the generated custom section can be relatively easily parsed from the wasm /// binary. The identifier of the custom section is "runtime_version". /// /// A shortcoming of this macro is that it is unable to embed information regarding supported /// APIs. This is supported by the `construct_runtime!` macro. /// /// # Usage /// /// This macro accepts a const item like the following: /// /// ```rust /// use sp_version::{create_runtime_str, RuntimeVersion}; /// /// #[sp_version::runtime_version] /// pub const VERSION: RuntimeVersion = RuntimeVersion { /// spec_name: create_runtime_str!("test"), /// impl_name: create_runtime_str!("test"), /// authoring_version: 10, /// spec_version: 265, /// impl_version: 1, /// apis: RUNTIME_API_VERSIONS, /// transaction_version: 2, /// }; /// /// # const RUNTIME_API_VERSIONS: sp_version::ApisVec = sp_version::create_apis_vec!([]); /// ``` /// /// It will pass it through and add code required for emitting a custom section. The /// information that will go into the custom section is parsed from the item declaration. Due /// to that, the macro is somewhat rigid in terms of the code it accepts. There are the /// following considerations: /// /// - The `spec_name` and `impl_name` must be set by a macro-like expression. The name of the /// macro doesn't matter though. /// /// - `authoring_version`, `spec_version`, `impl_version` and `transaction_version` must be set /// by a literal. Literal must be an integer. No other expressions are allowed there. In /// particular, you can't supply a constant variable. /// /// - `apis` doesn't have any specific constraints. This is because this information doesn't /// get into the custom section and is not parsed. /// /// # Compilation Target & "std" feature /// /// This macro assumes it will be used within a runtime. By convention, a runtime crate defines /// a feature named "std". This feature is enabled when the runtime is compiled to native code /// and disabled when it is compiled to the wasm code. /// /// The custom section can only be emitted while compiling to wasm. In order to detect the /// compilation target we use the "std" feature. This macro will emit the custom section only /// if the "std" feature is **not** enabled. /// /// Including this macro in the context where there is no "std" feature and the code is not /// compiled to wasm can lead to cryptic linking errors. pub use sp_version_proc_macro::runtime_version; /// The identity of a particular API interface that the runtime might provide. /// /// The id is generated by hashing the name of the runtime api with BLAKE2 using a hash size /// of 8 bytes. /// /// The name of the runtime api is the name of the trait when using `decl_runtime_apis!` macro. pub type ApiId = [u8; 8]; /// A vector of pairs of `ApiId` and a `u32` for version. pub type ApisVec = sp_std::borrow::Cow<'static, [(ApiId, u32)]>; /// Create a vector of Api declarations. #[macro_export] macro_rules! create_apis_vec { ( $y:expr ) => { $crate::sp_std::borrow::Cow::Borrowed(&$y) }; } /// Runtime version. /// This should not be thought of as classic Semver (major/minor/tiny). /// This triplet have different semantics and mis-interpretation could cause problems. /// In particular: bug fixes should result in an increment of `spec_version` and possibly /// `authoring_version`, absolutely not `impl_version` since they change the semantics of the /// runtime. #[derive(Clone, PartialEq, Eq, Encode, Decode, Default, sp_runtime::RuntimeDebug)] #[cfg_attr(feature = "std", derive(Serialize, Deserialize))] #[cfg_attr(feature = "std", serde(rename_all = "camelCase"))] pub struct RuntimeVersion { /// Identifies the different Substrate runtimes. There'll be at least polkadot and node. /// A different on-chain spec_name to that of the native runtime would normally result /// in node not attempting to sync or author blocks. pub spec_name: RuntimeString, /// Name of the implementation of the spec. This is of little consequence for the node /// and serves only to differentiate code of different implementation teams. For this /// codebase, it will be parity-polkadot. If there were a non-Rust implementation of the /// Polkadot runtime (e.g. C++), then it would identify itself with an accordingly different /// `impl_name`. pub impl_name: RuntimeString, /// `authoring_version` is the version of the authorship interface. An authoring node /// will not attempt to author blocks unless this is equal to its native runtime. pub authoring_version: u32, /// Version of the runtime specification. A full-node will not attempt to use its native /// runtime in substitute for the on-chain Wasm runtime unless all of `spec_name`, /// `spec_version` and `authoring_version` are the same between Wasm and native. pub spec_version: u32, /// Version of the implementation of the specification. Nodes are free to ignore this; it /// serves only as an indication that the code is different; as long as the other two versions /// are the same then while the actual code may be different, it is nonetheless required to /// do the same thing. /// Non-consensus-breaking optimizations are about the only changes that could be made which /// would result in only the `impl_version` changing. pub impl_version: u32, /// List of supported API "features" along with their versions. #[cfg_attr( feature = "std", serde( serialize_with = "apis_serialize::serialize", deserialize_with = "apis_serialize::deserialize", ) )] pub apis: ApisVec, /// All existing dispatches are fully compatible when this number doesn't change. If this /// number changes, then `spec_version` must change, also. /// /// This number must change when an existing dispatchable (module ID, dispatch ID) is changed, /// either through an alteration in its user-level semantics, a parameter /// added/removed/changed, a dispatchable being removed, a module being removed, or a /// dispatchable/module changing its index. /// /// It need *not* change when a new module is added or when a dispatchable is added. pub transaction_version: u32, } #[cfg(feature = "std")] impl fmt::Display for RuntimeVersion { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!( f, "{}-{} ({}-{}.tx{}.au{})", self.spec_name, self.spec_version, self.impl_name, self.impl_version, self.transaction_version, self.authoring_version, ) } } #[cfg(feature = "std")] impl RuntimeVersion { /// Check if this version matches other version for calling into runtime. pub fn can_call_with(&self, other: &RuntimeVersion) -> bool { self.spec_version == other.spec_version && self.spec_name == other.spec_name && self.authoring_version == other.authoring_version } /// Check if the given api with `api_id` is implemented and the version passes the given /// `predicate`. pub fn has_api_with<P: Fn(u32) -> bool>(&self, id: &ApiId, predicate: P) -> bool { self.apis.iter().any(|(s, v)| s == id && predicate(*v)) } /// Returns the api version found for api with `id`. pub fn api_version(&self, id: &ApiId) -> Option<u32> { self.apis.iter().find_map(|a| (a.0 == *id).then(|| a.1)) } } #[cfg(feature = "std")] #[derive(Debug)] pub struct NativeVersion { /// Basic runtime version info. pub runtime_version: RuntimeVersion, /// Authoring runtimes that this native runtime supports. pub can_author_with: HashSet<u32>, } #[cfg(feature = "std")] impl NativeVersion { /// Check if this version matches other version for authoring blocks. /// /// # Return /// /// - Returns `Ok(())` when authoring is supported. /// - Returns `Err(_)` with a detailed error when authoring is not supported. pub fn can_author_with(&self, other: &RuntimeVersion) -> Result<(), String> { if self.runtime_version.spec_name != other.spec_name { Err(format!( "`spec_name` does not match `{}` vs `{}`", self.runtime_version.spec_name, other.spec_name, )) } else if self.runtime_version.authoring_version != other.authoring_version && !self.can_author_with.contains(&other.authoring_version) { Err(format!( "`authoring_version` does not match `{version}` vs `{other_version}` and \ `can_author_with` not contains `{other_version}`", version = self.runtime_version.authoring_version, other_version = other.authoring_version, )) } else { Ok(()) } } } #[cfg(feature = "std")] /// Returns the version of the native runtime. pub trait GetNativeVersion { /// Returns the version of the native runtime. fn native_version(&self) -> &NativeVersion; } /// Something that can provide the runtime version at a given block. #[cfg(feature = "std")] pub trait GetRuntimeVersionAt<Block: BlockT> { /// Returns the version of runtime at the given block. fn runtime_version(&self, at: &BlockId<Block>) -> Result<RuntimeVersion, String>; } #[cfg(feature = "std")] impl<T: GetRuntimeVersionAt<Block>, Block: BlockT> GetRuntimeVersionAt<Block> for std::sync::Arc<T> { fn runtime_version(&self, at: &BlockId<Block>) -> Result<RuntimeVersion, String> { (&**self).runtime_version(at) } } #[cfg(feature = "std")] impl<T: GetNativeVersion> GetNativeVersion for std::sync::Arc<T> { fn native_version(&self) -> &NativeVersion { (&**self).native_version() } } #[cfg(feature = "std")] mod apis_serialize { use super::*; use impl_serde::serialize as bytes; use serde::{de, ser::SerializeTuple, Serializer}; #[derive(Serialize)] struct ApiId<'a>(#[serde(serialize_with = "serialize_bytesref")] &'a super::ApiId, &'a u32); pub fn serialize<S>(apis: &ApisVec, ser: S) -> Result<S::Ok, S::Error> where S: Serializer, { let len = apis.len(); let mut seq = ser.serialize_tuple(len)?; for (api, ver) in &**apis { seq.serialize_element(&ApiId(api, ver))?; } seq.end() } pub fn serialize_bytesref<S>(&apis: &&super::ApiId, ser: S) -> Result<S::Ok, S::Error> where S: Serializer, { bytes::serialize(apis, ser) } #[derive(Deserialize)] struct ApiIdOwned(#[serde(deserialize_with = "deserialize_bytes")] super::ApiId, u32); pub fn deserialize<'de, D>(deserializer: D) -> Result<ApisVec, D::Error> where D: de::Deserializer<'de>, { struct Visitor; impl<'de> de::Visitor<'de> for Visitor { type Value = ApisVec; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("a sequence of api id and version tuples") } fn visit_seq<V>(self, mut visitor: V) -> Result<Self::Value, V::Error> where V: de::SeqAccess<'de>, { let mut apis = Vec::new(); while let Some(value) = visitor.next_element::<ApiIdOwned>()? { apis.push((value.0, value.1)); } Ok(apis.into()) } } deserializer.deserialize_seq(Visitor) } pub fn deserialize_bytes<'de, D>(d: D) -> Result<super::ApiId, D::Error> where D: de::Deserializer<'de>, { let mut arr = [0; 8]; bytes::deserialize_check_len(d, bytes::ExpectedLen::Exact(&mut arr[..]))?; Ok(arr) } }