Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Node.Configuration.TopologyP2P

Synopsis

newtype TopologyError = NodeIdNotFoundInToplogyFile FilePath
data NetworkTopology = RealNodeTopology !LocalRootPeersGroups ![PublicRootPeers] !UseLedger
newtype PublicRootPeers = PublicRootPeers {
- publicRoots :: RootConfig
}
data LocalRootPeersGroup = LocalRootPeersGroup {
- localRoots :: RootConfig
- hotValency :: HotValency
- warmValency :: WarmValency
}
newtype LocalRootPeersGroups = LocalRootPeersGroups {
- groups :: [LocalRootPeersGroup]
}
data RootConfig = RootConfig {
- rootAccessPoints :: [RelayAccessPoint]
- rootAdvertise :: PeerAdvertise
}
newtype NodeHostIPAddress = NodeHostIPAddress {
- unNodeHostIPAddress :: IP
}
newtype NodeHostIPv4Address = NodeHostIPv4Address {
- unNodeHostIPv4Address :: IPv4
}
newtype NodeHostIPv6Address = NodeHostIPv6Address {
- unNodeHostIPv6Address :: IPv6
}
data NodeSetup = NodeSetup {
- nodeId :: !Word64
- nodeIPv4Address :: !(Maybe NodeIPv4Address)
- nodeIPv6Address :: !(Maybe NodeIPv6Address)
- producers :: ![RootConfig]
- useLedger :: !UseLedger
}
data PeerAdvertise
- = DoNotAdvertisePeer
- | DoAdvertisePeer
nodeAddressToSockAddr :: NodeIPAddress -> SockAddr
readTopologyFile :: Tracer IO (StartupTrace blk) -> NodeConfiguration -> IO (Either Text NetworkTopology)
readTopologyFileOrError :: Tracer IO (StartupTrace blk) -> NodeConfiguration -> IO NetworkTopology
rootConfigToRelayAccessPoint :: RootConfig -> [(RelayAccessPoint, PeerAdvertise)]

Documentation

newtype TopologyError Source #

Constructors

NodeIdNotFoundInToplogyFile FilePath

Instances

Instances details

Show TopologyError Source #
Instance details Defined in Cardano.Node.Configuration.Topology Methods showsPrec :: Int -> TopologyError -> ShowS Source # show :: TopologyError -> String Source # showList :: [TopologyError] -> ShowS Source #

data NetworkTopology Source #

Constructors

RealNodeTopology !LocalRootPeersGroups ![PublicRootPeers] !UseLedger

Instances

Instances details

FromJSON NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods parseJSON :: Value -> Parser NetworkTopology parseJSONList :: Value -> Parser [NetworkTopology] omittedField :: Maybe NetworkTopology
ToJSON NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods toJSON :: NetworkTopology -> Value # toEncoding :: NetworkTopology -> Encoding toJSONList :: [NetworkTopology] -> Value toEncodingList :: [NetworkTopology] -> Encoding omitField :: NetworkTopology -> Bool
Show NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods showsPrec :: Int -> NetworkTopology -> ShowS Source # show :: NetworkTopology -> String Source # showList :: [NetworkTopology] -> ShowS Source #
Eq NetworkTopology Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods (==) :: NetworkTopology -> NetworkTopology -> Bool Source # (/=) :: NetworkTopology -> NetworkTopology -> Bool Source #

newtype PublicRootPeers Source #

Constructors

PublicRootPeers
Fields publicRoots :: RootConfig

Instances

Instances details

FromJSON PublicRootPeers Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods parseJSON :: Value -> Parser PublicRootPeers parseJSONList :: Value -> Parser [PublicRootPeers] omittedField :: Maybe PublicRootPeers
ToJSON PublicRootPeers Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods toJSON :: PublicRootPeers -> Value # toEncoding :: PublicRootPeers -> Encoding toJSONList :: [PublicRootPeers] -> Value toEncodingList :: [PublicRootPeers] -> Encoding omitField :: PublicRootPeers -> Bool
Show PublicRootPeers Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods showsPrec :: Int -> PublicRootPeers -> ShowS Source # show :: PublicRootPeers -> String Source # showList :: [PublicRootPeers] -> ShowS Source #
Eq PublicRootPeers Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods (==) :: PublicRootPeers -> PublicRootPeers -> Bool Source # (/=) :: PublicRootPeers -> PublicRootPeers -> Bool Source #

data LocalRootPeersGroup Source #

A local root peers group. Local roots are treated by the outbound governor in a special way. The node will make sure that a node has the requested number (valency/hotValency) of connections to the local root peer group. warmValency value is the value of warm/established connections that the node will attempt to maintain. By default this value will be equal to hotValency.

Constructors

LocalRootPeersGroup
Fields localRoots :: RootConfig hotValency :: HotValency warmValency :: WarmValency

Instances

Instances details

FromJSON LocalRootPeersGroup Source #	Does not use the `FromJSON` instance of `RootConfig`, so that `accessPoints`, `advertise`, `valency` and `warmValency` fields are attached to the same object.
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods parseJSON :: Value -> Parser LocalRootPeersGroup parseJSONList :: Value -> Parser [LocalRootPeersGroup] omittedField :: Maybe LocalRootPeersGroup
ToJSON LocalRootPeersGroup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods toJSON :: LocalRootPeersGroup -> Value # toEncoding :: LocalRootPeersGroup -> Encoding toJSONList :: [LocalRootPeersGroup] -> Value toEncodingList :: [LocalRootPeersGroup] -> Encoding omitField :: LocalRootPeersGroup -> Bool
Show LocalRootPeersGroup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods showsPrec :: Int -> LocalRootPeersGroup -> ShowS Source # show :: LocalRootPeersGroup -> String Source # showList :: [LocalRootPeersGroup] -> ShowS Source #
Eq LocalRootPeersGroup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods (==) :: LocalRootPeersGroup -> LocalRootPeersGroup -> Bool Source # (/=) :: LocalRootPeersGroup -> LocalRootPeersGroup -> Bool Source #

newtype LocalRootPeersGroups Source #

Constructors

LocalRootPeersGroups
Fields groups :: [LocalRootPeersGroup]

Instances

Instances details

FromJSON LocalRootPeersGroups Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods parseJSON :: Value -> Parser LocalRootPeersGroups parseJSONList :: Value -> Parser [LocalRootPeersGroups] omittedField :: Maybe LocalRootPeersGroups
ToJSON LocalRootPeersGroups Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods toJSON :: LocalRootPeersGroups -> Value # toEncoding :: LocalRootPeersGroups -> Encoding toJSONList :: [LocalRootPeersGroups] -> Value toEncodingList :: [LocalRootPeersGroups] -> Encoding omitField :: LocalRootPeersGroups -> Bool
Show LocalRootPeersGroups Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods showsPrec :: Int -> LocalRootPeersGroups -> ShowS Source # show :: LocalRootPeersGroups -> String Source # showList :: [LocalRootPeersGroups] -> ShowS Source #
Eq LocalRootPeersGroups Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods (==) :: LocalRootPeersGroups -> LocalRootPeersGroups -> Bool Source # (/=) :: LocalRootPeersGroups -> LocalRootPeersGroups -> Bool Source #

data RootConfig Source #

Each root peer consists of a list of access points and a shared PeerAdvertise field.

Constructors

RootConfig
Fields rootAccessPoints :: [RelayAccessPoint] a list of relay access points, each of which is either an ip address or domain name and a port number. rootAdvertise :: PeerAdvertise `advertise` configures whether the root should be advertised through gossip.

Instances

Instances details

FromJSON RootConfig Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods parseJSON :: Value -> Parser RootConfig parseJSONList :: Value -> Parser [RootConfig] omittedField :: Maybe RootConfig
ToJSON RootConfig Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods toJSON :: RootConfig -> Value # toEncoding :: RootConfig -> Encoding toJSONList :: [RootConfig] -> Value toEncodingList :: [RootConfig] -> Encoding omitField :: RootConfig -> Bool
Show RootConfig Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods showsPrec :: Int -> RootConfig -> ShowS Source # show :: RootConfig -> String Source # showList :: [RootConfig] -> ShowS Source #
Eq RootConfig Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods (==) :: RootConfig -> RootConfig -> Bool Source # (/=) :: RootConfig -> RootConfig -> Bool Source #

newtype NodeHostIPAddress Source #

Constructors

NodeHostIPAddress
Fields unNodeHostIPAddress :: IP

Instances

Instances details

FromJSON NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods parseJSON :: Value -> Parser NodeHostIPAddress parseJSONList :: Value -> Parser [NodeHostIPAddress] omittedField :: Maybe NodeHostIPAddress
ToJSON NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods toJSON :: NodeHostIPAddress -> Value # toEncoding :: NodeHostIPAddress -> Encoding toJSONList :: [NodeHostIPAddress] -> Value toEncodingList :: [NodeHostIPAddress] -> Encoding omitField :: NodeHostIPAddress -> Bool
Show NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods showsPrec :: Int -> NodeHostIPAddress -> ShowS Source # show :: NodeHostIPAddress -> String Source # showList :: [NodeHostIPAddress] -> ShowS Source #
Eq NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods (==) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool Source # (/=) :: NodeHostIPAddress -> NodeHostIPAddress -> Bool Source #
Ord NodeHostIPAddress Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress 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 #

newtype NodeHostIPv4Address Source #

Constructors

NodeHostIPv4Address
Fields unNodeHostIPv4Address :: IPv4

Instances

Instances details

FromJSON NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods parseJSON :: Value -> Parser NodeHostIPv4Address parseJSONList :: Value -> Parser [NodeHostIPv4Address] omittedField :: Maybe NodeHostIPv4Address
ToJSON NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods toJSON :: NodeHostIPv4Address -> Value # toEncoding :: NodeHostIPv4Address -> Encoding toJSONList :: [NodeHostIPv4Address] -> Value toEncodingList :: [NodeHostIPv4Address] -> Encoding omitField :: NodeHostIPv4Address -> Bool
Show NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods showsPrec :: Int -> NodeHostIPv4Address -> ShowS Source # show :: NodeHostIPv4Address -> String Source # showList :: [NodeHostIPv4Address] -> ShowS Source #
Eq NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods (==) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool Source # (/=) :: NodeHostIPv4Address -> NodeHostIPv4Address -> Bool Source #
Ord NodeHostIPv4Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress 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 #

newtype NodeHostIPv6Address Source #

Constructors

NodeHostIPv6Address
Fields unNodeHostIPv6Address :: IPv6

Instances

Instances details

FromJSON NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods parseJSON :: Value -> Parser NodeHostIPv6Address parseJSONList :: Value -> Parser [NodeHostIPv6Address] omittedField :: Maybe NodeHostIPv6Address
ToJSON NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods toJSON :: NodeHostIPv6Address -> Value # toEncoding :: NodeHostIPv6Address -> Encoding toJSONList :: [NodeHostIPv6Address] -> Value toEncodingList :: [NodeHostIPv6Address] -> Encoding omitField :: NodeHostIPv6Address -> Bool
Show NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods showsPrec :: Int -> NodeHostIPv6Address -> ShowS Source # show :: NodeHostIPv6Address -> String Source # showList :: [NodeHostIPv6Address] -> ShowS Source #
Eq NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress Methods (==) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool Source # (/=) :: NodeHostIPv6Address -> NodeHostIPv6Address -> Bool Source #
Ord NodeHostIPv6Address Source #
Instance details Defined in Cardano.Node.Configuration.NodeAddress 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 #

data NodeSetup Source #

Constructors

NodeSetup
Fields nodeId :: !Word64 nodeIPv4Address :: !(Maybe NodeIPv4Address) nodeIPv6Address :: !(Maybe NodeIPv6Address) producers :: ![RootConfig] useLedger :: !UseLedger

Instances

Instances details

FromJSON NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods parseJSON :: Value -> Parser NodeSetup parseJSONList :: Value -> Parser [NodeSetup] omittedField :: Maybe NodeSetup
ToJSON NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods toJSON :: NodeSetup -> Value # toEncoding :: NodeSetup -> Encoding toJSONList :: [NodeSetup] -> Value toEncodingList :: [NodeSetup] -> Encoding omitField :: NodeSetup -> Bool
Show NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods showsPrec :: Int -> NodeSetup -> ShowS Source # show :: NodeSetup -> String Source # showList :: [NodeSetup] -> ShowS Source #
Eq NodeSetup Source #
Instance details Defined in Cardano.Node.Configuration.TopologyP2P Methods (==) :: NodeSetup -> NodeSetup -> Bool Source # (/=) :: NodeSetup -> NodeSetup -> Bool Source #

data PeerAdvertise #

Constructors

DoNotAdvertisePeer
DoAdvertisePeer

Instances

Instances details

FromJSON PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods parseJSON :: Value -> Parser PeerAdvertise parseJSONList :: Value -> Parser [PeerAdvertise] omittedField :: Maybe PeerAdvertise
ToJSON PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods toJSON :: PeerAdvertise -> Value # toEncoding :: PeerAdvertise -> Encoding toJSONList :: [PeerAdvertise] -> Value toEncodingList :: [PeerAdvertise] -> Encoding omitField :: PeerAdvertise -> Bool
Generic PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Associated Types type Rep PeerAdvertise :: Type -> Type Source # Methods from :: PeerAdvertise -> Rep PeerAdvertise x Source # to :: Rep PeerAdvertise x -> PeerAdvertise Source #
Show PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods showsPrec :: Int -> PeerAdvertise -> ShowS Source # show :: PeerAdvertise -> String Source # showList :: [PeerAdvertise] -> ShowS Source #
Eq PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods (==) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (/=) :: PeerAdvertise -> PeerAdvertise -> Bool Source #
Ord PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods compare :: PeerAdvertise -> PeerAdvertise -> Ordering Source # (<) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (<=) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (>) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (>=) :: PeerAdvertise -> PeerAdvertise -> Bool Source # max :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise Source # min :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise Source #
type Rep PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise type Rep PeerAdvertise = D1 ('MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.PeerAdvertise" "ouroboros-network-api-0.6.1.0-A47bjiHDBREVwYFbul59o" 'False) (C1 ('MetaCons "DoNotAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoAdvertisePeer" 'PrefixI 'False) (U1 :: Type -> Type))

nodeAddressToSockAddr :: NodeIPAddress -> SockAddr Source #

readTopologyFile :: Tracer IO (StartupTrace blk) -> NodeConfiguration -> IO (Either Text NetworkTopology) Source #

Read the NetworkTopology configuration from the specified file.

readTopologyFileOrError :: Tracer IO (StartupTrace blk) -> NodeConfiguration -> IO NetworkTopology Source #

rootConfigToRelayAccessPoint :: RootConfig -> [(RelayAccessPoint, PeerAdvertise)] Source #

Transforms a RootConfig into a pair of RelayAccessPoint and its corresponding PeerAdvertise value.