Struct ChannelId

pub struct ChannelId(pub [u8; 32]);

A unique 32-byte identifier for a channel. Depending on how the ID is generated, several varieties are distinguished (but all are stored as 32 bytes): v1 and temporary. A v1 channel ID is generated based on funding tx outpoint (txid & index). A temporary ID is generated randomly. (Later revocation-point-based v2 is a possibility.) The variety (context) is not stored, it is relevant only at creation.

Tuple Fields

0: [u8; 32]

Implementations

impl ChannelId

pub fn v1_from_funding_txid(txid: &[u8; 32], output_index: u16) -> Self

Create v1 channel ID based on a funding TX ID and output index

pub fn v1_from_funding_outpoint(outpoint: OutPoint) -> Self

Create v1 channel ID from a funding tx outpoint

pub fn temporary_from_entropy_source<ES: Deref>(entropy_source: &ES) -> Self

where ES::Target: EntropySource,

Create a temporary channel ID randomly, based on an entropy source.

pub fn from_bytes(data: [u8; 32]) -> Self

Generic constructor; create a new channel ID from the provided data. Use a more specific *_from_* constructor when possible.

pub fn new_zero() -> Self

Create a channel ID consisting of all-zeros data (e.g. when uninitialized or a placeholder).

pub fn is_zero(&self) -> bool

Check whether ID is consisting of all zeros (uninitialized)

pub fn v2_from_revocation_basepoints( ours: &RevocationBasepoint, theirs: &RevocationBasepoint, ) -> Self

Create v2 channel ID by concatenating the holder revocation basepoint with the counterparty revocation basepoint and hashing the result. The basepoints will be concatenated in increasing sorted order.

pub fn temporary_v2_from_revocation_basepoint( our_revocation_basepoint: &RevocationBasepoint, ) -> Self

Create temporary v2 channel ID by concatenating a zeroed out basepoint with the holder revocation basepoint and hashing the result.

pub fn is_v2_channel_id( &self, ours: &RevocationBasepoint, theirs: &RevocationBasepoint, ) -> bool

Indicates whether this is a V2 channel ID for the given local and remote revocation basepoints.

Trait Implementations

impl Borrow<[u8]> for ChannelId

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for ChannelId

fn clone(&self) -> ChannelId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelId

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

Formats the value using the given formatter.

impl Display for ChannelId

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

Formats the value using the given formatter.

impl Hash for ChannelId

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

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 LowerHex for ChannelId

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

Formats the value using the given formatter.

impl Ord for ChannelId

fn cmp(&self, other: &ChannelId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ChannelId

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

fn partial_cmp(&self, other: &ChannelId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Readable for ChannelId

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl UpperHex for ChannelId

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

Formats the value using the given formatter.

impl Writeable for ChannelId

fn write<W: Writer>(&self, w: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Copy for ChannelId

impl Eq for ChannelId

impl StructuralPartialEq for ChannelId