ppad-bolt2-0.0.1: Peer protocol per BOLT #2
Copyright(c) 2025 Jared Tobin
LicenseMIT
MaintainerJared Tobin <jared@ppad.tech>
Safe HaskellNone
LanguageHaskell2010

Lightning.Protocol.BOLT2.Types

Description

Core types for BOLT #2 peer protocol.

This module provides newtypes for identifiers, amounts, hashes, and keys used in the Lightning Network peer protocol.

Synopsis

Identifiers (re-exported from BOLT1)

newtype ChannelId Source #

A 32-byte channel identifier.

Constructors

ChannelId ByteString 

Instances

Instances details
NFData ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: ChannelId -> () #

Generic ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep ChannelId = D1 ('MetaData "ChannelId" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "ChannelId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: ChannelId -> Rep ChannelId x #

to :: Rep ChannelId x -> ChannelId #

Show ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> ChannelId -> ShowS #

show :: ChannelId -> String #

showList :: [ChannelId] -> ShowS #

Eq ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: ChannelId -> ChannelId -> Ordering #

(<) :: ChannelId -> ChannelId -> Bool #

(<=) :: ChannelId -> ChannelId -> Bool #

(>) :: ChannelId -> ChannelId -> Bool #

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

max :: ChannelId -> ChannelId -> ChannelId #

min :: ChannelId -> ChannelId -> ChannelId #

type Rep ChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep ChannelId = D1 ('MetaData "ChannelId" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "ChannelId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

channelId :: ByteString -> Maybe ChannelId Source #

Construct a ChannelId from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

unChannelId :: ChannelId -> ByteString Source #

Extract the raw bytes from a ChannelId.

Amounts (re-exported from BOLT1)

newtype Satoshi Source #

Amount in satoshis.

Constructors

Satoshi 

Fields

Instances

Instances details
NFData Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: Satoshi -> () #

Enum Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

succ :: Satoshi -> Satoshi #

pred :: Satoshi -> Satoshi #

toEnum :: Int -> Satoshi #

fromEnum :: Satoshi -> Int #

enumFrom :: Satoshi -> [Satoshi] #

enumFromThen :: Satoshi -> Satoshi -> [Satoshi] #

enumFromTo :: Satoshi -> Satoshi -> [Satoshi] #

enumFromThenTo :: Satoshi -> Satoshi -> Satoshi -> [Satoshi] #

Generic Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep Satoshi = D1 ('MetaData "Satoshi" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "Satoshi" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSatoshi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: Satoshi -> Rep Satoshi x #

to :: Rep Satoshi x -> Satoshi #

Num Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

(+) :: Satoshi -> Satoshi -> Satoshi #

(-) :: Satoshi -> Satoshi -> Satoshi #

(*) :: Satoshi -> Satoshi -> Satoshi #

negate :: Satoshi -> Satoshi #

abs :: Satoshi -> Satoshi #

signum :: Satoshi -> Satoshi #

fromInteger :: Integer -> Satoshi #

Integral Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

quot :: Satoshi -> Satoshi -> Satoshi #

rem :: Satoshi -> Satoshi -> Satoshi #

div :: Satoshi -> Satoshi -> Satoshi #

mod :: Satoshi -> Satoshi -> Satoshi #

quotRem :: Satoshi -> Satoshi -> (Satoshi, Satoshi) #

divMod :: Satoshi -> Satoshi -> (Satoshi, Satoshi) #

toInteger :: Satoshi -> Integer #

Real Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

toRational :: Satoshi -> Rational #

Show Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> Satoshi -> ShowS #

show :: Satoshi -> String #

showList :: [Satoshi] -> ShowS #

Eq Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: Satoshi -> Satoshi -> Ordering #

(<) :: Satoshi -> Satoshi -> Bool #

(<=) :: Satoshi -> Satoshi -> Bool #

(>) :: Satoshi -> Satoshi -> Bool #

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

max :: Satoshi -> Satoshi -> Satoshi #

min :: Satoshi -> Satoshi -> Satoshi #

type Rep Satoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep Satoshi = D1 ('MetaData "Satoshi" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "Satoshi" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSatoshi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

newtype MilliSatoshi Source #

Amount in millisatoshis.

Constructors

MilliSatoshi 

Fields

Instances

Instances details
NFData MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: MilliSatoshi -> () #

Enum MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

succ :: MilliSatoshi -> MilliSatoshi #

pred :: MilliSatoshi -> MilliSatoshi #

toEnum :: Int -> MilliSatoshi #

fromEnum :: MilliSatoshi -> Int #

enumFrom :: MilliSatoshi -> [MilliSatoshi] #

enumFromThen :: MilliSatoshi -> MilliSatoshi -> [MilliSatoshi] #

enumFromTo :: MilliSatoshi -> MilliSatoshi -> [MilliSatoshi] #

enumFromThenTo :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi -> [MilliSatoshi] #

Generic MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep MilliSatoshi = D1 ('MetaData "MilliSatoshi" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "MilliSatoshi" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMilliSatoshi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: MilliSatoshi -> Rep MilliSatoshi x #

to :: Rep MilliSatoshi x -> MilliSatoshi #

Num MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

(+) :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

(-) :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

(*) :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

negate :: MilliSatoshi -> MilliSatoshi #

abs :: MilliSatoshi -> MilliSatoshi #

signum :: MilliSatoshi -> MilliSatoshi #

fromInteger :: Integer -> MilliSatoshi #

Integral MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

quot :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

rem :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

div :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

mod :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

quotRem :: MilliSatoshi -> MilliSatoshi -> (MilliSatoshi, MilliSatoshi) #

divMod :: MilliSatoshi -> MilliSatoshi -> (MilliSatoshi, MilliSatoshi) #

toInteger :: MilliSatoshi -> Integer #

Real MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

toRational :: MilliSatoshi -> Rational #

Show MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> MilliSatoshi -> ShowS #

show :: MilliSatoshi -> String #

showList :: [MilliSatoshi] -> ShowS #

Eq MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: MilliSatoshi -> MilliSatoshi -> Ordering #

(<) :: MilliSatoshi -> MilliSatoshi -> Bool #

(<=) :: MilliSatoshi -> MilliSatoshi -> Bool #

(>) :: MilliSatoshi -> MilliSatoshi -> Bool #

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

max :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

min :: MilliSatoshi -> MilliSatoshi -> MilliSatoshi #

type Rep MilliSatoshi 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep MilliSatoshi = D1 ('MetaData "MilliSatoshi" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "MilliSatoshi" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMilliSatoshi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

satToMsat :: Satoshi -> MilliSatoshi Source #

Convert Satoshi to MilliSatoshi.

msatToSat :: MilliSatoshi -> Satoshi Source #

Convert MilliSatoshi to Satoshi (rounds down).

Cryptographic types (re-exported from BOLT1)

newtype Signature Source #

A 64-byte compact ECDSA signature.

Constructors

Signature ByteString 

Instances

Instances details
NFData Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: Signature -> () #

Generic Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep Signature = D1 ('MetaData "Signature" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: Signature -> Rep Signature x #

to :: Rep Signature x -> Signature #

Show Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> Signature -> ShowS #

show :: Signature -> String #

showList :: [Signature] -> ShowS #

Eq Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: Signature -> Signature -> Ordering #

(<) :: Signature -> Signature -> Bool #

(<=) :: Signature -> Signature -> Bool #

(>) :: Signature -> Signature -> Bool #

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

max :: Signature -> Signature -> Signature #

min :: Signature -> Signature -> Signature #

type Rep Signature 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep Signature = D1 ('MetaData "Signature" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

signature :: ByteString -> Maybe Signature Source #

Construct a Signature from a 64-byte ByteString.

Returns Nothing if the input is not exactly 64 bytes.

unSignature :: Signature -> ByteString Source #

Extract the raw bytes from a Signature.

newtype Point Source #

A 33-byte compressed secp256k1 public key.

Constructors

Point ByteString 

Instances

Instances details
NFData Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: Point -> () #

Generic Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep Point = D1 ('MetaData "Point" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "Point" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: Point -> Rep Point x #

to :: Rep Point x -> Point #

Show Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> Point -> ShowS #

show :: Point -> String #

showList :: [Point] -> ShowS #

Eq Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: Point -> Point -> Ordering #

(<) :: Point -> Point -> Bool #

(<=) :: Point -> Point -> Bool #

(>) :: Point -> Point -> Bool #

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

max :: Point -> Point -> Point #

min :: Point -> Point -> Point #

type Rep Point 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep Point = D1 ('MetaData "Point" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "Point" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

point :: ByteString -> Maybe Point Source #

Construct a Point from a 33-byte ByteString.

Returns Nothing if the input is not exactly 33 bytes.

unPoint :: Point -> ByteString Source #

Extract the raw bytes from a Point.

newtype PaymentHash Source #

A 32-byte SHA256 payment hash.

Constructors

PaymentHash ByteString 

Instances

Instances details
NFData PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: PaymentHash -> () #

Generic PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep PaymentHash = D1 ('MetaData "PaymentHash" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "PaymentHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: PaymentHash -> Rep PaymentHash x #

to :: Rep PaymentHash x -> PaymentHash #

Show PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> PaymentHash -> ShowS #

show :: PaymentHash -> String #

showList :: [PaymentHash] -> ShowS #

Eq PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: PaymentHash -> PaymentHash -> Ordering #

(<) :: PaymentHash -> PaymentHash -> Bool #

(<=) :: PaymentHash -> PaymentHash -> Bool #

(>) :: PaymentHash -> PaymentHash -> Bool #

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

max :: PaymentHash -> PaymentHash -> PaymentHash #

min :: PaymentHash -> PaymentHash -> PaymentHash #

type Rep PaymentHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep PaymentHash = D1 ('MetaData "PaymentHash" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "PaymentHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

paymentHash :: ByteString -> Maybe PaymentHash Source #

Construct a PaymentHash from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

unPaymentHash :: PaymentHash -> ByteString Source #

Extract the raw bytes from a PaymentHash.

newtype PaymentPreimage Source #

A 32-byte payment preimage.

Constructors

PaymentPreimage ByteString 

Instances

Instances details
NFData PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: PaymentPreimage -> () #

Generic PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep PaymentPreimage = D1 ('MetaData "PaymentPreimage" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "PaymentPreimage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: PaymentPreimage -> Rep PaymentPreimage x #

to :: Rep PaymentPreimage x -> PaymentPreimage #

Show PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> PaymentPreimage -> ShowS #

show :: PaymentPreimage -> String #

showList :: [PaymentPreimage] -> ShowS #

Eq PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: PaymentPreimage -> PaymentPreimage -> Ordering #

(<) :: PaymentPreimage -> PaymentPreimage -> Bool #

(<=) :: PaymentPreimage -> PaymentPreimage -> Bool #

(>) :: PaymentPreimage -> PaymentPreimage -> Bool #

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

max :: PaymentPreimage -> PaymentPreimage -> PaymentPreimage #

min :: PaymentPreimage -> PaymentPreimage -> PaymentPreimage #

type Rep PaymentPreimage 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep PaymentPreimage = D1 ('MetaData "PaymentPreimage" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "PaymentPreimage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

paymentPreimage :: ByteString -> Maybe PaymentPreimage Source #

Construct a PaymentPreimage from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

unPaymentPreimage :: PaymentPreimage -> ByteString Source #

Extract the raw bytes from a PaymentPreimage.

newtype PerCommitmentSecret Source #

A 32-byte per-commitment secret.

Constructors

PerCommitmentSecret ByteString 

Instances

Instances details
NFData PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: PerCommitmentSecret -> () #

Generic PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep PerCommitmentSecret = D1 ('MetaData "PerCommitmentSecret" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "PerCommitmentSecret" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: PerCommitmentSecret -> Rep PerCommitmentSecret x #

to :: Rep PerCommitmentSecret x -> PerCommitmentSecret #

Show PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> PerCommitmentSecret -> ShowS #

show :: PerCommitmentSecret -> String #

showList :: [PerCommitmentSecret] -> ShowS #

Eq PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: PerCommitmentSecret -> PerCommitmentSecret -> Ordering #

(<) :: PerCommitmentSecret -> PerCommitmentSecret -> Bool #

(<=) :: PerCommitmentSecret -> PerCommitmentSecret -> Bool #

(>) :: PerCommitmentSecret -> PerCommitmentSecret -> Bool #

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

max :: PerCommitmentSecret -> PerCommitmentSecret -> PerCommitmentSecret #

min :: PerCommitmentSecret -> PerCommitmentSecret -> PerCommitmentSecret #

type Rep PerCommitmentSecret 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep PerCommitmentSecret = D1 ('MetaData "PerCommitmentSecret" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "PerCommitmentSecret" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

perCommitmentSecret :: ByteString -> Maybe PerCommitmentSecret Source #

Construct a PerCommitmentSecret from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

unPerCommitmentSecret :: PerCommitmentSecret -> ByteString Source #

Extract the raw bytes from a PerCommitmentSecret.

Chain types (re-exported from BOLT1)

newtype ChainHash Source #

A chain hash (32-byte hash identifying a blockchain).

Constructors

ChainHash ByteString 

Instances

Instances details
NFData ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: ChainHash -> () #

Generic ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep ChainHash = D1 ('MetaData "ChainHash" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "ChainHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: ChainHash -> Rep ChainHash x #

to :: Rep ChainHash x -> ChainHash #

Show ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> ChainHash -> ShowS #

show :: ChainHash -> String #

showList :: [ChainHash] -> ShowS #

Eq ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: ChainHash -> ChainHash -> Ordering #

(<) :: ChainHash -> ChainHash -> Bool #

(<=) :: ChainHash -> ChainHash -> Bool #

(>) :: ChainHash -> ChainHash -> Bool #

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

max :: ChainHash -> ChainHash -> ChainHash #

min :: ChainHash -> ChainHash -> ChainHash #

type Rep ChainHash 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep ChainHash = D1 ('MetaData "ChainHash" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "ChainHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

chainHash :: ByteString -> Maybe ChainHash Source #

Construct a chain hash from a 32-byte bytestring.

Returns Nothing if the input is not exactly 32 bytes.

unChainHash :: ChainHash -> ByteString Source #

Extract the raw bytes from a chain hash.

newtype ShortChannelId Source #

A short channel identifier (8 bytes packed as Word64).

Encodes block height (3 bytes), transaction index (3 bytes), and output index (2 bytes).

Constructors

ShortChannelId Word64 

Instances

Instances details
NFData ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

rnf :: ShortChannelId -> () #

Generic ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Associated Types

type Rep ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep ShortChannelId = D1 ('MetaData "ShortChannelId" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "ShortChannelId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: ShortChannelId -> Rep ShortChannelId x #

to :: Rep ShortChannelId x -> ShortChannelId #

Show ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

showsPrec :: Int -> ShortChannelId -> ShowS #

show :: ShortChannelId -> String #

showList :: [ShortChannelId] -> ShowS #

Eq ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

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

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

Ord ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

Methods

compare :: ShortChannelId -> ShortChannelId -> Ordering #

(<) :: ShortChannelId -> ShortChannelId -> Bool #

(<=) :: ShortChannelId -> ShortChannelId -> Bool #

(>) :: ShortChannelId -> ShortChannelId -> Bool #

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

max :: ShortChannelId -> ShortChannelId -> ShortChannelId #

min :: ShortChannelId -> ShortChannelId -> ShortChannelId #

type Rep ShortChannelId 
Instance details

Defined in Lightning.Protocol.BOLT1.Prim

type Rep ShortChannelId = D1 ('MetaData "ShortChannelId" "Lightning.Protocol.BOLT1.Prim" "ppad-bolt1-0.0.1-GZKMoPKBmjXD9cKQTWAWgW" 'True) (C1 ('MetaCons "ShortChannelId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

shortChannelId Source #

Arguments

:: Word32

Block height (24 bits max)

-> Word32

Transaction index (24 bits max)

-> Word16

Output index

-> Maybe ShortChannelId 

Construct a ShortChannelId from components.

Returns Nothing if block height or tx index exceed 24 bits.

scidBlockHeight :: ShortChannelId -> Word32 Source #

Extract the block height from a ShortChannelId.

scidTxIndex :: ShortChannelId -> Word32 Source #

Extract the transaction index from a ShortChannelId.

scidOutputIndex :: ShortChannelId -> Word16 Source #

Extract the output index from a ShortChannelId.

Transaction types

newtype TxId Source #

Transaction ID (32 bytes, little-endian double-SHA256).

Constructors

TxId ByteString 

Instances

Instances details
NFData TxId 
Instance details

Defined in Bitcoin.Prim.Tx

Methods

rnf :: TxId -> () #

Generic TxId 
Instance details

Defined in Bitcoin.Prim.Tx

Associated Types

type Rep TxId 
Instance details

Defined in Bitcoin.Prim.Tx

type Rep TxId = D1 ('MetaData "TxId" "Bitcoin.Prim.Tx" "ppad-tx-0.1.0-IT48EoatyO26YFokfriqJ" 'True) (C1 ('MetaCons "TxId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: TxId -> Rep TxId x #

to :: Rep TxId x -> TxId #

Show TxId 
Instance details

Defined in Bitcoin.Prim.Tx

Methods

showsPrec :: Int -> TxId -> ShowS #

show :: TxId -> String #

showList :: [TxId] -> ShowS #

Eq TxId 
Instance details

Defined in Bitcoin.Prim.Tx

Methods

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

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

type Rep TxId 
Instance details

Defined in Bitcoin.Prim.Tx

type Rep TxId = D1 ('MetaData "TxId" "Bitcoin.Prim.Tx" "ppad-tx-0.1.0-IT48EoatyO26YFokfriqJ" 'True) (C1 ('MetaCons "TxId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

mkTxId :: ByteString -> Maybe TxId Source #

Construct a TxId from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

  mkTxId (BS.replicate 32 0x00) == Just (TxId ...)
  mkTxId (BS.replicate 31 0x00) == Nothing

data OutPoint Source #

Transaction outpoint (txid + output index).

Constructors

OutPoint 

Fields

Instances

Instances details
NFData OutPoint 
Instance details

Defined in Bitcoin.Prim.Tx

Methods

rnf :: OutPoint -> () #

Generic OutPoint 
Instance details

Defined in Bitcoin.Prim.Tx

Associated Types

type Rep OutPoint 
Instance details

Defined in Bitcoin.Prim.Tx

type Rep OutPoint = D1 ('MetaData "OutPoint" "Bitcoin.Prim.Tx" "ppad-tx-0.1.0-IT48EoatyO26YFokfriqJ" 'False) (C1 ('MetaCons "OutPoint" 'PrefixI 'True) (S1 ('MetaSel ('Just "op_txid") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 TxId) :*: S1 ('MetaSel ('Just "op_vout") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Word32)))

Methods

from :: OutPoint -> Rep OutPoint x #

to :: Rep OutPoint x -> OutPoint #

Show OutPoint 
Instance details

Defined in Bitcoin.Prim.Tx

Methods

showsPrec :: Int -> OutPoint -> ShowS #

show :: OutPoint -> String #

showList :: [OutPoint] -> ShowS #

Eq OutPoint 
Instance details

Defined in Bitcoin.Prim.Tx

Methods

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

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

type Rep OutPoint 
Instance details

Defined in Bitcoin.Prim.Tx

type Rep OutPoint = D1 ('MetaData "OutPoint" "Bitcoin.Prim.Tx" "ppad-tx-0.1.0-IT48EoatyO26YFokfriqJ" 'False) (C1 ('MetaCons "OutPoint" 'PrefixI 'True) (S1 ('MetaSel ('Just "op_txid") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 TxId) :*: S1 ('MetaSel ('Just "op_vout") 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Word32)))

data ScriptPubKey Source #

A script pubkey (output script).

Instances

Instances details
NFData ScriptPubKey Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

rnf :: ScriptPubKey -> () #

Generic ScriptPubKey Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Associated Types

type Rep ScriptPubKey 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

type Rep ScriptPubKey = D1 ('MetaData "ScriptPubKey" "Lightning.Protocol.BOLT2.Types" "ppad-bolt2-0.0.1-GI0K1t7dKAW7RblYmOAXen" 'True) (C1 ('MetaCons "ScriptPubKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: ScriptPubKey -> Rep ScriptPubKey x #

to :: Rep ScriptPubKey x -> ScriptPubKey #

Show ScriptPubKey Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

showsPrec :: Int -> ScriptPubKey -> ShowS #

show :: ScriptPubKey -> String #

showList :: [ScriptPubKey] -> ShowS #

Eq ScriptPubKey Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

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

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

Ord ScriptPubKey Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

compare :: ScriptPubKey -> ScriptPubKey -> Ordering #

(<) :: ScriptPubKey -> ScriptPubKey -> Bool #

(<=) :: ScriptPubKey -> ScriptPubKey -> Bool #

(>) :: ScriptPubKey -> ScriptPubKey -> Bool #

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

max :: ScriptPubKey -> ScriptPubKey -> ScriptPubKey #

min :: ScriptPubKey -> ScriptPubKey -> ScriptPubKey #

type Rep ScriptPubKey Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

type Rep ScriptPubKey = D1 ('MetaData "ScriptPubKey" "Lightning.Protocol.BOLT2.Types" "ppad-bolt2-0.0.1-GI0K1t7dKAW7RblYmOAXen" 'True) (C1 ('MetaCons "ScriptPubKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

scriptPubKey :: ByteString -> ScriptPubKey Source #

Construct a ScriptPubKey from a ByteString.

unScriptPubKey :: ScriptPubKey -> ByteString Source #

Extract the underlying ByteString from a ScriptPubKey.

Protocol types

data FeatureBits Source #

Feature bits (variable length).

Instances

Instances details
NFData FeatureBits Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

rnf :: FeatureBits -> () #

Generic FeatureBits Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Associated Types

type Rep FeatureBits 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

type Rep FeatureBits = D1 ('MetaData "FeatureBits" "Lightning.Protocol.BOLT2.Types" "ppad-bolt2-0.0.1-GI0K1t7dKAW7RblYmOAXen" 'True) (C1 ('MetaCons "FeatureBits" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: FeatureBits -> Rep FeatureBits x #

to :: Rep FeatureBits x -> FeatureBits #

Show FeatureBits Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

showsPrec :: Int -> FeatureBits -> ShowS #

show :: FeatureBits -> String #

showList :: [FeatureBits] -> ShowS #

Eq FeatureBits Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

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

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

Ord FeatureBits Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

compare :: FeatureBits -> FeatureBits -> Ordering #

(<) :: FeatureBits -> FeatureBits -> Bool #

(<=) :: FeatureBits -> FeatureBits -> Bool #

(>) :: FeatureBits -> FeatureBits -> Bool #

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

max :: FeatureBits -> FeatureBits -> FeatureBits #

min :: FeatureBits -> FeatureBits -> FeatureBits #

type Rep FeatureBits Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

type Rep FeatureBits = D1 ('MetaData "FeatureBits" "Lightning.Protocol.BOLT2.Types" "ppad-bolt2-0.0.1-GI0K1t7dKAW7RblYmOAXen" 'True) (C1 ('MetaCons "FeatureBits" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

featureBits :: ByteString -> FeatureBits Source #

Construct FeatureBits from a ByteString.

unFeatureBits :: FeatureBits -> ByteString Source #

Extract the underlying ByteString from FeatureBits.

data OnionPacket Source #

A 1366-byte onion routing packet.

Instances

Instances details
NFData OnionPacket Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

rnf :: OnionPacket -> () #

Generic OnionPacket Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Associated Types

type Rep OnionPacket 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

type Rep OnionPacket = D1 ('MetaData "OnionPacket" "Lightning.Protocol.BOLT2.Types" "ppad-bolt2-0.0.1-GI0K1t7dKAW7RblYmOAXen" 'True) (C1 ('MetaCons "OnionPacket" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: OnionPacket -> Rep OnionPacket x #

to :: Rep OnionPacket x -> OnionPacket #

Show OnionPacket Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

showsPrec :: Int -> OnionPacket -> ShowS #

show :: OnionPacket -> String #

showList :: [OnionPacket] -> ShowS #

Eq OnionPacket Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

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

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

Ord OnionPacket Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

Methods

compare :: OnionPacket -> OnionPacket -> Ordering #

(<) :: OnionPacket -> OnionPacket -> Bool #

(<=) :: OnionPacket -> OnionPacket -> Bool #

(>) :: OnionPacket -> OnionPacket -> Bool #

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

max :: OnionPacket -> OnionPacket -> OnionPacket #

min :: OnionPacket -> OnionPacket -> OnionPacket #

type Rep OnionPacket Source # 
Instance details

Defined in Lightning.Protocol.BOLT2.Types

type Rep OnionPacket = D1 ('MetaData "OnionPacket" "Lightning.Protocol.BOLT2.Types" "ppad-bolt2-0.0.1-GI0K1t7dKAW7RblYmOAXen" 'True) (C1 ('MetaCons "OnionPacket" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

onionPacket :: ByteString -> Maybe OnionPacket Source #

Construct an OnionPacket from a 1366-byte ByteString.

Returns Nothing if the input is not exactly 1366 bytes.

unOnionPacket :: OnionPacket -> ByteString Source #

Extract the underlying ByteString from an OnionPacket.

Constants

channelIdLen :: Int Source #

Length of a channel_id in bytes (32).

signatureLen :: Int Source #

Length of a signature in bytes (64, compact format).

pointLen :: Int Source #

Length of a compressed secp256k1 public key in bytes (33).

chainHashLen :: Int Source #

Length of a chain hash in bytes (32).

shortChannelIdLen :: Int Source #

Length of a short_channel_id in bytes (8).

paymentHashLen :: Int Source #

Length of a payment hash in bytes (32).

paymentPreimageLen :: Int Source #

Length of a payment preimage in bytes (32).

onionPacketLen :: Int Source #

Length of an onion routing packet in bytes (1366).

perCommitmentSecretLen :: Int Source #

Length of a per-commitment secret in bytes (32).