-
Notifications
You must be signed in to change notification settings - Fork 721
/
Byron.hs
209 lines (179 loc) · 8.38 KB
/
Byron.hs
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
{-# LANGUAGE NamedFieldPuns #-}
module Cardano.Node.Protocol.Byron
( mkSomeConsensusProtocolByron
-- * Errors
, ByronProtocolInstantiationError(..)
-- * Reusable parts
, readGenesis
, readLeaderCredentials
) where
import Cardano.Prelude
import Control.Monad.Trans.Except.Extra (bimapExceptT, firstExceptT, hoistEither,
hoistMaybe, left)
import qualified Data.ByteString.Lazy as LB
import qualified Data.Text as Text
import Cardano.Api.Byron
import qualified Cardano.Api.Protocol.Types as Protocol
import qualified Cardano.Crypto.Hash as Crypto
import qualified Cardano.Crypto.Hashing as Byron.Crypto
import qualified Cardano.Chain.Genesis as Genesis
import qualified Cardano.Chain.UTxO as UTxO
import qualified Cardano.Chain.Update as Update
import Cardano.Crypto.ProtocolMagic (RequiresNetworkMagic)
import Ouroboros.Consensus.Cardano
import qualified Ouroboros.Consensus.Cardano as Consensus
import qualified Ouroboros.Consensus.Mempool.TxLimits as TxLimits
import Cardano.Node.Types
import Cardano.Node.Protocol.Types
import Cardano.Tracing.OrphanInstances.Byron ()
import Cardano.Tracing.OrphanInstances.HardFork ()
import Cardano.Tracing.OrphanInstances.Shelley ()
import Cardano.TraceDispatcher.Era.Byron ()
import Cardano.TraceDispatcher.Era.HardFork ()
import Cardano.TraceDispatcher.ChainDB.Formatting ()
------------------------------------------------------------------------------
-- Byron protocol
--
-- | Make 'SomeConsensusProtocol' using the Byron instance.
--
-- This lets us handle multiple protocols in a generic way.
--
-- This also serves a purpose as a sanity check that we have all the necessary
-- type class instances available.
--
mkSomeConsensusProtocolByron
:: NodeByronProtocolConfiguration
-> Maybe ProtocolFilepaths
-> ExceptT ByronProtocolInstantiationError IO SomeConsensusProtocol
mkSomeConsensusProtocolByron NodeByronProtocolConfiguration {
npcByronGenesisFile,
npcByronGenesisFileHash,
npcByronReqNetworkMagic,
npcByronPbftSignatureThresh,
npcByronApplicationName,
npcByronApplicationVersion,
npcByronSupportedProtocolVersionMajor,
npcByronSupportedProtocolVersionMinor,
npcByronSupportedProtocolVersionAlt
}
files = do
genesisConfig <- readGenesis npcByronGenesisFile
npcByronGenesisFileHash
npcByronReqNetworkMagic
optionalLeaderCredentials <- readLeaderCredentials genesisConfig files
return $ SomeConsensusProtocol Protocol.ByronBlockType $ Protocol.ProtocolInfoArgsByron $ Consensus.ProtocolParamsByron {
byronGenesis = genesisConfig,
byronPbftSignatureThreshold =
PBftSignatureThreshold <$> npcByronPbftSignatureThresh,
byronProtocolVersion =
Update.ProtocolVersion
npcByronSupportedProtocolVersionMajor
npcByronSupportedProtocolVersionMinor
npcByronSupportedProtocolVersionAlt,
byronSoftwareVersion =
Update.SoftwareVersion
npcByronApplicationName
npcByronApplicationVersion,
byronLeaderCredentials =
optionalLeaderCredentials,
byronMaxTxCapacityOverrides =
TxLimits.mkOverrides TxLimits.noOverridesMeasure
}
readGenesis :: GenesisFile
-> Maybe GenesisHash
-> RequiresNetworkMagic
-> ExceptT ByronProtocolInstantiationError IO
Genesis.Config
readGenesis (GenesisFile file) mbExpectedGenesisHash ncReqNetworkMagic = do
(genesisData, genesisHash) <- firstExceptT (GenesisReadError file) $
Genesis.readGenesisData file
checkExpectedGenesisHash genesisHash
return Genesis.Config {
Genesis.configGenesisData = genesisData,
Genesis.configGenesisHash = genesisHash,
Genesis.configReqNetMagic = ncReqNetworkMagic,
Genesis.configUTxOConfiguration = UTxO.defaultUTxOConfiguration
--TODO: add config support for the UTxOConfiguration if needed
}
where
checkExpectedGenesisHash :: Genesis.GenesisHash
-> ExceptT ByronProtocolInstantiationError IO ()
checkExpectedGenesisHash actual' =
case mbExpectedGenesisHash of
Just expected | actual /= expected ->
throwError (GenesisHashMismatch actual expected)
where
actual = fromByronGenesisHash actual'
_ -> return ()
fromByronGenesisHash :: Genesis.GenesisHash -> GenesisHash
fromByronGenesisHash (Genesis.GenesisHash h) =
GenesisHash
. fromMaybe impossible
. Crypto.hashFromBytes
. Byron.Crypto.hashToBytes
$ h
where
impossible =
panic "fromByronGenesisHash: old and new crypto libs disagree on hash size"
readLeaderCredentials :: Genesis.Config
-> Maybe ProtocolFilepaths
-> ExceptT ByronProtocolInstantiationError IO
(Maybe ByronLeaderCredentials)
readLeaderCredentials _ Nothing = return Nothing
readLeaderCredentials genesisConfig
(Just ProtocolFilepaths {
byronCertFile,
byronKeyFile
}) =
case (byronCertFile, byronKeyFile) of
(Nothing, Nothing) -> pure Nothing
(Just _, Nothing) -> left SigningKeyFilepathNotSpecified
(Nothing, Just _) -> left DelegationCertificateFilepathNotSpecified
(Just delegCertFile, Just signingKeyFile) -> do
signingKeyFileBytes <- liftIO $ LB.readFile signingKeyFile
delegCertFileBytes <- liftIO $ LB.readFile delegCertFile
ByronSigningKey signingKey <- hoistMaybe (SigningKeyDeserialiseFailure signingKeyFile)
$ deserialiseFromRawBytes (AsSigningKey AsByronKey) $ LB.toStrict signingKeyFileBytes
delegCert <- firstExceptT (CanonicalDecodeFailure delegCertFile)
. hoistEither
$ canonicalDecodePretty delegCertFileBytes
bimapExceptT CredentialsError Just
. hoistEither
$ mkByronLeaderCredentials genesisConfig signingKey delegCert "Byron"
------------------------------------------------------------------------------
-- Byron Errors
--
data ByronProtocolInstantiationError =
CanonicalDecodeFailure !FilePath !Text
| GenesisHashMismatch !GenesisHash !GenesisHash -- actual, expected
| DelegationCertificateFilepathNotSpecified
| GenesisConfigurationError !FilePath !Genesis.ConfigurationError
| GenesisReadError !FilePath !Genesis.GenesisDataError
| CredentialsError !ByronLeaderCredentialsError
| SigningKeyDeserialiseFailure !FilePath
| SigningKeyFilepathNotSpecified
deriving Show
instance Error ByronProtocolInstantiationError where
displayError (CanonicalDecodeFailure fp failure) =
"Canonical decode failure in " <> fp
<> " Canonical failure: " <> Text.unpack failure
displayError (GenesisHashMismatch actual expected) =
"Wrong Byron genesis file: the actual hash is " <> show actual
<> ", but the expected Byron genesis hash given in the node configuration "
<> "file is " <> show expected
displayError DelegationCertificateFilepathNotSpecified =
"Delegation certificate filepath not specified"
--TODO: Implement configuration error render function in cardano-ledger
displayError (GenesisConfigurationError fp genesisConfigError) =
"Genesis configuration error in: " <> toS fp
<> " Error: " <> show genesisConfigError
displayError (GenesisReadError fp err) =
"There was an error parsing the genesis file: " <> toS fp
<> " Error: " <> show err
-- TODO: Implement ByronLeaderCredentialsError render function in ouroboros-network
displayError (CredentialsError byronLeaderCredentialsError) =
"Byron leader credentials error: " <> show byronLeaderCredentialsError
displayError (SigningKeyDeserialiseFailure fp) =
"Signing key deserialisation error in: " <> toS fp
displayError SigningKeyFilepathNotSpecified =
"Signing key filepath not specified"