Copyright	(c) 2025 Jared Tobin
License	MIT
Maintainer	Jared Tobin <jared@ppad.tech>
Safe Haskell	None
Language	Haskell2010

Lightning.Protocol.BOLT5.Types

Contents

Close identification
Output classification
HTLC output type
Spending transactions
Penalty batching
Weight constants (Appendix A)
Fee calculation

Description

Types for BOLT #5 on-chain transaction handling.

Synopsis

data CloseType
- = MutualClose
- | LocalCommitClose
- | RemoteCommitClose
- | RevokedCommitClose
data UnresolvedOutput = UnresolvedOutput {
- uo_outpoint :: !OutPoint
- uo_value :: !Satoshi
- uo_type :: !OutputResolution
}
data OutputResolution
- = Resolved
- | SpendToLocal !ToSelfDelay !RevocationPubkey !LocalDelayedPubkey
- | SpendHTLCTimeout !HTLC !CommitmentKeys !ChannelFeatures
- | SpendHTLCSuccess !HTLC !CommitmentKeys !ChannelFeatures
- | SpendHTLCTimeoutDirect !HTLC
- | SpendHTLCPreimageDirect !HTLC
- | Revoke !RevocationPubkey
- | RevokeHTLC !RevocationPubkey !HTLCOutputType
- | AnchorSpend !FundingPubkey
data HTLCOutputType
- = HTLCOfferedOutput !CltvExpiry
- | HTLCReceivedOutput !CltvExpiry
htlcOutputType :: OutputType -> Maybe HTLCOutputType
htlcOutputTypeWeight :: HTLCOutputType -> Word64
data SpendingTx = SpendingTx {
- stx_tx :: !Tx
- stx_input_script :: !Script
- stx_input_value :: !Satoshi
- stx_sighash_type :: !SighashType
}
data RevokedOutput = RevokedOutput {
- ro_outpoint :: !OutPoint
- ro_value :: !Satoshi
- ro_type :: !RevokedOutputType
}
data RevokedOutputType
- = RevokedToLocal
- | RevokedHTLC !HTLCOutputType
data PenaltyContext = PenaltyContext {
- pc_outputs :: !(NonEmpty RevokedOutput)
- pc_revocation_key :: !RevocationPubkey
- pc_destination :: !Script
- pc_feerate :: !FeeratePerKw
}
revoked_output_weight :: RevokedOutput -> Word64
to_local_penalty_witness_weight :: Word64
offered_htlc_penalty_witness_weight :: Word64
accepted_htlc_penalty_witness_weight :: Word64
to_local_penalty_input_weight :: Word64
offered_htlc_penalty_input_weight :: Word64
accepted_htlc_penalty_input_weight :: Word64
to_remote_input_weight :: Word64
penalty_tx_base_weight :: Word64
max_standard_weight :: Word64
spending_fee :: FeeratePerKw -> Word64 -> Satoshi

Close identification

data CloseType Source #

What kind of close was detected on chain.

Constructors

MutualClose	Cooperative closure agreed by both parties.
LocalCommitClose	Our commitment transaction was broadcast.
RemoteCommitClose	The remote party's commitment transaction was broadcast.
RevokedCommitClose	A revoked (outdated) commitment transaction was broadcast.

Instances

Instances details

Generic CloseType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep CloseType

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep CloseType = D1 ('MetaData "CloseType" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) ((C1 ('MetaCons "MutualClose" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LocalCommitClose" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RemoteCommitClose" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RevokedCommitClose" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: CloseType -> Rep CloseType x #

to :: Rep CloseType x -> CloseType #

Show CloseType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> CloseType -> ShowS #

show :: CloseType -> String #

showList :: [CloseType] -> ShowS #

Eq CloseType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: CloseType -> CloseType -> Bool #

(/=) :: CloseType -> CloseType -> Bool #

type Rep CloseType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep CloseType = D1 ('MetaData "CloseType" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) ((C1 ('MetaCons "MutualClose" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LocalCommitClose" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RemoteCommitClose" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RevokedCommitClose" 'PrefixI 'False) (U1 :: Type -> Type)))

Output classification

data UnresolvedOutput Source #

An unresolved commitment transaction output.

Constructors

UnresolvedOutput
Fields uo_outpoint :: !OutPoint uo_value :: !Satoshi uo_type :: !OutputResolution

Instances

Instances details

Generic UnresolvedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep UnresolvedOutput

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep UnresolvedOutput = D1 ('MetaData "UnresolvedOutput" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "UnresolvedOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "uo_outpoint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OutPoint) :*: (S1 ('MetaSel ('Just "uo_value") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Satoshi) :*: S1 ('MetaSel ('Just "uo_type") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OutputResolution))))

Methods

from :: UnresolvedOutput -> Rep UnresolvedOutput x #

to :: Rep UnresolvedOutput x -> UnresolvedOutput #

Show UnresolvedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> UnresolvedOutput -> ShowS #

show :: UnresolvedOutput -> String #

showList :: [UnresolvedOutput] -> ShowS #

Eq UnresolvedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: UnresolvedOutput -> UnresolvedOutput -> Bool #

(/=) :: UnresolvedOutput -> UnresolvedOutput -> Bool #

type Rep UnresolvedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep UnresolvedOutput = D1 ('MetaData "UnresolvedOutput" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "UnresolvedOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "uo_outpoint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OutPoint) :*: (S1 ('MetaSel ('Just "uo_value") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Satoshi) :*: S1 ('MetaSel ('Just "uo_type") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OutputResolution))))

data OutputResolution Source #

How to resolve an output, per BOLT #5 rules.

Constructors

Resolved	Already resolved (e.g. to_remote on local commit).
SpendToLocal !ToSelfDelay !RevocationPubkey !LocalDelayedPubkey	Spend to_local after CSV delay.
SpendHTLCTimeout !HTLC !CommitmentKeys !ChannelFeatures	Spend via HTLC-timeout second-stage tx (local commit, local offer).
SpendHTLCSuccess !HTLC !CommitmentKeys !ChannelFeatures	Spend via HTLC-success second-stage tx (local commit, remote offer).
SpendHTLCTimeoutDirect !HTLC	Spend HTLC directly after timeout (remote commit, local offer).
SpendHTLCPreimageDirect !HTLC	Spend HTLC directly with preimage (remote commit, remote offer).
Revoke !RevocationPubkey	Spend revoked to_local with revocation key.
RevokeHTLC !RevocationPubkey !HTLCOutputType	Spend revoked HTLC output with revocation key.
AnchorSpend !FundingPubkey	Spend anchor output.

Instances

Instances details

Generic OutputResolution Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep OutputResolution

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

from :: OutputResolution -> Rep OutputResolution x #

to :: Rep OutputResolution x -> OutputResolution #

Show OutputResolution Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> OutputResolution -> ShowS #

show :: OutputResolution -> String #

showList :: [OutputResolution] -> ShowS #

Eq OutputResolution Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: OutputResolution -> OutputResolution -> Bool #

(/=) :: OutputResolution -> OutputResolution -> Bool #

type Rep OutputResolution Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

HTLC output type

data HTLCOutputType Source #

Type of HTLC output, restricted to only HTLC variants.

Unlike bolt3's OutputType which includes all six output types, this ADT makes it impossible to confuse HTLC outputs with to_local, to_remote, or anchor outputs.

Constructors

HTLCOfferedOutput !CltvExpiry	Offered HTLC output with CLTV expiry.
HTLCReceivedOutput !CltvExpiry	Received HTLC output with CLTV expiry.

Instances

Instances details

Generic HTLCOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep HTLCOutputType

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep HTLCOutputType = D1 ('MetaData "HTLCOutputType" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "HTLCOfferedOutput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CltvExpiry)) :+: C1 ('MetaCons "HTLCReceivedOutput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CltvExpiry)))

Methods

from :: HTLCOutputType -> Rep HTLCOutputType x #

to :: Rep HTLCOutputType x -> HTLCOutputType #

Show HTLCOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> HTLCOutputType -> ShowS #

show :: HTLCOutputType -> String #

showList :: [HTLCOutputType] -> ShowS #

Eq HTLCOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: HTLCOutputType -> HTLCOutputType -> Bool #

(/=) :: HTLCOutputType -> HTLCOutputType -> Bool #

type Rep HTLCOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep HTLCOutputType = D1 ('MetaData "HTLCOutputType" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "HTLCOfferedOutput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CltvExpiry)) :+: C1 ('MetaCons "HTLCReceivedOutput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CltvExpiry)))

htlcOutputType :: OutputType -> Maybe HTLCOutputType Source #

Extract an HTLCOutputType from a bolt3 OutputType.

Returns Nothing for non-HTLC output types.

>>> htlcOutputType (OutputOfferedHTLC (CltvExpiry 500))
Just (HTLCOfferedOutput (CltvExpiry ...))
>>> htlcOutputType OutputToLocal
Nothing

htlcOutputTypeWeight :: HTLCOutputType -> Word64 Source #

Penalty input weight for an HTLC output type.

Spending transactions

data SpendingTx Source #

Unsigned spending transaction, ready for caller to sign.

The caller uses bolt3 witness constructors to assemble the final witness after signing.

Constructors

SpendingTx
Fields stx_tx :: !Tx The unsigned transaction. stx_input_script :: !Script Witness script for the input being spent. stx_input_value :: !Satoshi Value of the input being spent (for sighash). stx_sighash_type :: !SighashType Sighash type to use when signing.

Instances

Instances details

Generic SpendingTx Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep SpendingTx

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep SpendingTx = D1 ('MetaData "SpendingTx" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "SpendingTx" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stx_tx") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Tx) :*: S1 ('MetaSel ('Just "stx_input_script") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Script)) :*: (S1 ('MetaSel ('Just "stx_input_value") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Satoshi) :*: S1 ('MetaSel ('Just "stx_sighash_type") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SighashType))))

Methods

from :: SpendingTx -> Rep SpendingTx x #

to :: Rep SpendingTx x -> SpendingTx #

Show SpendingTx Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> SpendingTx -> ShowS #

show :: SpendingTx -> String #

showList :: [SpendingTx] -> ShowS #

Eq SpendingTx Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: SpendingTx -> SpendingTx -> Bool #

(/=) :: SpendingTx -> SpendingTx -> Bool #

type Rep SpendingTx Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep SpendingTx = D1 ('MetaData "SpendingTx" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "SpendingTx" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stx_tx") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Tx) :*: S1 ('MetaSel ('Just "stx_input_script") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Script)) :*: (S1 ('MetaSel ('Just "stx_input_value") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Satoshi) :*: S1 ('MetaSel ('Just "stx_sighash_type") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SighashType))))

Penalty batching

data RevokedOutput Source #

A revoked output that can be swept with a revocation key.

This type restricts penalty transaction inputs to only valid revocation targets: to_local outputs and HTLC outputs. Other output types (to_remote, anchors) cannot appear in penalty transactions.

Constructors

RevokedOutput
Fields ro_outpoint :: !OutPoint ro_value :: !Satoshi ro_type :: !RevokedOutputType

Instances

Instances details

Generic RevokedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep RevokedOutput

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep RevokedOutput = D1 ('MetaData "RevokedOutput" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "RevokedOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "ro_outpoint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OutPoint) :*: (S1 ('MetaSel ('Just "ro_value") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Satoshi) :*: S1 ('MetaSel ('Just "ro_type") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RevokedOutputType))))

Methods

from :: RevokedOutput -> Rep RevokedOutput x #

to :: Rep RevokedOutput x -> RevokedOutput #

Show RevokedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> RevokedOutput -> ShowS #

show :: RevokedOutput -> String #

showList :: [RevokedOutput] -> ShowS #

Eq RevokedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: RevokedOutput -> RevokedOutput -> Bool #

(/=) :: RevokedOutput -> RevokedOutput -> Bool #

type Rep RevokedOutput Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep RevokedOutput = D1 ('MetaData "RevokedOutput" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "RevokedOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "ro_outpoint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OutPoint) :*: (S1 ('MetaSel ('Just "ro_value") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Satoshi) :*: S1 ('MetaSel ('Just "ro_type") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RevokedOutputType))))

data RevokedOutputType Source #

What kind of revoked output is being swept.

Constructors

RevokedToLocal	Revoked to_local output.
RevokedHTLC !HTLCOutputType	Revoked HTLC output.

Instances

Instances details

Generic RevokedOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Associated Types

type Rep RevokedOutputType

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep RevokedOutputType = D1 ('MetaData "RevokedOutputType" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "RevokedToLocal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RevokedHTLC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HTLCOutputType)))

Methods

from :: RevokedOutputType -> Rep RevokedOutputType x #

to :: Rep RevokedOutputType x -> RevokedOutputType #

Show RevokedOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

showsPrec :: Int -> RevokedOutputType -> ShowS #

show :: RevokedOutputType -> String #

showList :: [RevokedOutputType] -> ShowS #

Eq RevokedOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

Methods

(==) :: RevokedOutputType -> RevokedOutputType -> Bool #

(/=) :: RevokedOutputType -> RevokedOutputType -> Bool #

type Rep RevokedOutputType Source #

Instance details

Defined in Lightning.Protocol.BOLT5.Types

type Rep RevokedOutputType = D1 ('MetaData "RevokedOutputType" "Lightning.Protocol.BOLT5.Types" "ppad-bolt5-0.0.1-IGu7gJAK79v1xlbxm4omg6" 'False) (C1 ('MetaCons "RevokedToLocal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RevokedHTLC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HTLCOutputType)))

data PenaltyContext Source #

Context for constructing batched penalty transactions.

Constructors

PenaltyContext
Fields pc_outputs :: !(NonEmpty RevokedOutput) Revoked outputs to sweep (must be non-empty). pc_revocation_key :: !RevocationPubkey Revocation pubkey for all outputs. pc_destination :: !Script Destination scriptPubKey. pc_feerate :: !FeeratePerKw Fee rate for the penalty transaction.