Module breez_sdk_core::lightning::util

Expand description

Some utility modules live here. See individual sub-modules for more info.

Modules§

  • Various user-configurable channel limits and settings which ChannelManager applies for you.
  • Error types live here.
  • This module has a map which can be iterated in a deterministic order. See the IndexedMap.
  • Low level invoice utilities.
  • Log traits live here, which are called throughout the library to provide useful information for debugging purposes.
  • Lightning message signing and verification lives here. These tools can be used to sign messages using the node’s secret so receivers are sure that they come from you. You can also use this to verify that a given message comes from a specific node. Furthermore, these tools can be used to sign / verify messages using ephemeral keys not tied to node’s identities.
  • This module contains a simple key-value store trait KVStore that allows one to implement the persistence for ChannelManager, NetworkGraph, and ChannelMonitor all in one place.
  • A very simple serialization framework which is used to serialize/deserialize messages as well as ChannelManagers and ChannelMonitors.
  • Some macros that implement Readable/Writeable traits for lightning messages. They also handle serialization and deserialization of TLVs.
  • Utilities for strings.
  • impls of traits that add exra enforcement on the way they’re called. Useful for detecting state machine errors and used in fuzz targets and tests.
  • Utilities which allow users to block on some future notification from LDK. These are specifically used by ChannelManager to allow waiting until the ChannelManager needs to be re-persisted.