Struct ChannelEntry 

pub struct ChannelEntry {
    pub source: Address,
    pub destination: Address,
    pub balance: Balance<WxHOPR>,
    pub ticket_index: u64,
    pub status: ChannelStatus,
    pub channel_epoch: u32,
    id: HashBase<CoreWrapper<Keccak256Core>>,
}

Overall description of a channel

Fields

source: Address

Source address of the channel.

destination: Address

Destination address of the channel.

balance: Balance<WxHOPR>

Stake amount on the channel in wxHOPR tokens.

ticket_index: u64

Next ticket index of the channel.

status: ChannelStatus

Current status of the channel.

channel_epoch: u32

Epoch of the channel.

id: HashBase<CoreWrapper<Keccak256Core>>

Implementations

impl ChannelEntry

pub fn builder() -> ChannelBuilder

Creates a new [ChannelBuilder].

pub fn new( source: Address, destination: Address, balance: Balance<WxHOPR>, ticket_index: u64, status: ChannelStatus, channel_epoch: u32, ) -> ChannelEntry

👎Deprecated since 1.3.0: use ChannelBuilder instead

DEPRECATED Construct a new channel entry.

pub fn get_id(&self) -> &HashBase<CoreWrapper<Keccak256Core>>

Generates the channel ID using the source and destination address

pub fn closure_time_passed(&self, current_time: SystemTime) -> bool

Checks if the closure time of this channel has passed.

Also returns false if the channel closure has not been initiated (it is in Open state). Returns also true if the channel is in Closed state.

pub fn remaining_closure_time( &self, current_time: SystemTime, ) -> Option<Duration>

Calculates the remaining channel closure grace period.

Returns None if the channel closure has not been initiated yet (channel is in Open state).

pub fn closure_time_at(&self) -> Option<SystemTime>

Returns the earliest time the channel can transition from PendingToClose into Closed.

If the channel is not in the PendingToClose state, it returns None.

pub fn direction(&self, me: &Address) -> Option<ChannelDirection>

Determines the channel direction given the self-address.

Returns None if neither source nor destination are equal to me.

pub fn orientation(&self, me: &Address) -> Option<(ChannelDirection, Address)>

Determines the channel’s direction and counterparty relative to me.

Returns None if neither source nor destination are equal to me.

pub fn diff(&self, other: &ChannelEntry) -> Vec<ChannelChange>

Makes a diff of this channel (left) and the other channel (right).

The channels must have the same ID.

See [ChannelChange]

Trait Implementations

impl Clone for ChannelEntry

fn clone(&self) -> ChannelEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelEntry

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChannelEntry, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChannelEntry

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

Formats the value using the given formatter.

impl Hash for ChannelEntry

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ChannelEntry

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ChannelEntry

impl Eq for ChannelEntry

impl StructuralPartialEq for ChannelEntry