Struct sp_version::RuntimeVersion

pub struct RuntimeVersion {
    pub spec_name: RuntimeString,
    pub impl_name: RuntimeString,
    pub authoring_version: u32,
    pub spec_version: u32,
    pub impl_version: u32,
    pub apis: ApisVec,
    pub transaction_version: u32,
    pub state_version: u8,
}

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.

Fields

spec_name: RuntimeString

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.

impl_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.

authoring_version: u32

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.

spec_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.

This number should never decrease.

impl_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.

This number can be reverted to 0 after a spec_version bump.

apis: ApisVec

List of supported API “features” along with their versions.

transaction_version: u32

All existing calls (dispatchables) 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 call (pallet index, call index) is changed, either through an alteration in its user-level semantics, a parameter added/removed, a parameter type changed, or a call/pallet changing its index. An alteration of the user level semantics is for example when the call was before transfer and now is transfer_all, the semantics of the call changed completely.

Removing a pallet or a call doesn’t require a bump as long as no pallet or call is put at the same index. Removing doesn’t require a bump as the chain will reject a transaction referencing this removed call/pallet while decoding and thus, the user isn’t at risk to execute any unknown call. FRAME runtime devs have control over the index of a call/pallet to prevent that an index gets reused.

Adding a new pallet or call also doesn’t require a bump as long as they also don’t reuse any previously used index.

This number should never decrease.

state_version: u8

Version of the state implementation used by this runtime. Use of an incorrect version is consensus breaking.

Implementations

impl RuntimeVersion

pub fn decode_with_version_hint<I: Input>( input: &mut I, core_version: Option<u32>, ) -> Result<RuntimeVersion, Error>

Decode while giving a “version hint”

There exists multiple versions of RuntimeVersion and they are versioned using the Core runtime api:

• Core version < 3 is a runtime version without a transaction version and state version.
• Core version 3 is a runtime version without a state version.
• Core version 4 is the latest runtime version.

impl RuntimeVersion

pub fn can_call_with(&self, other: &RuntimeVersion) -> bool

Check if this version matches other version for calling into runtime.

pub fn has_api_with<P: Fn(u32) -> bool>(&self, id: &ApiId, predicate: P) -> bool

Check if the given api with api_id is implemented and the version passes the given predicate.

pub fn api_version(&self, id: &ApiId) -> Option<u32>

Returns the api version found for api with id.

impl RuntimeVersion

pub fn state_version(&self) -> StateVersion

Returns state version to use for update.

For runtime with core api version less than 4, V0 trie version will be applied to state. Otherwise, V1 trie version will be use.

Trait Implementations

impl Clone for RuntimeVersion

fn clone(&self) -> RuntimeVersion

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuntimeVersion

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decode for RuntimeVersion

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for RuntimeVersion

fn default() -> RuntimeVersion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuntimeVersion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RuntimeVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for RuntimeVersion

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl PartialEq for RuntimeVersion

fn eq(&self, other: &RuntimeVersion) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RuntimeVersion

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeInfo for RuntimeVersion

type Identity = RuntimeVersion

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for RuntimeVersion

impl Eq for RuntimeVersion

impl StructuralPartialEq for RuntimeVersion