cardano-api:internal
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Modes

Description

Consensus modes. The node supports several different modes with different combinations of consensus protocols and ledger eras.

Synopsis

The protocols supported in each era

type family ConsensusProtocol era where ... Source #

Equations

ConsensusProtocol ShelleyEra = TPraos StandardCrypto 
ConsensusProtocol AllegraEra = TPraos StandardCrypto 
ConsensusProtocol MaryEra = TPraos StandardCrypto 
ConsensusProtocol AlonzoEra = TPraos StandardCrypto 
ConsensusProtocol BabbageEra = Praos StandardCrypto 
ConsensusProtocol ConwayEra = Praos StandardCrypto 

type family ChainDepStateProtocol era where ... Source #

Equations

ChainDepStateProtocol ShelleyEra = TPraosState StandardCrypto 
ChainDepStateProtocol AllegraEra = TPraosState StandardCrypto 
ChainDepStateProtocol MaryEra = TPraosState StandardCrypto 
ChainDepStateProtocol AlonzoEra = TPraosState StandardCrypto 
ChainDepStateProtocol BabbageEra = PraosState StandardCrypto 
ChainDepStateProtocol ConwayEra = PraosState StandardCrypto 

Connection parameters for each mode

data ConsensusModeParams where Source #

The consensus-mode-specific parameters needed to connect to a local node that is using each consensus mode.

It is in fact only the Byron era that requires extra parameters, but this is of course inherited by the CardanoMode that uses the Byron era. The reason this parameter is needed stems from unfortunate design decisions from the legacy Byron era. The slots per epoch are needed to be able to decode epoch boundary blocks from the Byron era.

It is possible in future that we may be able to eliminate this parameter by discovering it from the node during the initial handshake.

Constructors

CardanoModeParams :: EpochSlots -> ConsensusModeParams 

Instances

Instances details
Show ConsensusModeParams Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

showsPrec :: Int -> ConsensusModeParams -> ShowS Source #

show :: ConsensusModeParams -> String Source #

showList :: [ConsensusModeParams] -> ShowS Source #

newtype EpochSlots Source #

The number of slots per epoch.

Constructors

EpochSlots 

Fields

Instances

Instances details
Data EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EpochSlots -> c EpochSlots Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EpochSlots Source #

toConstr :: EpochSlots -> Constr Source #

dataTypeOf :: EpochSlots -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EpochSlots) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EpochSlots) Source #

gmapT :: (forall b. Data b => b -> b) -> EpochSlots -> EpochSlots Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EpochSlots -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EpochSlots -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> EpochSlots -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EpochSlots -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EpochSlots -> m EpochSlots Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EpochSlots -> m EpochSlots Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EpochSlots -> m EpochSlots Source #

Generic EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Associated Types

type Rep EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

type Rep EpochSlots = D1 ('MetaData "EpochSlots" "Cardano.Chain.Slotting.EpochSlots" "cardano-ledger-byron-1.0.1.0-170c1b876d38a1aa320a348e79d8a664ced269973d2dc19ad89cab94de534546" 'True) (C1 ('MetaCons "EpochSlots" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSlots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: EpochSlots -> Rep EpochSlots x Source #

to :: Rep EpochSlots x -> EpochSlots Source #

Read EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

readsPrec :: Int -> ReadS EpochSlots Source #

readList :: ReadS [EpochSlots] Source #

readPrec :: ReadPrec EpochSlots Source #

readListPrec :: ReadPrec [EpochSlots] Source #

Show EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

showsPrec :: Int -> EpochSlots -> ShowS Source #

show :: EpochSlots -> String Source #

showList :: [EpochSlots] -> ShowS Source #

FromCBOR EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

fromCBOR :: Decoder s EpochSlots Source #

label :: Proxy EpochSlots -> Text Source #

ToCBOR EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

toCBOR :: EpochSlots -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy EpochSlots -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [EpochSlots] -> Size Source #

DecCBOR EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

decCBOR :: Decoder s EpochSlots Source #

dropCBOR :: Proxy EpochSlots -> Decoder s () Source #

label :: Proxy EpochSlots -> Text Source #

EncCBOR EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

encCBOR :: EpochSlots -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy EpochSlots -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [EpochSlots] -> Size Source #

Buildable EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

build :: EpochSlots -> Builder

Eq EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

(==) :: EpochSlots -> EpochSlots -> Bool Source #

(/=) :: EpochSlots -> EpochSlots -> Bool Source #

Ord EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

compare :: EpochSlots -> EpochSlots -> Ordering Source #

(<) :: EpochSlots -> EpochSlots -> Bool Source #

(<=) :: EpochSlots -> EpochSlots -> Bool Source #

(>) :: EpochSlots -> EpochSlots -> Bool Source #

(>=) :: EpochSlots -> EpochSlots -> Bool Source #

max :: EpochSlots -> EpochSlots -> EpochSlots Source #

min :: EpochSlots -> EpochSlots -> EpochSlots Source #

NoThunks EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

Methods

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

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

showTypeOf :: Proxy EpochSlots -> String #

type Rep EpochSlots 
Instance details

Defined in Cardano.Chain.Slotting.EpochSlots

type Rep EpochSlots = D1 ('MetaData "EpochSlots" "Cardano.Chain.Slotting.EpochSlots" "cardano-ledger-byron-1.0.1.0-170c1b876d38a1aa320a348e79d8a664ced269973d2dc19ad89cab94de534546" 'True) (C1 ('MetaCons "EpochSlots" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSlots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Conversions to and from types in the consensus library

type family ConsensusCryptoForBlock block where ... Source #

Equations

ConsensusCryptoForBlock ByronBlockHFC = StandardCrypto 
ConsensusCryptoForBlock (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) = StandardShelley 
ConsensusCryptoForBlock (CardanoBlock StandardCrypto) = StandardCrypto 

type family ConsensusBlockForEra era where ... Source #

A closed type family that maps between the consensus mode (from this API) and the block type used by the consensus libraries.

Equations

ConsensusBlockForEra ByronEra = ByronBlock 
ConsensusBlockForEra ShelleyEra = StandardShelleyBlock 
ConsensusBlockForEra AllegraEra = StandardAllegraBlock 
ConsensusBlockForEra MaryEra = StandardMaryBlock 
ConsensusBlockForEra AlonzoEra = StandardAlonzoBlock 
ConsensusBlockForEra BabbageEra = StandardBabbageBlock 
ConsensusBlockForEra ConwayEra = StandardConwayBlock 

toConsensusEraIndex :: forall (xs :: [Type]) era. CardanoBlock StandardCrypto ~ HardForkBlock xs => CardanoEra era -> EraIndex xs Source #

fromConsensusEraIndex :: EraIndex (CardanoEras StandardCrypto) -> AnyCardanoEra Source #