Struct TicketBuilder

pub struct TicketBuilder { /* private fields */ }

Builder for Ticket and VerifiedTicket.

A new builder is created via TicketBuilder::default or TicketBuilder::zero_hop.

Input validation is performed upon calling TicketBuilder::build, TicketBuilder::build_signed and TicketBuilder::build_verified.

Implementations

impl TicketBuilder

pub fn zero_hop() -> Self

Initializes the builder for a zero-hop ticket.

pub fn direction(self, source: &Address, destination: &Address) -> Self

Sets channel id based on the source and destination. This, TicketBuilder::channel_id or TicketBuilder::addresses must be set.

pub fn addresses<T: Into<Address>, U: Into<Address>>( self, source: T, destination: U, ) -> Self

Sets channel id based on the source and destination. This, TicketBuilder::channel_id or TicketBuilder::direction must be set.

pub fn channel_id(self, channel_id: Hash) -> Self

Sets the channel id. This, TicketBuilder::addresses or TicketBuilder::direction must be set.

pub fn amount<T: Into<U256>>(self, amount: T) -> Self

Sets the ticket amount. This or TicketBuilder::balance must be set and be less or equal to 10^25.

pub fn balance(self, balance: Balance) -> Self

Sets the ticket amount as HOPR balance. This or TicketBuilder::amount must be set and be less or equal to 10^25.

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

Sets the ticket index. Must be less or equal to 2^48. Defaults to 0.

pub fn index_offset(self, index_offset: u32) -> Self

Sets the index offset. Must be greater or equal 1. Defaults to 1.

pub fn channel_epoch(self, channel_epoch: u32) -> Self

Sets the channel epoch. Must be less or equal to 2^24. Defaults to 1.

pub fn win_prob(self, win_prob: f64) -> Self

Sets the ticket winning probability. Mutually exclusive with TicketBuilder::win_prob_encoded. Defaults to 1.0

pub fn win_prob_encoded(self, win_prob: EncodedWinProb) -> Self

Sets the encoded ticket winning probability. Mutually exclusive with TicketBuilder::win_prob. Defaults to ALWAYS_WINNING.

pub fn challenge(self, challenge: EthereumChallenge) -> Self

Sets the EthereumChallenge for Proof of Relay. Must be set.

pub fn signature(self, signature: Signature) -> Self

Set the signature of this ticket. Defaults to None.

pub fn build(self) -> Result<Ticket>

Verifies all inputs and builds the Ticket. This does not perform signature verification if a signature was set.

pub fn build_signed( self, signer: &ChainKeypair, domain_separator: &Hash, ) -> Result<VerifiedTicket>

Validates all inputs and builds the VerifiedTicket by signing the ticket data with the given key. Fails if signature was previously set.

pub fn build_verified(self, hash: Hash) -> Result<VerifiedTicket>

Validates all input and builds the VerifiedTicket by assuming the previously set signature is valid and belongs to the given ticket hash. It does not check whether hash matches the input data nor that the signature verifies the given hash.

Trait Implementations

impl Clone for TicketBuilder

fn clone(&self) -> TicketBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TicketBuilder

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

Formats the value using the given formatter.

impl Default for TicketBuilder

fn default() -> Self

Return TicketBuilder { channel_id: Default::default(), amount: Default::default(), balance: Default::default(), index: 0, index_offset: 1, channel_epoch: 1, win_prob: Some(DEFAULT_OUTGOING_TICKET_WIN_PROB), win_prob_enc: Default::default(), challenge: Default::default(), signature: Default::default() }

impl From<&Ticket> for TicketBuilder

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.