Haskoin.Network.Common

Common functions and data types related to peer-to-peer network.

Network Data Types

newtype Addr

Provides information about known nodes in the bitcoin network. An Addr type is sent inside a Message as a response to a GetAddr message.

Constructors

Addr

Fields

• addrList :: [NetworkAddressTime]

Instances

Eq Addr

Defined in Haskoin.Network.Common

Methods

(==) :: Addr -> Addr -> Bool

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

Show Addr

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Addr -> ShowS

show :: Addr -> String

showList :: [Addr] -> ShowS

Generic Addr

Defined in Haskoin.Network.Common

Associated Types

type Rep Addr :: Type -> Type

Methods

from :: Addr -> Rep Addr x

to :: Rep Addr x -> Addr

Binary Addr

Defined in Haskoin.Network.Common

Methods

put :: Addr -> Put

get :: Get Addr

putList :: [Addr] -> Put

Serial Addr

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Addr

Serialize Addr

Defined in Haskoin.Network.Common

Methods

put :: Putter Addr

get :: Get Addr

NFData Addr

Defined in Haskoin.Network.Common

Methods

rnf :: Addr -> ()

type Rep Addr

Defined in Haskoin.Network.Common

type Rep Addr = D1 ('MetaData "Addr" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "Addr" 'PrefixI 'True) (S1 ('MetaSel ('Just "addrList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [NetworkAddressTime])))

type NetworkAddressTime = (Word32, NetworkAddress)

Network address with a timestamp.

data Alert

Data type describing signed messages that can be sent between bitcoin nodes to display important notifications to end users about the health of the network.

Constructors

Alert

Fields

• alertPayload :: !VarString

  Alert payload.

• alertSignature :: !VarString

  ECDSA signature of the payload

Instances

Eq Alert

Defined in Haskoin.Network.Common

Methods

(==) :: Alert -> Alert -> Bool

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

Read Alert

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS Alert

readList :: ReadS [Alert]

readPrec :: ReadPrec Alert

readListPrec :: ReadPrec [Alert]

Show Alert

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Alert -> ShowS

show :: Alert -> String

showList :: [Alert] -> ShowS

Generic Alert

Defined in Haskoin.Network.Common

Associated Types

type Rep Alert :: Type -> Type

Methods

from :: Alert -> Rep Alert x

to :: Rep Alert x -> Alert

Binary Alert

Defined in Haskoin.Network.Common

Methods

put :: Alert -> Put

get :: Get Alert

putList :: [Alert] -> Put

Serial Alert

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Alert

Serialize Alert

Defined in Haskoin.Network.Common

Methods

put :: Putter Alert

get :: Get Alert

NFData Alert

Defined in Haskoin.Network.Common

Methods

rnf :: Alert -> ()

type Rep Alert

Defined in Haskoin.Network.Common

type Rep Alert = D1 ('MetaData "Alert" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (C1 ('MetaCons "Alert" 'PrefixI 'True) (S1 ('MetaSel ('Just "alertPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VarString) :*: S1 ('MetaSel ('Just "alertSignature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VarString)))

newtype GetData

The GetData type is used to retrieve information on a specific object (Block or Tx) identified by the objects hash. The payload of a GetData request is a list of InvVector which represent all the hashes of objects that a node wants. The response to a GetBlock message will be either a Block or a Tx message depending on the type of the object referenced by the hash. Usually, GetData messages are sent after a node receives an Inv message that contains unknown object hashes.

Constructors

GetData

Fields

• getDataList :: [InvVector]

  list of object hashes

Instances

Eq GetData

Defined in Haskoin.Network.Common

Methods

(==) :: GetData -> GetData -> Bool

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

Show GetData

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> GetData -> ShowS

show :: GetData -> String

showList :: [GetData] -> ShowS

Generic GetData

Defined in Haskoin.Network.Common

Associated Types

type Rep GetData :: Type -> Type

Methods

from :: GetData -> Rep GetData x

to :: Rep GetData x -> GetData

Binary GetData

Defined in Haskoin.Network.Common

Methods

put :: GetData -> Put

get :: Get GetData

putList :: [GetData] -> Put

Serial GetData

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m GetData

Serialize GetData

Defined in Haskoin.Network.Common

Methods

put :: Putter GetData

get :: Get GetData

NFData GetData

Defined in Haskoin.Network.Common

Methods

rnf :: GetData -> ()

type Rep GetData

Defined in Haskoin.Network.Common

type Rep GetData = D1 ('MetaData "GetData" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "GetData" 'PrefixI 'True) (S1 ('MetaSel ('Just "getDataList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InvVector])))

newtype Inv

Inv messages are used by nodes to advertise their knowledge of new objects by publishing a list of hashes to a peer. Inv messages can be sent unsolicited or in response to a GetBlocks message.

Constructors

Inv

Fields

• invList :: [InvVector]

  inventory

Instances

Eq Inv

Defined in Haskoin.Network.Common

Methods

(==) :: Inv -> Inv -> Bool

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

Show Inv

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Inv -> ShowS

show :: Inv -> String

showList :: [Inv] -> ShowS

Generic Inv

Defined in Haskoin.Network.Common

Associated Types

type Rep Inv :: Type -> Type

Methods

from :: Inv -> Rep Inv x

to :: Rep Inv x -> Inv

Binary Inv

Defined in Haskoin.Network.Common

Methods

put :: Inv -> Put

get :: Get Inv

putList :: [Inv] -> Put

Serial Inv

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Inv

Serialize Inv

Defined in Haskoin.Network.Common

Methods

put :: Putter Inv

get :: Get Inv

NFData Inv

Defined in Haskoin.Network.Common

Methods

rnf :: Inv -> ()

type Rep Inv

Defined in Haskoin.Network.Common

type Rep Inv = D1 ('MetaData "Inv" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "Inv" 'PrefixI 'True) (S1 ('MetaSel ('Just "invList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InvVector])))

data InvVector

Invectory vectors represent hashes identifying objects such as a Block or a Tx. They notify other peers about new data or data they have otherwise requested.

Constructors

InvVector

Fields

• invType :: !InvType

  type of object

• invHash :: !Hash256

  256-bit hash of object

Instances

Eq InvVector

Defined in Haskoin.Network.Common

Methods

(==) :: InvVector -> InvVector -> Bool

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

Show InvVector

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> InvVector -> ShowS

show :: InvVector -> String

showList :: [InvVector] -> ShowS

Generic InvVector

Defined in Haskoin.Network.Common

Associated Types

type Rep InvVector :: Type -> Type

Methods

from :: InvVector -> Rep InvVector x

to :: Rep InvVector x -> InvVector

Binary InvVector

Defined in Haskoin.Network.Common

Methods

put :: InvVector -> Put

get :: Get InvVector

putList :: [InvVector] -> Put

Serial InvVector

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m InvVector

Serialize InvVector

Defined in Haskoin.Network.Common

Methods

put :: Putter InvVector

get :: Get InvVector

NFData InvVector

Defined in Haskoin.Network.Common

Methods

rnf :: InvVector -> ()

type Rep InvVector

Defined in Haskoin.Network.Common

type Rep InvVector = D1 ('MetaData "InvVector" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (C1 ('MetaCons "InvVector" 'PrefixI 'True) (S1 ('MetaSel ('Just "invType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 InvType) :*: S1 ('MetaSel ('Just "invHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash256)))

data InvType

Data type identifying the type of an inventory vector. SegWit types are only used in GetData messages, not Inv.

Constructors

InvError

error

InvTx

transaction

InvBlock

block

InvMerkleBlock

filtered block

InvWitnessTx

segwit transaction

InvWitnessBlock

segwit block

InvWitnessMerkleBlock

segwit filtered block

InvType Word32

unknown inv type

Instances

Eq InvType

Defined in Haskoin.Network.Common

Methods

(==) :: InvType -> InvType -> Bool

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

Read InvType

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS InvType

readList :: ReadS [InvType]

readPrec :: ReadPrec InvType

readListPrec :: ReadPrec [InvType]

Show InvType

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> InvType -> ShowS

show :: InvType -> String

showList :: [InvType] -> ShowS

Generic InvType

Defined in Haskoin.Network.Common

Associated Types

type Rep InvType :: Type -> Type

Methods

from :: InvType -> Rep InvType x

to :: Rep InvType x -> InvType

Binary InvType

Defined in Haskoin.Network.Common

Methods

put :: InvType -> Put

get :: Get InvType

putList :: [InvType] -> Put

Serial InvType

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m InvType

Serialize InvType

Defined in Haskoin.Network.Common

Methods

put :: Putter InvType

get :: Get InvType

NFData InvType

Defined in Haskoin.Network.Common

Methods

rnf :: InvType -> ()

type Rep InvType

Defined in Haskoin.Network.Common

type Rep InvType = D1 ('MetaData "InvType" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (((C1 ('MetaCons "InvError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvTx" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "InvBlock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvMerkleBlock" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "InvWitnessTx" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvWitnessBlock" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "InvWitnessMerkleBlock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))))

data HostAddress

Instances

Eq HostAddress

Defined in Haskoin.Network.Common

Methods

(==) :: HostAddress -> HostAddress -> Bool

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

Ord HostAddress

Defined in Haskoin.Network.Common

Methods

compare :: HostAddress -> HostAddress -> Ordering

(<) :: HostAddress -> HostAddress -> Bool

(<=) :: HostAddress -> HostAddress -> Bool

(>) :: HostAddress -> HostAddress -> Bool

(>=) :: HostAddress -> HostAddress -> Bool

max :: HostAddress -> HostAddress -> HostAddress

min :: HostAddress -> HostAddress -> HostAddress

Show HostAddress

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> HostAddress -> ShowS

show :: HostAddress -> String

showList :: [HostAddress] -> ShowS

Generic HostAddress

Defined in Haskoin.Network.Common

Associated Types

type Rep HostAddress :: Type -> Type

Methods

from :: HostAddress -> Rep HostAddress x

to :: Rep HostAddress x -> HostAddress

Binary HostAddress

Defined in Haskoin.Network.Common

Methods

put :: HostAddress -> Put

get :: Get HostAddress

putList :: [HostAddress] -> Put

Serial HostAddress

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m HostAddress

Serialize HostAddress

Defined in Haskoin.Network.Common

Methods

put :: Putter HostAddress

get :: Get HostAddress

NFData HostAddress

Defined in Haskoin.Network.Common

Methods

rnf :: HostAddress -> ()

type Rep HostAddress

Defined in Haskoin.Network.Common

type Rep HostAddress = D1 ('MetaData "HostAddress" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "HostAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

hostToSockAddr :: HostAddress -> SockAddr

sockToHostAddress :: SockAddr -> HostAddress

data NetworkAddress

Data type describing a bitcoin network address. Addresses are stored in IPv6 format. IPv4 addresses are mapped to IPv6 using IPv4 mapped IPv6 addresses: http://en.wikipedia.org/wiki/IPv6#IPv4-mapped_IPv6_addresses.

Constructors

NetworkAddress

Fields

• naServices :: !Word64

  bitmask of services available for this address

• naAddress :: !HostAddress

  address and port information

Instances

Eq NetworkAddress

Defined in Haskoin.Network.Common

Methods

(==) :: NetworkAddress -> NetworkAddress -> Bool

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

Show NetworkAddress

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> NetworkAddress -> ShowS

show :: NetworkAddress -> String

showList :: [NetworkAddress] -> ShowS

Generic NetworkAddress

Defined in Haskoin.Network.Common

Associated Types

type Rep NetworkAddress :: Type -> Type

Methods

from :: NetworkAddress -> Rep NetworkAddress x

to :: Rep NetworkAddress x -> NetworkAddress

Binary NetworkAddress

Defined in Haskoin.Network.Common

Methods

put :: NetworkAddress -> Put

get :: Get NetworkAddress

putList :: [NetworkAddress] -> Put

Serial NetworkAddress

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m NetworkAddress

Serialize NetworkAddress

Defined in Haskoin.Network.Common

Methods

put :: Putter NetworkAddress

get :: Get NetworkAddress

NFData NetworkAddress

Defined in Haskoin.Network.Common

Methods

rnf :: NetworkAddress -> ()

type Rep NetworkAddress

Defined in Haskoin.Network.Common

type Rep NetworkAddress = D1 ('MetaData "NetworkAddress" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (C1 ('MetaCons "NetworkAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "naServices") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "naAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HostAddress)))

newtype NotFound

A NotFound message is returned as a response to a GetData message whe one of the requested objects could not be retrieved. This could happen, for example, if a tranasaction was requested and was not available in the memory pool of the receiving node.

Constructors

NotFound

Fields

• notFoundList :: [InvVector]

  Inventory vectors related to this request

Instances

Eq NotFound

Defined in Haskoin.Network.Common

Methods

(==) :: NotFound -> NotFound -> Bool

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

Show NotFound

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> NotFound -> ShowS

show :: NotFound -> String

showList :: [NotFound] -> ShowS

Generic NotFound

Defined in Haskoin.Network.Common

Associated Types

type Rep NotFound :: Type -> Type

Methods

from :: NotFound -> Rep NotFound x

to :: Rep NotFound x -> NotFound

Binary NotFound

Defined in Haskoin.Network.Common

Methods

put :: NotFound -> Put

get :: Get NotFound

putList :: [NotFound] -> Put

Serial NotFound

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m NotFound

Serialize NotFound

Defined in Haskoin.Network.Common

Methods

put :: Putter NotFound

get :: Get NotFound

NFData NotFound

Defined in Haskoin.Network.Common

Methods

rnf :: NotFound -> ()

type Rep NotFound

Defined in Haskoin.Network.Common

type Rep NotFound = D1 ('MetaData "NotFound" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "NotFound" 'PrefixI 'True) (S1 ('MetaSel ('Just "notFoundList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InvVector])))

newtype Ping

A Ping message is sent to bitcoin peers to check if a connection is still open.

Constructors

Ping

Fields

• pingNonce :: Word64

  A random nonce used to identify the recipient of the ping request once a Pong response is received.

Instances

Eq Ping

Defined in Haskoin.Network.Common

Methods

(==) :: Ping -> Ping -> Bool

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

Read Ping

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS Ping

readList :: ReadS [Ping]

readPrec :: ReadPrec Ping

readListPrec :: ReadPrec [Ping]

Show Ping

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Ping -> ShowS

show :: Ping -> String

showList :: [Ping] -> ShowS

Generic Ping

Defined in Haskoin.Network.Common

Associated Types

type Rep Ping :: Type -> Type

Methods

from :: Ping -> Rep Ping x

to :: Rep Ping x -> Ping

Binary Ping

Defined in Haskoin.Network.Common

Methods

put :: Ping -> Put

get :: Get Ping

putList :: [Ping] -> Put

Serial Ping

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Ping

Serialize Ping

Defined in Haskoin.Network.Common

Methods

put :: Putter Ping

get :: Get Ping

NFData Ping

Defined in Haskoin.Network.Common

Methods

rnf :: Ping -> ()

type Rep Ping

Defined in Haskoin.Network.Common

type Rep Ping = D1 ('MetaData "Ping" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "Ping" 'PrefixI 'True) (S1 ('MetaSel ('Just "pingNonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

newtype Pong

A Pong message is sent as a response to a ping message.

Constructors

Pong

Fields

• pongNonce :: Word64

  nonce from corresponding Ping

Instances

Eq Pong

Defined in Haskoin.Network.Common

Methods

(==) :: Pong -> Pong -> Bool

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

Read Pong

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS Pong

readList :: ReadS [Pong]

readPrec :: ReadPrec Pong

readListPrec :: ReadPrec [Pong]

Show Pong

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Pong -> ShowS

show :: Pong -> String

showList :: [Pong] -> ShowS

Generic Pong

Defined in Haskoin.Network.Common

Associated Types

type Rep Pong :: Type -> Type

Methods

from :: Pong -> Rep Pong x

to :: Rep Pong x -> Pong

Binary Pong

Defined in Haskoin.Network.Common

Methods

put :: Pong -> Put

get :: Get Pong

putList :: [Pong] -> Put

Serial Pong

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Pong

Serialize Pong

Defined in Haskoin.Network.Common

Methods

put :: Putter Pong

get :: Get Pong

NFData Pong

Defined in Haskoin.Network.Common

Methods

rnf :: Pong -> ()

type Rep Pong

Defined in Haskoin.Network.Common

type Rep Pong = D1 ('MetaData "Pong" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "Pong" 'PrefixI 'True) (S1 ('MetaSel ('Just "pongNonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

data Reject

The Reject message is sent when messages are rejected by a peer.

Constructors

Reject

Fields

• rejectMessage :: !MessageCommand

  type of message rejected

• rejectCode :: !RejectCode

  rejection code

• rejectReason :: !VarString

  text reason for rejection

• rejectData :: !ByteString

  extra data such as block or tx hash

Instances

Eq Reject

Defined in Haskoin.Network.Common

Methods

(==) :: Reject -> Reject -> Bool

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

Read Reject

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS Reject

readList :: ReadS [Reject]

readPrec :: ReadPrec Reject

readListPrec :: ReadPrec [Reject]

Show Reject

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Reject -> ShowS

show :: Reject -> String

showList :: [Reject] -> ShowS

Generic Reject

Defined in Haskoin.Network.Common

Associated Types

type Rep Reject :: Type -> Type

Methods

from :: Reject -> Rep Reject x

to :: Rep Reject x -> Reject

Binary Reject

Defined in Haskoin.Network.Common

Methods

put :: Reject -> Put

get :: Get Reject

putList :: [Reject] -> Put

Serial Reject

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Reject

Serialize Reject

Defined in Haskoin.Network.Common

Methods

put :: Putter Reject

get :: Get Reject

NFData Reject

Defined in Haskoin.Network.Common

Methods

rnf :: Reject -> ()

type Rep Reject

Defined in Haskoin.Network.Common

type Rep Reject = D1 ('MetaData "Reject" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (C1 ('MetaCons "Reject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rejectMessage") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MessageCommand) :*: S1 ('MetaSel ('Just "rejectCode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RejectCode)) :*: (S1 ('MetaSel ('Just "rejectReason") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VarString) :*: S1 ('MetaSel ('Just "rejectData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString))))

data RejectCode

Rejection code associated to the Reject message.

Constructors

RejectMalformed

RejectInvalid

RejectObsolete

RejectDuplicate

RejectNonStandard

RejectDust

RejectInsufficientFee

RejectCheckpoint

Instances

Eq RejectCode

Defined in Haskoin.Network.Common

Methods

(==) :: RejectCode -> RejectCode -> Bool

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

Read RejectCode

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS RejectCode

readList :: ReadS [RejectCode]

readPrec :: ReadPrec RejectCode

readListPrec :: ReadPrec [RejectCode]

Show RejectCode

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> RejectCode -> ShowS

show :: RejectCode -> String

showList :: [RejectCode] -> ShowS

Generic RejectCode

Defined in Haskoin.Network.Common

Associated Types

type Rep RejectCode :: Type -> Type

Methods

from :: RejectCode -> Rep RejectCode x

to :: Rep RejectCode x -> RejectCode

Binary RejectCode

Defined in Haskoin.Network.Common

Methods

put :: RejectCode -> Put

get :: Get RejectCode

putList :: [RejectCode] -> Put

Serial RejectCode

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m RejectCode

Serialize RejectCode

Defined in Haskoin.Network.Common

Methods

put :: Putter RejectCode

get :: Get RejectCode

NFData RejectCode

Defined in Haskoin.Network.Common

Methods

rnf :: RejectCode -> ()

type Rep RejectCode

Defined in Haskoin.Network.Common

type Rep RejectCode = D1 ('MetaData "RejectCode" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (((C1 ('MetaCons "RejectMalformed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RejectInvalid" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RejectObsolete" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RejectDuplicate" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "RejectNonStandard" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RejectDust" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RejectInsufficientFee" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RejectCheckpoint" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype VarInt

Data type representing a variable-length integer. The VarInt type usually precedes an array or a string that can vary in length.

Constructors

VarInt

Fields

• getVarInt :: Word64

Instances

Eq VarInt

Defined in Haskoin.Network.Common

Methods

(==) :: VarInt -> VarInt -> Bool

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

Read VarInt

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS VarInt

readList :: ReadS [VarInt]

readPrec :: ReadPrec VarInt

readListPrec :: ReadPrec [VarInt]

Show VarInt

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> VarInt -> ShowS

show :: VarInt -> String

showList :: [VarInt] -> ShowS

Generic VarInt

Defined in Haskoin.Network.Common

Associated Types

type Rep VarInt :: Type -> Type

Methods

from :: VarInt -> Rep VarInt x

to :: Rep VarInt x -> VarInt

Binary VarInt

Defined in Haskoin.Network.Common

Methods

put :: VarInt -> Put

get :: Get VarInt

putList :: [VarInt] -> Put

Serial VarInt

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m VarInt

Serialize VarInt

Defined in Haskoin.Network.Common

Methods

put :: Putter VarInt

get :: Get VarInt

NFData VarInt

Defined in Haskoin.Network.Common

Methods

rnf :: VarInt -> ()

type Rep VarInt

Defined in Haskoin.Network.Common

type Rep VarInt = D1 ('MetaData "VarInt" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "VarInt" 'PrefixI 'True) (S1 ('MetaSel ('Just "getVarInt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

newtype VarString

Data type for serialization of variable-length strings.

Constructors

VarString

Fields

• getVarString :: ByteString

Instances

Eq VarString

Defined in Haskoin.Network.Common

Methods

(==) :: VarString -> VarString -> Bool

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

Read VarString

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS VarString

readList :: ReadS [VarString]

readPrec :: ReadPrec VarString

readListPrec :: ReadPrec [VarString]

Show VarString

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> VarString -> ShowS

show :: VarString -> String

showList :: [VarString] -> ShowS

Generic VarString

Defined in Haskoin.Network.Common

Associated Types

type Rep VarString :: Type -> Type

Methods

from :: VarString -> Rep VarString x

to :: Rep VarString x -> VarString

Binary VarString

Defined in Haskoin.Network.Common

Methods

put :: VarString -> Put

get :: Get VarString

putList :: [VarString] -> Put

Serial VarString

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m VarString

Serialize VarString

Defined in Haskoin.Network.Common

Methods

put :: Putter VarString

get :: Get VarString

NFData VarString

Defined in Haskoin.Network.Common

Methods

rnf :: VarString -> ()

type Rep VarString

Defined in Haskoin.Network.Common

type Rep VarString = D1 ('MetaData "VarString" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'True) (C1 ('MetaCons "VarString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getVarString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data Version

When a bitcoin node creates an outgoing connection to another node, the first message it will send is a Version message. The other node will similarly respond with it's own Version message.

Constructors

Version

Fields

• version :: !Word32

  protocol version

• services :: !Word64

  features supported by this connection

• timestamp :: !Word64

  unix timestamp

• addrRecv :: !NetworkAddress

  network address of remote node

• addrSend :: !NetworkAddress

  network address of sending node

• verNonce :: !Word64

  random nonce to detect connection to self

• userAgent :: !VarString

  user agent string

• startHeight :: !Word32

  height of the last block in sending node

• relay :: !Bool

  relay transactions flag (BIP-37)

Instances

Eq Version

Defined in Haskoin.Network.Common

Methods

(==) :: Version -> Version -> Bool

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

Show Version

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Generic Version

Defined in Haskoin.Network.Common

Associated Types

type Rep Version :: Type -> Type

Methods

from :: Version -> Rep Version x

to :: Rep Version x -> Version

Binary Version

Defined in Haskoin.Network.Common

Methods

put :: Version -> Put

get :: Get Version

putList :: [Version] -> Put

Serial Version

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m Version

Serialize Version

Defined in Haskoin.Network.Common

Methods

put :: Putter Version

get :: Get Version

NFData Version

Defined in Haskoin.Network.Common

Methods

rnf :: Version -> ()

type Rep Version

Defined in Haskoin.Network.Common

type Rep Version = D1 ('MetaData "Version" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) (C1 ('MetaCons "Version" 'PrefixI 'True) (((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "services") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "addrRecv") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NetworkAddress))) :*: ((S1 ('MetaSel ('Just "addrSend") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NetworkAddress) :*: S1 ('MetaSel ('Just "verNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "userAgent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VarString) :*: (S1 ('MetaSel ('Just "startHeight") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "relay") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))))

data MessageCommand

A MessageCommand is included in a MessageHeader in order to identify the type of message present in the payload. This allows the message de-serialization code to know how to decode a particular message payload. Every valid Message constructor has a corresponding MessageCommand constructor.

Constructors

MCVersion

MCVerAck

MCAddr

MCInv

MCGetData

MCNotFound

MCGetBlocks

MCGetHeaders

MCTx

MCBlock

MCMerkleBlock

MCHeaders

MCGetAddr

MCFilterLoad

MCFilterAdd

MCFilterClear

MCPing

MCPong

MCAlert

MCMempool

MCReject

MCSendHeaders

MCOther ByteString

Instances

Eq MessageCommand

Defined in Haskoin.Network.Common

Methods

(==) :: MessageCommand -> MessageCommand -> Bool

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

Read MessageCommand

Defined in Haskoin.Network.Common

Methods

readsPrec :: Int -> ReadS MessageCommand

readList :: ReadS [MessageCommand]

readPrec :: ReadPrec MessageCommand

readListPrec :: ReadPrec [MessageCommand]

Show MessageCommand

Defined in Haskoin.Network.Common

Methods

showsPrec :: Int -> MessageCommand -> ShowS

show :: MessageCommand -> String

showList :: [MessageCommand] -> ShowS

IsString MessageCommand

Defined in Haskoin.Network.Common

Methods

fromString :: String -> MessageCommand

Generic MessageCommand

Defined in Haskoin.Network.Common

Associated Types

type Rep MessageCommand :: Type -> Type

Methods

from :: MessageCommand -> Rep MessageCommand x

to :: Rep MessageCommand x -> MessageCommand

Binary MessageCommand

Defined in Haskoin.Network.Common

Methods

put :: MessageCommand -> Put

get :: Get MessageCommand

putList :: [MessageCommand] -> Put

Serial MessageCommand

Defined in Haskoin.Network.Common

Methods

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

deserialize :: MonadGet m => m MessageCommand

Serialize MessageCommand

Defined in Haskoin.Network.Common

Methods

put :: Putter MessageCommand

get :: Get MessageCommand

NFData MessageCommand

Defined in Haskoin.Network.Common

Methods

rnf :: MessageCommand -> ()

type Rep MessageCommand

Defined in Haskoin.Network.Common

type Rep MessageCommand = D1 ('MetaData "MessageCommand" "Haskoin.Network.Common" "haskoin-core-0.20.5-inplace" 'False) ((((C1 ('MetaCons "MCVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCVerAck" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MCAddr" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCInv" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCGetData" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "MCNotFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCGetBlocks" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCGetHeaders" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "MCTx" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCBlock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCMerkleBlock" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "MCHeaders" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCGetAddr" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCFilterLoad" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "MCFilterAdd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCFilterClear" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCPing" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "MCPong" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCAlert" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCMempool" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "MCReject" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MCSendHeaders" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MCOther" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))))))

reject :: MessageCommand -> RejectCode -> ByteString -> Reject

Convenience function to build a Reject message.

nodeNone :: Word64

Node offers no services.

nodeNetwork :: Word64

Services indicate node is a full node that can serve full blocks.

nodeGetUTXO :: Word64

Services indicate node allows to request UTXO set.

nodeBloom :: Word64

Services indicate node accepts bloom filters.

nodeWitness :: Word64

Services indicate SegWit-capable node.

nodeXThin :: Word64

Services indicate Xtreme Thinblocks compatibility.

commandToString :: MessageCommand -> ByteString

Convert a MessageCommand to its string representation.

stringToCommand :: ByteString -> MessageCommand

Read a MessageCommand from its string representation.

putVarInt :: (MonadPut m, Integral a) => a -> m ()