cardano-node-1.30.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Node.Types

Synopsis

Configuration

class AdjustFilePaths a where Source #

Methods

adjustFilePaths ∷ (FilePathFilePath) → 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 NodeAlonzoProtocolConfiguration 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

Methods

adjustFilePaths ∷ (FilePathFilePath) → Maybe a → Maybe a Source #

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

(==)DbFileDbFileBool Source #

(/=)DbFileDbFileBool Source #

Show DbFile Source # 
Instance details

Defined in Cardano.Node.Types

newtype GenesisHash Source #

Constructors

GenesisHash (Hash Blake2b_256 ByteString) 

Instances

Instances details
Eq GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

Show GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

ToJSON GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

Methods

toJSONGenesisHash → Value #

toEncodingGenesisHash → Encoding #

toJSONList ∷ [GenesisHash] → Value #

toEncodingList ∷ [GenesisHash] → Encoding #

FromJSON GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser GenesisHash #

parseJSONList ∷ Value → Parser [GenesisHash] #

newtype MaxConcurrencyBulkSync Source #

newtype MaxConcurrencyDeadline Source #

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 Source #

(<$) ∷ a → NodeAddress' b → NodeAddress' a Source #

Eq addr ⇒ Eq (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

(==)NodeAddress' addr → NodeAddress' addr → Bool Source #

(/=)NodeAddress' addr → NodeAddress' addr → Bool Source #

Ord addr ⇒ Ord (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

compareNodeAddress' addr → NodeAddress' addr → Ordering Source #

(<)NodeAddress' addr → NodeAddress' addr → Bool Source #

(<=)NodeAddress' addr → NodeAddress' addr → Bool Source #

(>)NodeAddress' addr → NodeAddress' addr → Bool Source #

(>=)NodeAddress' addr → NodeAddress' addr → Bool Source #

maxNodeAddress' addr → NodeAddress' addr → NodeAddress' addr Source #

minNodeAddress' addr → NodeAddress' addr → NodeAddress' addr Source #

Show addr ⇒ Show (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

showsPrecIntNodeAddress' addr → ShowS Source #

showNodeAddress' addr → String Source #

showList ∷ [NodeAddress' addr] → ShowS Source #

ToJSON addr ⇒ ToJSON (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

toJSONNodeAddress' addr → Value #

toEncodingNodeAddress' addr → Encoding #

toJSONList ∷ [NodeAddress' addr] → Value #

toEncodingList ∷ [NodeAddress' addr] → Encoding #

FromJSON addr ⇒ FromJSON (NodeAddress' addr) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser (NodeAddress' addr) #

parseJSONList ∷ Value → Parser [NodeAddress' addr] #

newtype NodeHostIPAddress Source #

Constructors

NodeHostIPAddress 

Fields

Instances

Instances details
Eq NodeHostIPAddress Source # 
Instance details

Defined in Cardano.Node.Types

Ord NodeHostIPAddress Source # 
Instance details

Defined in Cardano.Node.Types

Show NodeHostIPAddress Source # 
Instance details

Defined in Cardano.Node.Types

ToJSON NodeHostIPAddress Source # 
Instance details

Defined in Cardano.Node.Types

Methods

toJSONNodeHostIPAddress → Value #

toEncodingNodeHostIPAddress → Encoding #

toJSONList ∷ [NodeHostIPAddress] → Value #

toEncodingList ∷ [NodeHostIPAddress] → Encoding #

FromJSON NodeHostIPAddress Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser NodeHostIPAddress #

parseJSONList ∷ Value → Parser [NodeHostIPAddress] #

newtype NodeHostIPv4Address Source #

Constructors

NodeHostIPv4Address 

Fields

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

Methods

toJSONNodeHostIPv4Address → Value #

toEncodingNodeHostIPv4Address → Encoding #

toJSONList ∷ [NodeHostIPv4Address] → Value #

toEncodingList ∷ [NodeHostIPv4Address] → Encoding #

FromJSON NodeHostIPv4Address Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser NodeHostIPv4Address #

parseJSONList ∷ Value → Parser [NodeHostIPv4Address] #

newtype NodeHostIPv6Address Source #

Constructors

NodeHostIPv6Address 

Fields

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

Methods

toJSONNodeHostIPv6Address → Value #

toEncodingNodeHostIPv6Address → Encoding #

toJSONList ∷ [NodeHostIPv6Address] → Value #

toEncodingList ∷ [NodeHostIPv6Address] → Encoding #

FromJSON NodeHostIPv6Address Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser NodeHostIPv6Address #

parseJSONList ∷ Value → Parser [NodeHostIPv6Address] #

data PortNumber #

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

Storable PortNumber 
Instance details

Defined in Network.Socket.Types

FromJSON PortNumber Source # 
Instance details

Defined in Cardano.Tracing.OrphanInstances.Common

Methods

parseJSON ∷ Value → Parser PortNumber #

parseJSONList ∷ Value → Parser [PortNumber] #

newtype SocketPath Source #

Constructors

SocketPath 

Instances

Instances details
Eq SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

Ord SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

Show SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

IsString SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

FromJSON SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser SocketPath #

parseJSONList ∷ Value → Parser [SocketPath] #

AdjustFilePaths SocketPath Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths (Last SocketPath) Source # 
Instance details

Defined in Cardano.Node.Types

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

Instances

Instances details
Show NodeDiffusionMode Source # 
Instance details

Defined in Cardano.Node.Types

FromJSON NodeDiffusionMode Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser NodeDiffusionMode #

parseJSONList ∷ Value → Parser [NodeDiffusionMode] #

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

  • npcTestEnableDevelopmentHardForkErasBool

    During the development and integration of new eras we wish to be able to test the hard fork transition into the new era, but we do not wish to generally have the node advertise that it understands the new era. Avoiding advertising new development eras until they are ready makes it practical to include new not-yet-ready eras into the main release version of the node without the danger that operators on the mainnet will prematurely advertise that their nodes are capable of crossing the next hard fork.

    It should always remain at the default of false for nodes running on the mainnet.

    This flag should be set to true for nodes taking part in testnets for testing the new era.

  • npcTestShelleyHardForkAtEpochMaybe 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.

  • npcTestShelleyHardForkAtVersionMaybe 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.

  • npcTestAllegraHardForkAtEpochMaybe 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.

  • npcTestAllegraHardForkAtVersionMaybe 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.

  • npcTestMaryHardForkAtEpochMaybe 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.

  • npcTestMaryHardForkAtVersionMaybe 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.

  • npcTestAlonzoHardForkAtEpochMaybe 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.

  • npcTestAlonzoHardForkAtVersionMaybe 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.

protocolNameProtocolString Source #

A human readable name for the protocol