cardano-node-1.36.0: The cardano full node
Safe HaskellSafe-Inferred
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 PartialNodeConfiguration Source # 
Instance details

Defined in Cardano.Node.Configuration.POM

AdjustFilePaths SocketConfig Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths GenesisFile Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeAlonzoProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeByronProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeConwayProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths NodeShelleyProtocolConfiguration Source # 
Instance details

Defined in Cardano.Node.Types

AdjustFilePaths a ⇒ AdjustFilePaths (Last a) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

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

AdjustFilePaths a ⇒ AdjustFilePaths (Maybe a) Source # 
Instance details

Defined in Cardano.Node.Types

Methods

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

data 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
Show DbFile Source # 
Instance details

Defined in Cardano.Node.Types

Eq DbFile Source # 
Instance details

Defined in Cardano.Node.Types

Methods

(==)DbFileDbFileBool Source #

(/=)DbFileDbFileBool Source #

newtype GenesisHash Source #

Constructors

GenesisHash (Hash Blake2b_256 ByteString) 

Instances

Instances details
FromJSON GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser GenesisHash #

parseJSONList ∷ Value → Parser [GenesisHash] #

ToJSON GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

Methods

toJSONGenesisHash → Value #

toEncodingGenesisHash → Encoding #

toJSONList ∷ [GenesisHash] → Value #

toEncodingList ∷ [GenesisHash] → Encoding #

Show GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

Eq GenesisHash Source # 
Instance details

Defined in Cardano.Node.Types

newtype MaxConcurrencyBulkSync Source #

newtype MaxConcurrencyDeadline Source #

Networking

newtype TopologyFile Source #

Constructors

TopologyFile 

Fields

Instances

Instances details
Show TopologyFile Source # 
Instance details

Defined in Cardano.Node.Types

Eq 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
FromJSON NodeDiffusionMode Source # 
Instance details

Defined in Cardano.Node.Types

Methods

parseJSON ∷ Value → Parser NodeDiffusionMode #

parseJSONList ∷ Value → Parser [NodeDiffusionMode] #

Show NodeDiffusionMode Source # 
Instance details

Defined in Cardano.Node.Types

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.

  • npcTestBabbageHardForkAtEpochMaybe EpochNo
     
  • npcTestBabbageHardForkAtVersionMaybe 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.

  • npcTestConwayHardForkAtEpochMaybe EpochNo
     
  • npcTestConwayHardForkAtVersionMaybe Word