Module sign 

Provides keys to LDK and defines some useful objects describing spendable on-chain outputs.

The provided output descriptors follow a custom LDK data format and are currently not fully compatible with Bitcoin Core output descriptors.

Modules

ecdsa

Defines ECDSA-specific signer types.

tx_builder

Defines the TxBuilder trait, and the SpecTxBuilder type

Structs

ChannelDerivationParameters

The parameters required to derive a channel signer via SignerProvider.

DelayedPaymentOutputDescriptor

Information about a spendable output to a P2WSH script.

HTLCDescriptor

A descriptor used to sign for a commitment transaction’s HTLC output.

InMemorySigner

A simple implementation of EcdsaChannelSigner that just keeps the private keys in memory.

KeysManager

Simple implementation of EntropySource, NodeSigner, and SignerProvider that takes a 32-byte seed for use as a BIP 32 extended key and derives keys from that.

PeerStorageKey

Represents the secret key material used for encrypting Peer Storage.

PhantomKeysManager

Similar to KeysManager, but allows the node using this struct to receive phantom node payments.

RandomBytes

An implementation of EntropySource using ChaCha20.

ReceiveAuthKey

A secret key used to authenticate message contexts in received BlindedMessagePaths.

StaticPaymentOutputDescriptor

Information about a spendable output to our “payment key”.

Enums

Recipient

Specifies the recipient of an invoice.

SpendableOutputDescriptor

Describes the necessary information to spend a spendable output.

Constants

STATIC_PAYMENT_KEY_COUNT

If a KeysManager is built with KeysManager::new with v2_remote_key_derivation set (and for all channels after they’ve been spliced), the script which we receive funds to on-chain when our counterparty force-closes a channel is one of this many possible derivation paths.

Traits

ChangeDestinationSource

A helper trait that describes an on-chain wallet capable of returning a (change) destination script.

ChangeDestinationSourceSync

A synchronous helper trait that describes an on-chain wallet capable of returning a (change) destination script.

ChannelSigner

A trait to handle Lightning channel key material without concretizing the channel type or the signature mechanism.

EntropySource

A trait that describes a source of entropy.

NodeSigner

A trait that can handle cryptographic operations at the scope level of a node.

OutputSpender

A trait that describes a wallet capable of creating a spending Transaction from a set of SpendableOutputDescriptors.

SignerProvider

A trait that can return signer instances for individual channels.

Functions

compute_funding_key_tweak

Computes the tweak to apply to the base funding key of a channel.