type ChainOrderConfig (HardForkTiebreakerView xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type ChainOrderConfig (HardForkTiebreakerView xs) = PerEraChainOrderConfig xs
type ReasonForSwitch (HardForkTiebreakerView xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type ReasonForSwitch (HardForkTiebreakerView xs) = OneEraReasonForSwitch xs

Methods

preferCandidate ∷ ChainOrderConfig (HardForkTiebreakerView xs) → HardForkTiebreakerView xs → HardForkTiebreakerView xs → ShouldSwitch (ReasonForSwitch (HardForkTiebreakerView xs)) Source #

type ChainOrderConfig (HardForkTiebreakerView xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

type ChainOrderConfig (HardForkTiebreakerView xs) = PerEraChainOrderConfig xs

type ReasonForSwitch (HardForkTiebreakerView xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

type ReasonForSwitch (HardForkTiebreakerView xs) = OneEraReasonForSwitch xs

Re-exports to keep `State` an internal module

type HardForkCanBeLeader (xs ∷ [Type]) = SomeErasCanBeLeader xs Source #

We have one or more BlockForgings, and thus CanBeLeader proofs, for each era in which we can forge blocks.

type HardForkChainDepState (xs ∷ [Type]) = HardForkState WrapChainDepState xs Source #

type HardForkIsLeader (xs ∷ [Type]) = OneEraIsLeader xs Source #

We are a leader if we have a proof from one of the eras

data HardForkValidationErr (xs ∷ [Type]) Source #

Constructors

HardForkValidationErrFromEra (OneEraValidationErr xs)	Validation error from one of the eras
HardForkValidationErrWrongEra (MismatchEraInfo xs)	We tried to apply a block from the wrong era

Instances

Instances details

Generic (HardForkValidationErr xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

Associated Types

type Rep (HardForkValidationErr xs)

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

type Rep (HardForkValidationErr xs) = D1 ('MetaData "HardForkValidationErr" "Ouroboros.Consensus.HardFork.Combinator.Protocol" "ouroboros-consensus-3.0.1.0-inplace" 'False) (C1 ('MetaCons "HardForkValidationErrFromEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraValidationErr xs))) :+: C1 ('MetaCons "HardForkValidationErrWrongEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MismatchEraInfo xs))))

Methods

from ∷ HardForkValidationErr xs → Rep (HardForkValidationErr xs) x #

to ∷ Rep (HardForkValidationErr xs) x → HardForkValidationErr xs #

CanHardFork xs ⇒ Show (HardForkValidationErr xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

Methods

showsPrec ∷ Int → HardForkValidationErr xs → ShowS #

show ∷ HardForkValidationErr xs → String #

showList ∷ [HardForkValidationErr xs] → ShowS #

CanHardFork xs ⇒ Eq (HardForkValidationErr xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

Methods

(==) ∷ HardForkValidationErr xs → HardForkValidationErr xs → Bool #

(/=) ∷ HardForkValidationErr xs → HardForkValidationErr xs → Bool #

CanHardFork xs ⇒ NoThunks (HardForkValidationErr xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

Methods

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

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

showTypeOf ∷ Proxy (HardForkValidationErr xs) → String Source #

type Rep (HardForkValidationErr xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

type Rep (HardForkValidationErr xs) = D1 ('MetaData "HardForkValidationErr" "Ouroboros.Consensus.HardFork.Combinator.Protocol" "ouroboros-consensus-3.0.1.0-inplace" 'False) (C1 ('MetaCons "HardForkValidationErrFromEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraValidationErr xs))) :+: C1 ('MetaCons "HardForkValidationErrWrongEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MismatchEraInfo xs))))

Re-exports to keep `LedgerView` an internal module

type HardForkLedgerView = HardForkLedgerView_ WrapLedgerView Source #

data HardForkLedgerView_ (f ∷ Type → Type) (xs ∷ [Type]) Source #

Constructors

HardForkLedgerView
Fields hardForkLedgerViewTransition ∷ !TransitionInfo Information about the transition to the next era, if known hardForkLedgerViewPerEra ∷ !(HardForkState f xs) The underlying ledger view

Instances

Instances details

CanHardFork xs ⇒ Show (HardForkLedgerView_ WrapLedgerView xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol.LedgerView Methods showsPrec ∷ Int → HardForkLedgerView_ WrapLedgerView xs → ShowS # show ∷ HardForkLedgerView_ WrapLedgerView xs → String # showList ∷ [HardForkLedgerView_ WrapLedgerView xs] → ShowS #
(SListI xs, Show a) ⇒ Show (HardForkLedgerView_ (K a ∷ Type → Type) xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol.LedgerView Methods showsPrec ∷ Int → HardForkLedgerView_ (K a ∷ Type → Type) xs → ShowS # show ∷ HardForkLedgerView_ (K a ∷ Type → Type) xs → String # showList ∷ [HardForkLedgerView_ (K a ∷ Type → Type) xs] → ShowS #

Type family instances

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 Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → Ticked () → ShowS # show ∷ Ticked () → String # showList ∷ [Ticked ()] → ShowS #
(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 #
(CanHardFork xs, HasCanonicalTxIn xs, HasHardForkTxOut xs) ⇒ HasLedgerTables (Ticked LedgerState) (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState (HardForkBlock xs) mk → LedgerTables (HardForkBlock xs) mk Source # withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked LedgerState (HardForkBlock xs) any → LedgerTables (HardForkBlock xs) mk → Ticked LedgerState (HardForkBlock xs) mk Source #
(Bridge m a, HasLedgerTables (Ticked LedgerState) m) ⇒ HasLedgerTables (Ticked LedgerState) (DualBlock m a) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual 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 #
CanHardFork xs ⇒ GetTip (Ticked LedgerState (HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods getTip ∷ ∀ (mk ∷ MapKind). Ticked LedgerState (HardForkBlock xs) mk → Point (Ticked LedgerState (HardForkBlock xs)) Source #
Bridge m a ⇒ GetTip (Ticked LedgerState (DualBlock m a)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods getTip ∷ ∀ (mk ∷ MapKind). Ticked LedgerState (DualBlock m a) mk → Point (Ticked LedgerState (DualBlock m a)) 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 #
NoThunks (Ticked LedgerState (DualBlock m a) mk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual 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 #
Show (Ticked (f a)) ⇒ Show (((Ticked ∷ Type → Type) :.: f) a) Source #
Instance details Defined in Ouroboros.Consensus.Ticked 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 Defined in Ouroboros.Consensus.Ticked 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 Defined in Ouroboros.Consensus.Ticked 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 Defined in Ouroboros.Consensus.Protocol.PBFT 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)) }
type HeaderHash (Ticked l blk ∷ k2) Source #
Instance details Defined in Ouroboros.Consensus.Ticked 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) }
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) }
data Ticked LedgerState (DualBlock m a ∷ Type) (mk ∷ MapKind) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual 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 }

Orphan instances

CanHardFork xs ⇒ BlockSupportsProtocol (HardForkBlock xs) Source #

Instance details

Methods

validateView ∷ BlockConfig (HardForkBlock xs) → Header (HardForkBlock xs) → ValidateView (BlockProtocol (HardForkBlock xs)) Source #

tiebreakerView ∷ BlockConfig (HardForkBlock xs) → Header (HardForkBlock xs) → TiebreakerView (BlockProtocol (HardForkBlock xs)) Source #

projectChainOrderConfig ∷ BlockConfig (HardForkBlock xs) → ChainOrderConfig (SelectView (BlockProtocol (HardForkBlock xs))) Source #

CanHardFork xs ⇒ ConsensusProtocol (HardForkProtocol xs) Source #

Instance details

Associated Types

type ChainDepState (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type ChainDepState (HardForkProtocol xs) = HardForkChainDepState xs
type IsLeader (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type IsLeader (HardForkProtocol xs) = HardForkIsLeader xs
type CanBeLeader (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type CanBeLeader (HardForkProtocol xs) = HardForkCanBeLeader xs
type TiebreakerView (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type TiebreakerView (HardForkProtocol xs) = HardForkTiebreakerView xs
type LedgerView (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type LedgerView (HardForkProtocol xs) = HardForkLedgerView xs
type ValidationErr (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type ValidationErr (HardForkProtocol xs) = HardForkValidationErr xs
type ValidateView (HardForkProtocol xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol type ValidateView (HardForkProtocol xs) = OneEraValidateView xs

Methods

checkIsLeader ∷ ConsensusConfig (HardForkProtocol xs) → CanBeLeader (HardForkProtocol xs) → SlotNo → Ticked (ChainDepState (HardForkProtocol xs)) → Maybe (IsLeader (HardForkProtocol xs)) Source #

tickChainDepState ∷ ConsensusConfig (HardForkProtocol xs) → LedgerView (HardForkProtocol xs) → SlotNo → ChainDepState (HardForkProtocol xs) → Ticked (ChainDepState (HardForkProtocol xs)) Source #

updateChainDepState ∷ ConsensusConfig (HardForkProtocol xs) → ValidateView (HardForkProtocol xs) → SlotNo → Ticked (ChainDepState (HardForkProtocol xs)) → Except (ValidationErr (HardForkProtocol xs)) (ChainDepState (HardForkProtocol xs)) Source #

reupdateChainDepState ∷ ConsensusConfig (HardForkProtocol xs) → ValidateView (HardForkProtocol xs) → SlotNo → Ticked (ChainDepState (HardForkProtocol xs)) → ChainDepState (HardForkProtocol xs) Source #

protocolSecurityParam ∷ ConsensusConfig (HardForkProtocol xs) → SecurityParam Source #

Documentation

Instances

Re-exports to keep State an internal module

Instances

Re-exports to keep LedgerView an internal module

Instances

Type family instances

Instances

Orphan instances

Re-exports to keep `State` an internal module

Re-exports to keep `LedgerView` an internal module