Haskoin.Node

Integrates peers, manager, and block header synchronization processes.

Messages from peers that aren't consumed by the peer manager or chain are forwarded to the listen action provided in the node configuration.

Documentation

type Host = String

Type alias for a hostname.

type Port = Int

Type alias for a port number.

type HostPort = (Host, Port)

Type alias for a combination of hostname and port.

type Peer = Mailbox PeerMessage

Mailbox for a peer.

type Chain = Mailbox ChainMessage

Mailbox for chain header syncing process.

type Manager = Mailbox ManagerMessage

Mailbox for peer manager process.

data ChainMessage

Messages that can be sent to the chain process.

data ManagerMessage

Messages that can be sent to the peer manager.

data OnlinePeer

Data structure representing an online peer.

Constructors

OnlinePeer

Fields

• onlinePeerAddress :: !SockAddr

  network address

• onlinePeerVerAck :: !Bool

  got version acknowledgement from peer

• onlinePeerConnected :: !Bool

  peer is connected and ready

• onlinePeerVersion :: !(Maybe Version)

  protocol version

• onlinePeerAsync :: !(Async ())

  peer asynchronous process

• onlinePeerMailbox :: !Peer

  peer mailbox

• onlinePeerNonce :: !Word64

  random nonce sent during handshake

• onlinePeerPing :: !(Maybe (UTCTime, Word64))

  last sent ping time and nonce

• onlinePeerPings :: ![NominalDiffTime]

  last few ping rountrip duration

Instances

Eq OnlinePeer

Defined in Network.Haskoin.Node.Common

Methods

(==) :: OnlinePeer -> OnlinePeer -> Bool

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

Ord OnlinePeer

Defined in Network.Haskoin.Node.Common

Methods

compare :: OnlinePeer -> OnlinePeer -> Ordering

(<) :: OnlinePeer -> OnlinePeer -> Bool

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

(>) :: OnlinePeer -> OnlinePeer -> Bool

(>=) :: OnlinePeer -> OnlinePeer -> Bool

max :: OnlinePeer -> OnlinePeer -> OnlinePeer

min :: OnlinePeer -> OnlinePeer -> OnlinePeer

data NodeConfig

General node configuration.

Constructors

NodeConfig

Fields

• nodeConfMaxPeers :: !Int

  maximum number of connected peers allowed

• nodeConfDB :: !DB

  database handler

• nodeConfPeers :: ![HostPort]

  static list of peers to connect to

• nodeConfDiscover :: !Bool

  activate peer discovery

• nodeConfNetAddr :: !NetworkAddress

  network address for the local host

• nodeConfNet :: !Network

  network constants

• nodeConfEvents :: !(Listen NodeEvent)

  node events are sent to this publisher

• nodeConfTimeout :: !Int

  timeout in seconds

data NodeEvent

Chain and peer events generated by the node.

Constructors

ChainEvent !ChainEvent

events from the chain syncing process

PeerEvent !PeerEvent

events from peers and peer manager

Instances

Eq NodeEvent

Defined in Network.Haskoin.Node.Common

Methods

(==) :: NodeEvent -> NodeEvent -> Bool

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

data ChainEvent

Events originating from chain syncing process.

Constructors

ChainBestBlock !BlockNode

chain has new best block

ChainSynced !BlockNode

chain is in sync with the network

Instances

Eq ChainEvent

Defined in Network.Haskoin.Node.Common

Methods

(==) :: ChainEvent -> ChainEvent -> Bool

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

Show ChainEvent

Defined in Network.Haskoin.Node.Common

Methods

showsPrec :: Int -> ChainEvent -> ShowS

show :: ChainEvent -> String

showList :: [ChainEvent] -> ShowS

data PeerEvent

Events originating from peers and the peer manager.

Constructors

PeerConnected !Peer !SockAddr

new peer connected

PeerDisconnected !Peer !SockAddr

peer disconnected

PeerMessage !Peer !Message

peer sent a message

Instances

Eq PeerEvent

Defined in Network.Haskoin.Node.Common

Methods

(==) :: PeerEvent -> PeerEvent -> Bool

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

data PeerException

Reasons why a peer may stop working.

Constructors

PeerMisbehaving !String

peer is being a naughty boy

DuplicateVersion

peer sent an extra version message

DecodeHeaderError

incoming message headers could not be decoded

CannotDecodePayload

incoming message payload could not be decoded

PeerIsMyself

nonce for peer matches ours

PayloadTooLarge !Word32

message payload too large

PeerAddressInvalid

peer address not valid

PeerSentBadHeaders

peer sent wrong headers

NotNetworkPeer

peer cannot serve block chain data

PeerNoSegWit

peer has no segwit support

PeerTimeout

request to peer timed out

PurgingPeer

peers are being purged

UnknownPeer

peer is unknown

Instances

Eq PeerException

Defined in Network.Haskoin.Node.Common

Methods

(==) :: PeerException -> PeerException -> Bool

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

Show PeerException

Defined in Network.Haskoin.Node.Common

Methods

showsPrec :: Int -> PeerException -> ShowS

show :: PeerException -> String

showList :: [PeerException] -> ShowS

Exception PeerException

Defined in Network.Haskoin.Node.Common

Methods

toException :: PeerException -> SomeException

fromException :: SomeException -> Maybe PeerException

displayException :: PeerException -> String

withNode :: (MonadLoggerIO m, MonadUnliftIO m) => NodeConfig -> ((Manager, Chain) -> m a) -> m a

Launch a node in the background. Pass a Manager and Chain to a function. Node will stop once the function ends.

node :: (MonadLoggerIO m, MonadUnliftIO m) => NodeConfig -> Inbox ManagerMessage -> Inbox ChainMessage -> m ()

Launch node process in the foreground.

managerGetPeers :: MonadIO m => Manager -> m [OnlinePeer]

Get list of connected peers from manager.

managerGetPeer :: MonadIO m => Peer -> Manager -> m (Maybe OnlinePeer)

Get information for an online peer from manager.

killPeer :: MonadIO m => PeerException -> Peer -> m ()

Kill a peer with the provided exception.

sendMessage :: MonadIO m => Message -> Peer -> m ()

Send a network message to peer.

peerGetPublisher :: MonadUnliftIO m => Int -> Peer -> m (Maybe (Publisher Message))

Get a publisher associated to a peer. Must provide timeout as peer may disconnect and become unresponsive.

peerGetBlocks :: MonadUnliftIO m => Network -> Int -> Peer -> [BlockHash] -> m (Maybe [Block])

Request full blocks from peer. Will return Nothing if the list of blocks returned by the peer is incomplete, comes out of order, or a timeout is reached.

peerGetTxs :: MonadUnliftIO m => Network -> Int -> Peer -> [TxHash] -> m (Maybe [Tx])

Request transactions from peer. Will return Nothing if the list of transactions returned by the peer is incomplete, comes out of order, or a timeout is reached.

chainGetBlock :: MonadIO m => BlockHash -> Chain -> m (Maybe BlockNode)

Get a block header from Chain process.

chainGetBest :: MonadIO m => Chain -> m BlockNode

Get best block header from chain process.

chainGetAncestor :: MonadIO m => BlockHeight -> BlockNode -> Chain -> m (Maybe BlockNode)

Get ancestor of BlockNode at BlockHeight from chain process.

chainGetParents :: MonadIO m => BlockHeight -> BlockNode -> Chain -> m [BlockNode]

Get parents of BlockNode starting at BlockHeight from chain process.

chainGetSplitBlock :: MonadIO m => BlockNode -> BlockNode -> Chain -> m BlockNode

Get last common block from chain process.

chainBlockMain :: MonadIO m => BlockHash -> Chain -> m Bool

Is given BlockHash in the main chain?

chainIsSynced :: MonadIO m => Chain -> m Bool

Is chain in sync with network?

myVersion :: Word32

Our protocol version.