Struct lightning_persister::FilesystemPersister

pub struct FilesystemPersister { /* private fields */ }

FilesystemPersister persists channel data on disk, where each channel’s data is stored in a file named after its funding outpoint.

Warning: this module does the best it can with calls to persist data, but it can only guarantee that the data is passed to the drive. It is up to the drive manufacturers to do the actual persistence properly, which they often don’t (especially on consumer-grade hardware). Therefore, it is up to the user to validate their entire storage stack, to ensure the writes are persistent. Corollary: especially when dealing with larger amounts of money, it is best practice to have multiple channel data backups and not rely only on one FilesystemPersister.

Implementations

impl FilesystemPersister

pub fn new(path_to_channel_data: String) -> Self

Initialize a new FilesystemPersister and set the path to the individual channels’ files.

pub fn get_data_dir(&self) -> String

Get the directory which was provided when this persister was initialized.

pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
    data_dir: String,
    manager: &ChannelManager<Signer, M, T, K, F, L>
) -> Result<(), Error> where
    M::Target: Watch<Signer>,
    T::Target: BroadcasterInterface,
    K::Target: KeysInterface<Signer = Signer>,
    F::Target: FeeEstimator,
    L::Target: Logger, 

Writes the provided ChannelManager to the path provided at FilesystemPersister initialization, within a file called “manager”.

pub fn persist_network_graph(
    data_dir: String,
    network_graph: &NetworkGraph
) -> Result<(), Error>

Write the provided NetworkGraph to the path provided at FilesystemPersister initialization, within a file called “network_graph”

pub fn read_channelmonitors<Signer: Sign, K: Deref>(
    &self,
    keys_manager: K
) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, Error> where
    K::Target: KeysInterface<Signer = Signer> + Sized, 

Read ChannelMonitors from disk.

Trait Implementations

impl<ChannelSigner: Sign> Persist<ChannelSigner> for FilesystemPersister

fn persist_new_channel(
    &self,
    funding_txo: OutPoint,
    monitor: &ChannelMonitor<ChannelSigner>,
    _update_id: MonitorUpdateId
) -> Result<(), ChannelMonitorUpdateErr>

Persist a new channel’s data in response to a chain::Watch::watch_channel call. This is called by ChannelManager for new channels, or may be called directly, e.g. on startup.

fn update_persisted_channel(
    &self,
    funding_txo: OutPoint,
    _update: &Option<ChannelMonitorUpdate>,
    monitor: &ChannelMonitor<ChannelSigner>,
    _update_id: MonitorUpdateId
) -> Result<(), ChannelMonitorUpdateErr>

Update one channel’s data. The provided ChannelMonitor has already applied the given update.