Struct ChannelId

pub struct ChannelId(/* private fields */);

Channel identifier

This id is used to coordinate with the node and is not related to the channel ids in the Lightning protocol. The channel keys are derived from this and a base key.

A channel may have more than one id.

There are currently two ways to generate ids: one which uses a peer id and is compatible with CLN, and one which doesn’t and is compatible with LDK. In both cases the id of the channel at the node (called a dbid in CLN or oid in LDK) is stored in little-endian in the final 8 bytes of the id. This fact is relied when retrieving the dbid/oid`.

Implementations

impl ChannelId

pub fn new(inner: &[u8]) -> Self

Create an id from a nonce

pub fn new_from_oid(oid: u64) -> Self

Create an id from an oid (LDK-style)

The nonce is a 32 byte array, where the first 24 bytes are 0 and the last 8 are the original id (little-endian)

pub fn new_from_peer_id_and_oid(peer_id: &[u8; 33], oid: u64) -> Self

Create an id from a peer id and oid (CLN-style)

The nonce is a 41 byte array, where the first 33 bytes are the peer id and the final 8 are the original id (little-endian)

pub fn as_slice(&self) -> &[u8]

Return a byte slice of the nonce

pub fn inner(&self) -> &Vec<u8>

Return a reference to a vector of the nonce

pub fn oid(&self) -> u64

Returns the original id used at creation

pub fn ldk_channel_keys_id(&self) -> [u8; 32]

Return the id in a format compatible with the LDK SignerProvider generate_channel_keys_id interface

This will panic if the nonce is not exactly 32 bytes

Trait Implementations

impl Clone for ChannelId

fn clone(&self) -> ChannelId

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeAs<'de, ChannelId> for ChannelIdHandler

fn deserialize_as<D>(deserializer: D) -> Result<ChannelId, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display 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 Serialize for ChannelId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SerializeAs<ChannelId> for ChannelIdHandler

fn serialize_as<S>(source: &ChannelId, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ChannelId

impl StructuralPartialEq for ChannelId