Safe Haskell	None
Language	Haskell2010

Cardano.Api.Protocol

Synopsis

data BlockType blk where
- ByronBlockType :: BlockType (HardForkBlock '[ByronBlock])
- ShelleyBlockType :: BlockType (HardForkBlock '[ShelleyBlock (TPraos StandardCrypto) StandardShelley])
- CardanoBlockType :: BlockType (HardForkBlock (CardanoEras StandardCrypto))
data SomeBlockType where
- SomeBlockType :: forall blk. BlockType blk -> SomeBlockType
reflBlockType :: BlockType blk -> BlockType blk' -> Maybe (blk :~: blk')
class (RunNode blk, IOLike m) => Protocol (m :: Type -> Type) blk where
- data ProtocolInfoArgs blk
- protocolInfo :: ProtocolInfoArgs blk -> (ProtocolInfo blk, m [BlockForging m blk])
data family ProtocolInfoArgs blk
class RunNode blk => ProtocolClient blk where
- data ProtocolClientInfoArgs blk
- protocolClientInfo :: ProtocolClientInfoArgs blk -> ProtocolClientInfo blk
data family ProtocolClientInfoArgs blk

Documentation

data BlockType blk where Source #

Constructors

ByronBlockType :: BlockType (HardForkBlock '[ByronBlock])
ShelleyBlockType :: BlockType (HardForkBlock '[ShelleyBlock (TPraos StandardCrypto) StandardShelley])
CardanoBlockType :: BlockType (HardForkBlock (CardanoEras StandardCrypto))

Instances

Instances details

Show (BlockType blk) Source #
Instance details Defined in Cardano.Api.Protocol Methods showsPrec :: Int -> BlockType blk -> ShowS Source # show :: BlockType blk -> String Source # showList :: [BlockType blk] -> ShowS Source #
Eq (BlockType blk) Source #
Instance details Defined in Cardano.Api.Protocol Methods (==) :: BlockType blk -> BlockType blk -> Bool Source # (/=) :: BlockType blk -> BlockType blk -> Bool Source #

data SomeBlockType where Source #

Constructors

SomeBlockType :: forall blk. BlockType blk -> SomeBlockType

Instances

Instances details

Show SomeBlockType Source #
Instance details Defined in Cardano.Api.Protocol Methods showsPrec :: Int -> SomeBlockType -> ShowS Source # show :: SomeBlockType -> String Source # showList :: [SomeBlockType] -> ShowS Source #

reflBlockType :: BlockType blk -> BlockType blk' -> Maybe (blk :~: blk') Source #

class (RunNode blk, IOLike m) => Protocol (m :: Type -> Type) blk where Source #

Associated Types

data ProtocolInfoArgs blk Source #

Methods

protocolInfo :: ProtocolInfoArgs 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

Associated Types

data ProtocolInfoArgs ByronBlockHFC
Instance details Defined in Cardano.Api.Protocol data ProtocolInfoArgs ByronBlockHFC = ProtocolInfoArgsByron ProtocolParamsByron

Methods

protocolInfo :: ProtocolInfoArgs ByronBlockHFC -> (ProtocolInfo ByronBlockHFC, m [BlockForging m ByronBlockHFC]) Source #

(CardanoHardForkConstraints StandardCrypto, IOLike m) => Protocol m (CardanoBlock StandardCrypto) Source #

Instance details

Defined in Cardano.Api.Protocol

Associated Types

data ProtocolInfoArgs (CardanoBlock StandardCrypto)
Instance details Defined in Cardano.Api.Protocol data ProtocolInfoArgs (CardanoBlock StandardCrypto) = ProtocolInfoArgsCardano (CardanoProtocolParams StandardCrypto)

Methods

protocolInfo :: ProtocolInfoArgs (CardanoBlock StandardCrypto) -> (ProtocolInfo (CardanoBlock StandardCrypto), m [BlockForging m (CardanoBlock StandardCrypto)]) Source #

(IOLike m, LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto))) => Protocol m (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) Source #

Instance details

Defined in Cardano.Api.Protocol

Associated Types

data ProtocolInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley)
Instance details Defined in Cardano.Api.Protocol data ProtocolInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) = ProtocolInfoArgsShelley (ShelleyGenesis StandardCrypto) (ProtocolParamsShelleyBased StandardCrypto) ProtVer

Methods

protocolInfo :: ProtocolInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) -> (ProtocolInfo (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley), m [BlockForging m (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley)]) Source #

data family ProtocolInfoArgs blk Source #

Instances

Instances details

data ProtocolInfoArgs ByronBlockHFC Source #
Instance details Defined in Cardano.Api.Protocol data ProtocolInfoArgs ByronBlockHFC = ProtocolInfoArgsByron ProtocolParamsByron
data ProtocolInfoArgs (CardanoBlock StandardCrypto) Source #
Instance details Defined in Cardano.Api.Protocol data ProtocolInfoArgs (CardanoBlock StandardCrypto) = ProtocolInfoArgsCardano (CardanoProtocolParams StandardCrypto)
data ProtocolInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) Source #
Instance details Defined in Cardano.Api.Protocol data ProtocolInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) = ProtocolInfoArgsShelley (ShelleyGenesis StandardCrypto) (ProtocolParamsShelleyBased StandardCrypto) ProtVer

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

Associated Types

data ProtocolClientInfoArgs ByronBlockHFC
Instance details Defined in Cardano.Api.Protocol 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

Associated Types

data ProtocolClientInfoArgs (CardanoBlock StandardCrypto)
Instance details Defined in Cardano.Api.Protocol data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) = ProtocolClientInfoArgsCardano EpochSlots

Methods

protocolClientInfo :: ProtocolClientInfoArgs (CardanoBlock StandardCrypto) -> ProtocolClientInfo (CardanoBlock StandardCrypto) Source #

LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto)) => ProtocolClient (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) Source #

Instance details

Defined in Cardano.Api.Protocol

Associated Types

data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley)
Instance details Defined in Cardano.Api.Protocol data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) = ProtocolClientInfoArgsShelley

Methods

protocolClientInfo :: ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) -> ProtocolClientInfo (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) Source #

data family ProtocolClientInfoArgs blk Source #

Instances

Instances details

data ProtocolClientInfoArgs ByronBlockHFC Source #
Instance details Defined in Cardano.Api.Protocol data ProtocolClientInfoArgs ByronBlockHFC = ProtocolClientInfoArgsByron EpochSlots
data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) Source #
Instance details Defined in Cardano.Api.Protocol data ProtocolClientInfoArgs (CardanoBlock StandardCrypto) = ProtocolClientInfoArgsCardano EpochSlots
data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) Source #
Instance details Defined in Cardano.Api.Protocol data ProtocolClientInfoArgs (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley) = ProtocolClientInfoArgsShelley