Module lightning::ln

source ·
Expand description

High level lightning structs and impls live here.

You probably want to create a ChannelManager, and a P2PGossipSync first. Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to create/manage connections and call get_and_clear_pending_events after each action, handling them appropriately.

When you want to open/close a channel or send a payment, call into your ChannelManager and when you want to learn things about the network topology (eg get a route for sending a payment), call into your P2PGossipSync.

Modules

  • chan_utils
    Various utilities for building scripts and deriving keys related to channels. These are largely of interest for those implementing chain::keysinterface::Sign message signing by hand.
  • channelmanager
    The top-level channel management and payment tracking stuff lives here.
  • features
    Feature flag definitions for the Lightning protocol according to BOLT #9.
  • inbound_payment
    Utilities to generate inbound payment information in service of invoice creation.
  • msgs
    Wire messages, traits representing wire message handlers, and a few error types live here.
  • peer_handler
    Top level peer message handling and socket handling logic lives here.
  • script
    Abstractions for scripts used in the Lightning Network.
  • wire
    Wire encoding/decoding for Lightning messages according to BOLT #1, and for custom message through the CustomMessageReader trait.

Structs

  • PaymentHash
    payment_hash type, use to cross-lock hop (C-not exported) as we just use [u8; 32] directly
  • PaymentPreimage
    payment_preimage type, use to route payment between hop (C-not exported) as we just use [u8; 32] directly
  • PaymentSecret
    payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together (C-not exported) as we just use [u8; 32] directly

Constants