ouroboros-consensus-cardano-0.25.1.0: The instantation of the Ouroboros consensus layer used by Cardano
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Protocol.Types

Synopsis

Documentation

data BlockType blk where Source #

Constructors

ByronBlockType ∷ BlockType (HardForkBlock '[ByronBlock]) 
ShelleyBlockType ∷ BlockType (HardForkBlock '[ShelleyBlock (TPraos StandardCrypto) ShelleyEra]) 
CardanoBlockType ∷ BlockType (HardForkBlock (CardanoEras StandardCrypto)) 

Instances

Instances details
Show (BlockType blk) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Methods

showsPrec ∷ Int → BlockType blk → ShowS #

show ∷ BlockType blk → String #

showList ∷ [BlockType blk] → ShowS #

Eq (BlockType blk) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Methods

(==) ∷ BlockType blk → BlockType blk → Bool #

(/=) ∷ BlockType blk → BlockType blk → Bool #

class (RunNode blk, IOLike m) ⇒ Protocol (m ∷ Type → Type) blk where Source #

Associated Types

data ProtocolInfoArgs (m ∷ Type → Type) blk Source #

Methods

protocolInfo ∷ ProtocolInfoArgs m blk → (ProtocolInfo blk, m [BlockForging m blk]) Source #

Instances

Instances details
IOLike m ⇒ Protocol m ByronBlockHFC Source #

Run PBFT against the Byron ledger

Instance details

Defined in Cardano.Api.Protocol.Types

Associated Types

data ProtocolInfoArgs m ByronBlockHFC 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolInfoArgs m ByronBlockHFC = ProtocolInfoArgsByron ProtocolParamsByron

Methods

protocolInfo ∷ ProtocolInfoArgs m ByronBlockHFC → (ProtocolInfo ByronBlockHFC, m [BlockForging m ByronBlockHFC]) Source #

(CardanoHardForkConstraints StandardCrypto, IOLike m) ⇒ Protocol m (CardanoBlock StandardCrypto) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Associated Types

data ProtocolInfoArgs m (CardanoBlock StandardCrypto) 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolInfoArgs m (CardanoBlock StandardCrypto) = ProtocolInfoArgsCardano (CardanoProtocolParams StandardCrypto)

Methods

protocolInfo ∷ ProtocolInfoArgs m (CardanoBlock StandardCrypto) → (ProtocolInfo (CardanoBlock StandardCrypto), m [BlockForging m (CardanoBlock StandardCrypto)]) Source #

(IOLike m, LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) ShelleyEra)) ⇒ Protocol m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Associated Types

data ProtocolInfoArgs m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolInfoArgs m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) = ProtocolInfoArgsShelley ShelleyGenesis (ProtocolParamsShelleyBased StandardCrypto) ProtVer

Methods

protocolInfo ∷ ProtocolInfoArgs m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) → (ProtocolInfo (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra), m [BlockForging m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra)]) Source #

class RunNode blk ⇒ ProtocolClient blk where Source #

Node client support for each consensus protocol.

This is like Protocol but for clients of the node, so with less onerous requirements than to run a node.

Associated Types

data ProtocolClientInfoArgs blk Source #

Methods

protocolClientInfo ∷ ProtocolClientInfoArgs blk → ProtocolClientInfo blk Source #

Instances

Instances details
ProtocolClient ByronBlockHFC Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Associated Types

data ProtocolClientInfoArgs ByronBlockHFC 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolClientInfoArgs ByronBlockHFC = ProtocolClientInfoArgsByron EpochSlots

Methods

protocolClientInfo ∷ ProtocolClientInfoArgs ByronBlockHFC → ProtocolClientInfo ByronBlockHFC Source #

CardanoHardForkConstraints StandardCrypto ⇒ ProtocolClient (CardanoBlock StandardCrypto) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Associated Types

data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) = ProtocolClientInfoArgsCardano EpochSlots

Methods

protocolClientInfo ∷ ProtocolClientInfoArgs (CardanoBlock StandardCrypto) → ProtocolClientInfo (CardanoBlock StandardCrypto) Source #

LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) ShelleyEra) ⇒ ProtocolClient (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

Associated Types

data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) = ProtocolClientInfoArgsShelley

Methods

protocolClientInfo ∷ ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) → ProtocolClientInfo (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) Source #

data family ProtocolClientInfoArgs blk Source #

Instances

Instances details
data ProtocolClientInfoArgs ByronBlockHFC Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolClientInfoArgs ByronBlockHFC = ProtocolClientInfoArgsByron EpochSlots
data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) = ProtocolClientInfoArgsCardano EpochSlots
data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) = ProtocolClientInfoArgsShelley

data family ProtocolInfoArgs (m ∷ Type → Type) blk Source #

Instances

Instances details
data ProtocolInfoArgs m ByronBlockHFC Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolInfoArgs m ByronBlockHFC = ProtocolInfoArgsByron ProtocolParamsByron
data ProtocolInfoArgs m (CardanoBlock StandardCrypto) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolInfoArgs m (CardanoBlock StandardCrypto) = ProtocolInfoArgsCardano (CardanoProtocolParams StandardCrypto)
data ProtocolInfoArgs m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) Source # 
Instance details

Defined in Cardano.Api.Protocol.Types

data ProtocolInfoArgs m (ShelleyBlockHFC (TPraos StandardCrypto) ShelleyEra) = ProtocolInfoArgsShelley ShelleyGenesis (ProtocolParamsShelleyBased StandardCrypto) ProtVer