Documentation

Associated Types

type Rep (ConsensusConfig (Praos c))

Instance details

type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: (S1 ('MetaSel ('Just "praosInitialEta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "praosInitialStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeDist))) :*: (S1 ('MetaSel ('Just "praosEvolvingStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosEvolvingStake) :*: (S1 ('MetaSel ('Just "praosSignKeyVRF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyVRF (PraosVRF c))) :*: S1 ('MetaSel ('Just "praosVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c))))))))

Methods

from ∷ ConsensusConfig (Praos c) → Rep (ConsensusConfig (Praos c)) x #

to ∷ Rep (ConsensusConfig (Praos c)) x → ConsensusConfig (Praos c) #

PraosCrypto c ⇒ NoThunks (ConsensusConfig (Praos c)) Source #

Instance details

Methods

noThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (Praos c)) → String Source #

PraosCrypto c ⇒ ConsensusProtocol (Praos c) Source #

Instance details

Associated Types

type ChainDepState (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type ChainDepState (Praos c) = PraosChainDepState c
type IsLeader (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type IsLeader (Praos c)
type CanBeLeader (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type CanBeLeader (Praos c) = CoreNodeId
type TiebreakerView (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type TiebreakerView (Praos c) = NoTiebreaker
type LedgerView (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type LedgerView (Praos c) = ()
type ValidationErr (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type ValidationErr (Praos c) = PraosValidationError c
type ValidateView (Praos c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type ValidateView (Praos c) = PraosValidateView c

Methods

checkIsLeader ∷ ConsensusConfig (Praos c) → CanBeLeader (Praos c) → SlotNo → Ticked (ChainDepState (Praos c)) → Maybe (IsLeader (Praos c)) Source #

tickChainDepState ∷ ConsensusConfig (Praos c) → LedgerView (Praos c) → SlotNo → ChainDepState (Praos c) → Ticked (ChainDepState (Praos c)) Source #

updateChainDepState ∷ ConsensusConfig (Praos c) → ValidateView (Praos c) → SlotNo → Ticked (ChainDepState (Praos c)) → Except (ValidationErr (Praos c)) (ChainDepState (Praos c)) Source #

reupdateChainDepState ∷ ConsensusConfig (Praos c) → ValidateView (Praos c) → SlotNo → Ticked (ChainDepState (Praos c)) → ChainDepState (Praos c) Source #

protocolSecurityParam ∷ ConsensusConfig (Praos c) → SecurityParam Source #

type Rep (ConsensusConfig (Praos c)) Source #

Instance details

type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: (S1 ('MetaSel ('Just "praosInitialEta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "praosInitialStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeDist))) :*: (S1 ('MetaSel ('Just "praosEvolvingStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosEvolvingStake) :*: (S1 ('MetaSel ('Just "praosSignKeyVRF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyVRF (PraosVRF c))) :*: S1 ('MetaSel ('Just "praosVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c))))))))

type CanBeLeader (Praos c) Source #

Instance details

type CanBeLeader (Praos c) = CoreNodeId

type ChainDepState (Praos c) Source #

Instance details

type ChainDepState (Praos c) = PraosChainDepState c

data ConsensusConfig (Praos c) Source #

The configuration that will be provided to every node when running the MockPraos protocol.

Instance details

data ConsensusConfig (Praos c) = PraosConfig {

praosParams ∷ !PraosParams
praosInitialEta ∷ !Natural
praosInitialStake ∷ !StakeDist
praosEvolvingStake ∷ !PraosEvolvingStake
praosSignKeyVRF ∷ !(SignKeyVRF (PraosVRF c))
praosVerKeys ∷ !(Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c)))

}

type IsLeader (Praos c) Source #

Instance details

type IsLeader (Praos c)

type LedgerView (Praos c) Source #

Instance details

type LedgerView (Praos c) = ()

type TiebreakerView (Praos c) Source #

Instance details

type TiebreakerView (Praos c) = NoTiebreaker

type ValidateView (Praos c) Source #

Instance details

type ValidateView (Praos c) = PraosValidateView c

type ValidationErr (Praos c) Source #

Instance details

type ValidationErr (Praos c) = PraosValidationError c

newtype PraosChainDepState c Source #

The chain dependent state, in this case as it is a mock, we just will store a list of BlockInfos that allow us to look into the past.

Constructors

PraosChainDepState
Fields praosHistory ∷ [BlockInfo c]

Instances

Instances details

PraosCrypto c ⇒ Eq (PraosChainDepState c) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods (==) ∷ PraosChainDepState c → PraosChainDepState c → Bool # (/=) ∷ PraosChainDepState c → PraosChainDepState c → Bool #
PraosCrypto c ⇒ Show (PraosChainDepState c) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods showsPrec ∷ Int → PraosChainDepState c → ShowS # show ∷ PraosChainDepState c → String # showList ∷ [PraosChainDepState c] → ShowS #
PraosCrypto c ⇒ NoThunks (PraosChainDepState c) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods noThunks ∷ Context → PraosChainDepState c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosChainDepState c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PraosChainDepState c) → String Source #
ChainDepStateSupportsPeras (PraosChainDepState c) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods getEpochNonce ∷ PraosChainDepState c → Nonce Source #
PraosCrypto c ⇒ Serialise (PraosChainDepState c) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods encode ∷ PraosChainDepState c → Encoding Source # decode ∷ Decoder s (PraosChainDepState c) Source # encodeList ∷ [PraosChainDepState c] → Encoding Source # decodeList ∷ Decoder s [PraosChainDepState c] Source #
ChainDepStateSupportsPeras (Ticked (PraosChainDepState c)) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods getEpochNonce ∷ Ticked (PraosChainDepState c) → Nonce Source #
PraosCrypto c' ⇒ DecodeDisk (SimplePraosBlock c c') (PraosChainDepState c') Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block.Praos Methods decodeDisk ∷ CodecConfig (SimplePraosBlock c c') → ∀ s. Decoder s (PraosChainDepState c') Source #
PraosCrypto c' ⇒ EncodeDisk (SimplePraosBlock c c') (PraosChainDepState c') Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block.Praos Methods encodeDisk ∷ CodecConfig (SimplePraosBlock c c') → PraosChainDepState c' → Encoding Source #
data Ticked (PraosChainDepState c ∷ Type) Source #	Ticking the Praos chain dep state has no effect For the real Praos implementation, ticking is crucial, as it determines the point where the "nonce under construction" is swapped out for the "active" nonce. However, for the mock implementation, we keep the full history, and choose the right nonce from that; this means that ticking has no effect. We do however need access to the ticked stake distribution.
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos data Ticked (PraosChainDepState c ∷ Type) = TickedPraosChainDepState { praosLedgerView ∷ LedgerView (Praos c) untickedPraosChainDepState ∷ PraosChainDepState c }

newtype PraosEvolvingStake Source #

An association from epoch to stake distributions.

Should be used when checking if someone is the leader of a particular slot. This is sufficiently good for a mock protocol as far as consensus is concerned. It is not strictly necessary that the stake distribution is computed from previous epochs, as we just need to consider that:

1) an attacker cannot influence it. 2) all the nodes agree on the same value for each Slot.

Each pair stores the stake distribution established by the end of the epoch in the first item of the pair. See latestEvolvedStakeDistAsOfEpoch for the intended interface.

If no value is returned, that means we are checking the stake before any changes have happened so we should consult instead the praosInitialStake.

Constructors

PraosEvolvingStake (Map EpochNo StakeDist)

Instances

Instances details

Show PraosEvolvingStake Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods showsPrec ∷ Int → PraosEvolvingStake → ShowS # show ∷ PraosEvolvingStake → String # showList ∷ [PraosEvolvingStake] → ShowS #
NoThunks PraosEvolvingStake Source #
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos Methods noThunks ∷ Context → PraosEvolvingStake → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosEvolvingStake → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy PraosEvolvingStake → String Source #

data PraosExtraFields c Source #

Fields that should be included in the signature

Constructors

PraosExtraFields
Fields praosCreator ∷ CoreNodeId praosRho ∷ CertifiedVRF (PraosVRF c) (Natural, SlotNo, VRFType) praosY ∷ CertifiedVRF (PraosVRF c) (Natural, SlotNo, VRFType)

Instances

Instances details

PraosCrypto c ⇒ Eq (PraosExtraFields c) Source #

Instance details

Methods

(==) ∷ PraosExtraFields c → PraosExtraFields c → Bool #

(/=) ∷ PraosExtraFields c → PraosExtraFields c → Bool #

Generic (PraosExtraFields c) Source #

Instance details

Associated Types

type Rep (PraosExtraFields c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type Rep (PraosExtraFields c)

Methods

from ∷ PraosExtraFields c → Rep (PraosExtraFields c) x #

to ∷ Rep (PraosExtraFields c) x → PraosExtraFields c #

PraosCrypto c ⇒ Show (PraosExtraFields c) Source #

Instance details

Methods

showsPrec ∷ Int → PraosExtraFields c → ShowS #

show ∷ PraosExtraFields c → String #

showList ∷ [PraosExtraFields c] → ShowS #

PraosCrypto c ⇒ NoThunks (PraosExtraFields c) Source #

Instance details

Methods

noThunks ∷ Context → PraosExtraFields c → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PraosExtraFields c → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PraosExtraFields c) → String Source #

type Rep (PraosExtraFields c) Source #

Instance details

type Rep (PraosExtraFields c)

data PraosFields crypto typeBeingSigned Source #

The fields that Praos required in the header

Constructors

PraosFields
Fields praosSignature ∷ SignedKES (PraosKES crypto) typeBeingSigned praosExtraFields ∷ PraosExtraFields crypto

Instances

Instances details

PraosCrypto c ⇒ Eq (PraosFields c toSign) Source #

Instance details

Methods

(==) ∷ PraosFields c toSign → PraosFields c toSign → Bool #

(/=) ∷ PraosFields c toSign → PraosFields c toSign → Bool #

Generic (PraosFields crypto typeBeingSigned) Source #

Instance details

Associated Types

type Rep (PraosFields crypto typeBeingSigned)

Instance details

type Rep (PraosFields crypto typeBeingSigned) = D1 ('MetaData "PraosFields" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SignedKES (PraosKES crypto) typeBeingSigned)) :*: S1 ('MetaSel ('Just "praosExtraFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PraosExtraFields crypto))))

Methods

from ∷ PraosFields crypto typeBeingSigned → Rep (PraosFields crypto typeBeingSigned) x #

to ∷ Rep (PraosFields crypto typeBeingSigned) x → PraosFields crypto typeBeingSigned #

PraosCrypto c ⇒ Show (PraosFields c toSign) Source #

Instance details

Methods

showsPrec ∷ Int → PraosFields c toSign → ShowS #

show ∷ PraosFields c toSign → String #

showList ∷ [PraosFields c toSign] → ShowS #

(PraosCrypto c, Typeable toSign) ⇒ NoThunks (PraosFields c toSign) Source #

Instance details

Methods

noThunks ∷ Context → PraosFields c toSign → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PraosFields c toSign → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PraosFields c toSign) → String Source #

PraosCrypto c ⇒ Condense (PraosFields c toSign) Source #

Instance details

Methods

condense ∷ PraosFields c toSign → String Source #

type Rep (PraosFields crypto typeBeingSigned) Source #

Instance details

type Rep (PraosFields crypto typeBeingSigned) = D1 ('MetaData "PraosFields" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SignedKES (PraosKES crypto) typeBeingSigned)) :*: S1 ('MetaSel ('Just "praosExtraFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PraosExtraFields crypto))))

data PraosParams Source #

Praos parameters that are node independent

Constructors

PraosParams
Fields praosLeaderF ∷ !Double f, the active slots coefficient, defined in 3.3 in the Praos paper. praosSecurityParam ∷ !SecurityParam k, maximum number of blocks we can rollback praosSlotsPerEpoch ∷ !Word64 R, slots in each epoch, defined in section 3 in the Praos paper.

Instances

Instances details

Generic PraosParams Source #

Instance details

Associated Types

type Rep PraosParams

Instance details

type Rep PraosParams = D1 ('MetaData "PraosParams" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosLeaderF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "praosSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: S1 ('MetaSel ('Just "praosSlotsPerEpoch") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))))

Methods

from ∷ PraosParams → Rep PraosParams x #

to ∷ Rep PraosParams x → PraosParams #

NoThunks PraosParams Source #

Instance details

Methods

noThunks ∷ Context → PraosParams → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PraosParams → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PraosParams → String Source #

type Rep PraosParams Source #

Instance details

type Rep PraosParams = D1 ('MetaData "PraosParams" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosLeaderF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "praosSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: S1 ('MetaSel ('Just "praosSlotsPerEpoch") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))))

emptyPraosEvolvingStake ∷ PraosEvolvingStake Source #

evolveKey ∷ PraosCrypto c ⇒ SlotNo → HotKey c → (HotKey c, UpdateInfo (HotKey c) HotKeyEvolutionError) Source #

To be used in conjunction with, e.g., modifyMVar.

NOTE: when the key's period is after the target period, we shouldn't use it, but we currently do. In real TPraos we check this in tpraosCheckCanForge.

forgePraosFields ∷ (PraosCrypto c, Signable (PraosKES c) toSign, HasCallStack) ⇒ PraosProof c → HotKey c → (PraosExtraFields c → toSign) → PraosFields c toSign Source #

Create a PraosFields using a proof, a key and the data to be signed.

It is done by signing whatever is extracted from the extra fields by mkToSign and storing the signature and the extra fields on a PraosFields.

Type instances

data BlockInfo c Source #

Constructors

BlockInfo
Fields biSlot ∷ !SlotNo biRho ∷ !(CertifiedVRF (PraosVRF c) (Natural, SlotNo, VRFType))

Instances

Instances details

PraosCrypto c ⇒ Eq (BlockInfo c) Source #

Instance details

Methods

(==) ∷ BlockInfo c → BlockInfo c → Bool #

(/=) ∷ BlockInfo c → BlockInfo c → Bool #

Generic (BlockInfo c) Source #

Instance details

Associated Types

type Rep (BlockInfo c)
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos type Rep (BlockInfo c)

Methods

from ∷ BlockInfo c → Rep (BlockInfo c) x #

to ∷ Rep (BlockInfo c) x → BlockInfo c #

PraosCrypto c ⇒ Show (BlockInfo c) Source #

Instance details

Methods

showsPrec ∷ Int → BlockInfo c → ShowS #

show ∷ BlockInfo c → String #

showList ∷ [BlockInfo c] → ShowS #

PraosCrypto c ⇒ NoThunks (BlockInfo c) Source #

Instance details

Methods

noThunks ∷ Context → BlockInfo c → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → BlockInfo c → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (BlockInfo c) → String Source #

PraosCrypto c ⇒ Serialise (BlockInfo c) Source #

Instance details

Methods

encode ∷ BlockInfo c → Encoding Source #

decode ∷ Decoder s (BlockInfo c) Source #

encodeList ∷ [BlockInfo c] → Encoding Source #

decodeList ∷ Decoder s [BlockInfo c] Source #

type Rep (BlockInfo c) Source #

Instance details

type Rep (BlockInfo c)

data family ConsensusConfig p Source #

Static configuration required to run the consensus protocol

Every method in the ConsensusProtocol class takes the consensus configuration as a parameter, so having this as a data family rather than a type family resolves most ambiguity.

Defined out of the class so that protocols can define this type without having to define the entire protocol at the same time (or indeed in the same module).

Instances

Instances details

Generic (ConsensusConfig (HardForkProtocol xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Associated Types

type Rep (ConsensusConfig (HardForkProtocol xs))

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

type Rep (ConsensusConfig (HardForkProtocol xs)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.HardFork.Combinator.Basics" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "HardForkConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardForkConsensusConfigK") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "hardForkConsensusConfigShape") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Shape xs)) :*: S1 ('MetaSel ('Just "hardForkConsensusConfigPerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerEraConsensusConfig xs)))))

Methods

from ∷ ConsensusConfig (HardForkProtocol xs) → Rep (ConsensusConfig (HardForkProtocol xs)) x #

to ∷ Rep (ConsensusConfig (HardForkProtocol xs)) x → ConsensusConfig (HardForkProtocol xs) #

Generic (ConsensusConfig (Bft c)) Source #

Instance details

Associated Types

type Rep (ConsensusConfig (Bft c))

Instance details

type Rep (ConsensusConfig (Bft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.BFT" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "BftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "bftParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BftParams) :*: (S1 ('MetaSel ('Just "bftSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (BftDSIGN c))) :*: S1 ('MetaSel ('Just "bftVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map NodeId (VerKeyDSIGN (BftDSIGN c)))))))

Methods

from ∷ ConsensusConfig (Bft c) → Rep (ConsensusConfig (Bft c)) x #

to ∷ Rep (ConsensusConfig (Bft c)) x → ConsensusConfig (Bft c) #

Generic (ConsensusConfig (ModChainSel p t)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

Associated Types

type Rep (ConsensusConfig (ModChainSel p t))

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

type Rep (ConsensusConfig (ModChainSel p t)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))

Methods

from ∷ ConsensusConfig (ModChainSel p t) → Rep (ConsensusConfig (ModChainSel p t)) x #

to ∷ Rep (ConsensusConfig (ModChainSel p t)) x → ConsensusConfig (ModChainSel p t) #

Generic (ConsensusConfig (PBft c)) Source #

Instance details

Associated Types

type Rep (ConsensusConfig (PBft c))
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))

Methods

from ∷ ConsensusConfig (PBft c) → Rep (ConsensusConfig (PBft c)) x #

to ∷ Rep (ConsensusConfig (PBft c)) x → ConsensusConfig (PBft c) #

Generic (ConsensusConfig (WithLeaderSchedule p)) Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

Associated Types

type Rep (ConsensusConfig (WithLeaderSchedule p))

Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

type Rep (ConsensusConfig (WithLeaderSchedule p)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.LeaderSchedule" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "WLSConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "wlsConfigSchedule") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeaderSchedule) :*: (S1 ('MetaSel ('Just "wlsConfigP") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ConsensusConfig p)) :*: S1 ('MetaSel ('Just "wlsConfigNodeId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CoreNodeId))))

Methods

from ∷ ConsensusConfig (WithLeaderSchedule p) → Rep (ConsensusConfig (WithLeaderSchedule p)) x #

to ∷ Rep (ConsensusConfig (WithLeaderSchedule p)) x → ConsensusConfig (WithLeaderSchedule p) #

Generic (ConsensusConfig (Praos c)) Source #

Instance details

Associated Types

type Rep (ConsensusConfig (Praos c))

Instance details

type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: (S1 ('MetaSel ('Just "praosInitialEta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "praosInitialStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeDist))) :*: (S1 ('MetaSel ('Just "praosEvolvingStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosEvolvingStake) :*: (S1 ('MetaSel ('Just "praosSignKeyVRF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyVRF (PraosVRF c))) :*: S1 ('MetaSel ('Just "praosVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c))))))))

Methods

from ∷ ConsensusConfig (Praos c) → Rep (ConsensusConfig (Praos c)) x #

to ∷ Rep (ConsensusConfig (Praos c)) x → ConsensusConfig (Praos c) #

CanHardFork xs ⇒ NoThunks (ConsensusConfig (HardForkProtocol xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

noThunks ∷ Context → ConsensusConfig (HardForkProtocol xs) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (HardForkProtocol xs) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (HardForkProtocol xs)) → String Source #

BftCrypto c ⇒ NoThunks (ConsensusConfig (Bft c)) Source #

Instance details

Methods

noThunks ∷ Context → ConsensusConfig (Bft c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (Bft c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (Bft c)) → String Source #

ConsensusProtocol p ⇒ NoThunks (ConsensusConfig (ModChainSel p t)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

Methods

noThunks ∷ Context → ConsensusConfig (ModChainSel p t) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (ModChainSel p t) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (ModChainSel p t)) → String Source #

NoThunks (ConsensusConfig (PBft c)) Source #

Instance details

Methods

noThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (PBft c)) → String Source #

ConsensusProtocol p ⇒ NoThunks (ConsensusConfig (WithLeaderSchedule p)) Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

Methods

noThunks ∷ Context → ConsensusConfig (WithLeaderSchedule p) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (WithLeaderSchedule p) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (WithLeaderSchedule p)) → String Source #

PraosCrypto c ⇒ NoThunks (ConsensusConfig (Praos c)) Source #

Instance details

Methods

noThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (Praos c)) → String Source #

type Rep (ConsensusConfig (HardForkProtocol xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

type Rep (ConsensusConfig (HardForkProtocol xs)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.HardFork.Combinator.Basics" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "HardForkConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardForkConsensusConfigK") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "hardForkConsensusConfigShape") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Shape xs)) :*: S1 ('MetaSel ('Just "hardForkConsensusConfigPerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerEraConsensusConfig xs)))))

type Rep (ConsensusConfig (Bft c)) Source #

Instance details

type Rep (ConsensusConfig (Bft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.BFT" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "BftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "bftParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BftParams) :*: (S1 ('MetaSel ('Just "bftSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (BftDSIGN c))) :*: S1 ('MetaSel ('Just "bftVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map NodeId (VerKeyDSIGN (BftDSIGN c)))))))

type Rep (ConsensusConfig (ModChainSel p t)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

type Rep (ConsensusConfig (ModChainSel p t)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))

type Rep (ConsensusConfig (PBft c)) Source #

Instance details

type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))

type Rep (ConsensusConfig (WithLeaderSchedule p)) Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

type Rep (ConsensusConfig (WithLeaderSchedule p)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.LeaderSchedule" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "WLSConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "wlsConfigSchedule") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeaderSchedule) :*: (S1 ('MetaSel ('Just "wlsConfigP") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ConsensusConfig p)) :*: S1 ('MetaSel ('Just "wlsConfigNodeId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CoreNodeId))))

type Rep (ConsensusConfig (Praos c)) Source #

Instance details

type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: (S1 ('MetaSel ('Just "praosInitialEta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "praosInitialStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeDist))) :*: (S1 ('MetaSel ('Just "praosEvolvingStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosEvolvingStake) :*: (S1 ('MetaSel ('Just "praosSignKeyVRF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyVRF (PraosVRF c))) :*: S1 ('MetaSel ('Just "praosVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c))))))))

data ConsensusConfig (HardForkProtocol xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

data ConsensusConfig (HardForkProtocol xs) = HardForkConsensusConfig {

hardForkConsensusConfigK ∷ !SecurityParam
hardForkConsensusConfigShape ∷ !(Shape xs)
hardForkConsensusConfigPerEra ∷ !(PerEraConsensusConfig xs)

}

data ConsensusConfig (Bft c) Source #

(Static) node configuration

Instance details

data ConsensusConfig (Bft c) = BftConfig {

bftParams ∷ !BftParams
bftSignKey ∷ !(SignKeyDSIGN (BftDSIGN c))
bftVerKeys ∷ !(Map NodeId (VerKeyDSIGN (BftDSIGN c)))

}

newtype ConsensusConfig (PBft c) Source #

(Static) node configuration

Instance details

newtype ConsensusConfig (PBft c) = PBftConfig {

pbftParams ∷ PBftParams

}

data ConsensusConfig (WithLeaderSchedule p) Source #

Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

data ConsensusConfig (WithLeaderSchedule p) = WLSConfig {

}

data ConsensusConfig (Praos c) Source #

The configuration that will be provided to every node when running the MockPraos protocol.

Instance details

data ConsensusConfig (Praos c) = PraosConfig {

praosParams ∷ !PraosParams
praosInitialEta ∷ !Natural
praosInitialStake ∷ !StakeDist
praosEvolvingStake ∷ !PraosEvolvingStake
praosSignKeyVRF ∷ !(SignKeyVRF (PraosVRF c))
praosVerKeys ∷ !(Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c)))

}

newtype ConsensusConfig (ModChainSel p t) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

newtype ConsensusConfig (ModChainSel p t) = McsConsensusConfig {

mcsConfigP ∷ ConsensusConfig p

}

data family Ticked (st ∷ k) ∷ k Source #

" Ticked " piece of state, either LedgerState or ChainDepState

Ticking refers to the passage of time (the ticking of the clock). When a piece of state is marked as ticked, it means that time-related changes have been applied to the state. There are exactly two methods in the interface that do that: tickChainDepState and applyChainTickLedgerResult.

Also note that a successful forecast forecastFor (ledgerViewForecastAt cfg st) slot must equal protocolLedgerView cfg (applyChainTick cfg slot st). Thus a LedgerView can only be projected from a Ticked state, but cannot itself be ticked.

Some examples of time related changes:

Scheduled delegations might have been applied in Byron
New leader schedule computed for Shelley
Transition from Byron to Shelley activated in the hard fork combinator.
Nonces switched out at the start of a new epoch.

Ticked is used mainly in two ways:

Ticked (Ext)LedgerState where its kind gets concretized to StateKind -> StateKind
Ticked (HeaderState blk) where its kind gets concretized to Type -> Type

Instances

Instances details

Show (Ticked ()) Source #

Instance details

Methods

showsPrec ∷ Int → Ticked () → ShowS #

show ∷ Ticked () → String #

showList ∷ [Ticked ()] → ShowS #

ChainDepStateSupportsPeras (Ticked (ChainDepState (BlockProtocol blk))) ⇒ ChainDepStateSupportsPeras (Ticked (HeaderState blk)) Source #

Instance details

Defined in Ouroboros.Consensus.HeaderValidation

Methods

getEpochNonce ∷ Ticked (HeaderState blk) → Nonce Source #

ChainDepStateSupportsPeras (Ticked (PBftState c)) Source #

Instance details

Methods

getEpochNonce ∷ Ticked (PBftState c) → Nonce Source #

ChainDepStateSupportsPeras (Ticked (PraosChainDepState c)) Source #

Instance details

Methods

getEpochNonce ∷ Ticked (PraosChainDepState c) → Nonce Source #

ChainDepStateSupportsPeras (Ticked ()) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.Abstract

Methods

getEpochNonce ∷ Ticked () → Nonce Source #

HasLedgerTables (Ticked LedgerState) TestBlock #

Instance details

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState TestBlock mk → LedgerTables TestBlock mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState TestBlock any → LedgerTables TestBlock mk → Ticked LedgerState TestBlock mk Source #

HasLedgerTables (Ticked LedgerState) TestBlock #

Instance details

Defined in Test.Util.TestBlock

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState TestBlock mk → LedgerTables TestBlock mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState TestBlock any → LedgerTables TestBlock mk → Ticked LedgerState TestBlock mk Source #

(NoThunks (TxIn blk), NoThunks (TxOut blk), HasLedgerTables (Ticked LedgerState) blk) ⇒ HasLedgerTables (Ticked ExtLedgerState) blk Source #

Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked ExtLedgerState blk mk → LedgerTables blk mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked ExtLedgerState blk any → LedgerTables blk mk → Ticked ExtLedgerState blk mk Source #

LedgerTablesAreTrivial (Ticked LedgerState) TestBlock #

Instance details

Methods

convertMapKind ∷ ∀ (mk ∷ MapKind) (mk' ∷ MapKind). Ticked LedgerState TestBlock mk → Ticked LedgerState TestBlock mk' Source #

LedgerTablesAreTrivial (Ticked LedgerState) TestBlock #

Instance details

Defined in Test.Util.TestBlock

Methods

convertMapKind ∷ ∀ (mk ∷ MapKind) (mk' ∷ MapKind). Ticked LedgerState TestBlock mk → Ticked LedgerState TestBlock mk' Source #

(Bridge m a, HasLedgerTables (Ticked LedgerState) m) ⇒ HasLedgerTables (Ticked LedgerState) (DualBlock m a) Source #

Instance details

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState (DualBlock m a) mk → LedgerTables (DualBlock m a) mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState (DualBlock m a) any → LedgerTables (DualBlock m a) mk → Ticked LedgerState (DualBlock m a) mk Source #

HasLedgerTables (Ticked LedgerState) (SimpleBlock c ext) Source #

Instance details

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState (SimpleBlock c ext) mk → LedgerTables (SimpleBlock c ext) mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState (SimpleBlock c ext) any → LedgerTables (SimpleBlock c ext) mk → Ticked LedgerState (SimpleBlock c ext) mk Source #

Bridge m a ⇒ GetTip (Ticked LedgerState (DualBlock m a)) Source #

Instance details

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked LedgerState (DualBlock m a) mk → Point (Ticked LedgerState (DualBlock m a)) Source #

GetTip (Ticked LedgerState TestBlock) #

Instance details

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked LedgerState TestBlock mk → Point (Ticked LedgerState TestBlock) Source #

GetTip (Ticked LedgerState (TestBlockWith ptype)) #

Instance details

Defined in Test.Util.TestBlock

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked LedgerState (TestBlockWith ptype) mk → Point (Ticked LedgerState (TestBlockWith ptype)) Source #

GetTip (Ticked LedgerState (SimpleBlock c ext)) Source #

Instance details

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked LedgerState (SimpleBlock c ext) mk → Point (Ticked LedgerState (SimpleBlock c ext)) Source #

IsLedger LedgerState blk ⇒ GetTip (Ticked ExtLedgerState blk) Source #

Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked ExtLedgerState blk mk → Point (Ticked ExtLedgerState blk) Source #

LedgerStateSupportsPeras (Ticked LedgerState (DualBlock m a)) Source #

Instance details

Methods

getPoolDistr ∷ Ticked LedgerState (DualBlock m a) EmptyMK → PoolDistr Source #

getPerasParams ∷ proxy blk → Ticked LedgerState (DualBlock m a) EmptyMK → PerasParams blk Source #

LedgerStateSupportsPeras (Ticked LedgerState TestBlock) #

Instance details

Methods

getPoolDistr ∷ Ticked LedgerState TestBlock EmptyMK → PoolDistr Source #

getPerasParams ∷ proxy blk → Ticked LedgerState TestBlock EmptyMK → PerasParams blk Source #

LedgerStateSupportsPeras (Ticked LedgerState (TestBlockWith ptype)) #

Instance details

Defined in Test.Util.TestBlock

Methods

getPoolDistr ∷ Ticked LedgerState (TestBlockWith ptype) EmptyMK → PoolDistr Source #

getPerasParams ∷ proxy blk → Ticked LedgerState (TestBlockWith ptype) EmptyMK → PerasParams blk Source #

LedgerStateSupportsPeras (Ticked LedgerState (SimpleBlock c ext)) Source #

Instance details

Methods

getPoolDistr ∷ Ticked LedgerState (SimpleBlock c ext) EmptyMK → PoolDistr Source #

getPerasParams ∷ proxy blk → Ticked LedgerState (SimpleBlock c ext) EmptyMK → PerasParams blk Source #

CanStowLedgerTables (Ticked LedgerState (SimpleBlock c ext)) Source #

Instance details

Methods

stowLedgerTables ∷ Ticked LedgerState (SimpleBlock c ext) ValuesMK → Ticked LedgerState (SimpleBlock c ext) EmptyMK Source #

unstowLedgerTables ∷ Ticked LedgerState (SimpleBlock c ext) EmptyMK → Ticked LedgerState (SimpleBlock c ext) ValuesMK Source #

Generic (Ticked LedgerState (TestBlockWith ptype) mk) #

Instance details

Defined in Test.Util.TestBlock

Associated Types

type Rep (Ticked LedgerState (TestBlockWith ptype) mk)

Instance details

Defined in Test.Util.TestBlock

type Rep (Ticked LedgerState (TestBlockWith ptype) mk) = D1 ('MetaData "Ticked" "Test.Util.TestBlock" "ouroboros-consensus-4.0.0.0-inplace-unstable-consensus-testlib" 'True) (C1 ('MetaCons "TickedTestLedger" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedTestLedger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (TestBlockWith ptype) mk))))

Methods

from ∷ Ticked LedgerState (TestBlockWith ptype) mk → Rep (Ticked LedgerState (TestBlockWith ptype) mk) x #

to ∷ Rep (Ticked LedgerState (TestBlockWith ptype) mk) x → Ticked LedgerState (TestBlockWith ptype) mk #

Generic (Ticked LedgerState (SimpleBlock c ext) mk) Source #

Instance details

Associated Types

type Rep (Ticked LedgerState (SimpleBlock c ext) mk)

Instance details

type Rep (Ticked LedgerState (SimpleBlock c ext) mk) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.Mock.Ledger.Block" "ouroboros-consensus-4.0.0.0-inplace-unstable-mock-block" 'True) (C1 ('MetaCons "TickedSimpleLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedSimpleLedgerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (SimpleBlock c ext) mk))))

Methods

from ∷ Ticked LedgerState (SimpleBlock c ext) mk → Rep (Ticked LedgerState (SimpleBlock c ext) mk) x #

to ∷ Rep (Ticked LedgerState (SimpleBlock c ext) mk) x → Ticked LedgerState (SimpleBlock c ext) mk #

(SimpleCrypto c, Typeable ext, Show (LedgerState (SimpleBlock c ext) mk)) ⇒ Show (Ticked LedgerState (SimpleBlock c ext) mk) Source #

Instance details

Methods

showsPrec ∷ Int → Ticked LedgerState (SimpleBlock c ext) mk → ShowS #

show ∷ Ticked LedgerState (SimpleBlock c ext) mk → String #

showList ∷ [Ticked LedgerState (SimpleBlock c ext) mk] → ShowS #

NoThunks (Ticked LedgerState (DualBlock m a) mk) Source #

Instance details

Methods

noThunks ∷ Context → Ticked LedgerState (DualBlock m a) mk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Ticked LedgerState (DualBlock m a) mk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Ticked LedgerState (DualBlock m a) mk) → String Source #

(NoThunksMK mk, NoThunks (PayloadDependentState ptype mk)) ⇒ NoThunks (Ticked LedgerState (TestBlockWith ptype) mk) #

Instance details

Defined in Test.Util.TestBlock

Methods

noThunks ∷ Context → Ticked LedgerState (TestBlockWith ptype) mk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Ticked LedgerState (TestBlockWith ptype) mk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Ticked LedgerState (TestBlockWith ptype) mk) → String Source #

(SimpleCrypto c, Typeable ext) ⇒ NoThunks (Ticked LedgerState (SimpleBlock c ext) TrackingMK) Source #

Instance details

Methods

noThunks ∷ Context → Ticked LedgerState (SimpleBlock c ext) TrackingMK → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Ticked LedgerState (SimpleBlock c ext) TrackingMK → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Ticked LedgerState (SimpleBlock c ext) TrackingMK) → String Source #

Show (Ticked (f a)) ⇒ Show (((Ticked ∷ Type → Type) :.: f) a) Source #

Instance details

Methods

showsPrec ∷ Int → ((Ticked ∷ Type → Type) :.: f) a → ShowS #

show ∷ ((Ticked ∷ Type → Type) :.: f) a → String #

showList ∷ [((Ticked ∷ Type → Type) :.: f) a] → ShowS #

NoThunks (Ticked (f a)) ⇒ NoThunks (((Ticked ∷ Type → Type) :.: f) a) Source #

Instance details

Methods

noThunks ∷ Context → ((Ticked ∷ Type → Type) :.: f) a → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ((Ticked ∷ Type → Type) :.: f) a → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (((Ticked ∷ Type → Type) :.: f) a) → String Source #

data Ticked () Source #

Instance details

data Ticked () = TickedTrivial

data Ticked (HardForkChainDepState xs ∷ Type) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

data Ticked (HardForkChainDepState xs ∷ Type) = TickedHardForkChainDepState {

tickedHardForkChainDepStatePerEra ∷ HardForkState ((Ticked ∷ Type → Type) :.: WrapChainDepState) xs
tickedHardForkChainDepStateEpochInfo ∷ EpochInfo (Except PastHorizonException)

}

data Ticked (HeaderState blk ∷ Type) Source #

Instance details

Defined in Ouroboros.Consensus.HeaderValidation

data Ticked (HeaderState blk ∷ Type) = TickedHeaderState {

untickedHeaderStateTip ∷ WithOrigin (AnnTip blk)
tickedHeaderStateChainDep ∷ Ticked (ChainDepState (BlockProtocol blk))

}

data Ticked (PBftState c ∷ Type) Source #

Instance details

data Ticked (PBftState c ∷ Type) = TickedPBftState {

getPBftLedgerView ∷ LedgerView (PBft c)
getTickedPBftState ∷ PBftState c

}

newtype Ticked (WrapChainDepState blk ∷ Type) Source #

Instance details

Defined in Ouroboros.Consensus.TypeFamilyWrappers

newtype Ticked (WrapChainDepState blk ∷ Type) = WrapTickedChainDepState {

unwrapTickedChainDepState ∷ Ticked (ChainDepState (BlockProtocol blk))

}

data Ticked (PraosChainDepState c ∷ Type) Source #

Ticking the Praos chain dep state has no effect

For the real Praos implementation, ticking is crucial, as it determines the point where the "nonce under construction" is swapped out for the "active" nonce. However, for the mock implementation, we keep the full history, and choose the right nonce from that; this means that ticking has no effect.

We do however need access to the ticked stake distribution.

Instance details

data Ticked (PraosChainDepState c ∷ Type) = TickedPraosChainDepState {

praosLedgerView ∷ LedgerView (Praos c)
untickedPraosChainDepState ∷ PraosChainDepState c

}

type HeaderHash (Ticked l blk ∷ k2) Source #

Instance details

type HeaderHash (Ticked l blk ∷ k2) = HeaderHash (l blk)

data Ticked ExtLedgerState (blk ∷ Type) (mk ∷ MapKind) Source #

Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

data Ticked ExtLedgerState (blk ∷ Type) (mk ∷ MapKind) = TickedExtLedgerState {

tickedLedgerState ∷ Ticked LedgerState blk mk
ledgerView ∷ LedgerView (BlockProtocol blk)
tickedHeaderState ∷ Ticked (HeaderState blk)
tickedPerasState ∷ PerasState blk

}

newtype Ticked LedgerState TestBlock (mk ∷ MapKind) #

Instance details

newtype Ticked LedgerState TestBlock (mk ∷ MapKind) = TickedTestLedger {

getTickedTestLedger ∷ LedgerState TestBlock mk

}

data Ticked LedgerState (HardForkBlock xs ∷ Type) (mk ∷ MapKind) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger

data Ticked LedgerState (HardForkBlock xs ∷ Type) (mk ∷ MapKind) = TickedHardForkLedgerState {

tickedHardForkLedgerStateTransition ∷ !TransitionInfo
tickedHardForkLedgerStatePerEra ∷ !(HardForkState (FlipTickedLedgerState mk) xs)

}

newtype Ticked LedgerState (TestBlockWith ptype ∷ Type) (mk ∷ MapKind) #

Instance details

Defined in Test.Util.TestBlock

newtype Ticked LedgerState (TestBlockWith ptype ∷ Type) (mk ∷ MapKind) = TickedTestLedger {

getTickedTestLedger ∷ LedgerState (TestBlockWith ptype) mk

}

data Ticked LedgerState (DualBlock m a ∷ Type) (mk ∷ MapKind) Source #

Instance details

data Ticked LedgerState (DualBlock m a ∷ Type) (mk ∷ MapKind) = TickedDualLedgerState {

tickedDualLedgerStateMain ∷ Ticked LedgerState m mk
tickedDualLedgerStateAux ∷ Ticked LedgerState a ValuesMK
tickedDualLedgerStateBridge ∷ BridgeLedger m a
tickedDualLedgerStateAuxOrig ∷ LedgerState a ValuesMK

}

newtype Ticked LedgerState (SimpleBlock c ext ∷ Type) (mk ∷ MapKind) Source #

Instance details

newtype Ticked LedgerState (SimpleBlock c ext ∷ Type) (mk ∷ MapKind) = TickedSimpleLedgerState {

getTickedSimpleLedgerState ∷ LedgerState (SimpleBlock c ext) mk

}

type Rep (Ticked LedgerState (TestBlockWith ptype) mk) #

Instance details

Defined in Test.Util.TestBlock

type Rep (Ticked LedgerState (TestBlockWith ptype) mk) = D1 ('MetaData "Ticked" "Test.Util.TestBlock" "ouroboros-consensus-4.0.0.0-inplace-unstable-consensus-testlib" 'True) (C1 ('MetaCons "TickedTestLedger" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedTestLedger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (TestBlockWith ptype) mk))))

type Rep (Ticked LedgerState (SimpleBlock c ext) mk) Source #

Instance details