Struct UpdateName

pub struct UpdateName(pub u64, _);

A struct representing a name for a channel monitor update.

UpdateName is primarily used within the MonitorUpdatingPersister in functions that store or retrieve partial updates to channel monitors. It provides a consistent way to generate and parse unique identifiers for monitor updates based on their sequence number.

The name is derived from the update’s sequence ID, which is a monotonically increasing u64 value. This format allows for easy ordering of updates and efficient storage and retrieval in key-value stores.

Usage

While users of the Lightning Dev Kit library generally won’t need to interact with UpdateName directly, it still can be useful for custom persistence implementations. The u64 value is the update_id that can be compared with ChannelMonitor::get_latest_update_id to check if this update has been applied to the channel monitor or not, which is useful for pruning stale channel monitor updates off persistence.

Examples

use lightning::util::persist::UpdateName;

let update_id: u64 = 42;
let update_name = UpdateName::from(update_id);
assert_eq!(update_name.as_str(), "42");

// Using UpdateName to generate a storage key
let monitor_name = "some_monitor_name";
let storage_key = format!("channel_monitor_updates/{}/{}", monitor_name, update_name.as_str());

Tuple Fields

0: u64

Implementations

impl UpdateName

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

Constructs an UpdateName, after verifying that an update sequence ID can be derived from the given name.

pub fn as_str(&self) -> &str

Convert this update name to a string slice.

This method is particularly useful when you need to use the update name as part of a key in a key-value store or when logging.

Examples

use lightning::util::persist::UpdateName;

let update_name = UpdateName::from(42);
assert_eq!(update_name.as_str(), "42");

Trait Implementations

impl Debug for UpdateName

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

Formats the value using the given formatter.

impl From<u64> for UpdateName

fn from(value: u64) -> Self

Creates an UpdateName from a u64.

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

Examples

use lightning::util::persist::UpdateName;

let update_id: u64 = 42;
let update_name = UpdateName::from(update_id);
assert_eq!(update_name.as_str(), "42");