Struct ChannelEndState 

pub struct ChannelEndState {

    pub address: Address,
    pub contract_balance: TokenAmount,
    pub onchain_total_withdraw: TokenAmount,
    pub withdraws_pending: HashMap<U256, PendingWithdrawState>,
    pub withdraws_expired: Vec<ExpiredWithdrawState>,
    pub initiated_coop_settle: Option<CoopSettleState>,
    pub expired_coop_settles: Vec<CoopSettleState>,
    pub secrethashes_to_lockedlocks: HashMap<SecretHash, HashTimeLockState>,
    pub secrethashes_to_unlockedlocks: HashMap<SecretHash, UnlockPartialProofState>,
    pub secrethashes_to_onchain_unlockedlocks: HashMap<SecretHash, UnlockPartialProofState>,
    pub balance_proof: Option<BalanceProofState>,
    pub pending_locks: PendingLocksState,
    pub onchain_locksroot: Locksroot,
    pub nonce: Nonce,
}

The state of one of the nodes in a two party channel.

Fields

address: Address

contract_balance: TokenAmount

onchain_total_withdraw: TokenAmount

withdraws_pending: HashMap<U256, PendingWithdrawState>

withdraws_expired: Vec<ExpiredWithdrawState>

initiated_coop_settle: Option<CoopSettleState>

expired_coop_settles: Vec<CoopSettleState>

secrethashes_to_lockedlocks: HashMap<SecretHash, HashTimeLockState>

secrethashes_to_unlockedlocks: HashMap<SecretHash, UnlockPartialProofState>

secrethashes_to_onchain_unlockedlocks: HashMap<SecretHash, UnlockPartialProofState>

balance_proof: Option<BalanceProofState>

pending_locks: PendingLocksState

onchain_locksroot: Locksroot

nonce: Nonce

Implementations

impl ChannelEndState

pub fn new(address: Address) -> Self

Return an instance of ChannelEndState.

pub fn offchain_total_withdraw(&self) -> TokenAmount

returns the off-chain total withdraw amount.

pub fn total_withdraw(&self) -> TokenAmount

Returns the total of off-chain and on-chain withdraw amounts.

pub fn next_nonce(&self) -> Nonce

Returns the next usable nonce.

pub fn count_pending_transfers(&self) -> usize

Returns the number of pending transfers.

pub fn locked_amount(&self) -> TokenAmount

Returns the total amount locked.

pub fn get_current_balanceproof(&self) -> BalanceProofData

Returns the latest balance proof.

pub fn is_valid_amount(&self, amount: TokenAmount) -> bool

Returns true if the amount after unlock is valid

pub fn is_secret_known(&self, secrethash: SecretHash) -> bool

Returns true if secret is known either off-chain or on-chain.

pub fn secret_known_onchain(&self, secrethash: SecretHash) -> bool

Returns true if secret is known on-chain.

pub fn is_secret_known_offchain(&self, secrethash: SecretHash) -> bool

Returns true if secret is known off-chain.

pub fn get_secret(&self, secrethash: SecretHash) -> Option<Secret>

Returns the secret of a lock if known.

Trait Implementations

impl Clone for ChannelEndState

fn clone(&self) -> ChannelEndState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelEndState

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

Formats the value using the given formatter.

impl Default for ChannelEndState

fn default() -> ChannelEndState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChannelEndState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChannelEndState

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ChannelEndState

impl StructuralPartialEq for ChannelEndState