Network.Haskoin.Node.STM

Documentation

type MerkleTxs = [TxHash]

type NodeT = ReaderT SharedNodeState

type PeerId = Unique

type PeerHostScore = Word32

newtype ShowPeerId

Constructors

ShowPeerId

Fields

• getShowPeerId :: PeerId

Instances

Eq ShowPeerId

Methods

(==) :: ShowPeerId -> ShowPeerId -> Bool

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

Show ShowPeerId

Methods

showsPrec :: Int -> ShowPeerId -> ShowS

show :: ShowPeerId -> String

showList :: [ShowPeerId] -> ShowS

runSql :: MonadBaseControl IO m => SqlPersistT m a -> Either SqlBackend ConnectionPool -> m a

runSqlNodeT :: MonadBaseControl IO m => SqlPersistT m a -> NodeT m a

getNodeState :: (MonadLoggerIO m, MonadBaseControl IO m) => Either SqlBackend ConnectionPool -> m SharedNodeState

runNodeT :: Monad m => NodeT m a -> SharedNodeState -> m a

withNodeT :: (MonadLoggerIO m, MonadBaseControl IO m) => NodeT m a -> Either SqlBackend ConnectionPool -> m a

atomicallyNodeT :: MonadIO m => NodeT STM a -> NodeT m a

data PeerHostSession

Constructors

PeerHostSession

Fields

• peerHostSessionScore :: !PeerHostScore
• peerHostSessionReconnect :: !Int
• peerHostSessionLog :: ![String]

  Important host log messages that should appear in status command

Instances

NFData PeerHostSession

Methods

rnf :: PeerHostSession -> ()

data SharedNodeState

Constructors

SharedNodeState

Fields

• sharedPeerMap :: !(TVar (Map PeerId (TVar PeerSession)))

  Map of all active peers and their sessions

• sharedHostMap :: !(TVar (Map PeerHost (TVar PeerHostSession)))

  The peer that is currently syncing the block headers

• sharedNetworkHeight :: !(TVar BlockHeight)

  The current height of the network

• sharedHeaders :: !(TMVar (PeerId, Headers))

  Block headers sent from a peer

• sharedHeaderPeer :: !(TVar (Maybe PeerId))

  Peer currently syncing headers

• sharedMerklePeer :: !(TVar (Maybe PeerId))

  Peer currently downloading merkle blocks

• sharedSyncLock :: !Lock

  Lock on the header syncing process

• sharedBestHeader :: !(TVar NodeBlock)

  Our best block header

• sharedBestBlock :: !(TVar NodeBlock)

  Our best merkle block's height

• sharedTxGetData :: !(TVar (Map TxHash [(PeerId, PeerHost)]))

  List of Tx GetData requests

• sharedBloomFilter :: !(TVar (Maybe (BloomFilter, Int)))

  Bloom filter

• sharedTickleChan :: !(TBMChan (PeerId, PeerHost, BlockHash))

  Channel containing all the block tickles received from peers

• sharedTxChan :: !(TBMChan (PeerId, PeerHost, Tx))

  Transaction channel

• sharedRescan :: !(TMVar (Either Timestamp BlockHeight))

  Rescan requests from a timestamp or from a block height

• sharedMempool :: !(TVar Bool)

  Did we do a Mempool sync ?

• sharedSqlBackend :: !(Either SqlBackend ConnectionPool)

type PingNonce = Word64

data PeerSession

Constructors

PeerSession

Fields

• peerSessionConnected :: !Bool

  True if the peer is connected (completed the handshake)

• peerSessionVersion :: !(Maybe Version)

  Contains the version message that we received from the peer

• peerSessionHeight :: !BlockHeight

  Current known height of the peer

• peerSessionChan :: !(TBMChan Message)

  Message channel to send messages to the peer

• peerSessionHost :: !PeerHost

  Host to which this peer is connected

• peerSessionThreadId :: !ThreadId

  Peer ThreadId

• peerSessionMerkleChan :: !(TBMChan (Either (MerkleBlock, MerkleTxs) Tx))

  Merkle block/Merkle transaction channel

• peerSessionPings :: !(TVar [PingNonce])

  Time at which we requested pings

• peerSessionScore :: !(Maybe NominalDiffTime)

  Ping scores for this peer (round trip times)

Instances

NFData PeerSession

Methods

rnf :: PeerSession -> ()

data PeerHost

Constructors

PeerHost

Fields

• peerHost :: !String
• peerPort :: !Int

Instances

Eq PeerHost

Methods

(==) :: PeerHost -> PeerHost -> Bool

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

Ord PeerHost

Methods

compare :: PeerHost -> PeerHost -> Ordering

(<) :: PeerHost -> PeerHost -> Bool

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

(>) :: PeerHost -> PeerHost -> Bool

(>=) :: PeerHost -> PeerHost -> Bool

max :: PeerHost -> PeerHost -> PeerHost

min :: PeerHost -> PeerHost -> PeerHost

ToJSON PeerHost

Methods

toJSON :: PeerHost -> Value

toEncoding :: PeerHost -> Encoding

toJSONList :: [PeerHost] -> Value

toEncodingList :: [PeerHost] -> Encoding

FromJSON PeerHost

Methods

parseJSON :: Value -> Parser PeerHost

parseJSONList :: Value -> Parser [PeerHost]

NFData PeerHost

Methods

rnf :: PeerHost -> ()

peerHostString :: PeerHost -> String

data PeerStatus

Constructors

PeerStatus

Fields

• peerStatusPeerId :: !Int
• peerStatusHost :: !PeerHost
• peerStatusConnected :: !Bool
• peerStatusHeight :: !BlockHeight
• peerStatusProtocol :: !(Maybe Word32)
• peerStatusUserAgent :: !(Maybe String)
• peerStatusPing :: !(Maybe String)
• peerStatusDoSScore :: !(Maybe PeerHostScore)
• peerStatusHaveMerkles :: !Bool
• peerStatusHaveMessage :: !Bool
• peerStatusPingNonces :: ![PingNonce]
• peerStatusReconnectTimer :: !(Maybe Int)
• peerStatusLog :: !(Maybe [String])

Instances

ToJSON PeerStatus

Methods

toJSON :: PeerStatus -> Value

toEncoding :: PeerStatus -> Encoding

toJSONList :: [PeerStatus] -> Value

toEncodingList :: [PeerStatus] -> Encoding

FromJSON PeerStatus

Methods

parseJSON :: Value -> Parser PeerStatus

parseJSONList :: Value -> Parser [PeerStatus]

data NodeStatus

Constructors

NodeStatus

Fields

• nodeStatusPeers :: ![PeerStatus]
• nodeStatusNetworkHeight :: !BlockHeight
• nodeStatusBestHeader :: !BlockHash
• nodeStatusBestHeaderHeight :: !BlockHeight
• nodeStatusBestBlock :: !BlockHash
• nodeStatusBestBlockHeight :: !BlockHeight
• nodeStatusBloomSize :: !Int
• nodeStatusHeaderPeer :: !(Maybe Int)
• nodeStatusMerklePeer :: !(Maybe Int)
• nodeStatusHaveHeaders :: !Bool
• nodeStatusHaveTickles :: !Bool
• nodeStatusHaveTxs :: !Bool
• nodeStatusGetData :: ![TxHash]
• nodeStatusRescan :: !(Maybe (Either Timestamp BlockHeight))
• nodeStatusMempool :: !Bool
• nodeStatusSyncLock :: !Bool

Instances

ToJSON NodeStatus

Methods

toJSON :: NodeStatus -> Value

toEncoding :: NodeStatus -> Encoding

toJSONList :: [NodeStatus] -> Value

toEncodingList :: [NodeStatus] -> Encoding

FromJSON NodeStatus

Methods

parseJSON :: Value -> Parser NodeStatus

parseJSONList :: Value -> Parser [NodeStatus]

tryGetPeerSession :: PeerId -> NodeT STM (Maybe PeerSession)

getPeerSession :: PeerId -> NodeT STM PeerSession

newPeerSession :: PeerId -> PeerSession -> NodeT STM ()

modifyPeerSession :: PeerId -> (PeerSession -> PeerSession) -> NodeT STM ()

removePeerSession :: PeerId -> NodeT STM (Maybe PeerSession)

getHostSession :: PeerHost -> NodeT STM (Maybe PeerHostSession)

modifyHostSession :: PeerHost -> (PeerHostSession -> PeerHostSession) -> NodeT STM ()

newHostSession :: PeerHost -> PeerHostSession -> NodeT STM ()

bannedScore :: PeerHostScore

minorDoS :: PeerHostScore -> PeerHostScore

moderateDoS :: PeerHostScore -> PeerHostScore

severeDoS :: PeerHostScore -> PeerHostScore

isHostScoreBanned :: PeerHostScore -> Bool

orElseNodeT :: NodeT STM a -> NodeT STM a -> NodeT STM a

readTVarS :: (SharedNodeState -> TVar a) -> NodeT STM a

writeTVarS :: (SharedNodeState -> TVar a) -> a -> NodeT STM ()

takeTMVarS :: (SharedNodeState -> TMVar a) -> NodeT STM a

readTMVarS :: (SharedNodeState -> TMVar a) -> NodeT STM a

tryReadTMVarS :: (SharedNodeState -> TMVar a) -> NodeT STM (Maybe a)

putTMVarS :: (SharedNodeState -> TMVar a) -> a -> NodeT STM ()

tryPutTMVarS :: (SharedNodeState -> TMVar a) -> a -> NodeT STM Bool

swapTMVarS :: (SharedNodeState -> TMVar a) -> a -> NodeT STM ()

isEmptyTMVarS :: (SharedNodeState -> TMVar a) -> NodeT STM Bool

data NodeException

Constructors

NodeExceptionBanned

NodeExceptionConnected

NodeExceptionInvalidPeer !ShowPeerId

NodeExceptionPeerNotConnected !ShowPeerId

NodeException !String

Instances

Show NodeException

Methods

showsPrec :: Int -> NodeException -> ShowS

show :: NodeException -> String

showList :: [NodeException] -> ShowS

Exception NodeException

Methods

toException :: NodeException -> SomeException

fromException :: SomeException -> Maybe NodeException

displayException :: NodeException -> String

isNodeException :: SomeException -> Bool

catchAny :: MonadBaseControl IO m => m a -> (SomeException -> m a) -> m a

catchAny_ :: MonadBaseControl IO m => m () -> m ()