Haskoin.Node

Documentation

type Host = String

type Port = Int

type HostPort = (Host, Port)

type Peer = Inbox PeerMessage

Mailbox for a peer process.

type Chain = Inbox ChainMessage

Mailbox for chain headers process.

type Manager = Inbox ManagerMessage

Mailbox for peer manager process.

data OnlinePeer

Data structure representing an online peer.

Constructors

OnlinePeer

Fields

• onlinePeerAddress :: !SockAddr

  network address

• onlinePeerConnected :: !Bool

  has it finished handshake

• onlinePeerVersion :: !Word32

  protocol version

• onlinePeerServices :: !Word64

  services field

• onlinePeerRemoteNonce :: !Word64

  random nonce sent by peer

• onlinePeerUserAgent :: !ByteString

  user agent string

• onlinePeerRelay :: !Bool

  peer will relay transactions (BIP-37)

• onlinePeerBestBlock :: !BlockNode

  estimated best block that peer has

• onlinePeerAsync :: !(Async ())

  peer asynchronous process

• onlinePeerMailbox :: !Peer

  peer mailbox

• onlinePeerNonce :: !Word64

  random nonce sent during handshake

• onlinePeerPings :: ![NominalDiffTime]

  last few ping rountrip duration

data NodeConfig

Node configuration. Mailboxes for manager and chain processes must be created before launching the node. The node will start those processes and receive any messages sent to those mailboxes.

Constructors

NodeConfig

Fields

• maxPeers :: !Int

  maximum number of connected peers allowed

• database :: !DB

  RocksDB database handler

• initPeers :: ![HostPort]

  static list of peers to connect to

• discover :: !Bool

  activate peer discovery

• nodeEvents :: !(Listen NodeEvent)

  listener for events originated by the node

• netAddress :: !NetworkAddress

  network address for the local host

• nodeNet :: !Network

  network constants

data NodeEvent

Event originating from the node. Aggregates events from the peer manager, chain, and any connected peers.

Constructors

ManagerEvent !ManagerEvent

event originating from peer manager

ChainEvent !ChainEvent

event originating from chain process

PeerEvent !(Peer, PeerEvent)

event originating from a peer

data ManagerEvent

Peer manager event.

Constructors

ManagerConnect !Peer

a new peer connected and its handshake completed

ManagerDisconnect !Peer

a peer disconnected

data ChainEvent

Events originating from chain process.

Constructors

ChainNewBest !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 a peer.

Constructors

TxAvail ![TxHash]

peer sent transaction inventory

GotBlock !Block

peer sent a Block

GotMerkleBlock !MerkleBlock

peer sent a MerkleBlock

GotTx !Tx

peer sent a Tx

GotPong !Word64

peer responded to a Ping

SendBlocks !GetBlocks

peer is requesting some blocks

SendHeaders !GetHeaders

peer is requesting some headers

SendData ![InvVector]

per is requesting an inventory

TxNotFound !TxHash

peer could not find transaction

BlockNotFound !BlockHash

peer could not find block

WantMempool

peer wants our mempool

Rejected !Reject

peer rejected something we sent

data PeerException

Reasons why a peer may stop working.

Constructors

PeerMisbehaving !String

peer was a naughty boy

DecodeMessageError !String

incoming message could not be decoded

CannotDecodePayload !String

incoming message payload could not be decoded

PeerIsMyself

nonce for peer matches ours

PayloadTooLarge !Word32

message payload too large

PeerAddressInvalid

peer address did not parse with fromSockAddr

BloomFiltersNotSupported

peer does not support bloom filters

PeerSentBadHeaders

peer sent wrong headers

NotNetworkPeer

peer is SPV and cannot serve blockchain data

PeerNoSegWit

peer has no segwit support

PeerTimeout

request to peer timed out

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

managerGetPeerVersion :: MonadIO m => Peer -> Manager -> m (Maybe Word32)

Get version of peer from manager.

managerGetPeerBest :: MonadIO m => Peer -> Manager -> m (Maybe BlockNode)

Get best block for peer from manager.

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

Get list of peers from manager.

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

Get peer information for a peer from manager.

managerKill :: MonadIO m => PeerException -> Peer -> Manager -> m ()

Ask manager to kill a peer with the provided exception.

setManagerFilter :: MonadIO m => BloomFilter -> Manager -> m ()

Set bloom filters in peer manager.

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

Send a network message to peer.

getMerkleBlocks :: MonadIO m => Peer -> [BlockHash] -> m ()

Request Merkle blocks from peer.

peerGetBlocks :: MonadIO m => Network -> Peer -> [BlockHash] -> m ()

Request full blocks from peer.

peerGetTxs :: MonadIO m => Network -> Peer -> [TxHash] -> m ()

Request transactions from peer.

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.