Module breez_sdk_core::lightning::util

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

Modules

• config
  Various user-configurable channel limits and settings which ChannelManager applies for you.
• errors
  Error types live here.
• indexed_map
  This module has a map which can be iterated in a deterministic order. See the IndexedMap.
• invoice
  Low level invoice utilities.
• logger
  Log traits live here, which are called throughout the library to provide useful information for debugging purposes.
• message_signing
  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.
• persist
  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.
• ser
  A very simple serialization framework which is used to serialize/deserialize messages as well as ChannelManagers and ChannelMonitors.
• ser_macros
  Some macros that implement Readable/Writeable traits for lightning messages. They also handle serialization and deserialization of TLVs.
• string
  Utilities for strings.
• test_channel_signer
  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.
• test_utils
• wakers
  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.