Network.Haskoin.Node.Chain.Logic

State and code for block header synchronization.

Documentation

dataVersion :: Word32

Version of the database.

data ChainDataVersionKey

Database key for version.

Constructors

ChainDataVersionKey

Instances

Eq ChainDataVersionKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

(==) :: ChainDataVersionKey -> ChainDataVersionKey -> Bool

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

Ord ChainDataVersionKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

compare :: ChainDataVersionKey -> ChainDataVersionKey -> Ordering

(<) :: ChainDataVersionKey -> ChainDataVersionKey -> Bool

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

(>) :: ChainDataVersionKey -> ChainDataVersionKey -> Bool

(>=) :: ChainDataVersionKey -> ChainDataVersionKey -> Bool

max :: ChainDataVersionKey -> ChainDataVersionKey -> ChainDataVersionKey

min :: ChainDataVersionKey -> ChainDataVersionKey -> ChainDataVersionKey

Show ChainDataVersionKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

showsPrec :: Int -> ChainDataVersionKey -> ShowS

show :: ChainDataVersionKey -> String

showList :: [ChainDataVersionKey] -> ShowS

Serialize ChainDataVersionKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

put :: Putter ChainDataVersionKey

get :: Get ChainDataVersionKey

Key ChainDataVersionKey

Defined in Network.Haskoin.Node.Chain.Logic

KeyValue ChainDataVersionKey Word32

Defined in Network.Haskoin.Node.Chain.Logic

data ChainState p

Mutable state for the header chain process.

Constructors

ChainState

Fields

• syncingPeer :: !(Maybe (p, UTCTime))

  peer to sync against and time of last received message

• newPeers :: ![p]

  queue of peers to sync against

• mySynced :: !Bool

  has the header chain ever been considered synced?

newtype BlockHeaderKey

Key for block header in database.

Constructors

BlockHeaderKey BlockHash

Instances

Eq BlockHeaderKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

(==) :: BlockHeaderKey -> BlockHeaderKey -> Bool

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

Show BlockHeaderKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

showsPrec :: Int -> BlockHeaderKey -> ShowS

show :: BlockHeaderKey -> String

showList :: [BlockHeaderKey] -> ShowS

Serialize BlockHeaderKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

put :: Putter BlockHeaderKey

get :: Get BlockHeaderKey

KeyValue BlockHeaderKey BlockNode

Defined in Network.Haskoin.Node.Chain.Logic

data BestBlockKey

Key for best block in database.

Constructors

BestBlockKey

Instances

Eq BestBlockKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

(==) :: BestBlockKey -> BestBlockKey -> Bool

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

Show BestBlockKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

showsPrec :: Int -> BestBlockKey -> ShowS

show :: BestBlockKey -> String

showList :: [BestBlockKey] -> ShowS

Serialize BestBlockKey

Defined in Network.Haskoin.Node.Chain.Logic

Methods

put :: Putter BestBlockKey

get :: Get BestBlockKey

KeyValue BestBlockKey BlockNode

Defined in Network.Haskoin.Node.Chain.Logic

type MonadChainLogic a p m = (BlockHeaders m, MonadReader (ChainReader a p) m)

Type alias for monad commonly used in this module.

data ChainReader a p

Reader for header synchronization code.

Constructors

ChainReader

Fields

• myReader :: !a

  placeholder for upstream data

• myChainDB :: !DB

  database handle

• chainState :: !(TVar (ChainState p))

  mutable state for header synchronization

initChainDB :: (MonadChainLogic a p m, MonadUnliftIO m) => Network -> m ()

Initialize header database. If version is different from current, the database is purged of conflicting elements first.

purgeChainDB :: (MonadChainLogic a p m, MonadUnliftIO m) => m ()

Purge database of elements having keys that may conflict with those used in this module.

importHeaders :: (MonadIO m, BlockHeaders m) => Network -> [BlockHeader] -> m (Either PeerException Bool)

Import a bunch of continuous headers. Returns True if the number of headers is 2000, which means that there are possibly more headers to sync from whatever peer delivered these.

notifySynced :: (MonadIO m, MonadChainLogic a p m) => m Bool

Check if best block header is in sync with the rest of the block chain by comparing the best block with the current time, verifying that there are no peers in the queue to be synced, and no peer is being synced at the moment. This function will only return True once. It should be used to decide whether to notify other processes that the header chain has been synced. The state of the chain will be flipped to synced when this function returns True.

nextPeer :: (MonadIO m, MonadChainLogic a p m) => m (Maybe p)

Get next peer to sync against from the queue.

syncHeaders :: (Eq p, MonadChainLogic a p m, MonadIO m) => BlockNode -> p -> m GetHeaders

Set a syncing peer and generate a GetHeaders data structure with a block locator to send to that peer for syncing.

setLastReceived :: (MonadChainLogic a p m, MonadIO m) => m ()

Set the time of last received data to now if a syncing peer is active.

addPeer :: (Eq p, MonadIO m, MonadChainLogic a p m) => p -> m ()

Add a new peer to the queue of peers to sync against.

getSyncingPeer :: (MonadChainLogic a p m, MonadIO m) => m (Maybe p)

Get syncing peer if there is one.

setSyncingPeer :: (MonadChainLogic a p m, MonadIO m) => p -> m ()

Set syncing peer to the pone provided.

isSynced :: (MonadChainLogic a p m, MonadIO m) => m Bool

Return True if the chain has ever been considered synced. it will always return True, even if the chain gets out of sync for any reason.

setSynced :: (MonadChainLogic a p m, MonadIO m) => m ()

Set chain as synced.

finishPeer :: (Eq p, MonadIO m, MonadChainLogic a p m) => p -> m ()

Remove a peer from the queue of peers to sync and unset the syncing peer if it is set to the provided value.

lastMessage :: (MonadChainLogic a p m, MonadIO m) => m (Maybe (p, UTCTime))

Return the syncing peer and time of last communication received, if any.

Orphan instances

(Monad m, MonadIO m, MonadReader (ChainReader a p) m) => BlockHeaders m

Methods

addBlockHeader :: BlockNode -> m ()

getBlockHeader :: BlockHash -> m (Maybe BlockNode)

getBestBlockHeader :: m BlockNode

setBestBlockHeader :: BlockNode -> m ()

addBlockHeaders :: [BlockNode] -> m ()