Struct MonitorName

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

A struct representing a name for a channel monitor.

MonitorName is primarily used within the MonitorUpdatingPersister in functions that store or retrieve channel monitor snapshots. It provides a consistent way to generate a unique key for channel monitors based on their funding outpoints.

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 lightning::util::persist::MonitorName;
use lightning::chain::transaction::OutPoint;

let outpoint = OutPoint {
 txid: Txid::from_str("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef").unwrap(),
 index: 1,
};
let monitor_name = MonitorName::from(outpoint);
assert_eq!(monitor_name.as_str(), "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1");

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

Implementations

impl MonitorName

pub fn new(name: String) -> Result<MonitorName, Error>

Constructs a MonitorName, after verifying that an OutPoint can be formed from the given name. This method is useful if you have a String and you want to verify that it’s a valid storage key for a channel monitor.

pub fn as_str(&self) -> &str

Convert this monitor name to a str. This method is particularly useful when you need to use the monitor name as a key in a key-value store or when logging.

Trait Implementations

impl Debug for MonitorName

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

Formats the value using the given formatter.

impl From<OutPoint> for MonitorName

fn from(value: OutPoint) -> MonitorName

Creates a MonitorName from an OutPoint.

This is typically used when you need to generate a storage key or identifier for a new or existing channel monitor.

impl TryFrom<&MonitorName> for OutPoint

fn try_from(value: &MonitorName) -> Result<OutPoint, Error>

Attempts to convert a MonitorName back into an OutPoint.

This is useful when you have a MonitorName (perhaps retrieved from storage) and need to reconstruct the original OutPoint it represents.

type Error = Error

The type returned in the event of a conversion error.