Struct ModuleConsensusVersion

pub struct ModuleConsensusVersion {
    pub major: u32,
    pub minor: u32,
}

Consensus version of a specific module instance

Any breaking change to the module’s consensus rules require incrementing the major part of it.

Any backwards-compatible changes with regards to clients require incrementing the minor part of it. Backwards compatible changes will typically be introducing new input/output/consensus item variants that old clients won’t understand but can safely ignore while new clients can use new functionality. It’s akin to soft forks in Bitcoin.

A module instance can run only in one consensus version, which must be the same (both major and minor) across all corresponding instances on other nodes of the federation.

When CoreConsensusVersion changes, this can but is not requires to be a breaking change for each module’s ModuleConsensusVersion.

For many modules it might be preferable to implement a new fedimint_core::core::ModuleKind “versions” (to be implemented at the time of writing this comment), and by running two instances of the module at the same time (each of different ModuleKind version), allow users to slowly migrate to a new one. This avoids complex and error-prone server-side consensus-migration logic.

Fields

major: u32

minor: u32

Implementations

impl ModuleConsensusVersion

pub const fn new(major: u32, minor: u32) -> Self

Trait Implementations

impl Clone for ModuleConsensusVersion

fn clone(&self) -> ModuleConsensusVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleConsensusVersion

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

Formats the value using the given formatter.

impl Decodable for ModuleConsensusVersion

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for ModuleConsensusVersion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for ModuleConsensusVersion

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, H::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl Hash for ModuleConsensusVersion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ModuleConsensusVersion

fn cmp(&self, other: &ModuleConsensusVersion) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModuleConsensusVersion

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ModuleConsensusVersion

fn partial_cmp(&self, other: &ModuleConsensusVersion) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ModuleConsensusVersion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ModuleConsensusVersion

impl Eq for ModuleConsensusVersion

impl StructuralPartialEq for ModuleConsensusVersion