chainweb-node/src/Chainweb/BlockHeader.hs at 9b0b8ec23686de1b904469bd61e485ba6a72056b · kadena-io/chainweb-node · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
{-# LANGUAGE ImportQualifiedPost #-}

-- Use this module to get read-only access to a 'BlockHeader' via 'Getter's.
--
-- Editing or manually constructing 'BlockHeader's outside of tests is dangerous
-- and likely to result in invalid headers, whether through invalid block hashes
-- or invalid adjacent hash records.
--
-- If you need to manually construct or overwrite a BlockHeader record or
-- 'Setter', again only in tests, use 'Chainweb.BlockHeader.Internal' instead.
module Chainweb.BlockHeader
(
-- * Newtype wrappers for function parameters
  I.ParentHeader(..)
, I.parentHeader
, I.parentHeaderHash
, I._rankedParentHash
, I.rankedParentHash
, I.ParentCreationTime(..)

-- * Block Payload Hash
, I.BlockPayloadHash
, I.BlockPayloadHash_(..)
, I.encodeBlockPayloadHash
, I.decodeBlockPayloadHash

-- * Nonce
, I.Nonce(..)
, I.encodeNonce
, I.encodeNonceToWord64
, I.decodeNonce

-- * EpochStartTime
, I.EpochStartTime(..)
, I.encodeEpochStartTime
, I.decodeEpochStartTime
, I.epochStart

-- * POW Target
, I.powTarget

-- * BlockHeader
, I.BlockHeader

-- ** Getters
, blockFlags
, blockCreationTime
, blockParent
, blockAdjacentHashes
, blockTarget
, blockPayloadHash
, blockChainId
, blockWeight
, blockHeight
, blockChainwebVersion
, blockEpochStart
, blockNonce
, blockHash
, blockForkState
, blockForkVotes
, blockForkNumber

-- ** Utilities
, I._blockPow
, I.blockPow
, I.rankedBlockHash
, I._rankedBlockHash
, I.rankedBlockPayloadHash
, I._rankedBlockPayloadHash
, I._blockAdjacentChainIds
, I.blockAdjacentChainIds
, I.encodeBlockHeader
, I.encodeBlockHeaderWithoutHash
, I.decodeBlockHeader
, I.decodeBlockHeaderWithoutHash
, I.decodeBlockHeaderChecked
, I.decodeBlockHeaderCheckedChainId
, I.blockHeaderShortDescription
, I.ObjectEncoded(..)

, I.timeBetween
, I.getAdjacentHash
, I.computeBlockHash
, I.adjacentChainIds
, I.absBlockHeightDiff

-- ** Fork State
, I.isForkEpochStart
, I.forkEpochLength
, I.isForkCountBlock
, I.isForkVoteBlock
, I.newForkState
, I.genesisForkState

-- * IsBlockHeader
, I.IsBlockHeader(..)

-- * Genesis BlockHeader
, I.isGenesisBlockHeader
, I.genesisParentBlockHash
, I.genesisBlockHeader
, I.genesisBlockHeaders
, I.genesisBlockHeadersAtHeight
, I.genesisHeight
, I.headerSizes
, I.headerSizeBytes
, I.workSizeBytes

-- * Create a new BlockHeader
, I.newBlockHeader

-- * CAS Constraint
, I.BlockHeaderCas
)
where

import Chainweb.ForkState (ForkState, ForkVotes, ForkNumber)
import Chainweb.BlockCreationTime (BlockCreationTime)
import Chainweb.BlockHash (BlockHash, BlockHashRecord)
import Chainweb.BlockHeader.Internal qualified as I
import Chainweb.BlockHeight (BlockHeight)
import Chainweb.BlockWeight (BlockWeight)
import Chainweb.ChainId (ChainId)
import Chainweb.Difficulty (HashTarget)
import Chainweb.Payload (BlockPayloadHash)
import Chainweb.Version (ChainwebVersionCode)
import Control.Lens (Getter)

blockFlags :: Getter I.BlockHeader ForkState
blockFlags = I.blockFlags

blockCreationTime :: Getter I.BlockHeader BlockCreationTime
blockCreationTime = I.blockCreationTime

blockParent :: Getter I.BlockHeader BlockHash
blockParent = I.blockParent

blockAdjacentHashes :: Getter I.BlockHeader BlockHashRecord
blockAdjacentHashes = I.blockAdjacentHashes

blockTarget :: Getter I.BlockHeader HashTarget
blockTarget = I.blockTarget

blockPayloadHash :: Getter I.BlockHeader BlockPayloadHash
blockPayloadHash = I.blockPayloadHash

blockChainId :: Getter I.BlockHeader ChainId
blockChainId = I.blockChainId

blockWeight :: Getter I.BlockHeader BlockWeight
blockWeight = I.blockWeight

blockHeight :: Getter I.BlockHeader BlockHeight
blockHeight = I.blockHeight

blockChainwebVersion :: Getter I.BlockHeader ChainwebVersionCode
blockChainwebVersion = I.blockChainwebVersion

blockEpochStart :: Getter I.BlockHeader I.EpochStartTime
blockEpochStart = I.blockEpochStart

blockNonce :: Getter I.BlockHeader I.Nonce
blockNonce = I.blockNonce

blockHash :: Getter I.BlockHeader BlockHash
blockHash = I.blockHash

blockForkState :: Getter I.BlockHeader ForkState
blockForkState = I.blockForkState

blockForkVotes :: Getter I.BlockHeader ForkVotes
blockForkVotes = I.blockForkVotes

blockForkNumber :: Getter I.BlockHeader ForkNumber
blockForkNumber = I.blockForkNumber