type Rep EncodeError
Instance details Defined in Lightning.Protocol.BOLT7.Codec type Rep EncodeError = D1 ('MetaData "EncodeError" "Lightning.Protocol.BOLT7.Codec" "ppad-bolt7-0.0.1-9AmpjHUse7iEtxOkiaMheY" 'False) (C1 ('MetaCons "EncodeLengthOverflow" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: EncodeError -> Rep EncodeError x #

to :: Rep EncodeError x -> EncodeError #

Show EncodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

Methods

showsPrec :: Int -> EncodeError -> ShowS #

show :: EncodeError -> String #

showList :: [EncodeError] -> ShowS #

Eq EncodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

Methods

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

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

type Rep EncodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

type Rep EncodeError = D1 ('MetaData "EncodeError" "Lightning.Protocol.BOLT7.Codec" "ppad-bolt7-0.0.1-9AmpjHUse7iEtxOkiaMheY" 'False) (C1 ('MetaCons "EncodeLengthOverflow" 'PrefixI 'False) (U1 :: Type -> Type))

data DecodeError Source #

Decoding errors.

Constructors

DecodeInsufficientBytes	Not enough bytes
DecodeInvalidSignature	Invalid signature field
DecodeInvalidChainHash	Invalid chain hash field
DecodeInvalidShortChannelId	Invalid short channel ID field
DecodeInvalidChannelId	Invalid channel ID field
DecodeInvalidNodeId	Invalid node ID field
DecodeInvalidPoint	Invalid point field
DecodeInvalidRgbColor	Invalid RGB color field
DecodeInvalidAlias	Invalid alias field
DecodeInvalidAddress	Invalid address encoding
DecodeTlvError	TLV decoding error

Instances

Instances details

NFData DecodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

Methods

rnf :: DecodeError -> () #

Generic DecodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

Associated Types

type Rep DecodeError

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

type Rep DecodeError = D1 ('MetaData "DecodeError" "Lightning.Protocol.BOLT7.Codec" "ppad-bolt7-0.0.1-9AmpjHUse7iEtxOkiaMheY" 'False) (((C1 ('MetaCons "DecodeInsufficientBytes" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeInvalidSignature" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DecodeInvalidChainHash" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DecodeInvalidShortChannelId" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeInvalidChannelId" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "DecodeInvalidNodeId" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DecodeInvalidPoint" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeInvalidRgbColor" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "DecodeInvalidAlias" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DecodeInvalidAddress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeTlvError" 'PrefixI 'False) (U1 :: Type -> Type)))))

Methods

from :: DecodeError -> Rep DecodeError x #

to :: Rep DecodeError x -> DecodeError #

Show DecodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

Methods

showsPrec :: Int -> DecodeError -> ShowS #

show :: DecodeError -> String #

showList :: [DecodeError] -> ShowS #

Eq DecodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

Methods

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

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

type Rep DecodeError Source #

Instance details

Defined in Lightning.Protocol.BOLT7.Codec

type Rep DecodeError = D1 ('MetaData "DecodeError" "Lightning.Protocol.BOLT7.Codec" "ppad-bolt7-0.0.1-9AmpjHUse7iEtxOkiaMheY" 'False) (((C1 ('MetaCons "DecodeInsufficientBytes" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeInvalidSignature" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DecodeInvalidChainHash" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DecodeInvalidShortChannelId" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeInvalidChannelId" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "DecodeInvalidNodeId" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DecodeInvalidPoint" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeInvalidRgbColor" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "DecodeInvalidAlias" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DecodeInvalidAddress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecodeTlvError" 'PrefixI 'False) (U1 :: Type -> Type)))))

Channel announcement

encodeChannelAnnouncement :: ChannelAnnouncement -> ByteString Source #

Encode channel_announcement message.

decodeChannelAnnouncement :: ByteString -> Either DecodeError (ChannelAnnouncement, ByteString) Source #

Decode channel_announcement message.

Node announcement

encodeNodeAnnouncement :: NodeAnnouncement -> Either EncodeError ByteString Source #

Encode node_announcement message.

decodeNodeAnnouncement :: ByteString -> Either DecodeError (NodeAnnouncement, ByteString) Source #

Decode node_announcement message.

Channel update

encodeChannelUpdate :: ChannelUpdate -> ByteString Source #

Encode channel_update message.

decodeChannelUpdate :: ByteString -> Either DecodeError (ChannelUpdate, ByteString) Source #

Decode channel_update message.

Announcement signatures

encodeAnnouncementSignatures :: AnnouncementSignatures -> ByteString Source #

Encode announcement_signatures message.

decodeAnnouncementSignatures :: ByteString -> Either DecodeError (AnnouncementSignatures, ByteString) Source #

Decode announcement_signatures message.

Query messages

encodeQueryShortChannelIds :: QueryShortChannelIds -> Either EncodeError ByteString Source #

Encode query_short_channel_ids message.

decodeQueryShortChannelIds :: ByteString -> Either DecodeError (QueryShortChannelIds, ByteString) Source #

Decode query_short_channel_ids message.

encodeReplyShortChannelIdsEnd :: ReplyShortChannelIdsEnd -> ByteString Source #

Encode reply_short_channel_ids_end message.

decodeReplyShortChannelIdsEnd :: ByteString -> Either DecodeError (ReplyShortChannelIdsEnd, ByteString) Source #

Decode reply_short_channel_ids_end message.

encodeQueryChannelRange :: QueryChannelRange -> ByteString Source #

Encode query_channel_range message.

decodeQueryChannelRange :: ByteString -> Either DecodeError (QueryChannelRange, ByteString) Source #

Decode query_channel_range message.

encodeReplyChannelRange :: ReplyChannelRange -> Either EncodeError ByteString Source #

Encode reply_channel_range message.

decodeReplyChannelRange :: ByteString -> Either DecodeError (ReplyChannelRange, ByteString) Source #

Decode reply_channel_range message.

encodeGossipTimestampFilter :: GossipTimestampFilter -> ByteString Source #

Encode gossip_timestamp_filter message.

decodeGossipTimestampFilter :: ByteString -> Either DecodeError (GossipTimestampFilter, ByteString) Source #

Decode gossip_timestamp_filter message.

Short channel ID encoding

encodeShortChannelIdList :: [ShortChannelId] -> ByteString Source #

Encode a list of short channel IDs as concatenated 8-byte values.

This produces encoded_short_ids data with encoding type 0 (uncompressed). The first byte is the encoding type (0), followed by the concatenated SCIDs.

Note: This does NOT sort the SCIDs. The caller should ensure they are in ascending order if that's required by the protocol context.

decodeShortChannelIdList :: ByteString -> Either DecodeError [ShortChannelId] Source #

Decode a list of short channel IDs from encoded_short_ids data.

Supports encoding type 0 (uncompressed). Other encoding types will fail.