cardano-node-1.22.1
Safe HaskellNone
LanguageHaskell2010

Cardano.Node.Types

Synopsis

Configuration

class AdjustFilePaths a where Source #

Methods

adjustFilePaths :: (FilePath -> FilePath) -> a -> a Source #

Instances

Instances details
AdjustFilePaths SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeByronProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeShelleyProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths GenesisFile Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths PartialNodeConfiguration Source # 
Instance details

Defined in Cardano.Node.Configuration.POM

AdjustFilePaths a => AdjustFilePaths (Maybe a) Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths (Last SocketPath) Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths (Last NodeProtocolConfiguration) Source # 
Instance details

Defined in Cardano.Node.Types

newtype ConfigError Source #

Errors for the cardano-config module.

Instances

Instances details
Show ConfigError Source # 
Instance details

Defined in Cardano.Node.Types

newtype ConfigYamlFilePath Source #

Filepath of the configuration yaml file. This file determines all the configuration settings required for the cardano node (logging, tracing, protocol, slot length etc)

Constructors

ConfigYamlFilePath 

newtype DbFile Source #

Constructors

DbFile 

Fields

Instances

Instances details
Eq DbFile Source # 
Instance details

Defined in Cardano.Node.Types

Methods

(==) :: DbFile -> DbFile -> Bool #

(/=) :: DbFile -> DbFile -> Bool #

Show DbFile Source # 
Instance details

Defined in Cardano.Node.Types

Node addresses

data NodeAddress' addr Source #

IPv4 or IPv6 address with a port number.

Constructors

NodeAddress 

Fields

Instances

Instances details
Functor NodeAddress' Source # 
Instance details

Defined in Cardano.Node.Types

Methods

fmap :: (a -> b) -> NodeAddress' a -> NodeAddress' b #

(<$) :: a -> NodeAddress' b -> NodeAddress' a #

Eq addr => Eq (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

(==) :: NodeAddress' addr -> NodeAddress' addr -> Bool #

(/=) :: NodeAddress' addr -> NodeAddress' addr -> Bool #

Ord addr => Ord (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

compare :: NodeAddress' addr -> NodeAddress' addr -> Ordering #

(<) :: NodeAddress' addr -> NodeAddress' addr -> Bool #

(<=) :: NodeAddress' addr -> NodeAddress' addr -> Bool #

(>) :: NodeAddress' addr -> NodeAddress' addr -> Bool #

(>=) :: NodeAddress' addr -> NodeAddress' addr -> Bool #

max :: NodeAddress' addr -> NodeAddress' addr -> NodeAddress' addr #

min :: NodeAddress' addr -> NodeAddress' addr -> NodeAddress' addr #

Show addr => Show (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

showsPrec :: Int -> NodeAddress' addr -> ShowS #

show :: NodeAddress' addr -> String #

showList :: [NodeAddress' addr] -> ShowS #

ToJSON addr => ToJSON (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

FromJSON addr => FromJSON (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

newtype NodeHostIPAddress Source #

Constructors

NodeHostIPAddress 

newtype NodeHostIPv4Address Source #

Instances

Instances details
Eq NodeHostIPv4Address Source # 
Instance details

Defined in Cardano.Node.Types

Ord NodeHostIPv4Address Source # 
Instance details

Defined in Cardano.Node.Types

Show NodeHostIPv4Address Source # 
Instance details

Defined in Cardano.Node.Types

ToJSON NodeHostIPv4Address Source # 
Instance details

Defined in Cardano.Node.Types

FromJSON NodeHostIPv4Address Source # 
Instance details

Defined in Cardano.Node.Types

newtype NodeHostIPv6Address Source #

Instances

Instances details
Eq NodeHostIPv6Address Source # 
Instance details

Defined in Cardano.Node.Types

Ord NodeHostIPv6Address Source # 
Instance details

Defined in Cardano.Node.Types

Show NodeHostIPv6Address Source # 
Instance details

Defined in Cardano.Node.Types

ToJSON NodeHostIPv6Address Source # 
Instance details

Defined in Cardano.Node.Types

FromJSON NodeHostIPv6Address Source # 
Instance details

Defined in Cardano.Node.Types

data PortNumber Source #

Port number. Use the Num instance (i.e. use a literal) to create a PortNumber value.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1
>>> show (12345 :: PortNumber)
"12345"
>>> 50000 < (51000 :: PortNumber)
True
>>> 50000 < (52000 :: PortNumber)
True
>>> 50000 + (10000 :: PortNumber)
60000

Instances

Instances details
Bounded PortNumber 
Instance details

Defined in Network.Socket.Types

Enum PortNumber 
Instance details

Defined in Network.Socket.Types

Eq PortNumber 
Instance details

Defined in Network.Socket.Types

Integral PortNumber 
Instance details

Defined in Network.Socket.Types

Num PortNumber 
Instance details

Defined in Network.Socket.Types

Ord PortNumber 
Instance details

Defined in Network.Socket.Types

Read PortNumber 
Instance details

Defined in Network.Socket.Types

Real PortNumber 
Instance details

Defined in Network.Socket.Types

Show PortNumber 
Instance details

Defined in Network.Socket.Types

FromJSON PortNumber Source # 
Instance details

Defined in Cardano.Tracing.OrphanInstances.Common

Storable PortNumber 
Instance details

Defined in Network.Socket.Types

newtype SocketPath Source #

Constructors

SocketPath 

newtype TopologyFile Source #

Constructors

TopologyFile 

Fields

Instances

Instances details
Eq TopologyFile Source # 
Instance details

Defined in Cardano.Node.Types

Show TopologyFile Source # 
Instance details

Defined in Cardano.Node.Types

newtype NodeDiffusionMode Source #

Newtype wrapper which provides FromJSON instance for DiffusionMode.

Constructors

NodeDiffusionMode 

Fields

Consensus protocol configuration

data NodeByronProtocolConfiguration Source #

Constructors

NodeByronProtocolConfiguration 

Fields

data NodeHardForkProtocolConfiguration Source #

Configuration relating to a hard forks themselves, not the specific eras.

Constructors

NodeHardForkProtocolConfiguration 

Fields

  • npcShelleyHardForkNotBeforeEpoch :: Maybe EpochNo

    If we have knowledge about when the Shelley hard fork is then we have an opportunity to optimise the bulk sync slightly.

  • npcTestShelleyHardForkAtEpoch :: Maybe EpochNo

    For testing purposes we support specifying that the hard fork happens at an exact epoch number (ie the first epoch of the new era).

    Obviously if this is used, all the nodes in the test cluster must be configured the same, or they will disagree.

  • npcTestShelleyHardForkAtVersion :: Maybe Word

    For testing purposes we support specifying that the hard fork happens at a given major protocol version. For example this can be used to cause the Shelley hard fork to occur at the transition from protocol version 0 to version 1 (rather than the default of from 1 to 2) which can make the test setup simpler.

    Obviously if this is used, all the nodes in the test cluster must be configured the same, or they will disagree.

  • npcAllegraHardForkNotBeforeEpoch :: Maybe EpochNo

    If we have knowledge about when the Allegra hard fork is then we have an opportunity to optimise the bulk sync slightly.

  • npcTestAllegraHardForkAtEpoch :: Maybe EpochNo

    For testing purposes we support specifying that the hard fork happens at an exact epoch number (ie the first epoch of the new era).

    Obviously if this is used, all the nodes in the test cluster must be configured the same, or they will disagree.

  • npcTestAllegraHardForkAtVersion :: Maybe Word

    For testing purposes we support specifying that the hard fork happens at a given major protocol version.

    Obviously if this is used, all the nodes in the test cluster must be configured the same, or they will disagree.

  • npcTestMaryHardForkAtEpoch :: Maybe EpochNo

    For testing purposes we support specifying that the hard fork happens at an exact epoch number (ie the first epoch of the new era).

    Obviously if this is used, all the nodes in the test cluster must be configured the same, or they will disagree.

  • npcTestMaryHardForkAtVersion :: Maybe Word

    For testing purposes we support specifying that the hard fork happens at an exact epoch number (ie the first epoch of the new era).

    Obviously if this is used, all the nodes in the test cluster must be configured the same, or they will disagree.

  • npcMaryHardForkNotBeforeEpoch :: Maybe EpochNo

    If we have knowledge about when the Shelley hard fork is then we have an opportunity to optimise the bulk sync slightly.

data NodeShelleyProtocolConfiguration Source #

Constructors

NodeShelleyProtocolConfiguration 

Fields

protocolName :: Protocol -> String Source #

A human readable name for the protocol