Enum WitnessOrd 

pub enum WitnessOrd {
    Mined(WitnessPos),
    Tentative,
    Ignored,
    Archived,
}

RGB consensus information about the status of a witness transaction. This information is used in ordering state transitions during the validation, as well as consensus ordering of the contract global state data, as they are presented to all contract users.

Variants

Mined(WitnessPos)

Transaction is included into layer 1 blockchain at a specific height and timestamp.

NB: only timestamp is used in consensus ordering though, see WitnessPos::cmp for the details.

Tentative

Valid witness transaction which commits the most recent RGB state, but is not (yet) included into a layer 1 blockchain. Such transactions have a higher priority over onchain transactions (i.e. they are processed by the VM at the very end, and their global state becomes at the top of the contract state).

NB: not each and every signed offchain transaction should have this status; all offchain cases which fall under Self::Archived must be excluded. Valid cases for assigning Self::Tentative status are:

• transaction is present in the memepool;
• transaction is a part of transaction graph inside a state channel (only actual channel state is accounted for; all previous channel state must have corresponding transactions set to Self::Archived);
• transaction is an RBF replacement prepared to be broadcast (with the previous transaction set to Self::Archived at the same moment).

Ignored

Witness transaction must be ignored by the update witnesses process.

Archived

Witness transaction must be excluded from the state processing.

Cases for the exclusion:

• transaction was removed from blockchain after a re-org and its inputs were spent by other transaction;
• previous transaction(s) after RBF replacement, once it is excluded from the mempool and replaced by RBFed successors;
• past state channel transactions once a new channel state is signed (and until they may become valid once again due to an uncooperative channel closing).

Implementations

impl WitnessOrd

pub fn is_valid(self) -> bool

Trait Implementations

impl Clone for WitnessOrd

fn clone(&self) -> WitnessOrd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WitnessOrd

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WitnessOrd

fn deserialize<__D>( __deserializer: __D, ) -> Result<WitnessOrd, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WitnessOrd

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

Formats the value using the given formatter.

impl From<WitnessPos> for WitnessOrd

fn from(v: WitnessPos) -> WitnessOrd

Converts to this type from the input type.

impl Hash for WitnessOrd

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

where __H: Hasher,

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 WitnessOrd

fn cmp(&self, other: &WitnessOrd) -> 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 WitnessOrd

fn eq(&self, other: &WitnessOrd) -> 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 WitnessOrd

fn partial_cmp(&self, other: &WitnessOrd) -> 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 WitnessOrd

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for WitnessOrd

fn strict_decode(reader: &mut impl TypedRead) -> Result<WitnessOrd, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for WitnessOrd

fn strict_dumb() -> WitnessOrd

impl StrictEncode for WitnessOrd

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictSum for WitnessOrd

const ALL_VARIANTS: &'static [(u8, &'static str)]

fn variant_name(&self) -> &'static str

fn strict_check_variants()

fn variant_name_by_tag(tag: u8) -> Option<VariantName>

fn variant_ord(&self) -> u8

impl StrictType for WitnessOrd

const STRICT_LIB_NAME: &'static str = LIB_NAME_RGB_LOGIC

fn strict_name() -> Option<TypeName>

impl StrictUnion for WitnessOrd

fn strict_type_info() -> TypeInfo<Self>

impl Copy for WitnessOrd

impl Eq for WitnessOrd

impl StructuralPartialEq for WitnessOrd