Safe Haskell | None |
---|---|
Language | Haskell2010 |
Cardano.Node.Types
Synopsis
- class AdjustFilePaths a where
- adjustFilePaths :: (FilePath -> FilePath) -> a -> a
- newtype ConfigError = ConfigErrorFileNotFound FilePath
- newtype ConfigYamlFilePath = ConfigYamlFilePath {}
- newtype DbFile = DbFile {}
- newtype GenesisFile = GenesisFile {}
- data ProtocolFilepaths = ProtocolFilepaths {
- byronCertFile :: !(Maybe FilePath)
- byronKeyFile :: !(Maybe FilePath)
- shelleyKESFile :: !(Maybe FilePath)
- shelleyVRFFile :: !(Maybe FilePath)
- shelleyCertFile :: !(Maybe FilePath)
- newtype GenesisHash = GenesisHash (Hash Blake2b_256 ByteString)
- newtype MaxConcurrencyBulkSync = MaxConcurrencyBulkSync {}
- newtype MaxConcurrencyDeadline = MaxConcurrencyDeadline {}
- data NodeAddress' addr = NodeAddress {
- naHostAddress :: !addr
- naPort :: !PortNumber
- type NodeIPAddress = NodeAddress' NodeHostIPAddress
- nodeAddressToSockAddr :: NodeIPAddress -> SockAddr
- type NodeIPv4Address = NodeAddress' NodeHostIPv4Address
- type NodeIPv6Address = NodeAddress' NodeHostIPv6Address
- type NodeDnsAddress = NodeAddress' NodeHostDnsAddress
- nodeIPv4ToIPAddress :: NodeIPv4Address -> NodeIPAddress
- nodeIPv6ToIPAddress :: NodeIPv6Address -> NodeIPAddress
- nodeDnsAddressToDomainAddress :: NodeDnsAddress -> DomainAddress
- newtype NodeHostIPAddress = NodeHostIPAddress {}
- nodeHostIPAddressToSockAddr :: NodeIPAddress -> SockAddr
- newtype NodeHostIPv4Address = NodeHostIPv4Address {}
- newtype NodeHostIPv6Address = NodeHostIPv6Address {}
- nodeHostIPv4AddressToIPAddress :: NodeHostIPv4Address -> NodeHostIPAddress
- nodeHostIPv6AddressToIPAddress :: NodeHostIPv6Address -> NodeHostIPAddress
- newtype NodeHostDnsAddress = NodeHostDnsAddress {}
- nodeHostDnsAddressToDomain :: NodeHostDnsAddress -> Domain
- data PortNumber
- newtype SocketPath = SocketPath {}
- newtype TopologyFile = TopologyFile {}
- newtype NodeDiffusionMode = NodeDiffusionMode {
- getDiffusionMode :: DiffusionMode
- data NodeByronProtocolConfiguration = NodeByronProtocolConfiguration {
- npcByronGenesisFile :: !GenesisFile
- npcByronGenesisFileHash :: !(Maybe GenesisHash)
- npcByronReqNetworkMagic :: !RequiresNetworkMagic
- npcByronPbftSignatureThresh :: !(Maybe Double)
- npcByronApplicationName :: !ApplicationName
- npcByronApplicationVersion :: !NumSoftwareVersion
- npcByronSupportedProtocolVersionMajor :: !Word16
- npcByronSupportedProtocolVersionMinor :: !Word16
- npcByronSupportedProtocolVersionAlt :: !Word8
- data NodeHardForkProtocolConfiguration = NodeHardForkProtocolConfiguration {
- npcShelleyHardForkNotBeforeEpoch :: Maybe EpochNo
- npcTestShelleyHardForkAtEpoch :: Maybe EpochNo
- npcTestShelleyHardForkAtVersion :: Maybe Word
- npcAllegraHardForkNotBeforeEpoch :: Maybe EpochNo
- npcTestAllegraHardForkAtEpoch :: Maybe EpochNo
- npcTestAllegraHardForkAtVersion :: Maybe Word
- npcTestMaryHardForkAtEpoch :: Maybe EpochNo
- npcTestMaryHardForkAtVersion :: Maybe Word
- npcMaryHardForkNotBeforeEpoch :: Maybe EpochNo
- data NodeProtocolConfiguration
- data NodeShelleyProtocolConfiguration = NodeShelleyProtocolConfiguration {}
- data VRFPrivateKeyFilePermissionError
- protocolName :: Protocol -> String
- renderVRFPrivateKeyFilePermissionError :: VRFPrivateKeyFilePermissionError -> Text
Configuration
class AdjustFilePaths a where Source #
Methods
adjustFilePaths :: (FilePath -> FilePath) -> a -> a Source #
Instances
newtype ConfigError Source #
Errors for the cardano-config module.
Constructors
ConfigErrorFileNotFound FilePath |
Instances
Show ConfigError Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> ConfigError -> ShowS # show :: ConfigError -> String # showList :: [ConfigError] -> ShowS # |
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 | |
Fields |
Instances
Eq ConfigYamlFilePath Source # | |
Defined in Cardano.Node.Types Methods (==) :: ConfigYamlFilePath -> ConfigYamlFilePath -> Bool # (/=) :: ConfigYamlFilePath -> ConfigYamlFilePath -> Bool # | |
Show ConfigYamlFilePath Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> ConfigYamlFilePath -> ShowS # show :: ConfigYamlFilePath -> String # showList :: [ConfigYamlFilePath] -> ShowS # |
newtype GenesisFile Source #
Constructors
GenesisFile | |
Fields |
Instances
data ProtocolFilepaths Source #
Constructors
ProtocolFilepaths | |
Fields
|
Instances
Eq ProtocolFilepaths Source # | |
Defined in Cardano.Node.Types Methods (==) :: ProtocolFilepaths -> ProtocolFilepaths -> Bool # (/=) :: ProtocolFilepaths -> ProtocolFilepaths -> Bool # | |
Show ProtocolFilepaths Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> ProtocolFilepaths -> ShowS # show :: ProtocolFilepaths -> String # showList :: [ProtocolFilepaths] -> ShowS # |
newtype GenesisHash Source #
Constructors
GenesisHash (Hash Blake2b_256 ByteString) |
Instances
Eq GenesisHash Source # | |
Defined in Cardano.Node.Types | |
Show GenesisHash Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> GenesisHash -> ShowS # show :: GenesisHash -> String # showList :: [GenesisHash] -> ShowS # | |
ToJSON GenesisHash Source # | |
Defined in Cardano.Node.Types Methods toJSON :: GenesisHash -> Value Source # toEncoding :: GenesisHash -> Encoding Source # toJSONList :: [GenesisHash] -> Value Source # toEncodingList :: [GenesisHash] -> Encoding Source # | |
FromJSON GenesisHash Source # | |
Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser GenesisHash Source # parseJSONList :: Value -> Parser [GenesisHash] Source # |
newtype MaxConcurrencyBulkSync Source #
Constructors
MaxConcurrencyBulkSync | |
Fields |
Instances
newtype MaxConcurrencyDeadline Source #
Constructors
MaxConcurrencyDeadline | |
Fields |
Instances
Node addresses
data NodeAddress' addr Source #
IPv4 or IPv6 address with a port number.
Constructors
NodeAddress | |
Fields
|
Instances
nodeDnsAddressToDomainAddress :: NodeDnsAddress -> DomainAddress Source #
newtype NodeHostIPAddress Source #
Constructors
NodeHostIPAddress | |
Fields |
Instances
newtype NodeHostIPv4Address Source #
Constructors
NodeHostIPv4Address | |
Fields |
Instances
newtype NodeHostIPv6Address Source #
Constructors
NodeHostIPv6Address | |
Fields |
Instances
newtype NodeHostDnsAddress Source #
Domain name.
Constructors
NodeHostDnsAddress | |
Fields |
Instances
Eq NodeHostDnsAddress Source # | |
Defined in Cardano.Node.Types Methods (==) :: NodeHostDnsAddress -> NodeHostDnsAddress -> Bool # (/=) :: NodeHostDnsAddress -> NodeHostDnsAddress -> Bool # | |
Ord NodeHostDnsAddress Source # | |
Defined in Cardano.Node.Types Methods compare :: NodeHostDnsAddress -> NodeHostDnsAddress -> Ordering # (<) :: NodeHostDnsAddress -> NodeHostDnsAddress -> Bool # (<=) :: NodeHostDnsAddress -> NodeHostDnsAddress -> Bool # (>) :: NodeHostDnsAddress -> NodeHostDnsAddress -> Bool # (>=) :: NodeHostDnsAddress -> NodeHostDnsAddress -> Bool # max :: NodeHostDnsAddress -> NodeHostDnsAddress -> NodeHostDnsAddress # min :: NodeHostDnsAddress -> NodeHostDnsAddress -> NodeHostDnsAddress # | |
Show NodeHostDnsAddress Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeHostDnsAddress -> ShowS # show :: NodeHostDnsAddress -> String # showList :: [NodeHostDnsAddress] -> ShowS # |
nodeHostDnsAddressToDomain :: NodeHostDnsAddress -> Domain Source #
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
newtype SocketPath Source #
Constructors
SocketPath | |
Fields |
Instances
newtype TopologyFile Source #
Constructors
TopologyFile | |
Fields |
Instances
Eq TopologyFile Source # | |
Defined in Cardano.Node.Types | |
Show TopologyFile Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> TopologyFile -> ShowS # show :: TopologyFile -> String # showList :: [TopologyFile] -> ShowS # |
newtype NodeDiffusionMode Source #
Newtype wrapper which provides FromJSON
instance for DiffusionMode
.
Constructors
NodeDiffusionMode | |
Fields
|
Instances
Show NodeDiffusionMode Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeDiffusionMode -> ShowS # show :: NodeDiffusionMode -> String # showList :: [NodeDiffusionMode] -> ShowS # | |
FromJSON NodeDiffusionMode Source # | |
Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser NodeDiffusionMode Source # parseJSONList :: Value -> Parser [NodeDiffusionMode] Source # |
Consensus protocol configuration
data NodeByronProtocolConfiguration Source #
Constructors
NodeByronProtocolConfiguration | |
Fields
|
Instances
Eq NodeByronProtocolConfiguration Source # | |
Defined in Cardano.Node.Types | |
Show NodeByronProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeByronProtocolConfiguration -> ShowS # show :: NodeByronProtocolConfiguration -> String # showList :: [NodeByronProtocolConfiguration] -> ShowS # | |
AdjustFilePaths NodeByronProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods adjustFilePaths :: (FilePath -> FilePath) -> NodeByronProtocolConfiguration -> NodeByronProtocolConfiguration Source # |
data NodeHardForkProtocolConfiguration Source #
Configuration relating to a hard forks themselves, not the specific eras.
Constructors
NodeHardForkProtocolConfiguration | |
Fields
|
Instances
Eq NodeHardForkProtocolConfiguration Source # | |
Defined in Cardano.Node.Types | |
Show NodeHardForkProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeHardForkProtocolConfiguration -> ShowS # |
data NodeProtocolConfiguration Source #
Constructors
Instances
Eq NodeProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods (==) :: NodeProtocolConfiguration -> NodeProtocolConfiguration -> Bool # (/=) :: NodeProtocolConfiguration -> NodeProtocolConfiguration -> Bool # | |
Show NodeProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeProtocolConfiguration -> ShowS # show :: NodeProtocolConfiguration -> String # showList :: [NodeProtocolConfiguration] -> ShowS # | |
AdjustFilePaths NodeProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods adjustFilePaths :: (FilePath -> FilePath) -> NodeProtocolConfiguration -> NodeProtocolConfiguration Source # | |
AdjustFilePaths (Last NodeProtocolConfiguration) Source # | |
Defined in Cardano.Node.Types Methods adjustFilePaths :: (FilePath -> FilePath) -> Last NodeProtocolConfiguration -> Last NodeProtocolConfiguration Source # |
data NodeShelleyProtocolConfiguration Source #
Constructors
NodeShelleyProtocolConfiguration | |
Fields
|
Instances
Eq NodeShelleyProtocolConfiguration Source # | |
Defined in Cardano.Node.Types | |
Show NodeShelleyProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeShelleyProtocolConfiguration -> ShowS # | |
AdjustFilePaths NodeShelleyProtocolConfiguration Source # | |
Defined in Cardano.Node.Types Methods adjustFilePaths :: (FilePath -> FilePath) -> NodeShelleyProtocolConfiguration -> NodeShelleyProtocolConfiguration Source # |
data VRFPrivateKeyFilePermissionError Source #
Constructors
OtherPermissionsExist FilePath | |
GroupPermissionsExist FilePath |
Instances
Show VRFPrivateKeyFilePermissionError Source # | |
Defined in Cardano.Node.Types Methods showsPrec :: Int -> VRFPrivateKeyFilePermissionError -> ShowS # |
protocolName :: Protocol -> String Source #
A human readable name for the protocol