Struct TicketSelector

pub struct TicketSelector {
    pub channel_identifiers: Vec<(Hash, U256)>,
    pub index: TicketIndexSelector,
    pub win_prob: (Bound<WinningProbability>, Bound<WinningProbability>),
    pub amount: (Bound<HoprBalance>, Bound<HoprBalance>),
    pub state: Option<AcknowledgedTicketStatus>,
    pub only_aggregated: bool,
}

Allows selecting multiple tickets (if index does not contain a single value) or a single ticket (with unitary index) in the given channel and epoch. The selection can be further restricted to select ticket only in the given state.

Fields

channel_identifiers: Vec<(Hash, U256)>

Channel ID and Epoch pairs.

index: TicketIndexSelector

If given, will select ticket(s) with the given indices in the given channel and epoch. See TicketIndexSelector for possible options.

win_prob: (Bound<WinningProbability>, Bound<WinningProbability>)

If given, the tickets are further restricted to the ones with a winning probability in this range.

amount: (Bound<HoprBalance>, Bound<HoprBalance>)

If given, the tickets are further restricted to the ones with an amount in this range.

state: Option<AcknowledgedTicketStatus>

Further restriction to tickets with the given state.

only_aggregated: bool

Further restrict to only aggregated tickets.

Implementations

impl TicketSelector

pub fn new<T: Into<U256>>(channel_id: Hash, epoch: T) -> Self

Create a new ticket selector given the channel_id and epoch.

pub fn also_on_channel<T: Into<U256>>(self, channel_id: Hash, epoch: T) -> Self

Allows matching tickets on multiple channels, by adding the given channel_id and epoch to the selector.

This also nullifies any prior effect of any prior calls to TicketSelector::with_index or TicketSelector::with_index_range as ticket indices cannot be matched over multiple channels.

pub fn just_on_channel<T: Into<U256>>(self, channel_id: Hash, epoch: T) -> Self

Sets the selector to match only tickets on the given channel_id and epoch. This nullifies any prior calls to TicketSelector::also_on_channel.

pub fn is_single_channel(&self) -> bool

Checks if this selector operates only on a single channel.

This will return false if TicketSelector::also_on_channel was called, and neither the TicketSelector::with_index nor TicketSelector::with_index_range were called subsequently.

pub fn is_unique(&self) -> bool

If false is returned, the selector can fetch more than a single ticket.

pub fn with_index(self, index: u64) -> Self

Returns this instance with a ticket index set. This method can be called multiple times to select multiple tickets. If TicketSelector::with_index_range was previously called, it will be replaced. If TicketSelector::also_on_channel was previously called, its effect will be nullified.

pub fn with_index_range<T: RangeBounds<u64>>(self, index_bound: T) -> Self

Returns this instance with a ticket index upper bound set. If TicketSelector::with_index was previously called, it will be replaced. If TicketSelector::also_on_channel was previously called, its effect will be nullified.

pub fn with_state(self, state: AcknowledgedTicketStatus) -> Self

Returns this instance with a ticket state set.

pub fn with_no_state(self) -> Self

Returns this instance without a ticket state set.

pub fn with_aggregated_only(self, only_aggregated: bool) -> Self

Returns this instance with only_aggregated flag value.

pub fn with_winning_probability<T: RangeBounds<WinningProbability>>( self, range: T, ) -> Self

Returns this instance with a winning probability range bounds set.

pub fn with_amount<T: RangeBounds<HoprBalance>>(self, range: T) -> Self

Returns this instance with the ticket amount range bounds set.

Trait Implementations

impl Clone for TicketSelector

fn clone(&self) -> TicketSelector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TicketSelector

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

Formats the value using the given formatter.

impl Display for TicketSelector

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

Formats the value using the given formatter.

impl From<&AcknowledgedTicket> for TicketSelector

fn from(value: &AcknowledgedTicket) -> Self

Converts to this type from the input type.

impl From<&ChannelEntry> for TicketSelector

fn from(value: &ChannelEntry) -> Self

Converts to this type from the input type.

impl From<&RedeemableTicket> for TicketSelector

fn from(value: &RedeemableTicket) -> Self

Converts to this type from the input type.

impl From<ChannelEntry> for TicketSelector

fn from(value: ChannelEntry) -> Self

Converts to this type from the input type.