Enum pallet_circuit::circuit::CircuitStatus

pub enum CircuitStatus {
    Requested,
    Reserved,
    PendingBidding,
    InBidding,
    Killed(Cause),
    Ready,
    PendingExecution,
    Finished,
    FinishedAllSteps,
    Reverted(Cause),
    Committed,
}

Status of Circuit storage items: Requested - default Requested -> Validated - successfully passed the validation Option<Validated -> PendingInsurance>: If there are some side effects that request insurance, the status will stay in PendingInsurance until all insurance deposits are committed Validated/PendingInsurance -> Ready - ready for relayers to pick up and start executing on targets Ready -> PendingExecution - at least one side effect has already been confirmed, but not all of them PendingExecution -> Finished - all of the side effects are confirmed, now awaiting for the decision about Revert/Commit Circuit::Apply -> called internally - based on the side effects confirmations decides: Ready -> Committed: All of the side effects have been successfully confirmed Ready -> Reverted: Some of the side effects failed and the Xtx was reverted

Variants

Requested

unvalidated xtx requested

Reserved

validated xtx with empty side effects - reserved for 3vm following execution

PendingBidding

validated xtx pending for bidding; no bids has been posted so far

InBidding

at least one bid has already been posted, still awaiting for bidding resolution

Killed(Cause)

xtx killed on user’s request or Dropped at Bidding

Ready

all bids has been posted and xtx is awaiting confirmations of execution

PendingExecution

at least one valid confirmation of execution has already been accepted; xtx still in progress

Finished

xtx step successfully finished

FinishedAllSteps

all of the steps has successfully finished - can still await for attestations to move to foreign consensus targets

Reverted(Cause)

xtx reverts due timeout when confirmations haven’t arrived on time,

Committed

Implementations

impl CircuitStatus

pub fn check_transition<T>( previous: CircuitStatus, new: CircuitStatus, maybe_forced: Option<CircuitStatus> ) -> Result<CircuitStatus, DispatchError>where T: Config,

pub fn determine_bidding_status<T, Balance>( fsx_step: &[FullSideEffect<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, Balance>] ) -> CircuitStatuswhere T: Config, Balance: Clone,

Check if all FSX have the bidding companion. Additionally, if SFX::Optimistic check if the optional insurance and bonded_deposit fields are present if SFX::Escrow check if the optional insurance and bonded_deposit are set to None

pub fn determine_execution_status<T, Balance>( fsx_step: &[FullSideEffect<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, Balance>] ) -> CircuitStatuswhere T: Config, Balance: Clone,

pub fn determine_step_status<T, Balance>( step: &[FullSideEffect<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, Balance>] ) -> CircuitStatuswhere T: Config, Balance: Clone,

Based solely on full steps + insurance deposits determine the execution status. Start with checking the criteria from the earliest status to latest

pub fn determine_xtx_status<T, Balance>( steps: &[Vec<FullSideEffect<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, Balance>, Global>] ) -> CircuitStatuswhere T: Config, Balance: Clone,

Trait Implementations

impl Clone for CircuitStatus

fn clone(&self) -> CircuitStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CircuitStatus

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

Formats the value using the given formatter.

impl Decode for CircuitStatus

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<CircuitStatus, Error>where __CodecInputEdqy: Input,

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 CircuitStatus

fn default() -> CircuitStatus

Returns the “default value” for a type.

impl Encode for CircuitStatus

fn size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere 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<CircuitStatus> for CircuitStatus

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TypeInfo for CircuitStatus

type Identity = CircuitStatus

The type identifying for which type info is provided.

fn type_info() -> Type<MetaForm>

Returns the static type identifier for Self.

impl EncodeLike<CircuitStatus> for CircuitStatus

impl Eq for CircuitStatus

impl StructuralEq for CircuitStatus

impl StructuralPartialEq for CircuitStatus