Safe Haskell	None
Language	Haskell2010

Bcc.Node.Types

Contents

Configuration
Node addresses
Consensus protocol configuration

Synopsis

class AdjustFilePaths a where
- adjustFilePaths ∷ (FilePath → FilePath) → a → a
newtype ConfigError = ConfigErrorFileNotFound FilePath
newtype ConfigYamlFilePath = ConfigYamlFilePath {
- unConfigPath ∷ FilePath
}
newtype DbFile = DbFile {
- unDB ∷ FilePath
}
newtype GenesisFile = GenesisFile {
- unGenesisFile ∷ FilePath
}
data ProtocolFilepaths = ProtocolFilepaths {
- coleCertFile ∷ !(Maybe FilePath)
- coleKeyFile ∷ !(Maybe FilePath)
- sophieKESFile ∷ !(Maybe FilePath)
- sophieVRFFile ∷ !(Maybe FilePath)
- sophieCertFile ∷ !(Maybe FilePath)
- sophieBulkCredsFile ∷ !(Maybe FilePath)
}
newtype GenesisHash = GenesisHash (Hash Blake2b_256 ByteString)
newtype MaxConcurrencyBulkSync = MaxConcurrencyBulkSync {
- unMaxConcurrencyBulkSync ∷ Word
}
newtype MaxConcurrencyDeadline = MaxConcurrencyDeadline {
- unMaxConcurrencyDeadline ∷ Word
}
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 {
- unNodeHostIPAddress ∷ IP
}
nodeHostIPAddressToSockAddr ∷ NodeIPAddress → SockAddr
newtype NodeHostIPv4Address = NodeHostIPv4Address {
- unNodeHostIPv4Address ∷ IPv4
}
newtype NodeHostIPv6Address = NodeHostIPv6Address {
- unNodeHostIPv6Address ∷ IPv6
}
nodeHostIPv4AddressToIPAddress ∷ NodeHostIPv4Address → NodeHostIPAddress
nodeHostIPv6AddressToIPAddress ∷ NodeHostIPv6Address → NodeHostIPAddress
newtype NodeHostDnsAddress = NodeHostDnsAddress {
- unNodeHostDnsAddress ∷ Text
}
nodeHostDnsAddressToDomain ∷ NodeHostDnsAddress → Domain
data PortNumber
newtype SocketPath = SocketPath {
- unSocketPath ∷ FilePath
}
newtype TopologyFile = TopologyFile {
- unTopology ∷ FilePath
}
newtype NodeDiffusionMode = NodeDiffusionMode {
- getDiffusionMode ∷ DiffusionMode
}
data NodeColeProtocolConfiguration = NodeColeProtocolConfiguration {
- npcColeGenesisFile ∷ !GenesisFile
- npcColeGenesisFileHash ∷ !(Maybe GenesisHash)
- npcColeReqNetworkMagic ∷ !RequiresNetworkMagic
- npcColePbftSignatureThresh ∷ !(Maybe Double)
- npcColeApplicationName ∷ !ApplicationName
- npcColeApplicationVersion ∷ !NumSoftwareVersion
- npcColeSupportedProtocolVersionMajor ∷ !Word16
- npcColeSupportedProtocolVersionSentry ∷ !Word16
}
data NodeHardForkProtocolConfiguration = NodeHardForkProtocolConfiguration {
- npcTestEnableDevelopmentHardForkEras ∷ Bool
- npcTestSophieHardForkAtEpoch ∷ Maybe EpochNo
- npcTestSophieHardForkAtVersion ∷ Maybe Word
- npcTestEvieHardForkAtEpoch ∷ Maybe EpochNo
- npcTestEvieHardForkAtVersion ∷ Maybe Word
- npcTestJenHardForkAtEpoch ∷ Maybe EpochNo
- npcTestJenHardForkAtVersion ∷ Maybe Word
- npcTestAurumHardForkAtEpoch ∷ Maybe EpochNo
- npcTestAurumHardForkAtVersion ∷ Maybe Word
}
data NodeProtocolConfiguration
- = NodeProtocolConfigurationCole NodeColeProtocolConfiguration
- | NodeProtocolConfigurationSophie NodeSophieProtocolConfiguration
- | NodeProtocolConfigurationBcc NodeColeProtocolConfiguration NodeSophieProtocolConfiguration NodeAurumProtocolConfiguration NodeHardForkProtocolConfiguration
data NodeSophieProtocolConfiguration = NodeSophieProtocolConfiguration {
- npcSophieGenesisFile ∷ !GenesisFile
- npcSophieGenesisFileHash ∷ !(Maybe GenesisHash)
}
data NodeAurumProtocolConfiguration = NodeAurumProtocolConfiguration {
- npcAurumGenesisFile ∷ !GenesisFile
- npcAurumGenesisFileHash ∷ !(Maybe GenesisHash)
}
data VRFPrivateKeyFilePermissionError
- = OtherPermissionsExist FilePath
- | GroupPermissionsExist FilePath
- | GenericPermissionsExist FilePath
protocolName ∷ Protocol → String
renderVRFPrivateKeyFilePermissionError ∷ VRFPrivateKeyFilePermissionError → Text

Configuration

class AdjustFilePaths a where Source #

Methods

adjustFilePaths ∷ (FilePath → FilePath) → a → a Source #

Instances

Instances details

AdjustFilePaths SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → SocketPath → SocketPath Source #
AdjustFilePaths NodeColeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeColeProtocolConfiguration → NodeColeProtocolConfiguration Source #
AdjustFilePaths NodeAurumProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeAurumProtocolConfiguration → NodeAurumProtocolConfiguration Source #
AdjustFilePaths NodeSophieProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeSophieProtocolConfiguration → NodeSophieProtocolConfiguration Source #
AdjustFilePaths NodeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeProtocolConfiguration → NodeProtocolConfiguration Source #
AdjustFilePaths GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → GenesisFile → GenesisFile Source #
AdjustFilePaths PartialNodeConfiguration Source #
Instance details Defined in Bcc.Node.Configuration.POM Methods adjustFilePaths ∷ (FilePath → FilePath) → PartialNodeConfiguration → PartialNodeConfiguration Source #
AdjustFilePaths a ⇒ AdjustFilePaths (Maybe a) Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → Maybe a → Maybe a Source #
AdjustFilePaths (Last SocketPath) Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → Last SocketPath → Last SocketPath Source #
AdjustFilePaths (Last NodeProtocolConfiguration) Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → Last NodeProtocolConfiguration → Last NodeProtocolConfiguration Source #

newtype ConfigError Source #

Errors for the bcc-config module.

Constructors

ConfigErrorFileNotFound FilePath

Instances

Instances details

Show ConfigError Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → ConfigError → ShowS Source # show ∷ ConfigError → String Source # showList ∷ [ConfigError] → ShowS Source #

newtype ConfigYamlFilePath Source #

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

Constructors

ConfigYamlFilePath
Fields unConfigPath ∷ FilePath

Instances

Instances details

Eq ConfigYamlFilePath Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ ConfigYamlFilePath → ConfigYamlFilePath → Bool Source # (/=) ∷ ConfigYamlFilePath → ConfigYamlFilePath → Bool Source #
Show ConfigYamlFilePath Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → ConfigYamlFilePath → ShowS Source # show ∷ ConfigYamlFilePath → String Source # showList ∷ [ConfigYamlFilePath] → ShowS Source #

newtype DbFile Source #

Constructors

DbFile
Fields unDB ∷ FilePath

Instances

Instances details

Eq DbFile Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ DbFile → DbFile → Bool Source # (/=) ∷ DbFile → DbFile → Bool Source #
Show DbFile Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → DbFile → ShowS Source # show ∷ DbFile → String Source # showList ∷ [DbFile] → ShowS Source #

newtype GenesisFile Source #

Constructors

GenesisFile
Fields unGenesisFile ∷ FilePath

Instances

Instances details

Eq GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ GenesisFile → GenesisFile → Bool Source # (/=) ∷ GenesisFile → GenesisFile → Bool Source #
Ord GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ GenesisFile → GenesisFile → Ordering Source # (<) ∷ GenesisFile → GenesisFile → Bool Source # (<=) ∷ GenesisFile → GenesisFile → Bool Source # (>) ∷ GenesisFile → GenesisFile → Bool Source # (>=) ∷ GenesisFile → GenesisFile → Bool Source # max ∷ GenesisFile → GenesisFile → GenesisFile Source # min ∷ GenesisFile → GenesisFile → GenesisFile Source #
Show GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → GenesisFile → ShowS Source # show ∷ GenesisFile → String Source # showList ∷ [GenesisFile] → ShowS Source #
IsString GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods fromString ∷ String → GenesisFile Source #
FromJSON GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser GenesisFile # parseJSONList ∷ Value → Parser [GenesisFile] #
AdjustFilePaths GenesisFile Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → GenesisFile → GenesisFile Source #

data ProtocolFilepaths Source #

Constructors

ProtocolFilepaths
Fields coleCertFile ∷ !(Maybe FilePath) coleKeyFile ∷ !(Maybe FilePath) sophieKESFile ∷ !(Maybe FilePath) sophieVRFFile ∷ !(Maybe FilePath) sophieCertFile ∷ !(Maybe FilePath) sophieBulkCredsFile ∷ !(Maybe FilePath)

Instances

Instances details

Eq ProtocolFilepaths Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ ProtocolFilepaths → ProtocolFilepaths → Bool Source # (/=) ∷ ProtocolFilepaths → ProtocolFilepaths → Bool Source #
Show ProtocolFilepaths Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → ProtocolFilepaths → ShowS Source # show ∷ ProtocolFilepaths → String Source # showList ∷ [ProtocolFilepaths] → ShowS Source #

newtype GenesisHash Source #

Constructors

GenesisHash (Hash Blake2b_256 ByteString)

Instances

Instances details

Eq GenesisHash Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ GenesisHash → GenesisHash → Bool Source # (/=) ∷ GenesisHash → GenesisHash → Bool Source #
Show GenesisHash Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → GenesisHash → ShowS Source # show ∷ GenesisHash → String Source # showList ∷ [GenesisHash] → ShowS Source #
ToJSON GenesisHash Source #
Instance details Defined in Bcc.Node.Types Methods toJSON ∷ GenesisHash → Value # toEncoding ∷ GenesisHash → Encoding # toJSONList ∷ [GenesisHash] → Value # toEncodingList ∷ [GenesisHash] → Encoding #
FromJSON GenesisHash Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser GenesisHash # parseJSONList ∷ Value → Parser [GenesisHash] #

newtype MaxConcurrencyBulkSync Source #

Constructors

MaxConcurrencyBulkSync
Fields unMaxConcurrencyBulkSync ∷ Word

Instances

Instances details

Eq MaxConcurrencyBulkSync Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Bool Source # (/=) ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Bool Source #
Ord MaxConcurrencyBulkSync Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Ordering Source # (<) ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Bool Source # (<=) ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Bool Source # (>) ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Bool Source # (>=) ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → Bool Source # max ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → MaxConcurrencyBulkSync Source # min ∷ MaxConcurrencyBulkSync → MaxConcurrencyBulkSync → MaxConcurrencyBulkSync Source #
Show MaxConcurrencyBulkSync Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → MaxConcurrencyBulkSync → ShowS Source # show ∷ MaxConcurrencyBulkSync → String Source # showList ∷ [MaxConcurrencyBulkSync] → ShowS Source #
FromJSON MaxConcurrencyBulkSync Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser MaxConcurrencyBulkSync # parseJSONList ∷ Value → Parser [MaxConcurrencyBulkSync] #

newtype MaxConcurrencyDeadline Source #

Constructors

MaxConcurrencyDeadline
Fields unMaxConcurrencyDeadline ∷ Word

Instances

Instances details

Eq MaxConcurrencyDeadline Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Bool Source # (/=) ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Bool Source #
Ord MaxConcurrencyDeadline Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Ordering Source # (<) ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Bool Source # (<=) ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Bool Source # (>) ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Bool Source # (>=) ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → Bool Source # max ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → MaxConcurrencyDeadline Source # min ∷ MaxConcurrencyDeadline → MaxConcurrencyDeadline → MaxConcurrencyDeadline Source #
Show MaxConcurrencyDeadline Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → MaxConcurrencyDeadline → ShowS Source # show ∷ MaxConcurrencyDeadline → String Source # showList ∷ [MaxConcurrencyDeadline] → ShowS Source #
FromJSON MaxConcurrencyDeadline Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser MaxConcurrencyDeadline # parseJSONList ∷ Value → Parser [MaxConcurrencyDeadline] #

Node addresses

data NodeAddress' addr Source #

IPv4 or IPv6 address with a port number.

Constructors

NodeAddress
Fields naHostAddress ∷ !addr naPort ∷ !PortNumber

Instances

Instances details

Functor NodeAddress' Source #
Instance details Defined in Bcc.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 Bcc.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 Bcc.Node.Types Methods compare ∷ NodeAddress' 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 # max ∷ NodeAddress' addr → NodeAddress' addr → NodeAddress' addr Source # min ∷ NodeAddress' addr → NodeAddress' addr → NodeAddress' addr Source #
Show addr ⇒ Show (NodeAddress' addr) Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeAddress' addr → ShowS Source # show ∷ NodeAddress' addr → String Source # showList ∷ [NodeAddress' addr] → ShowS Source #
ToJSON addr ⇒ ToJSON (NodeAddress' addr) Source #
Instance details Defined in Bcc.Node.Types Methods toJSON ∷ NodeAddress' addr → Value # toEncoding ∷ NodeAddress' addr → Encoding # toJSONList ∷ [NodeAddress' addr] → Value # toEncodingList ∷ [NodeAddress' addr] → Encoding #
FromJSON addr ⇒ FromJSON (NodeAddress' addr) Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser (NodeAddress' addr) # parseJSONList ∷ Value → Parser [NodeAddress' addr] #

type NodeIPAddress = NodeAddress' NodeHostIPAddress Source #

nodeAddressToSockAddr ∷ NodeIPAddress → SockAddr Source #

type NodeIPv4Address = NodeAddress' NodeHostIPv4Address Source #

type NodeIPv6Address = NodeAddress' NodeHostIPv6Address Source #

type NodeDnsAddress = NodeAddress' NodeHostDnsAddress Source #

nodeIPv4ToIPAddress ∷ NodeIPv4Address → NodeIPAddress Source #

nodeIPv6ToIPAddress ∷ NodeIPv6Address → NodeIPAddress Source #

nodeDnsAddressToDomainAddress ∷ NodeDnsAddress → DomainAddress Source #

newtype NodeHostIPAddress Source #

Constructors

NodeHostIPAddress
Fields unNodeHostIPAddress ∷ IP

Instances

Instances details

Eq NodeHostIPAddress Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeHostIPAddress → NodeHostIPAddress → Bool Source # (/=) ∷ NodeHostIPAddress → NodeHostIPAddress → Bool Source #
Ord NodeHostIPAddress Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ NodeHostIPAddress → NodeHostIPAddress → Ordering Source # (<) ∷ NodeHostIPAddress → NodeHostIPAddress → Bool Source # (<=) ∷ NodeHostIPAddress → NodeHostIPAddress → Bool Source # (>) ∷ NodeHostIPAddress → NodeHostIPAddress → Bool Source # (>=) ∷ NodeHostIPAddress → NodeHostIPAddress → Bool Source # max ∷ NodeHostIPAddress → NodeHostIPAddress → NodeHostIPAddress Source # min ∷ NodeHostIPAddress → NodeHostIPAddress → NodeHostIPAddress Source #
Show NodeHostIPAddress Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeHostIPAddress → ShowS Source # show ∷ NodeHostIPAddress → String Source # showList ∷ [NodeHostIPAddress] → ShowS Source #
ToJSON NodeHostIPAddress Source #
Instance details Defined in Bcc.Node.Types Methods toJSON ∷ NodeHostIPAddress → Value # toEncoding ∷ NodeHostIPAddress → Encoding # toJSONList ∷ [NodeHostIPAddress] → Value # toEncodingList ∷ [NodeHostIPAddress] → Encoding #
FromJSON NodeHostIPAddress Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser NodeHostIPAddress # parseJSONList ∷ Value → Parser [NodeHostIPAddress] #

nodeHostIPAddressToSockAddr ∷ NodeIPAddress → SockAddr Source #

newtype NodeHostIPv4Address Source #

Constructors

NodeHostIPv4Address
Fields unNodeHostIPv4Address ∷ IPv4

Instances

Instances details

Eq NodeHostIPv4Address Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeHostIPv4Address → NodeHostIPv4Address → Bool Source # (/=) ∷ NodeHostIPv4Address → NodeHostIPv4Address → Bool Source #
Ord NodeHostIPv4Address Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ NodeHostIPv4Address → NodeHostIPv4Address → Ordering Source # (<) ∷ NodeHostIPv4Address → NodeHostIPv4Address → Bool Source # (<=) ∷ NodeHostIPv4Address → NodeHostIPv4Address → Bool Source # (>) ∷ NodeHostIPv4Address → NodeHostIPv4Address → Bool Source # (>=) ∷ NodeHostIPv4Address → NodeHostIPv4Address → Bool Source # max ∷ NodeHostIPv4Address → NodeHostIPv4Address → NodeHostIPv4Address Source # min ∷ NodeHostIPv4Address → NodeHostIPv4Address → NodeHostIPv4Address Source #
Show NodeHostIPv4Address Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeHostIPv4Address → ShowS Source # show ∷ NodeHostIPv4Address → String Source # showList ∷ [NodeHostIPv4Address] → ShowS Source #
ToJSON NodeHostIPv4Address Source #
Instance details Defined in Bcc.Node.Types Methods toJSON ∷ NodeHostIPv4Address → Value # toEncoding ∷ NodeHostIPv4Address → Encoding # toJSONList ∷ [NodeHostIPv4Address] → Value # toEncodingList ∷ [NodeHostIPv4Address] → Encoding #
FromJSON NodeHostIPv4Address Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser NodeHostIPv4Address # parseJSONList ∷ Value → Parser [NodeHostIPv4Address] #

newtype NodeHostIPv6Address Source #

Constructors

NodeHostIPv6Address
Fields unNodeHostIPv6Address ∷ IPv6

Instances

Instances details

Eq NodeHostIPv6Address Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeHostIPv6Address → NodeHostIPv6Address → Bool Source # (/=) ∷ NodeHostIPv6Address → NodeHostIPv6Address → Bool Source #
Ord NodeHostIPv6Address Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ NodeHostIPv6Address → NodeHostIPv6Address → Ordering Source # (<) ∷ NodeHostIPv6Address → NodeHostIPv6Address → Bool Source # (<=) ∷ NodeHostIPv6Address → NodeHostIPv6Address → Bool Source # (>) ∷ NodeHostIPv6Address → NodeHostIPv6Address → Bool Source # (>=) ∷ NodeHostIPv6Address → NodeHostIPv6Address → Bool Source # max ∷ NodeHostIPv6Address → NodeHostIPv6Address → NodeHostIPv6Address Source # min ∷ NodeHostIPv6Address → NodeHostIPv6Address → NodeHostIPv6Address Source #
Show NodeHostIPv6Address Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeHostIPv6Address → ShowS Source # show ∷ NodeHostIPv6Address → String Source # showList ∷ [NodeHostIPv6Address] → ShowS Source #
ToJSON NodeHostIPv6Address Source #
Instance details Defined in Bcc.Node.Types Methods toJSON ∷ NodeHostIPv6Address → Value # toEncoding ∷ NodeHostIPv6Address → Encoding # toJSONList ∷ [NodeHostIPv6Address] → Value # toEncodingList ∷ [NodeHostIPv6Address] → Encoding #
FromJSON NodeHostIPv6Address Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser NodeHostIPv6Address # parseJSONList ∷ Value → Parser [NodeHostIPv6Address] #

nodeHostIPv4AddressToIPAddress ∷ NodeHostIPv4Address → NodeHostIPAddress Source #

nodeHostIPv6AddressToIPAddress ∷ NodeHostIPv6Address → NodeHostIPAddress Source #

newtype NodeHostDnsAddress Source #

Domain name.

Constructors

NodeHostDnsAddress
Fields unNodeHostDnsAddress ∷ Text

Instances

Instances details

Eq NodeHostDnsAddress Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeHostDnsAddress → NodeHostDnsAddress → Bool Source # (/=) ∷ NodeHostDnsAddress → NodeHostDnsAddress → Bool Source #
Ord NodeHostDnsAddress Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ NodeHostDnsAddress → NodeHostDnsAddress → Ordering Source # (<) ∷ NodeHostDnsAddress → NodeHostDnsAddress → Bool Source # (<=) ∷ NodeHostDnsAddress → NodeHostDnsAddress → Bool Source # (>) ∷ NodeHostDnsAddress → NodeHostDnsAddress → Bool Source # (>=) ∷ NodeHostDnsAddress → NodeHostDnsAddress → Bool Source # max ∷ NodeHostDnsAddress → NodeHostDnsAddress → NodeHostDnsAddress Source # min ∷ NodeHostDnsAddress → NodeHostDnsAddress → NodeHostDnsAddress Source #
Show NodeHostDnsAddress Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeHostDnsAddress → ShowS Source # show ∷ NodeHostDnsAddress → String Source # showList ∷ [NodeHostDnsAddress] → ShowS Source #

nodeHostDnsAddressToDomain ∷ NodeHostDnsAddress → Domain Source #

data PortNumber #

Instances

Instances details

Bounded PortNumber
Instance details Defined in Network.Socket.Types Methods minBound ∷ PortNumber Source # maxBound ∷ PortNumber Source #
Enum PortNumber
Instance details Defined in Network.Socket.Types Methods succ ∷ PortNumber → PortNumber Source # pred ∷ PortNumber → PortNumber Source # toEnum ∷ Int → PortNumber Source # fromEnum ∷ PortNumber → Int Source # enumFrom ∷ PortNumber → [PortNumber] Source # enumFromThen ∷ PortNumber → PortNumber → [PortNumber] Source # enumFromTo ∷ PortNumber → PortNumber → [PortNumber] Source # enumFromThenTo ∷ PortNumber → PortNumber → PortNumber → [PortNumber] Source #
Eq PortNumber
Instance details Defined in Network.Socket.Types Methods (==) ∷ PortNumber → PortNumber → Bool Source # (/=) ∷ PortNumber → PortNumber → Bool Source #
Integral PortNumber
Instance details Defined in Network.Socket.Types Methods quot ∷ PortNumber → PortNumber → PortNumber Source # rem ∷ PortNumber → PortNumber → PortNumber Source # div ∷ PortNumber → PortNumber → PortNumber Source # mod ∷ PortNumber → PortNumber → PortNumber Source # quotRem ∷ PortNumber → PortNumber → (PortNumber, PortNumber) Source # divMod ∷ PortNumber → PortNumber → (PortNumber, PortNumber) Source # toInteger ∷ PortNumber → Integer Source #
Num PortNumber
Instance details Defined in Network.Socket.Types Methods (+) ∷ PortNumber → PortNumber → PortNumber Source # (-) ∷ PortNumber → PortNumber → PortNumber Source # (*) ∷ PortNumber → PortNumber → PortNumber Source # negate ∷ PortNumber → PortNumber Source # abs ∷ PortNumber → PortNumber Source # signum ∷ PortNumber → PortNumber Source # fromInteger ∷ Integer → PortNumber Source #
Ord PortNumber
Instance details Defined in Network.Socket.Types Methods compare ∷ PortNumber → PortNumber → Ordering Source # (<) ∷ PortNumber → PortNumber → Bool Source # (<=) ∷ PortNumber → PortNumber → Bool Source # (>) ∷ PortNumber → PortNumber → Bool Source # (>=) ∷ PortNumber → PortNumber → Bool Source # max ∷ PortNumber → PortNumber → PortNumber Source # min ∷ PortNumber → PortNumber → PortNumber Source #
Read PortNumber
Instance details Defined in Network.Socket.Types Methods readsPrec ∷ Int → ReadS PortNumber Source # readList ∷ ReadS [PortNumber] Source # readPrec ∷ ReadPrec PortNumber Source # readListPrec ∷ ReadPrec [PortNumber] Source #
Real PortNumber
Instance details Defined in Network.Socket.Types Methods toRational ∷ PortNumber → Rational Source #
Show PortNumber
Instance details Defined in Network.Socket.Types Methods showsPrec ∷ Int → PortNumber → ShowS Source # show ∷ PortNumber → String Source # showList ∷ [PortNumber] → ShowS Source #
Storable PortNumber
Instance details Defined in Network.Socket.Types Methods sizeOf ∷ PortNumber → Int Source # alignment ∷ PortNumber → Int Source # peekElemOff ∷ Ptr PortNumber → Int → IO PortNumber Source # pokeElemOff ∷ Ptr PortNumber → Int → PortNumber → IO () Source # peekByteOff ∷ Ptr b → Int → IO PortNumber Source # pokeByteOff ∷ Ptr b → Int → PortNumber → IO () Source # peek ∷ Ptr PortNumber → IO PortNumber Source # poke ∷ Ptr PortNumber → PortNumber → IO () Source #
FromJSON PortNumber Source #
Instance details Defined in Bcc.Tracing.OrphanInstances.Common Methods parseJSON ∷ Value → Parser PortNumber # parseJSONList ∷ Value → Parser [PortNumber] #

newtype SocketPath Source #

Constructors

SocketPath
Fields unSocketPath ∷ FilePath

Instances

Instances details

Eq SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ SocketPath → SocketPath → Bool Source # (/=) ∷ SocketPath → SocketPath → Bool Source #
Ord SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods compare ∷ SocketPath → SocketPath → Ordering Source # (<) ∷ SocketPath → SocketPath → Bool Source # (<=) ∷ SocketPath → SocketPath → Bool Source # (>) ∷ SocketPath → SocketPath → Bool Source # (>=) ∷ SocketPath → SocketPath → Bool Source # max ∷ SocketPath → SocketPath → SocketPath Source # min ∷ SocketPath → SocketPath → SocketPath Source #
Show SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → SocketPath → ShowS Source # show ∷ SocketPath → String Source # showList ∷ [SocketPath] → ShowS Source #
IsString SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods fromString ∷ String → SocketPath Source #
FromJSON SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser SocketPath # parseJSONList ∷ Value → Parser [SocketPath] #
AdjustFilePaths SocketPath Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → SocketPath → SocketPath Source #
AdjustFilePaths (Last SocketPath) Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → Last SocketPath → Last SocketPath Source #

newtype TopologyFile Source #

Constructors

TopologyFile
Fields unTopology ∷ FilePath

Instances

Instances details

Eq TopologyFile Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ TopologyFile → TopologyFile → Bool Source # (/=) ∷ TopologyFile → TopologyFile → Bool Source #
Show TopologyFile Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → TopologyFile → ShowS Source # show ∷ TopologyFile → String Source # showList ∷ [TopologyFile] → ShowS Source #

newtype NodeDiffusionMode Source #

Newtype wrapper which provides FromJSON instance for DiffusionMode.

Constructors

NodeDiffusionMode
Fields getDiffusionMode ∷ DiffusionMode

Instances

Instances details

Show NodeDiffusionMode Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeDiffusionMode → ShowS Source # show ∷ NodeDiffusionMode → String Source # showList ∷ [NodeDiffusionMode] → ShowS Source #
FromJSON NodeDiffusionMode Source #
Instance details Defined in Bcc.Node.Types Methods parseJSON ∷ Value → Parser NodeDiffusionMode # parseJSONList ∷ Value → Parser [NodeDiffusionMode] #

Consensus protocol configuration

data NodeColeProtocolConfiguration Source #

Constructors

NodeColeProtocolConfiguration

Fields

npcColeGenesisFile ∷ !GenesisFile
npcColeGenesisFileHash ∷ !(Maybe GenesisHash)
npcColeReqNetworkMagic ∷ !RequiresNetworkMagic
npcColePbftSignatureThresh ∷ !(Maybe Double)
npcColeApplicationName ∷ !ApplicationName
Update application name.
npcColeApplicationVersion ∷ !NumSoftwareVersion
Application (ie software) version.
npcColeSupportedProtocolVersionMajor ∷ !Word16
These declare the version of the protocol that the node is prepared to run. This is usually the version of the protocol in use on the chain now, but during protocol updates this version will be the one that we declare that we are ready to move to. This is the endorsement mechanism for determining when enough block producers are ready to move to the next version.
npcColeSupportedProtocolVersionSentry ∷ !Word16

Instances

Instances details

Eq NodeColeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeColeProtocolConfiguration → NodeColeProtocolConfiguration → Bool Source # (/=) ∷ NodeColeProtocolConfiguration → NodeColeProtocolConfiguration → Bool Source #
Show NodeColeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeColeProtocolConfiguration → ShowS Source # show ∷ NodeColeProtocolConfiguration → String Source # showList ∷ [NodeColeProtocolConfiguration] → ShowS Source #
AdjustFilePaths NodeColeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeColeProtocolConfiguration → NodeColeProtocolConfiguration Source #

data NodeHardForkProtocolConfiguration Source #

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

Constructors

NodeHardForkProtocolConfiguration

Fields

npcTestEnableDevelopmentHardForkEras ∷ Bool
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.
npcTestSophieHardForkAtEpoch ∷ 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.
npcTestSophieHardForkAtVersion ∷ 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 Sophie 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.
npcTestEvieHardForkAtEpoch ∷ 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.
npcTestEvieHardForkAtVersion ∷ 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.
npcTestJenHardForkAtEpoch ∷ 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.
npcTestJenHardForkAtVersion ∷ 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.
npcTestAurumHardForkAtEpoch ∷ 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.
npcTestAurumHardForkAtVersion ∷ 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.

Instances

Instances details

Eq NodeHardForkProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeHardForkProtocolConfiguration → NodeHardForkProtocolConfiguration → Bool Source # (/=) ∷ NodeHardForkProtocolConfiguration → NodeHardForkProtocolConfiguration → Bool Source #
Show NodeHardForkProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeHardForkProtocolConfiguration → ShowS Source # show ∷ NodeHardForkProtocolConfiguration → String Source # showList ∷ [NodeHardForkProtocolConfiguration] → ShowS Source #

data NodeProtocolConfiguration Source #

Constructors

NodeProtocolConfigurationCole NodeColeProtocolConfiguration
NodeProtocolConfigurationSophie NodeSophieProtocolConfiguration
NodeProtocolConfigurationBcc NodeColeProtocolConfiguration NodeSophieProtocolConfiguration NodeAurumProtocolConfiguration NodeHardForkProtocolConfiguration

Instances

Instances details

Eq NodeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeProtocolConfiguration → NodeProtocolConfiguration → Bool Source # (/=) ∷ NodeProtocolConfiguration → NodeProtocolConfiguration → Bool Source #
Show NodeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeProtocolConfiguration → ShowS Source # show ∷ NodeProtocolConfiguration → String Source # showList ∷ [NodeProtocolConfiguration] → ShowS Source #
AdjustFilePaths NodeProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeProtocolConfiguration → NodeProtocolConfiguration Source #
AdjustFilePaths (Last NodeProtocolConfiguration) Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → Last NodeProtocolConfiguration → Last NodeProtocolConfiguration Source #

data NodeSophieProtocolConfiguration Source #

Constructors

NodeSophieProtocolConfiguration
Fields npcSophieGenesisFile ∷ !GenesisFile npcSophieGenesisFileHash ∷ !(Maybe GenesisHash)

Instances

Instances details

Eq NodeSophieProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeSophieProtocolConfiguration → NodeSophieProtocolConfiguration → Bool Source # (/=) ∷ NodeSophieProtocolConfiguration → NodeSophieProtocolConfiguration → Bool Source #
Show NodeSophieProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeSophieProtocolConfiguration → ShowS Source # show ∷ NodeSophieProtocolConfiguration → String Source # showList ∷ [NodeSophieProtocolConfiguration] → ShowS Source #
AdjustFilePaths NodeSophieProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeSophieProtocolConfiguration → NodeSophieProtocolConfiguration Source #

data NodeAurumProtocolConfiguration Source #

Constructors

NodeAurumProtocolConfiguration
Fields npcAurumGenesisFile ∷ !GenesisFile npcAurumGenesisFileHash ∷ !(Maybe GenesisHash)

Instances

Instances details

Eq NodeAurumProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods (==) ∷ NodeAurumProtocolConfiguration → NodeAurumProtocolConfiguration → Bool Source # (/=) ∷ NodeAurumProtocolConfiguration → NodeAurumProtocolConfiguration → Bool Source #
Show NodeAurumProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → NodeAurumProtocolConfiguration → ShowS Source # show ∷ NodeAurumProtocolConfiguration → String Source # showList ∷ [NodeAurumProtocolConfiguration] → ShowS Source #
AdjustFilePaths NodeAurumProtocolConfiguration Source #
Instance details Defined in Bcc.Node.Types Methods adjustFilePaths ∷ (FilePath → FilePath) → NodeAurumProtocolConfiguration → NodeAurumProtocolConfiguration Source #

data VRFPrivateKeyFilePermissionError Source #

Constructors

OtherPermissionsExist FilePath
GroupPermissionsExist FilePath
GenericPermissionsExist FilePath

Instances

Instances details

Show VRFPrivateKeyFilePermissionError Source #
Instance details Defined in Bcc.Node.Types Methods showsPrec ∷ Int → VRFPrivateKeyFilePermissionError → ShowS Source # show ∷ VRFPrivateKeyFilePermissionError → String Source # showList ∷ [VRFPrivateKeyFilePermissionError] → ShowS Source #

protocolName ∷ Protocol → String Source #

A human readable name for the protocol

renderVRFPrivateKeyFilePermissionError ∷ VRFPrivateKeyFilePermissionError → Text Source #