haskoin-core-0.8.2: Bitcoin & Bitcoin Cash library for Haskell

CopyrightNo rights reserved
LicenseUNLICENSE
Maintainerxenog@protonmail.com
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Network.Haskoin.Block.Headers

Contents

Description

Block chain header synchronization and proof-of-work consensus functions.

Synopsis

Documentation

data BlockNode Source #

Data structure representing a block header and its position in the block chain.

Constructors

BlockNode

non-Genesis block header

Fields

GenesisNode

Genesis block header

Fields

Instances
Eq BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Ord BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Read BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Show BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Generic BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Associated Types

type Rep BlockNode :: * -> * #

Hashable BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Serialize BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

type Rep BlockNode Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

class Monad m => BlockHeaders m where Source #

Typeclass for block header chain storage monad.

Methods

addBlockHeader :: BlockNode -> m () Source #

Add a new BlockNode to the chain. Does not validate.

getBlockHeader :: BlockHash -> m (Maybe BlockNode) Source #

Get a BlockNode associated with a BlockHash.

getBestBlockHeader :: m BlockNode Source #

Locate the BlockNode for the highest block in the chain

setBestBlockHeader :: BlockNode -> m () Source #

Set the highest block in the chain.

addBlockHeaders :: [BlockNode] -> m () Source #

Add a continuous bunch of block headers the chain. Does not validate.

type BlockWork = Integer Source #

Represents accumulated work in the block chain so far.

genesisNode :: Network -> BlockNode Source #

Build the genesis BlockNode for the supplied Network.

genesisBlock :: Network -> Block Source #

Generate the entire Genesis block for Network.

isGenesis :: BlockNode -> Bool Source #

Is the provided BlockNode the Genesis block?

chooseBest :: BlockNode -> BlockNode -> BlockNode Source #

Compare two blocks to get the best.

Header Chain Storage Functions

parentBlock :: BlockHeaders m => BlockHeader -> m (Maybe BlockNode) Source #

Block's parent. If the block header is in the store, its parent must also be there. No block header get deleted or pruned from the store.

getParents Source #

Arguments

:: BlockHeaders m 
=> Int 
-> BlockNode 
-> m [BlockNode]

starts from immediate parent

Get a number of parents for the provided block.

getAncestor :: BlockHeaders m => BlockHeight -> BlockNode -> m (Maybe BlockNode) Source #

Get the ancestor of the provided BlockNode at the specified BlockHeight.

splitPoint :: BlockHeaders m => BlockNode -> BlockNode -> m BlockNode Source #

Find the last common block ancestor between provided block headers.

connectBlocks Source #

Arguments

:: BlockHeaders m 
=> Network 
-> Timestamp

current time

-> [BlockHeader] 
-> m (Either String [BlockNode]) 

Validate a list of continuous block headers and import them to the block chain. Return Left on failure with error information.

connectBlock Source #

Arguments

:: BlockHeaders m 
=> Network 
-> Timestamp

current time

-> BlockHeader 
-> m (Either String BlockNode) 

Validate and connect single block header to the block chain. Return Left if fails to be validated.

blockLocator :: BlockHeaders m => BlockNode -> m BlockLocator Source #

Get block locator.

In-Memory Header Chain Store

data HeaderMemory Source #

Memory-based header tree.

Instances
Eq HeaderMemory Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Read HeaderMemory Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Show HeaderMemory Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Generic HeaderMemory Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Associated Types

type Rep HeaderMemory :: * -> * #

Hashable HeaderMemory Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

Monad m => BlockHeaders (StateT HeaderMemory m) Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

type Rep HeaderMemory Source # 
Instance details

Defined in Network.Haskoin.Block.Headers

type Rep HeaderMemory = D1 (MetaData "HeaderMemory" "Network.Haskoin.Block.Headers" "haskoin-core-0.8.2-DBbfowLuwQJDnYGV2ClFSV" False) (C1 (MetaCons "HeaderMemory" PrefixI True) (S1 (MetaSel (Just "memoryHeaderMap") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BlockMap) :*: S1 (MetaSel (Just "memoryBestHeader") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BlockNode)))

type ShortBlockHash = Word64 Source #

Short version of the block hash. Uses the good end of the hash (the part that doesn't have a long string of zeroes).

type BlockMap = HashMap ShortBlockHash ShortByteString Source #

Memory-based map to a serialized BlockNode data structure. ShortByteString is used to avoid memory fragmentation and make the data structure compact.

shortBlockHash :: BlockHash -> ShortBlockHash Source #

Calculate short block hash taking eight non-zero bytes from the 16-byte hash. This function will take the bytes that are not on the zero-side of the hash, making colissions between short block hashes difficult.

initialChain :: Network -> HeaderMemory Source #

Initialize memory-based chain.

genesisMap :: Network -> BlockMap Source #

Initialize map for memory-based chain.

Helper Functions

appendBlocks Source #

Arguments

:: Network 
-> Word32

random seed

-> BlockHeader 
-> Int 
-> [BlockHeader] 

Generate and append new blocks (mining). Only practical in regtest network.

validBlock Source #

Arguments

:: Network 
-> Timestamp

current time

-> BlockNode

best block

-> BlockNode

immediate parent

-> [BlockNode]

10 parents above

-> BlockHeader

header to validate

-> BlockNode

skip node (black magic)

-> Either String BlockNode 

Validate this block header. Build a BlockNode if successful.

validCP Source #

Arguments

:: Network 
-> BlockHeight

new child height

-> BlockHash

new child hash

-> Bool 

Verify that checkpoint location is valid.

afterLastCP Source #

Arguments

:: Network 
-> BlockHeight

best height

-> BlockHeight

new imported block height

-> Bool 

New block height above the last checkpoint imported. Used to prevent a reorg below the highest checkpoint that was already imported.

bip34 Source #

Arguments

:: Network 
-> BlockHeight

new child height

-> BlockHash

new child hash

-> Bool 

This block should be at least version 2 (BIP34). Block height must be included in the coinbase transaction to prevent non-unique transaction hashes.

validVersion Source #

Arguments

:: Network 
-> BlockHeight

new child height

-> Word32

new child version

-> Bool 

Check if the provided block height and version are valid.

lastNoMinDiff :: BlockHeaders m => Network -> BlockNode -> m BlockNode Source #

Find last block with normal, as opposed to minimum difficulty (for test networks).

nextWorkRequired :: BlockHeaders m => Network -> BlockNode -> BlockHeader -> m Word32 Source #

Returns the work required on a block header given the previous block. This coresponds to bitcoind function GetNextWorkRequired in main.cpp.

nextEdaWorkRequired :: BlockHeaders m => Network -> BlockNode -> BlockHeader -> m Word32 Source #

Find out the next amount of work required according to the Emergency Difficulty Adjustment (EDA) algorithm from Bitcoin Cash.

nextDaaWorkRequired :: BlockHeaders m => Network -> BlockNode -> BlockHeader -> m Word32 Source #

Find the next amount of work required according to the Difficulty Adjustment Algorithm (DAA) from Bitcoin Cash.

computeTarget :: Network -> BlockNode -> BlockNode -> Integer Source #

Compute Bitcoin Cash DAA target for a new block.

getSuitableBlock :: BlockHeaders m => BlockNode -> m BlockNode Source #

Get suitable block for Bitcoin Cash DAA computation.

nextPowWorkRequired :: BlockHeaders m => Network -> BlockNode -> BlockHeader -> m Word32 Source #

Returns the work required on a block header given the previous block. This coresponds to bitcoind function GetNextWorkRequired in main.cpp.

calcNextWork Source #

Arguments

:: Network 
-> BlockHeader

last block in previous retarget (parent)

-> Timestamp

timestamp of first block in previous retarget

-> Word32 

Computes the work required for the first block in a new retarget period.

isValidPOW :: Network -> BlockHeader -> Bool Source #

Returns True if the difficulty target (bits) of the header is valid and the proof of work of the header matches the advertised difficulty target. This function corresponds to the function CheckProofOfWork from bitcoind in main.cpp.

blockPOW :: BlockHash -> Integer Source #

Returns the proof of work of a block header hash as an Integer number.

headerWork :: BlockHeader -> Integer Source #

Returns the work represented by this block. Work is defined as the number of tries needed to solve a block in the average case with respect to the target.

diffInterval :: Network -> Word32 Source #

Number of blocks on average between difficulty cycles (2016 blocks).

blockLocatorNodes :: BlockHeaders m => BlockNode -> m [BlockNode] Source #

Get list of blocks for a block locator.

mineBlock :: Network -> Word32 -> BlockHeader -> BlockHeader Source #

Become rich beyond your wildest dreams.