Struct TicketBuilder

Source
pub struct TicketBuilder { /* private fields */ }
Expand description

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§

Source§

impl TicketBuilder

Source

pub fn zero_hop() -> Self

Initializes the builder for a zero-hop ticket.

Source

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.

Source

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.

Source

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

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

Source

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.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

Sets the ticket winning probability. Defaults to 1.0

Source

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

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

Source

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

Set the signature of this ticket. Defaults to None.

Source

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

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

Source

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.

Source

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

Validates all inputs 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§

Source§

impl Clone for TicketBuilder

Source§

fn clone(&self) -> TicketBuilder

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 TicketBuilder

Source§

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

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

impl Default for TicketBuilder

Source§

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: Default::default(), challenge: Default::default(), signature: Default::default() }

Source§

impl From<&Ticket> for TicketBuilder

Source§

fn from(value: &Ticket) -> Self

Converts to this type from the input type.
Source§

impl From<Ticket> for TicketBuilder

Source§

fn from(value: Ticket) -> Self

Converts to this type from the input type.

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
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
Source§

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

Source§

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

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> Instrument for T

Source§

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

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

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> 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
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, 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> 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
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,