ChainEvent

hopr_lib::api::chain

Enum ChainEvent 

Source 
pub enum ChainEvent {
    Announcement(AccountEntry),
    ChannelOpened(ChannelEntry),
    ChannelClosureInitiated(ChannelEntry),
    ChannelClosed(ChannelEntry),
    ChannelBalanceIncreased(ChannelEntry, Balance<WxHOPR>),
    ChannelBalanceDecreased(ChannelEntry, Balance<WxHOPR>),
    TicketRedeemed(ChannelEntry, Option<Box<VerifiedTicket>>),
    WinningProbabilityIncreased(WinningProbability),
    WinningProbabilityDecreased(WinningProbability),
    TicketPriceChanged(Balance<WxHOPR>),
}
Expand description

Enumeration of HOPR chain events.

Variants§

§

Announcement(AccountEntry)

Peer on-chain announcement event.

The AccountEntry is guaranteed to be announced.

§

ChannelOpened(ChannelEntry)

A new channel has been opened

The ChannelEntry is guaranteed to be opened.

§

ChannelClosureInitiated(ChannelEntry)

Channel closure has been initiated.

The ChannelEntry is guaranteed to be pending to close.

§

ChannelClosed(ChannelEntry)

Channel closure has been finalized.

The ChannelEntry is guaranteed to be closed.

§

ChannelBalanceIncreased(ChannelEntry, Balance<WxHOPR>)

Channel balance has increased by an amount.

The HoprBalance is never 0 and represents the difference from the current new balance on the ChannelEntry.

§

ChannelBalanceDecreased(ChannelEntry, Balance<WxHOPR>)

Channel balance has decreased by an amount.

The HoprBalance is never 0 and represents the difference from the current new balance on the ChannelEntry.

§

TicketRedeemed(ChannelEntry, Option<Box<VerifiedTicket>>)

Ticket has been redeemed on a channel.

If the channel is a node’s own, it also contains the ticket that has been redeemed.

§

WinningProbabilityIncreased(WinningProbability)

The minimum winning probability has been increased.

§

WinningProbabilityDecreased(WinningProbability)

The minimum winning probability has been decreased.

§

TicketPriceChanged(Balance<WxHOPR>)

A new ticket price has been set.

Implementations§

Source§

impl ChainEvent

Source

pub fn try_as_announcement(self) -> Option<AccountEntry>

Source

pub const fn try_as_announcement_ref(&self) -> Option<&AccountEntry>

Source

pub fn try_as_announcement_mut(&mut self) -> Option<&mut AccountEntry>

Source

pub fn try_as_channel_opened(self) -> Option<ChannelEntry>

Source

pub const fn try_as_channel_opened_ref(&self) -> Option<&ChannelEntry>

Source

pub fn try_as_channel_opened_mut(&mut self) -> Option<&mut ChannelEntry>

Source

pub fn try_as_channel_closure_initiated(self) -> Option<ChannelEntry>

Source

pub const fn try_as_channel_closure_initiated_ref( &self, ) -> Option<&ChannelEntry>

Source

pub fn try_as_channel_closure_initiated_mut( &mut self, ) -> Option<&mut ChannelEntry>

Source

pub fn try_as_channel_closed(self) -> Option<ChannelEntry>

Source

pub const fn try_as_channel_closed_ref(&self) -> Option<&ChannelEntry>

Source

pub fn try_as_channel_closed_mut(&mut self) -> Option<&mut ChannelEntry>

Source

pub fn try_as_channel_balance_increased( self, ) -> Option<(ChannelEntry, Balance<WxHOPR>)>

Source

pub const fn try_as_channel_balance_increased_ref( &self, ) -> Option<(&ChannelEntry, &Balance<WxHOPR>)>

Source

pub fn try_as_channel_balance_increased_mut( &mut self, ) -> Option<(&mut ChannelEntry, &mut Balance<WxHOPR>)>

Source

pub fn try_as_channel_balance_decreased( self, ) -> Option<(ChannelEntry, Balance<WxHOPR>)>

Source

pub const fn try_as_channel_balance_decreased_ref( &self, ) -> Option<(&ChannelEntry, &Balance<WxHOPR>)>

Source

pub fn try_as_channel_balance_decreased_mut( &mut self, ) -> Option<(&mut ChannelEntry, &mut Balance<WxHOPR>)>

Source

pub fn try_as_ticket_redeemed( self, ) -> Option<(ChannelEntry, Option<Box<VerifiedTicket>>)>

Source

pub const fn try_as_ticket_redeemed_ref( &self, ) -> Option<(&ChannelEntry, &Option<Box<VerifiedTicket>>)>

Source

pub fn try_as_ticket_redeemed_mut( &mut self, ) -> Option<(&mut ChannelEntry, &mut Option<Box<VerifiedTicket>>)>

Source

pub fn try_as_winning_probability_increased(self) -> Option<WinningProbability>

Source

pub const fn try_as_winning_probability_increased_ref( &self, ) -> Option<&WinningProbability>

Source

pub fn try_as_winning_probability_increased_mut( &mut self, ) -> Option<&mut WinningProbability>

Source

pub fn try_as_winning_probability_decreased(self) -> Option<WinningProbability>

Source

pub const fn try_as_winning_probability_decreased_ref( &self, ) -> Option<&WinningProbability>

Source

pub fn try_as_winning_probability_decreased_mut( &mut self, ) -> Option<&mut WinningProbability>

Source

pub fn try_as_ticket_price_changed(self) -> Option<Balance<WxHOPR>>

Source

pub const fn try_as_ticket_price_changed_ref(&self) -> Option<&Balance<WxHOPR>>

Source

pub fn try_as_ticket_price_changed_mut( &mut self, ) -> Option<&mut Balance<WxHOPR>>

Source§

impl ChainEvent

Source

pub const fn is_announcement(&self) -> bool

Returns true if the enum is ChainEvent::Announcement otherwise false

Source

pub const fn is_channel_opened(&self) -> bool

Returns true if the enum is ChainEvent::ChannelOpened otherwise false

Source

pub const fn is_channel_closure_initiated(&self) -> bool

Returns true if the enum is ChainEvent::ChannelClosureInitiated otherwise false

Source

pub const fn is_channel_closed(&self) -> bool

Returns true if the enum is ChainEvent::ChannelClosed otherwise false

Source

pub const fn is_channel_balance_increased(&self) -> bool

Returns true if the enum is ChainEvent::ChannelBalanceIncreased otherwise false

Source

pub const fn is_channel_balance_decreased(&self) -> bool

Returns true if the enum is ChainEvent::ChannelBalanceDecreased otherwise false

Source

pub const fn is_ticket_redeemed(&self) -> bool

Returns true if the enum is ChainEvent::TicketRedeemed otherwise false

Source

pub const fn is_winning_probability_increased(&self) -> bool

Returns true if the enum is ChainEvent::WinningProbabilityIncreased otherwise false

Source

pub const fn is_winning_probability_decreased(&self) -> bool

Returns true if the enum is ChainEvent::WinningProbabilityDecreased otherwise false

Source

pub const fn is_ticket_price_changed(&self) -> bool

Returns true if the enum is ChainEvent::TicketPriceChanged otherwise false

Trait Implementations§

Source§

impl Clone for ChainEvent

Source§

fn clone(&self) -> ChainEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChainEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ChainEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoDiscriminant for ChainEvent

Source§

type Discriminant = ChainEventDiscriminants

Enum listing the same variants as this enum but without any data fields
Source§

fn discriminant(&self) -> <ChainEvent as IntoDiscriminant>::Discriminant

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> ValidateIp for T
where T: ToString,

§

fn validate_ipv4(&self) -> bool

Validates whether the given string is an IP V4
§

fn validate_ipv6(&self) -> bool

Validates whether the given string is an IP V6
§

fn validate_ip(&self) -> bool

Validates whether the given string is an IP
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more