-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1184 from input-output-hk/abailly-iohk/explain-co…
…nfiguration-errors Explain configuration errors
- Loading branch information
Showing
5 changed files
with
153 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| {-# LANGUAGE DuplicateRecordFields #-} | ||
|
|
||
| module Hydra.Node.Run where | ||
|
|
||
| import Hydra.Prelude hiding (fromList) | ||
|
|
||
| import Hydra.API.Server (Server (..), withAPIServer) | ||
| import Hydra.API.ServerOutput (ServerOutput (..)) | ||
| import Hydra.Cardano.Api ( | ||
| ProtocolParametersConversionError, | ||
| ShelleyBasedEra (..), | ||
| toLedgerPParams, | ||
| ) | ||
| import Hydra.Chain (maximumNumberOfParties) | ||
| import Hydra.Chain.CardanoClient (QueryPoint (..), queryGenesisParameters) | ||
| import Hydra.Chain.Direct (loadChainContext, mkTinyWallet, withDirectChain) | ||
| import Hydra.Chain.Direct.State (initialChainState) | ||
| import Hydra.HeadLogic ( | ||
| Environment (..), | ||
| Event (..), | ||
| defaultTTL, | ||
| ) | ||
| import Hydra.Ledger.Cardano qualified as Ledger | ||
| import Hydra.Ledger.Cardano.Configuration ( | ||
| newGlobals, | ||
| newLedgerEnv, | ||
| protocolParametersFromJson, | ||
| readJsonFileThrow, | ||
| ) | ||
| import Hydra.Logging (Verbosity (..), traceWith, withTracer) | ||
| import Hydra.Logging.Messages (HydraLog (..)) | ||
| import Hydra.Logging.Monitoring (withMonitoring) | ||
| import Hydra.Network.Authenticate (Authenticated (Authenticated)) | ||
| import Hydra.Network.Message (Connectivity (..)) | ||
| import Hydra.Node ( | ||
| HydraNode (..), | ||
| checkHeadState, | ||
| createNodeState, | ||
| initEnvironment, | ||
| loadState, | ||
| runHydraNode, | ||
| ) | ||
| import Hydra.Node.EventQueue (EventQueue (..), createEventQueue) | ||
| import Hydra.Node.Network (NetworkConfiguration (..), withNetwork) | ||
| import Hydra.Options ( | ||
| ChainConfig (..), | ||
| InvalidOptions (..), | ||
| LedgerConfig (..), | ||
| RunOptions (..), | ||
| validateRunOptions, | ||
| ) | ||
| import Hydra.Persistence (createPersistenceIncremental) | ||
|
|
||
| data ConfigurationException | ||
| = ConfigurationException ProtocolParametersConversionError | ||
| | InvalidOptionException InvalidOptions | ||
| deriving stock (Show) | ||
| deriving anyclass (Exception) | ||
|
|
||
| explain :: ConfigurationException -> String | ||
| explain = \case | ||
| InvalidOptionException MaximumNumberOfPartiesExceeded -> | ||
| "Maximum number of parties is currently set to: " <> show maximumNumberOfParties | ||
| InvalidOptionException CardanoAndHydraKeysMissmatch -> | ||
| "Number of loaded cardano and hydra keys needs to match" | ||
| ConfigurationException err -> | ||
| "Incorrect protocol parameters configuration provided: " <> show err | ||
|
|
||
| run :: RunOptions -> IO () | ||
| run opts = do | ||
| either (throwIO . InvalidOptionException) pure $ validateRunOptions opts | ||
| let RunOptions{verbosity, monitoringPort, persistenceDir} = opts | ||
| env@Environment{party, otherParties, signingKey} <- initEnvironment opts | ||
| withTracer verbosity $ \tracer' -> | ||
| withMonitoring monitoringPort tracer' $ \tracer -> do | ||
| traceWith tracer (NodeOptions opts) | ||
| eq@EventQueue{putEvent} <- createEventQueue | ||
| let RunOptions{hydraScriptsTxId, chainConfig, ledgerConfig} = opts | ||
| protocolParams <- readJsonFileThrow protocolParametersFromJson (cardanoLedgerProtocolParametersFile ledgerConfig) | ||
| pparams <- case toLedgerPParams ShelleyBasedEraBabbage protocolParams of | ||
| Left err -> throwIO (ConfigurationException err) | ||
| Right bpparams -> pure bpparams | ||
| withCardanoLedger chainConfig pparams $ \ledger -> do | ||
| persistence <- createPersistenceIncremental $ persistenceDir <> "/state" | ||
| (hs, chainStateHistory) <- loadState (contramap Node tracer) persistence initialChainState | ||
| checkHeadState (contramap Node tracer) env hs | ||
| nodeState <- createNodeState hs | ||
| -- Chain | ||
| ctx <- loadChainContext chainConfig party otherParties hydraScriptsTxId | ||
| wallet <- mkTinyWallet (contramap DirectChain tracer) chainConfig | ||
| withDirectChain (contramap DirectChain tracer) chainConfig ctx wallet chainStateHistory (putEvent . OnChainEvent) $ \chain -> do | ||
| -- API | ||
| let RunOptions{host, port, peers, nodeId} = opts | ||
| putNetworkEvent (Authenticated msg otherParty) = putEvent $ NetworkEvent defaultTTL otherParty msg | ||
| RunOptions{apiHost, apiPort} = opts | ||
| apiPersistence <- createPersistenceIncremental $ persistenceDir <> "/server-output" | ||
| withAPIServer apiHost apiPort party apiPersistence (contramap APIServer tracer) chain pparams (putEvent . ClientEvent) $ \server -> do | ||
| -- Network | ||
| let networkConfiguration = NetworkConfiguration{persistenceDir, signingKey, otherParties, host, port, peers, nodeId} | ||
| withNetwork tracer (connectionMessages server) networkConfiguration putNetworkEvent $ \hn -> do | ||
| -- Main loop | ||
| runHydraNode (contramap Node tracer) $ | ||
| HydraNode | ||
| { eq | ||
| , hn | ||
| , nodeState | ||
| , oc = chain | ||
| , server | ||
| , ledger | ||
| , env | ||
| , persistence | ||
| } | ||
| where | ||
| connectionMessages Server{sendOutput} = \case | ||
| Connected nodeid -> sendOutput $ PeerConnected nodeid | ||
| Disconnected nodeid -> sendOutput $ PeerDisconnected nodeid | ||
|
|
||
| withCardanoLedger chainConfig protocolParams action = do | ||
| let DirectChainConfig{networkId, nodeSocket} = chainConfig | ||
| globals <- newGlobals =<< queryGenesisParameters networkId nodeSocket QueryTip | ||
| let ledgerEnv = newLedgerEnv protocolParams | ||
| action (Ledger.cardanoLedger globals ledgerEnv) | ||
|
|
||
| identifyNode :: RunOptions -> RunOptions | ||
| identifyNode opt@RunOptions{verbosity = Verbose "HydraNode", nodeId} = opt{verbosity = Verbose $ "HydraNode-" <> show nodeId} | ||
| identifyNode opt = opt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| module Hydra.Node.RunSpec where | ||
|
|
||
| import Hydra.Node.Run (ConfigurationException, run) | ||
| import Hydra.Options (ChainConfig (..), RunOptions (..), defaultRunOptions, genFilePath) | ||
| import Hydra.Prelude | ||
| import Test.Hydra.Prelude | ||
| import Test.QuickCheck (generate) | ||
|
|
||
| spec :: Spec | ||
| spec = | ||
| it "throws exception given options are invalid" $ do | ||
| cardanoKeys <- generate $ replicateM 1 (genFilePath "vk") | ||
| hydraVerificationKeys <- generate $ replicateM 2 (genFilePath "vk") | ||
| let chainConfiguration = (chainConfig defaultRunOptions){cardanoVerificationKeys = cardanoKeys} | ||
| options = defaultRunOptions{chainConfig = chainConfiguration, hydraVerificationKeys} | ||
|
|
||
| run options `shouldThrow` aConfigurationException | ||
|
|
||
| aConfigurationException :: Selector ConfigurationException | ||
| aConfigurationException = const True |