Struct ChannelEntry

pub struct ChannelEntry {
    pub source: Address,
    pub destination: Address,
    pub balance: HoprBalance,
    pub ticket_index: U256,
    pub status: ChannelStatus,
    pub channel_epoch: U256,
    /* private fields */
}

Overall description of a channel

Fields

source: Address

destination: Address

balance: HoprBalance

ticket_index: U256

status: ChannelStatus

channel_epoch: U256

Implementations

impl ChannelEntry

pub const MAX_CHANNEL_BALANCE: u128 = 10_000_000_000_000_000_000_000_000u128

Maximum possible balance of a channel: 10^25 wxHOPR

pub fn new( source: Address, destination: Address, balance: HoprBalance, ticket_index: U256, status: ChannelStatus, channel_epoch: U256, ) -> Self

pub fn get_id(&self) -> ChannelId

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 PendingToClose state, 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.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChannelEntry

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

Formats the value using the given formatter.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ChannelEntry

impl StructuralPartialEq for ChannelEntry