Haskoin.Network.Message

Peer-to-peer network message serialization.

Network Message

data Message

The Message type is used to identify all the valid messages that can be sent between bitcoin peers. Only values of type Message will be accepted by other bitcoin peers as bitcoin protocol messages need to be correctly serialized with message headers. Serializing a Message value will include the MessageHeader with the correct checksum value automatically. No need to add the MessageHeader separately.

Constructors

MVersion !Version

MVerAck

MAddr !Addr

MInv !Inv

MGetData !GetData

MNotFound !NotFound

MGetBlocks !GetBlocks

MGetHeaders !GetHeaders

MTx !Tx

MBlock !Block

MMerkleBlock !MerkleBlock

MHeaders !Headers

MGetAddr

MFilterLoad !FilterLoad

MFilterAdd !FilterAdd

MFilterClear

MPing !Ping

MPong !Pong

MAlert !Alert

MMempool

MReject !Reject

MSendHeaders

MOther !ByteString !ByteString

Instances

Eq Message

Defined in Haskoin.Network.Message

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Show Message

Defined in Haskoin.Network.Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Generic Message

Defined in Haskoin.Network.Message

Associated Types

type Rep Message :: Type -> Type

Methods

from :: Message -> Rep Message x

to :: Rep Message x -> Message

NFData Message

Defined in Haskoin.Network.Message

Methods

rnf :: Message -> ()

type Rep Message

Defined in Haskoin.Network.Message

type Rep Message = D1 ('MetaData "Message" "Haskoin.Network.Message" "haskoin-core-0.21.1-inplace" 'False) ((((C1 ('MetaCons "MVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Version)) :+: C1 ('MetaCons "MVerAck" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MAddr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Addr)) :+: (C1 ('MetaCons "MInv" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Inv)) :+: C1 ('MetaCons "MGetData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GetData))))) :+: ((C1 ('MetaCons "MNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NotFound)) :+: (C1 ('MetaCons "MGetBlocks" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GetBlocks)) :+: C1 ('MetaCons "MGetHeaders" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GetHeaders)))) :+: (C1 ('MetaCons "MTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Tx)) :+: (C1 ('MetaCons "MBlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Block)) :+: C1 ('MetaCons "MMerkleBlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MerkleBlock)))))) :+: (((C1 ('MetaCons "MHeaders" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Headers)) :+: (C1 ('MetaCons "MGetAddr" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MFilterLoad" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilterLoad)))) :+: (C1 ('MetaCons "MFilterAdd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilterAdd)) :+: (C1 ('MetaCons "MFilterClear" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MPing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Ping))))) :+: ((C1 ('MetaCons "MPong" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pong)) :+: (C1 ('MetaCons "MAlert" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Alert)) :+: C1 ('MetaCons "MMempool" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "MReject" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Reject)) :+: (C1 ('MetaCons "MSendHeaders" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MOther" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)))))))

data MessageHeader

Data type representing the header of a Message. All messages sent between nodes contain a message header.

Constructors

MessageHeader

Fields

• headMagic :: !Word32

  magic bytes identify network

• headCmd :: !MessageCommand

  message type

• headPayloadSize :: !Word32

  length of payload

• headChecksum :: !CheckSum32

  checksum of payload

Instances

Eq MessageHeader

Defined in Haskoin.Network.Message

Methods

(==) :: MessageHeader -> MessageHeader -> Bool

(/=) :: MessageHeader -> MessageHeader -> Bool

Show MessageHeader

Defined in Haskoin.Network.Message

Methods

showsPrec :: Int -> MessageHeader -> ShowS

show :: MessageHeader -> String

showList :: [MessageHeader] -> ShowS

Generic MessageHeader

Defined in Haskoin.Network.Message

Associated Types

type Rep MessageHeader :: Type -> Type

Methods

from :: MessageHeader -> Rep MessageHeader x

to :: Rep MessageHeader x -> MessageHeader

Binary MessageHeader

Defined in Haskoin.Network.Message

Methods

put :: MessageHeader -> Put

get :: Get MessageHeader

putList :: [MessageHeader] -> Put

Serial MessageHeader

Defined in Haskoin.Network.Message

Methods

serialize :: MonadPut m => MessageHeader -> m ()

deserialize :: MonadGet m => m MessageHeader

Serialize MessageHeader

Defined in Haskoin.Network.Message

Methods

put :: Putter MessageHeader

get :: Get MessageHeader

NFData MessageHeader

Defined in Haskoin.Network.Message

Methods

rnf :: MessageHeader -> ()

type Rep MessageHeader

Defined in Haskoin.Network.Message

type Rep MessageHeader = D1 ('MetaData "MessageHeader" "Haskoin.Network.Message" "haskoin-core-0.21.1-inplace" 'False) (C1 ('MetaCons "MessageHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headMagic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "headCmd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MessageCommand)) :*: (S1 ('MetaSel ('Just "headPayloadSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "headChecksum") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CheckSum32))))

msgType :: Message -> MessageCommand

Get MessageCommand assocated with a message.

putMessage :: MonadPut m => Network -> Message -> m ()

Serializer for network messages.

getMessage :: MonadGet m => Network -> m Message

Deserializer for network messages.