Haskoin.Block.Common

Common data types and functions to handle blocks from the block chain.

Blocks

data Block

Block header and transactions.

Constructors

Block

Fields

• blockHeader :: !BlockHeader
• blockTxns :: ![Tx]

Instances

Eq Block

Defined in Haskoin.Block.Common

Methods

(==) :: Block -> Block -> Bool

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

Read Block

Defined in Haskoin.Block.Common

Methods

readsPrec :: Int -> ReadS Block

readList :: ReadS [Block]

readPrec :: ReadPrec Block

readListPrec :: ReadPrec [Block]

Show Block

Defined in Haskoin.Block.Common

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

Generic Block

Defined in Haskoin.Block.Common

Associated Types

type Rep Block :: Type -> Type

Methods

from :: Block -> Rep Block x

to :: Rep Block x -> Block

Hashable Block

Defined in Haskoin.Block.Common

Methods

hashWithSalt :: Int -> Block -> Int

hash :: Block -> Int

ToJSON Block

Defined in Haskoin.Block.Common

Methods

toJSON :: Block -> Value

toEncoding :: Block -> Encoding

toJSONList :: [Block] -> Value

toEncodingList :: [Block] -> Encoding

FromJSON Block

Defined in Haskoin.Block.Common

Methods

parseJSON :: Value -> Parser Block

parseJSONList :: Value -> Parser [Block]

Serialize Block

Defined in Haskoin.Block.Common

Methods

put :: Putter Block

get :: Get Block

NFData Block

Defined in Haskoin.Block.Common

Methods

rnf :: Block -> ()

type Rep Block

Defined in Haskoin.Block.Common

type Rep Block = D1 ('MetaData "Block" "Haskoin.Block.Common" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "Block" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockHeader") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockHeader) :*: S1 ('MetaSel ('Just "blockTxns") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Tx])))

type BlockHeight = Word32

Height of a block in the block chain, starting at 0 for Genesis.

type Timestamp = Word32

Block timestamp as Unix time (seconds since 1970-01-01 00:00 UTC).

data BlockHeader

Data type recording information of a Block. The hash of a block is defined as the hash of this data structure, serialized. The block mining process involves finding a partial hash collision by varying the nonce in the BlockHeader and/or additional entropy in the coinbase Transaction of this Block. Variations in the coinbase will result in different merkle roots in the BlockHeader.

Constructors

BlockHeader

Fields

• blockVersion :: !Word32
• prevBlock :: !BlockHash

  hash of the previous block (parent)

• merkleRoot :: !Hash256

  root of the merkle tree of transactions

• blockTimestamp :: !Timestamp

  unix timestamp

• blockBits :: !Word32

  difficulty target

• bhNonce :: !Word32

  random nonce

Instances

Eq BlockHeader

Defined in Haskoin.Block.Common

Methods

(==) :: BlockHeader -> BlockHeader -> Bool

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

Ord BlockHeader

Defined in Haskoin.Block.Common

Methods

compare :: BlockHeader -> BlockHeader -> Ordering

(<) :: BlockHeader -> BlockHeader -> Bool

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

(>) :: BlockHeader -> BlockHeader -> Bool

(>=) :: BlockHeader -> BlockHeader -> Bool

max :: BlockHeader -> BlockHeader -> BlockHeader

min :: BlockHeader -> BlockHeader -> BlockHeader

Read BlockHeader

Defined in Haskoin.Block.Common

Methods

readsPrec :: Int -> ReadS BlockHeader

readList :: ReadS [BlockHeader]

readPrec :: ReadPrec BlockHeader

readListPrec :: ReadPrec [BlockHeader]

Show BlockHeader

Defined in Haskoin.Block.Common

Methods

showsPrec :: Int -> BlockHeader -> ShowS

show :: BlockHeader -> String

showList :: [BlockHeader] -> ShowS

Generic BlockHeader

Defined in Haskoin.Block.Common

Associated Types

type Rep BlockHeader :: Type -> Type

Methods

from :: BlockHeader -> Rep BlockHeader x

to :: Rep BlockHeader x -> BlockHeader

Hashable BlockHeader

Defined in Haskoin.Block.Common

Methods

hashWithSalt :: Int -> BlockHeader -> Int

hash :: BlockHeader -> Int

ToJSON BlockHeader

Defined in Haskoin.Block.Common

Methods

toJSON :: BlockHeader -> Value

toEncoding :: BlockHeader -> Encoding

toJSONList :: [BlockHeader] -> Value

toEncodingList :: [BlockHeader] -> Encoding

FromJSON BlockHeader

Defined in Haskoin.Block.Common

Methods

parseJSON :: Value -> Parser BlockHeader

parseJSONList :: Value -> Parser [BlockHeader]

Serialize BlockHeader

Defined in Haskoin.Block.Common

Methods

put :: Putter BlockHeader

get :: Get BlockHeader

NFData BlockHeader

Defined in Haskoin.Block.Common

Methods

rnf :: BlockHeader -> ()

type Rep BlockHeader

Defined in Haskoin.Block.Common

type Rep BlockHeader = D1 ('MetaData "BlockHeader" "Haskoin.Block.Common" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "BlockHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blockVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "prevBlock") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockHash) :*: S1 ('MetaSel ('Just "merkleRoot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash256))) :*: (S1 ('MetaSel ('Just "blockTimestamp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Timestamp) :*: (S1 ('MetaSel ('Just "blockBits") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "bhNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32)))))

headerHash :: BlockHeader -> BlockHash

Compute hash of BlockHeader.

type BlockLocator = [BlockHash]

A block locator is a set of block headers, denser towards the best block and sparser towards the genesis block. It starts at the highest block known. It is used by a node to synchronize against the network. When the locator is provided to a peer, it will send back block hashes starting from the first block in the locator that it recognizes.

data GetBlocks

Data type representing a getblocks message request. It is used in the bitcoin protocol to retrieve blocks from a peer by providing it a BlockLocator object. The response to a GetBlocks message is an Inv message containing a list of block hashes that the peer believes this node is missing. The number of block hashes in that inv message will end at the stop block hash, at at the tip of the chain, or after 500 entries, whichever comes earlier.

Constructors

GetBlocks

Fields

• getBlocksVersion :: !Word32
• getBlocksLocator :: !BlockLocator

  block locator object

• getBlocksHashStop :: !BlockHash

  hash of the last desired block

Instances

Eq GetBlocks

Defined in Haskoin.Block.Common

Methods

(==) :: GetBlocks -> GetBlocks -> Bool

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

Read GetBlocks

Defined in Haskoin.Block.Common

Methods

readsPrec :: Int -> ReadS GetBlocks

readList :: ReadS [GetBlocks]

readPrec :: ReadPrec GetBlocks

readListPrec :: ReadPrec [GetBlocks]

Show GetBlocks

Defined in Haskoin.Block.Common

Methods

showsPrec :: Int -> GetBlocks -> ShowS

show :: GetBlocks -> String

showList :: [GetBlocks] -> ShowS

Generic GetBlocks

Defined in Haskoin.Block.Common

Associated Types

type Rep GetBlocks :: Type -> Type

Methods

from :: GetBlocks -> Rep GetBlocks x

to :: Rep GetBlocks x -> GetBlocks

Serialize GetBlocks

Defined in Haskoin.Block.Common

Methods

put :: Putter GetBlocks

get :: Get GetBlocks

NFData GetBlocks

Defined in Haskoin.Block.Common

Methods

rnf :: GetBlocks -> ()

type Rep GetBlocks

Defined in Haskoin.Block.Common

type Rep GetBlocks = D1 ('MetaData "GetBlocks" "Haskoin.Block.Common" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "GetBlocks" 'PrefixI 'True) (S1 ('MetaSel ('Just "getBlocksVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "getBlocksLocator") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockLocator) :*: S1 ('MetaSel ('Just "getBlocksHashStop") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockHash))))

data GetHeaders

Similar to the GetBlocks message type but for retrieving block headers only. The response to a GetHeaders request is a Headers message containing a list of block headers. A maximum of 2000 block headers can be returned. GetHeaders is used by simplified payment verification (SPV) clients to exclude block contents when synchronizing the block chain.

Constructors

GetHeaders

Fields

• getHeadersVersion :: !Word32
• getHeadersBL :: !BlockLocator

  block locator object

• getHeadersHashStop :: !BlockHash

  hash of the last desired block header

Instances

Eq GetHeaders

Defined in Haskoin.Block.Common

Methods

(==) :: GetHeaders -> GetHeaders -> Bool

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

Read GetHeaders

Defined in Haskoin.Block.Common

Methods

readsPrec :: Int -> ReadS GetHeaders

readList :: ReadS [GetHeaders]

readPrec :: ReadPrec GetHeaders

readListPrec :: ReadPrec [GetHeaders]

Show GetHeaders

Defined in Haskoin.Block.Common

Methods

showsPrec :: Int -> GetHeaders -> ShowS

show :: GetHeaders -> String

showList :: [GetHeaders] -> ShowS

Generic GetHeaders

Defined in Haskoin.Block.Common

Associated Types

type Rep GetHeaders :: Type -> Type

Methods

from :: GetHeaders -> Rep GetHeaders x

to :: Rep GetHeaders x -> GetHeaders

Serialize GetHeaders

Defined in Haskoin.Block.Common

Methods

put :: Putter GetHeaders

get :: Get GetHeaders

NFData GetHeaders

Defined in Haskoin.Block.Common

Methods

rnf :: GetHeaders -> ()

type Rep GetHeaders

Defined in Haskoin.Block.Common

type Rep GetHeaders = D1 ('MetaData "GetHeaders" "Haskoin.Block.Common" "haskoin-core-0.19.0-inplace" 'False) (C1 ('MetaCons "GetHeaders" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHeadersVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "getHeadersBL") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockLocator) :*: S1 ('MetaSel ('Just "getHeadersHashStop") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockHash))))

type BlockHeaderCount = (BlockHeader, VarInt)

BlockHeader type with a transaction count as VarInt

newtype BlockHash

Block header hash. To be serialized reversed for display purposes.

Constructors

BlockHash

Fields

• getBlockHash :: Hash256

Instances

Eq BlockHash

Defined in Haskoin.Block.Common

Methods

(==) :: BlockHash -> BlockHash -> Bool

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

Ord BlockHash

Defined in Haskoin.Block.Common

Methods

compare :: BlockHash -> BlockHash -> Ordering

(<) :: BlockHash -> BlockHash -> Bool

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

(>) :: BlockHash -> BlockHash -> Bool

(>=) :: BlockHash -> BlockHash -> Bool

max :: BlockHash -> BlockHash -> BlockHash

min :: BlockHash -> BlockHash -> BlockHash

Read BlockHash

Defined in Haskoin.Block.Common

Methods

readsPrec :: Int -> ReadS BlockHash

readList :: ReadS [BlockHash]

readPrec :: ReadPrec BlockHash

readListPrec :: ReadPrec [BlockHash]

Show BlockHash

Defined in Haskoin.Block.Common

Methods

showsPrec :: Int -> BlockHash -> ShowS

show :: BlockHash -> String

showList :: [BlockHash] -> ShowS

IsString BlockHash

Defined in Haskoin.Block.Common

Methods

fromString :: String -> BlockHash

Generic BlockHash

Defined in Haskoin.Block.Common

Associated Types

type Rep BlockHash :: Type -> Type

Methods

from :: BlockHash -> Rep BlockHash x

to :: Rep BlockHash x -> BlockHash

Hashable BlockHash

Defined in Haskoin.Block.Common

Methods

hashWithSalt :: Int -> BlockHash -> Int

hash :: BlockHash -> Int

ToJSON BlockHash

Defined in Haskoin.Block.Common

Methods

toJSON :: BlockHash -> Value

toEncoding :: BlockHash -> Encoding

toJSONList :: [BlockHash] -> Value

toEncodingList :: [BlockHash] -> Encoding

FromJSON BlockHash

Defined in Haskoin.Block.Common

Methods

parseJSON :: Value -> Parser BlockHash

parseJSONList :: Value -> Parser [BlockHash]

Serialize BlockHash

Defined in Haskoin.Block.Common

Methods

put :: Putter BlockHash

get :: Get BlockHash

NFData BlockHash

Defined in Haskoin.Block.Common

Methods

rnf :: BlockHash -> ()

type Rep BlockHash

Defined in Haskoin.Block.Common

type Rep BlockHash = D1 ('MetaData "BlockHash" "Haskoin.Block.Common" "haskoin-core-0.19.0-inplace" 'True) (C1 ('MetaCons "BlockHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getBlockHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hash256)))

blockHashToHex :: BlockHash -> Text

Block hashes are reversed with respect to the in-memory byte order in a block hash when displayed.

hexToBlockHash :: Text -> Maybe BlockHash

Convert a human-readable hex block hash into a BlockHash. Bytes are reversed as normal.

newtype Headers

The Headers type is used to return a list of block headers in response to a GetHeaders message.

Constructors

Headers

Fields

• headersList :: [BlockHeaderCount]

  list of block headers with transaction count

Instances

Eq Headers

Defined in Haskoin.Block.Common

Methods

(==) :: Headers -> Headers -> Bool

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

Read Headers

Defined in Haskoin.Block.Common

Methods

readsPrec :: Int -> ReadS Headers

readList :: ReadS [Headers]

readPrec :: ReadPrec Headers

readListPrec :: ReadPrec [Headers]

Show Headers

Defined in Haskoin.Block.Common

Methods

showsPrec :: Int -> Headers -> ShowS

show :: Headers -> String

showList :: [Headers] -> ShowS

Generic Headers

Defined in Haskoin.Block.Common

Associated Types

type Rep Headers :: Type -> Type

Methods

from :: Headers -> Rep Headers x

to :: Rep Headers x -> Headers

Serialize Headers

Defined in Haskoin.Block.Common

Methods

put :: Putter Headers

get :: Get Headers

NFData Headers

Defined in Haskoin.Block.Common

Methods

rnf :: Headers -> ()

type Rep Headers

Defined in Haskoin.Block.Common

type Rep Headers = D1 ('MetaData "Headers" "Haskoin.Block.Common" "haskoin-core-0.19.0-inplace" 'True) (C1 ('MetaCons "Headers" 'PrefixI 'True) (S1 ('MetaSel ('Just "headersList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BlockHeaderCount])))

decodeCompact

Arguments

:: Word32

-> (Integer, Bool)

true means overflow

Decode the compact number used in the difficulty target of a block.

The compact format is a representation of a whole number \(N\) using an unsigned 32-bit number similar to a floating point format. The most significant 8 bits are the unsigned exponent of base 256. This exponent can be thought of as the number of bytes of \(N\). The lower 23 bits are the mantissa. Bit number 24 represents the sign of \(N\).

\[ N = -1^{sign} \times mantissa \times 256^{exponent-3} \]

encodeCompact :: Integer -> Word32

Encode an Integer to the compact number format used in the difficulty target of a block.