Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Node.Configuration.POM

Synopsis

data NodeConfiguration = NodeConfiguration {
- ncSocketConfig :: !SocketConfig
- ncConfigFile :: !ConfigYamlFilePath
- ncTopologyFile :: !TopologyFile
- ncDatabaseFile :: !DbFile
- ncProtocolFiles :: !ProtocolFilepaths
- ncValidateDB :: !Bool
- ncShutdownConfig :: !ShutdownConfig
- ncStartAsNonProducingNode :: !Bool
- ncProtocolConfig :: !NodeProtocolConfiguration
- ncDiffusionMode :: !DiffusionMode
- ncSnapshotInterval :: !SnapshotInterval
- ncExperimentalProtocolsEnabled :: !Bool
- ncMaxConcurrencyBulkSync :: !(Maybe MaxConcurrencyBulkSync)
- ncMaxConcurrencyDeadline :: !(Maybe MaxConcurrencyDeadline)
- ncLoggingSwitch :: !Bool
- ncLogMetrics :: !Bool
- ncTraceConfig :: !TraceOptions
- ncTraceForwardSocket :: !(Maybe (SocketPath, ForwarderMode))
- ncMaybeMempoolCapacityOverride :: !(Maybe MempoolCapacityBytesOverride)
- ncProtocolIdleTimeout :: DiffTime
- ncTimeWaitTimeout :: DiffTime
- ncChainSyncIdleTimeout :: TimeoutOverride
- ncAcceptedConnectionsLimit :: !AcceptedConnectionsLimit
- ncTargetNumberOfRootPeers :: Int
- ncTargetNumberOfKnownPeers :: Int
- ncTargetNumberOfEstablishedPeers :: Int
- ncTargetNumberOfActivePeers :: Int
- ncTargetNumberOfKnownBigLedgerPeers :: Int
- ncTargetNumberOfEstablishedBigLedgerPeers :: Int
- ncTargetNumberOfActiveBigLedgerPeers :: Int
- ncEnableP2P :: SomeNetworkP2PMode
- ncPeerSharing :: PeerSharing
}
data NetworkP2PMode
- = EnabledP2PMode
- | DisabledP2PMode
data SomeNetworkP2PMode where
- SomeNetworkP2PMode :: forall p2p. NetworkP2PMode p2p -> SomeNetworkP2PMode
data PartialNodeConfiguration = PartialNodeConfiguration {
- pncSocketConfig :: !(Last SocketConfig)
- pncConfigFile :: !(Last ConfigYamlFilePath)
- pncTopologyFile :: !(Last TopologyFile)
- pncDatabaseFile :: !(Last DbFile)
- pncProtocolFiles :: !(Last ProtocolFilepaths)
- pncValidateDB :: !(Last Bool)
- pncShutdownConfig :: !(Last ShutdownConfig)
- pncStartAsNonProducingNode :: !(Last Bool)
- pncProtocolConfig :: !(Last NodeProtocolConfiguration)
- pncDiffusionMode :: !(Last DiffusionMode)
- pncSnapshotInterval :: !(Last SnapshotInterval)
- pncExperimentalProtocolsEnabled :: !(Last Bool)
- pncMaxConcurrencyBulkSync :: !(Last MaxConcurrencyBulkSync)
- pncMaxConcurrencyDeadline :: !(Last MaxConcurrencyDeadline)
- pncLoggingSwitch :: !(Last Bool)
- pncLogMetrics :: !(Last Bool)
- pncTraceConfig :: !(Last PartialTraceOptions)
- pncTraceForwardSocket :: !(Last (SocketPath, ForwarderMode))
- pncMaybeMempoolCapacityOverride :: !(Last MempoolCapacityBytesOverride)
- pncProtocolIdleTimeout :: !(Last DiffTime)
- pncTimeWaitTimeout :: !(Last DiffTime)
- pncChainSyncIdleTimeout :: !(Last DiffTime)
- pncAcceptedConnectionsLimit :: !(Last AcceptedConnectionsLimit)
- pncTargetNumberOfRootPeers :: !(Last Int)
- pncTargetNumberOfKnownPeers :: !(Last Int)
- pncTargetNumberOfEstablishedPeers :: !(Last Int)
- pncTargetNumberOfActivePeers :: !(Last Int)
- pncTargetNumberOfKnownBigLedgerPeers :: !(Last Int)
- pncTargetNumberOfEstablishedBigLedgerPeers :: !(Last Int)
- pncTargetNumberOfActiveBigLedgerPeers :: !(Last Int)
- pncEnableP2P :: !(Last NetworkP2PMode)
- pncPeerSharing :: !(Last PeerSharing)
}
data TimeoutOverride
- = NoTimeoutOverride
- | TimeoutOverride DiffTime
defaultPartialNodeConfiguration :: PartialNodeConfiguration
lastOption :: Parser a -> Parser (Last a)
makeNodeConfiguration :: PartialNodeConfiguration -> Either String NodeConfiguration
parseNodeConfigurationFP :: Maybe ConfigYamlFilePath -> IO PartialNodeConfiguration
pncProtocol :: PartialNodeConfiguration -> Either Text Protocol
ncProtocol :: NodeConfiguration -> Protocol

Documentation

data NodeConfiguration Source #

Constructors

NodeConfiguration

Fields

ncSocketConfig :: !SocketConfig
ncConfigFile :: !ConfigYamlFilePath
Filepath of the configuration yaml file. This file determines all the configuration settings required for the cardano node (logging, tracing, protocol, slot length etc)
ncTopologyFile :: !TopologyFile
ncDatabaseFile :: !DbFile
ncProtocolFiles :: !ProtocolFilepaths
ncValidateDB :: !Bool
ncShutdownConfig :: !ShutdownConfig
ncStartAsNonProducingNode :: !Bool
ncProtocolConfig :: !NodeProtocolConfiguration
ncDiffusionMode :: !DiffusionMode
ncSnapshotInterval :: !SnapshotInterval
ncExperimentalProtocolsEnabled :: !Bool
During the development and integration of new network protocols (node-to-node and node-to-client) we wish to be able to test them but not have everybody use them by default on the mainnet. Avoiding enabling them by default makes it practical to include such not-yet-ready protocol versions into released versions of the node without the danger that node operators on the mainnet will start using them prematurely, before the testing is complete.
The flag defaults to False
This flag should be set to True when testing the new protocol versions.
ncMaxConcurrencyBulkSync :: !(Maybe MaxConcurrencyBulkSync)
ncMaxConcurrencyDeadline :: !(Maybe MaxConcurrencyDeadline)
ncLoggingSwitch :: !Bool
ncLogMetrics :: !Bool
ncTraceConfig :: !TraceOptions
ncTraceForwardSocket :: !(Maybe (SocketPath, ForwarderMode))
ncMaybeMempoolCapacityOverride :: !(Maybe MempoolCapacityBytesOverride)
ncProtocolIdleTimeout :: DiffTime
Protocol idleness timeout, see daProtocolIdleTimeout.
ncTimeWaitTimeout :: DiffTime
Wait time timeout, see daTimeWaitTimeout.
ncChainSyncIdleTimeout :: TimeoutOverride
Timeout override for ChainSync, see ChainSyncTimeout
ncAcceptedConnectionsLimit :: !AcceptedConnectionsLimit
Node AcceptedConnectionsLimit
ncTargetNumberOfRootPeers :: Int
ncTargetNumberOfKnownPeers :: Int
ncTargetNumberOfEstablishedPeers :: Int
ncTargetNumberOfActivePeers :: Int
ncTargetNumberOfKnownBigLedgerPeers :: Int
ncTargetNumberOfEstablishedBigLedgerPeers :: Int
ncTargetNumberOfActiveBigLedgerPeers :: Int
ncEnableP2P :: SomeNetworkP2PMode
ncPeerSharing :: PeerSharing

Instances

Instances details

Show NodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods showsPrec :: Int -> NodeConfiguration -> ShowS Source # show :: NodeConfiguration -> String Source # showList :: [NodeConfiguration] -> ShowS Source #
Eq NodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods (==) :: NodeConfiguration -> NodeConfiguration -> Bool Source # (/=) :: NodeConfiguration -> NodeConfiguration -> Bool Source #

data NetworkP2PMode Source #

Constructors

EnabledP2PMode
DisabledP2PMode

Instances

Instances details

Generic NetworkP2PMode Source #
Instance details Defined in Cardano.Node.Configuration.POM Associated Types type Rep NetworkP2PMode :: Type -> Type Source # Methods from :: NetworkP2PMode -> Rep NetworkP2PMode x Source # to :: Rep NetworkP2PMode x -> NetworkP2PMode Source #
Show NetworkP2PMode Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods showsPrec :: Int -> NetworkP2PMode -> ShowS Source # show :: NetworkP2PMode -> String Source # showList :: [NetworkP2PMode] -> ShowS Source #
Eq NetworkP2PMode Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods (==) :: NetworkP2PMode -> NetworkP2PMode -> Bool Source # (/=) :: NetworkP2PMode -> NetworkP2PMode -> Bool Source #
type Rep NetworkP2PMode Source #
Instance details Defined in Cardano.Node.Configuration.POM type Rep NetworkP2PMode = D1 ('MetaData "NetworkP2PMode" "Cardano.Node.Configuration.POM" "cardano-node-8.8.1-inplace" 'False) (C1 ('MetaCons "EnabledP2PMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DisabledP2PMode" 'PrefixI 'False) (U1 :: Type -> Type))

data SomeNetworkP2PMode where Source #

Constructors

SomeNetworkP2PMode :: forall p2p. NetworkP2PMode p2p -> SomeNetworkP2PMode

Instances

Instances details

Show SomeNetworkP2PMode Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods showsPrec :: Int -> SomeNetworkP2PMode -> ShowS Source # show :: SomeNetworkP2PMode -> String Source # showList :: [SomeNetworkP2PMode] -> ShowS Source #
Eq SomeNetworkP2PMode Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods (==) :: SomeNetworkP2PMode -> SomeNetworkP2PMode -> Bool Source # (/=) :: SomeNetworkP2PMode -> SomeNetworkP2PMode -> Bool Source #

data PartialNodeConfiguration Source #

Constructors

PartialNodeConfiguration

Fields

pncSocketConfig :: !(Last SocketConfig)
pncConfigFile :: !(Last ConfigYamlFilePath)
Filepath of the configuration yaml file. This file determines all the configuration settings required for the cardano node (logging, tracing, protocol, slot length etc)
pncTopologyFile :: !(Last TopologyFile)
pncDatabaseFile :: !(Last DbFile)
pncProtocolFiles :: !(Last ProtocolFilepaths)
pncValidateDB :: !(Last Bool)
pncShutdownConfig :: !(Last ShutdownConfig)
pncStartAsNonProducingNode :: !(Last Bool)
pncProtocolConfig :: !(Last NodeProtocolConfiguration)
pncDiffusionMode :: !(Last DiffusionMode)
pncSnapshotInterval :: !(Last SnapshotInterval)
pncExperimentalProtocolsEnabled :: !(Last Bool)
pncMaxConcurrencyBulkSync :: !(Last MaxConcurrencyBulkSync)
pncMaxConcurrencyDeadline :: !(Last MaxConcurrencyDeadline)
pncLoggingSwitch :: !(Last Bool)
pncLogMetrics :: !(Last Bool)
pncTraceConfig :: !(Last PartialTraceOptions)
pncTraceForwardSocket :: !(Last (SocketPath, ForwarderMode))
pncMaybeMempoolCapacityOverride :: !(Last MempoolCapacityBytesOverride)
pncProtocolIdleTimeout :: !(Last DiffTime)
pncTimeWaitTimeout :: !(Last DiffTime)
pncChainSyncIdleTimeout :: !(Last DiffTime)
pncAcceptedConnectionsLimit :: !(Last AcceptedConnectionsLimit)
pncTargetNumberOfRootPeers :: !(Last Int)
pncTargetNumberOfKnownPeers :: !(Last Int)
pncTargetNumberOfEstablishedPeers :: !(Last Int)
pncTargetNumberOfActivePeers :: !(Last Int)
pncTargetNumberOfKnownBigLedgerPeers :: !(Last Int)
pncTargetNumberOfEstablishedBigLedgerPeers :: !(Last Int)
pncTargetNumberOfActiveBigLedgerPeers :: !(Last Int)
pncEnableP2P :: !(Last NetworkP2PMode)
pncPeerSharing :: !(Last PeerSharing)

Instances

Instances details

FromJSON PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods parseJSON :: Value -> Parser PartialNodeConfiguration # parseJSONList :: Value -> Parser [PartialNodeConfiguration] # omittedField :: Maybe PartialNodeConfiguration #
Semigroup PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods (<>) :: PartialNodeConfiguration -> PartialNodeConfiguration -> PartialNodeConfiguration Source # sconcat :: NonEmpty PartialNodeConfiguration -> PartialNodeConfiguration Source # stimes :: Integral b => b -> PartialNodeConfiguration -> PartialNodeConfiguration Source #
Generic PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Associated Types type Rep PartialNodeConfiguration :: Type -> Type Source # Methods from :: PartialNodeConfiguration -> Rep PartialNodeConfiguration x Source # to :: Rep PartialNodeConfiguration x -> PartialNodeConfiguration Source #
Show PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods showsPrec :: Int -> PartialNodeConfiguration -> ShowS Source # show :: PartialNodeConfiguration -> String Source # showList :: [PartialNodeConfiguration] -> ShowS Source #
AdjustFilePaths PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods adjustFilePaths :: (FilePath -> FilePath) -> PartialNodeConfiguration -> PartialNodeConfiguration Source #
Eq PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods (==) :: PartialNodeConfiguration -> PartialNodeConfiguration -> Bool Source # (/=) :: PartialNodeConfiguration -> PartialNodeConfiguration -> Bool Source #
type Rep PartialNodeConfiguration Source #
Instance details Defined in Cardano.Node.Configuration.POM type Rep PartialNodeConfiguration = D1 ('MetaData "PartialNodeConfiguration" "Cardano.Node.Configuration.POM" "cardano-node-8.8.1-inplace" 'False) (C1 ('MetaCons "PartialNodeConfiguration" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "pncSocketConfig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last SocketConfig)) :: S1 ('MetaSel ('Just "pncConfigFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last ConfigYamlFilePath))) :: (S1 ('MetaSel ('Just "pncTopologyFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last TopologyFile)) :: S1 ('MetaSel ('Just "pncDatabaseFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last DbFile)))) :: ((S1 ('MetaSel ('Just "pncProtocolFiles") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last ProtocolFilepaths)) :: S1 ('MetaSel ('Just "pncValidateDB") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool))) :: (S1 ('MetaSel ('Just "pncShutdownConfig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last ShutdownConfig)) :: S1 ('MetaSel ('Just "pncStartAsNonProducingNode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool))))) :: (((S1 ('MetaSel ('Just "pncProtocolConfig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last NodeProtocolConfiguration)) :: S1 ('MetaSel ('Just "pncDiffusionMode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last DiffusionMode))) :: (S1 ('MetaSel ('Just "pncSnapshotInterval") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last SnapshotInterval)) :: S1 ('MetaSel ('Just "pncExperimentalProtocolsEnabled") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool)))) :: ((S1 ('MetaSel ('Just "pncMaxConcurrencyBulkSync") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last MaxConcurrencyBulkSync)) :: S1 ('MetaSel ('Just "pncMaxConcurrencyDeadline") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last MaxConcurrencyDeadline))) :: (S1 ('MetaSel ('Just "pncLoggingSwitch") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool)) :: S1 ('MetaSel ('Just "pncLogMetrics") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Bool)))))) :: ((((S1 ('MetaSel ('Just "pncTraceConfig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last PartialTraceOptions)) :: S1 ('MetaSel ('Just "pncTraceForwardSocket") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last (SocketPath, ForwarderMode)))) :: (S1 ('MetaSel ('Just "pncMaybeMempoolCapacityOverride") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last MempoolCapacityBytesOverride)) :: S1 ('MetaSel ('Just "pncProtocolIdleTimeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last DiffTime)))) :: ((S1 ('MetaSel ('Just "pncTimeWaitTimeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last DiffTime)) :: S1 ('MetaSel ('Just "pncChainSyncIdleTimeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last DiffTime))) :: (S1 ('MetaSel ('Just "pncAcceptedConnectionsLimit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last AcceptedConnectionsLimit)) :: S1 ('MetaSel ('Just "pncTargetNumberOfRootPeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int))))) :: (((S1 ('MetaSel ('Just "pncTargetNumberOfKnownPeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int)) :: S1 ('MetaSel ('Just "pncTargetNumberOfEstablishedPeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int))) :: (S1 ('MetaSel ('Just "pncTargetNumberOfActivePeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int)) :: S1 ('MetaSel ('Just "pncTargetNumberOfKnownBigLedgerPeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int)))) :: ((S1 ('MetaSel ('Just "pncTargetNumberOfEstablishedBigLedgerPeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int)) :: S1 ('MetaSel ('Just "pncTargetNumberOfActiveBigLedgerPeers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last Int))) :: (S1 ('MetaSel ('Just "pncEnableP2P") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last NetworkP2PMode)) :*: S1 ('MetaSel ('Just "pncPeerSharing") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Last PeerSharing))))))))

data TimeoutOverride Source #

Isomorphic to a `Maybe DiffTime`, but expresses what Nothing means, in this case that we want to NOT override the default timeout.

Constructors

NoTimeoutOverride
TimeoutOverride DiffTime

Instances

Instances details

Show TimeoutOverride Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods showsPrec :: Int -> TimeoutOverride -> ShowS Source # show :: TimeoutOverride -> String Source # showList :: [TimeoutOverride] -> ShowS Source #
Eq TimeoutOverride Source #
Instance details Defined in Cardano.Node.Configuration.POM Methods (==) :: TimeoutOverride -> TimeoutOverride -> Bool Source # (/=) :: TimeoutOverride -> TimeoutOverride -> Bool Source #

defaultPartialNodeConfiguration :: PartialNodeConfiguration Source #

Default configuration is mainnet

lastOption :: Parser a -> Parser (Last a) Source #

makeNodeConfiguration :: PartialNodeConfiguration -> Either String NodeConfiguration Source #

parseNodeConfigurationFP :: Maybe ConfigYamlFilePath -> IO PartialNodeConfiguration Source #

pncProtocol :: PartialNodeConfiguration -> Either Text Protocol Source #

ncProtocol :: NodeConfiguration -> Protocol Source #