Enum MonitorName 

pub enum MonitorName {
    V1Channel(OutPoint),
    V2Channel(ChannelId),
}

A struct representing a name for a channel monitor.

MonitorName is primarily used within the MonitorUpdatingPersister in functions that store or retrieve ChannelMonitor snapshots. It provides a consistent way to generate a unique key for channel monitors based on the channel’s funding OutPoint for v1 channels or ChannelId for v2 channels. Use ChannelMonitor::persistence_key to obtain the correct MonitorName.

While users of the Lightning Dev Kit library generally won’t need to interact with MonitorName directly, it can be useful for:

• Custom persistence implementations
• Debugging or logging channel monitor operations
• Extending the functionality of the MonitorUpdatingPersister

Examples

use std::str::FromStr;

use bitcoin::Txid;
use bitcoin::hashes::hex::FromHex;

use lightning::util::persist::MonitorName;
use lightning::chain::transaction::OutPoint;
use lightning::ln::types::ChannelId;

// v1 channel
let outpoint = OutPoint {
 txid: Txid::from_str("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef").unwrap(),
 index: 1,
};
let monitor_name = MonitorName::V1Channel(outpoint);
assert_eq!(&monitor_name.to_string(), "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1");

// v2 channel
let channel_id = ChannelId(<[u8; 32]>::from_hex("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef").unwrap());
let monitor_name = MonitorName::V2Channel(channel_id);
assert_eq!(&monitor_name.to_string(), "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef");

// Using MonitorName to generate a storage key
let storage_key = format!("channel_monitors/{}", monitor_name);

Variants

V1Channel(OutPoint)

The outpoint of the channel’s funding transaction.

V2Channel(ChannelId)

The id of the channel produced by ChannelId::v2_from_revocation_basepoints.

Trait Implementations

impl Clone for MonitorName

fn clone(&self) -> MonitorName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MonitorName

impl Debug for MonitorName

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

Formats the value using the given formatter.

impl Display for MonitorName

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

Formats the value using the given formatter.

impl Eq for MonitorName

impl Hash for MonitorName

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 PartialEq for MonitorName

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