Network.Haskoin.Node.HeaderTree

Documentation

data BlockChainAction

Constructors

BestChain

Fields

• actionNodes :: ![NodeBlock]

ChainReorg

Fields

• actionSplitNode :: !NodeBlock
• actionOldNodes :: ![NodeBlock]
• actionNodes :: ![NodeBlock]

SideChain

Fields

• actionNodes :: ![NodeBlock]

KnownChain

Fields

• actionNodes :: ![NodeBlock]

Instances

Eq BlockChainAction

Methods

(==) :: BlockChainAction -> BlockChainAction -> Bool

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

Show BlockChainAction

Methods

showsPrec :: Int -> BlockChainAction -> ShowS

show :: BlockChainAction -> String

showList :: [BlockChainAction] -> ShowS

type BlockHeight = Word32

data NodeBlock

Instances

Eq NodeBlock

Methods

(==) :: NodeBlock -> NodeBlock -> Bool

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

Show NodeBlock

Methods

showsPrec :: Int -> NodeBlock -> ShowS

show :: NodeBlock -> String

showList :: [NodeBlock] -> ShowS

PersistField NodeBlock

Methods

toPersistValue :: NodeBlock -> PersistValue

fromPersistValue :: PersistValue -> Either Text NodeBlock

PersistEntity NodeBlock

Associated Types

type PersistEntityBackend NodeBlock :: *

data Key NodeBlock :: *

data EntityField NodeBlock a :: *

data Unique NodeBlock :: *

Methods

keyToValues :: Key NodeBlock -> [PersistValue]

keyFromValues :: [PersistValue] -> Either Text (Key NodeBlock)

persistIdField :: EntityField NodeBlock (Key NodeBlock)

entityDef :: Monad m => m NodeBlock -> EntityDef

persistFieldDef :: EntityField NodeBlock typ -> FieldDef

toPersistFields :: NodeBlock -> [SomePersistField]

fromPersistValues :: [PersistValue] -> Either Text NodeBlock

persistUniqueKeys :: NodeBlock -> [Unique NodeBlock]

persistUniqueToFieldNames :: Unique NodeBlock -> [(HaskellName, DBName)]

persistUniqueToValues :: Unique NodeBlock -> [PersistValue]

fieldLens :: EntityField NodeBlock field -> forall f. Functor f => (field -> f field) -> Entity NodeBlock -> f (Entity NodeBlock)

PersistFieldSql NodeBlock

Methods

sqlType :: Proxy * NodeBlock -> SqlType

ToBackendKey SqlBackend NodeBlock

Methods

toBackendKey :: Key NodeBlock -> BackendKey SqlBackend

fromBackendKey :: BackendKey SqlBackend -> Key NodeBlock

Eq (Key NodeBlock)

Methods

(==) :: Key NodeBlock -> Key NodeBlock -> Bool

(/=) :: Key NodeBlock -> Key NodeBlock -> Bool

Ord (Key NodeBlock)

Methods

compare :: Key NodeBlock -> Key NodeBlock -> Ordering

(<) :: Key NodeBlock -> Key NodeBlock -> Bool

(<=) :: Key NodeBlock -> Key NodeBlock -> Bool

(>) :: Key NodeBlock -> Key NodeBlock -> Bool

(>=) :: Key NodeBlock -> Key NodeBlock -> Bool

max :: Key NodeBlock -> Key NodeBlock -> Key NodeBlock

min :: Key NodeBlock -> Key NodeBlock -> Key NodeBlock

Read (Key NodeBlock)

Methods

readsPrec :: Int -> ReadS (Key NodeBlock)

readList :: ReadS [Key NodeBlock]

readPrec :: ReadPrec (Key NodeBlock)

readListPrec :: ReadPrec [Key NodeBlock]

Show (Key NodeBlock)

Methods

showsPrec :: Int -> Key NodeBlock -> ShowS

show :: Key NodeBlock -> String

showList :: [Key NodeBlock] -> ShowS

ToJSON (Key NodeBlock)

Methods

toJSON :: Key NodeBlock -> Value

toEncoding :: Key NodeBlock -> Encoding

toJSONList :: [Key NodeBlock] -> Value

toEncodingList :: [Key NodeBlock] -> Encoding

FromJSON (Key NodeBlock)

Methods

parseJSON :: Value -> Parser (Key NodeBlock)

parseJSONList :: Value -> Parser [Key NodeBlock]

PersistField (Key NodeBlock)

Methods

toPersistValue :: Key NodeBlock -> PersistValue

fromPersistValue :: PersistValue -> Either Text (Key NodeBlock)

PersistFieldSql (Key NodeBlock)

Methods

sqlType :: Proxy * (Key NodeBlock) -> SqlType

ToHttpApiData (Key NodeBlock)

Methods

toUrlPiece :: Key NodeBlock -> Text

toEncodedUrlPiece :: Key NodeBlock -> Builder

toHeader :: Key NodeBlock -> ByteString

toQueryParam :: Key NodeBlock -> Text

FromHttpApiData (Key NodeBlock)

Methods

parseUrlPiece :: Text -> Either Text (Key NodeBlock)

parseHeader :: ByteString -> Either Text (Key NodeBlock)

parseQueryParam :: Text -> Either Text (Key NodeBlock)

PathPiece (Key NodeBlock)

Methods

fromPathPiece :: Text -> Maybe (Key NodeBlock)

toPathPiece :: Key NodeBlock -> Text

data EntityField NodeBlock

data EntityField NodeBlock where

• NodeBlockId :: EntityField NodeBlock typ
• NodeBlockHash :: EntityField NodeBlock typ
• NodeBlockHeader :: EntityField NodeBlock typ
• NodeBlockWork :: EntityField NodeBlock typ
• NodeBlockHeight :: EntityField NodeBlock typ
• NodeBlockChain :: EntityField NodeBlock typ

type PersistEntityBackend NodeBlock

type PersistEntityBackend NodeBlock = SqlBackend

data Key NodeBlock

data Key NodeBlock = NodeBlockKey {

• unNodeBlockKey :: BackendKey SqlBackend

}

data Unique NodeBlock

data Unique NodeBlock

• = UniqueHash ShortHash
• | UniqueChain Word32 BlockHeight

type Timestamp = Word32

initHeaderTree :: MonadIO m => SqlPersistT m ()

Initialize the block header chain by inserting the genesis block if it doesn't already exist.

migrateHeaderTree :: Migration

getBestBlock :: MonadIO m => SqlPersistT m NodeBlock

getHeads :: MonadIO m => SqlPersistT m [NodeBlock]

getBlockByHash :: MonadIO m => BlockHash -> SqlPersistT m (Maybe NodeBlock)

getParentBlock :: MonadIO m => NodeBlock -> SqlPersistT m (Maybe NodeBlock)

Finds the parent of a block.

getBlockWindow

Arguments

:: MonadIO m

=> NodeBlock

Best block

-> NodeBlock

Start of window

-> Word32

Window count

-> SqlPersistT m BlockChainAction

Return blockchain action to connect given block with best block. Count will limit the amount of blocks building up from split point towards the best block.

getBlockAfterTime :: MonadIO m => Timestamp -> SqlPersistT m (Maybe NodeBlock)

Get node immediately at or after timestamp in main chain.

getChildBlocks :: MonadIO m => BlockHash -> SqlPersistT m [NodeBlock]

Get all children for a block

getBlockByHeight

Arguments

:: MonadIO m

=> NodeBlock

Best block

-> BlockHeight

-> SqlPersistT m (Maybe NodeBlock)

Get ancestor of specified block at given height.

getBlocksByHeight

Arguments

:: MonadIO m

=> NodeBlock

Best block

-> [BlockHeight]

-> SqlPersistT m [NodeBlock]

Get ancestors for specified block at given heights.

getBlocksFromHeight

Arguments

:: MonadIO m

=> NodeBlock

Best block

-> Word32

Count (0 for all)

-> BlockHeight

Height from (including)

-> SqlPersistT m [NodeBlock]

Get a range of block headers building up to specified block. If specified height is too large, an empty list will be returned.

getBlocksAtHeight :: MonadIO m => BlockHeight -> SqlPersistT m [NodeBlock]

Get blocks at specified height in all chains.

putBlock :: MonadIO m => NodeBlock -> SqlPersistT m ()

Put single block in database.

putBlocks :: MonadIO m => [NodeBlock] -> SqlPersistT m ()

Put multiple blocks in database.

genesisBlock :: NodeBlock

Genesis block.

splitBlock :: MonadIO m => NodeBlock -> NodeBlock -> SqlPersistT m NodeBlock

Get node height and chain common to both given.

splitChains :: MonadIO m => (NodeBlock, Word32) -> (NodeBlock, Word32) -> SqlPersistT m (NodeBlock, [NodeBlock], [NodeBlock])

Find the split point between two nodes. It also returns the two partial chains leading from the split point to the respective nodes. Tuples must contain a block node and the count of nodes that should be returned from the split towards that block. 0 means all.

nodeBlock

Arguments

:: NodeBlock

Parent block node

-> Word32

Chain number for new node

-> BlockHeader

-> NodeBlock

Create a block node data structure from a block header.

nodeBlockHeight :: NodeBlock -> BlockHeight

nodeHash :: NodeBlock -> BlockHash

nodeHeader :: NodeBlock -> BlockHeader

nodePrev :: NodeBlock -> BlockHash

nodeTimestamp :: NodeBlock -> Timestamp

nodeWork :: NodeBlock -> Work

nodeHeight :: NodeBlock -> BlockHeight

nodeChain :: NodeBlock -> Word32

isBestChain :: BlockChainAction -> Bool

Returns True if the action is a best chain.

isChainReorg :: BlockChainAction -> Bool

Returns True if the action is a chain reorg.

isSideChain :: BlockChainAction -> Bool

Returns True if the action is a side chain.

isKnownChain :: BlockChainAction -> Bool

Returns True if the action is a known chain.

connectHeader :: MonadIO m => NodeBlock -> BlockHeader -> Timestamp -> SqlPersistT m (Either String BlockChainAction)

Connect a block header to this block header chain. Corresponds to bitcoind function ProcessBlockHeader and AcceptBlockHeader in main.cpp.

connectHeaders :: MonadIO m => NodeBlock -> [BlockHeader] -> Timestamp -> SqlPersistT m (Either String BlockChainAction)

A more efficient way of connecting a list of block headers than connecting them individually. The list of block headers have must form a valid chain.

blockLocator :: MonadIO m => NodeBlock -> SqlPersistT m BlockLocator

Returns a BlockLocator object for a given block hash.

pruneChain :: MonadIO m => NodeBlock -> SqlPersistT m NodeBlock

Remove all other chains from database and return updated best block node.