Safe Haskell	None
Language	Haskell2010

Cardano.Network.LedgerPeerConsensusInterface

Contents

Re-exports

Synopsis

data LedgerPeersConsensusInterface (m :: Type -> Type) = LedgerPeersConsensusInterface {
- readFetchMode :: STM m FetchMode
- getLedgerStateJudgement :: STM m LedgerStateJudgement
- updateOutboundConnectionsState :: OutboundConnectionsState -> STM m ()
}
data FetchMode
- = FetchModeGenesis
- | PraosFetchMode PraosFetchMode
data LedgerStateJudgement
- = YoungEnough
- | TooOld
data OutboundConnectionsState
- = TrustedStateWithExternalPeers
- | UntrustedState

Documentation

data LedgerPeersConsensusInterface (m :: Type -> Type) Source #

Cardano Node specific consensus interface actions.

Constructors

LedgerPeersConsensusInterface

Fields

readFetchMode :: STM m FetchMode
Required for BlockFetch protocol
getLedgerStateJudgement :: STM m LedgerStateJudgement
updateOutboundConnectionsState :: OutboundConnectionsState -> STM m ()
Callback provided by consensus to inform it if the node is connected to only local roots or also some external peers.
This is useful in order for the Bootstrap State Machine to simply refuse to transition from TooOld to YoungEnough while it only has local peers.

Re-exports

data FetchMode #

Constructors

FetchModeGenesis
PraosFetchMode PraosFetchMode

Instances

Instances details

Show FetchMode
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface Methods showsPrec :: Int -> FetchMode -> ShowS # show :: FetchMode -> String # showList :: [FetchMode] -> ShowS #
Eq FetchMode
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface Methods (==) :: FetchMode -> FetchMode -> Bool # (/=) :: FetchMode -> FetchMode -> Bool #

data LedgerStateJudgement #

Constructors

YoungEnough
TooOld

Instances

Instances details

Generic LedgerStateJudgement

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Associated Types

type Rep LedgerStateJudgement
Instance details Defined in Cardano.Network.LedgerStateJudgement type Rep LedgerStateJudgement = D1 ('MetaData "LedgerStateJudgement" "Cardano.Network.LedgerStateJudgement" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "YoungEnough" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TooOld" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: LedgerStateJudgement -> Rep LedgerStateJudgement x #

to :: Rep LedgerStateJudgement x -> LedgerStateJudgement #

Show LedgerStateJudgement

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Methods

showsPrec :: Int -> LedgerStateJudgement -> ShowS #

show :: LedgerStateJudgement -> String #

showList :: [LedgerStateJudgement] -> ShowS #

Eq LedgerStateJudgement

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Methods

(==) :: LedgerStateJudgement -> LedgerStateJudgement -> Bool #

(/=) :: LedgerStateJudgement -> LedgerStateJudgement -> Bool #

NoThunks LedgerStateJudgement

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Methods

noThunks :: Context -> LedgerStateJudgement -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> LedgerStateJudgement -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy LedgerStateJudgement -> String #

type Rep LedgerStateJudgement

Instance details

Defined in Cardano.Network.LedgerStateJudgement

type Rep LedgerStateJudgement = D1 ('MetaData "LedgerStateJudgement" "Cardano.Network.LedgerStateJudgement" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "YoungEnough" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TooOld" 'PrefixI 'False) (U1 :: Type -> Type))

data OutboundConnectionsState #

Constructors

TrustedStateWithExternalPeers
UntrustedState

Instances

Instances details

Generic OutboundConnectionsState

Instance details

Defined in Cardano.Network.PeerSelection.LocalRootPeers

Associated Types

type Rep OutboundConnectionsState

Instance details

Defined in Cardano.Network.PeerSelection.LocalRootPeers

type Rep OutboundConnectionsState = D1 ('MetaData "OutboundConnectionsState" "Cardano.Network.PeerSelection.LocalRootPeers" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "TrustedStateWithExternalPeers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UntrustedState" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: OutboundConnectionsState -> Rep OutboundConnectionsState x #

to :: Rep OutboundConnectionsState x -> OutboundConnectionsState #

Show OutboundConnectionsState

Instance details

Defined in Cardano.Network.PeerSelection.LocalRootPeers

Methods

showsPrec :: Int -> OutboundConnectionsState -> ShowS #

show :: OutboundConnectionsState -> String #

showList :: [OutboundConnectionsState] -> ShowS #

Eq OutboundConnectionsState

Instance details

Defined in Cardano.Network.PeerSelection.LocalRootPeers

Methods

(==) :: OutboundConnectionsState -> OutboundConnectionsState -> Bool #

(/=) :: OutboundConnectionsState -> OutboundConnectionsState -> Bool #

NoThunks OutboundConnectionsState

Instance details

Defined in Cardano.Network.PeerSelection.LocalRootPeers

Methods

noThunks :: Context -> OutboundConnectionsState -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> OutboundConnectionsState -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy OutboundConnectionsState -> String #

type Rep OutboundConnectionsState

Instance details

Defined in Cardano.Network.PeerSelection.LocalRootPeers

type Rep OutboundConnectionsState = D1 ('MetaData "OutboundConnectionsState" "Cardano.Network.PeerSelection.LocalRootPeers" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "TrustedStateWithExternalPeers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UntrustedState" 'PrefixI 'False) (U1 :: Type -> Type))