Expand description
Implementations of various parts of the Lightning protocol are in this module.
Modules§
- Various utilities for building scripts related to channels. These are largely of interest for those implementing the traits on
crate::sign
by hand. - Keys used to generate commitment transactions. See: https://github.com/lightning/bolts/blob/master/03-transactions.md#keys
- The top-level channel management and payment tracking stuff lives here.
- Feature flag definitions for the Lightning protocol according to BOLT #9.
- Utilities to generate inbound payment information in service of invoice creation.
- Wire messages, traits representing wire message handlers, and a few error types live here.
- Utilities to decode payment onions and do contextless validation of incoming payments.
- Top level peer message handling and socket handling logic lives here.
- Abstractions for scripts used in the Lightning Network.
- Wire encoding/decoding for Lightning messages according to BOLT #1, and for custom message through the
CustomMessageReader
trait.
Structs§
- A unique 32-byte identifier for a channel. Depending on how the ID is generated, several varieties are distinguished (but all are stored as 32 bytes): v1 and temporary. A v1 channel ID is generated based on funding tx outpoint (txid & index). A temporary ID is generated randomly. (Later revocation-point-based v2 is a possibility.) The variety (context) is not stored, it is relevant only at creation.
- payment_hash type, use to cross-lock hop
- payment_preimage type, use to route payment between hop
- payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
Constants§
- LN_MAX_MSG_LENNon-
fuzzing
Functions§
- Build a payment onion, returning the first hop msat and cltv values as well.
cur_block_height
should be set to the best known block height + 1.