Struct ChannelBuilder 

pub struct ChannelBuilder {
    source: Option<Address>,
    destination: Option<Address>,
    balance: Option<Balance<WxHOPR>>,
    ticket_index: u64,
    status: ChannelStatus,
    channel_epoch: u32,
}

Builder for ChannelEntry.

Fields

source: Option<Address>

destination: Option<Address>

balance: Option<Balance<WxHOPR>>

ticket_index: u64

status: ChannelStatus

channel_epoch: u32

Implementations

impl ChannelBuilder

pub const MAX_FUNDING_AMOUNT: u128

Maximum possible funding amount channel: 10^25 wxHOPR

pub const MAX_CHANNEL_STAKE: u128

Maximum possible stake on the channel: 2^96 wxHOPR

pub fn source<A>(self, source: A) -> ChannelBuilder

where A: Into<Address>,

Source of the channel.

Must be set along with ChannelBuilder::destination, or ChannelBuilder::between may be used to set both.

pub fn destination<A>(self, destination: A) -> ChannelBuilder

where A: Into<Address>,

Destination of the channel.

Must be set along with ChannelBuilder::source, or ChannelBuilder::between may be used to set both.

pub fn between<A, B>(self, source: A, destination: B) -> ChannelBuilder

where A: Into<Address>, B: Into<Address>,

Sets both source and destination of the channel.

This function or ChannelBuilder::source and ChannelBuilder::destination must be called.

pub fn amount<A>(self, amount: A) -> ChannelBuilder

where A: Into<U256>,

Sets the stake amount on the channel in wei wxHOPR tokens.

This function or ChannelBuilder::balance must be called.

pub fn balance(self, balance: Balance<WxHOPR>) -> ChannelBuilder

Sets specific HoprBalance as the stake on the channel.

This function or ChannelBuilder::amount must be called.

pub fn ticket_index(self, ticket_index: u64) -> ChannelBuilder

Ticket index of the channel.

Default is 0, maximum is 2^48 - 1.

pub fn status(self, status: ChannelStatus) -> ChannelBuilder

Status of the channel.

The default is ChannelStatus::Open.

pub fn epoch(self, channel_epoch: u32) -> ChannelBuilder

Epoch of the channel.

Default is 1, maximum is 2^24 - 1.

pub fn build(self) -> Result<ChannelEntry, CoreTypesError>

Tries to build the ChannelEntry.

Returns an error if values are out of range.

Trait Implementations

impl Clone for ChannelBuilder

fn clone(&self) -> ChannelBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelBuilder

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

Formats the value using the given formatter.

impl Default for ChannelBuilder

fn default() -> ChannelBuilder

Return ChannelBuilder { source: Default::default(), destination: Default::default(), balance: Default::default(), ticket_index: 0, status: ChannelStatus::Open, channel_epoch: 1 }

impl Copy for ChannelBuilder