Channel

Enum Channel 

Source
pub enum Channel {
    Offered(OfferedChannel),
    Accepted(AcceptedChannel),
    Signed(SignedChannel),
    FailedAccept(FailedAccept),
    FailedSign(FailedSign),
    Cancelled(OfferedChannel),
    Closing(ClosingChannel),
    Closed(ClosedChannel),
    CounterClosed(ClosedChannel),
    ClosedPunished(ClosedPunishedChannel),
    CollaborativelyClosed(ClosedChannel),
}
Expand description

Enumeration containing the possible state a DLC channel can be in.

Variants§

§

Offered(OfferedChannel)

A channel that has been offered.

§

Accepted(AcceptedChannel)

A channel that has been accepted.

§

Signed(SignedChannel)

A channel whose fund outputs have been signed by the offer party.

§

FailedAccept(FailedAccept)

A channel that failed when validating an [dlc_messages::channel::AcceptChannel] message.

§

FailedSign(FailedSign)

A channel that failed when validating an [dlc_messages::channel::SignChannel] message.

§

Cancelled(OfferedChannel)

A OfferedChannel that got rejected by the counterparty.

§

Closing(ClosingChannel)

A Channel is in Closing state when the local party has broadcast a buffer transaction and is waiting to finalize the closing of the channel by broadcasting a CET.

§

Closed(ClosedChannel)

A Channel is in Closed state when it was force closed by the local party.

§

CounterClosed(ClosedChannel)

A Channel is in CounterClosed state when it was force closed by the counter party.

§

ClosedPunished(ClosedPunishedChannel)

A Channel is in ClosedPunished state when the local party broadcast a punishment transaction in response to the counter party broadcasting a settle or buffer transaction for a revoked channel state.

§

CollaborativelyClosed(ClosedChannel)

A SignedChannel is in CollaborativelyClosed state when it was collaboratively closed.

Implementations§

Source§

impl Channel

Source

pub fn get_counter_party_id(&self) -> PublicKey

Returns the public key of the counter party’s node.

Source§

impl Channel

Source

pub fn get_temporary_id(&self) -> ChannelId

Returns the temporary crate::ChannelId for the channel.

Source

pub fn get_id(&self) -> ChannelId

Returns the crate::ChannelId for the channel.

Source

pub fn get_contract_id(&self) -> Option<ContractId>

Returns the contract id associated with the channel if in a state where a contract is set.

Trait Implementations§

Source§

impl Clone for Channel

Source§

fn clone(&self) -> Channel

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 Channel

Source§

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

Formats the value using the given formatter. Read more

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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