Struct Ticket

pub struct Ticket {
    pub channel_id: Hash,
    pub amount: HoprBalance,
    pub index: u64,
    pub index_offset: u32,
    pub encoded_win_prob: EncodedWinProb,
    pub channel_epoch: u32,
    pub challenge: EthereumChallenge,
    pub signature: Option<Signature>,
}

Contains the overall description of a ticket with a signature.

This structure is not considered verified, unless the Ticket::verify or Ticket::sign methods are called.

Ticket state machine

See the entire state machine describing the relations of different ticket types below:

flowchart TB A[Ticket] -->|verify| B(VerifiedTicket) B --> |leak| A A --> |sign| B B --> |into_unacknowledged| C(UnacknowledgedTicket) B --> |into_acknowledged| D(AcknowledgedTicket) C --> |acknowledge| D D --> |into_redeemable| E(RedeemableTicket) D --> |into_transferable| F(TransferableWinningTicket) E --> |into_transferable| F F --> |into_redeemable| E

Fields

channel_id: Hash

Channel ID. See generate_channel_id for how this value is generated.

amount: HoprBalance

Amount of HOPR tokens this ticket is worth. Always between 0 and 2^92.

index: u64

Ticket index. Always between 0 and 2^48.

index_offset: u32

Ticket index offset. Always between 1 and 2^32. For normal tickets this is always equal to 1, for aggregated this is always > 1.

encoded_win_prob: EncodedWinProb

Encoded winning probability represented via 56-bit number.

channel_epoch: u32

Epoch of the channel this ticket belongs to. Always between 0 and 2^24.

challenge: EthereumChallenge

Represent the Proof of Relay challenge encoded as an Ethereum address.

signature: Option<Signature>

ECDSA secp256k1 signature of all the above values.

Implementations

impl Ticket

pub fn get_hash(&self, domain_separator: &Hash) -> Hash

Computes Ethereum signature hash of the ticket, must be equal to on-chain computation

pub fn sign( self, signing_key: &ChainKeypair, domain_separator: &Hash, ) -> VerifiedTicket

Signs the ticket using the given private key, turning this ticket into VerifiedTicket. If a signature was already present, it will be replaced.

pub fn verify( self, issuer: &Address, domain_separator: &Hash, ) -> Result<VerifiedTicket, Box<Ticket>>

Verifies the signature of this ticket, turning this ticket into VerifiedTicket. If the verification fails, Self is returned in the error.

This is done by recovering the signer from the signature and verifying that it matches the given issuer argument. This is possible due this specific instantiation of the ECDSA over the secp256k1 curve. The operation can fail if a public key cannot be recovered from the ticket signature.

pub fn is_aggregated(&self) -> bool

Returns true if this ticket aggregates multiple tickets.

pub fn win_prob(&self) -> WinningProbability

Returns the decoded winning probability of the ticket

Trait Implementations

impl BytesEncodable<TICKET_SIZE> for Ticket

const SIZE: usize = N

Size of the encoded byte array. Defaults to N and should not be overridden.

fn into_encoded(self) -> [u8; N]

Convenience function to represent the A shorthand for let v: [u8; N] = self.into().

fn into_boxed(self) -> Box<[u8]>

Convenience function to encode the type into a Box.

impl Clone for Ticket

fn clone(&self) -> Ticket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ticket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ticket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Ticket

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

Formats the value using the given formatter.

impl From<&Ticket> for TicketBuilder

fn from(value: &Ticket) -> Self

Converts to this type from the input type.

impl From<Ticket> for [u8; 148]

fn from(value: Ticket) -> Self

Converts to this type from the input type.

impl From<Ticket> for TicketBuilder

fn from(value: Ticket) -> Self

Converts to this type from the input type.

impl Ord for Ticket

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Ticket

type Error = GeneralError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Ticket

impl StructuralPartialEq for Ticket