Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Shelley.API.Validation

Description

Interface to the block validation and chain extension logic in the Shelley API.

Synopsis

class (EraGov era, EraSegWits era) ⇒ ApplyBlock era where
- applyBlock ∷ SingEP ep → ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → (NewEpochState era, [PredicateFailure (EraRule "BBODY" era)], [Event (EraRule "BBODY" era)])
- applyTick ∷ SingEP ep → Globals → NewEpochState era → SlotNo → (NewEpochState era, [Event (EraRule "TICK" era)])
applyBlockEither ∷ ApplyBlock era ⇒ SingEP ep → ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → Either (BlockTransitionError era) (NewEpochState era, [Event (EraRule "BBODY" era)])
applyBlockEitherNoEvents ∷ ApplyBlock era ⇒ ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → Either (BlockTransitionError era) (NewEpochState era)
applyBlockNoValidaton ∷ ApplyBlock era ⇒ Globals → NewEpochState era → Block BHeaderView era → NewEpochState era
applyTickNoEvents ∷ ApplyBlock era ⇒ Globals → NewEpochState era → SlotNo → NewEpochState era
newtype TickTransitionError era = TickTransitionError (NonEmpty (PredicateFailure (EraRule "TICK" era)))
newtype BlockTransitionError era = BlockTransitionError (NonEmpty (PredicateFailure (EraRule "BBODY" era)))
chainChecks ∷ ∀ m. MonadError ChainPredicateFailure m ⇒ Version → ChainChecksPParams → BHeaderView → m ()

Documentation

class (EraGov era, EraSegWits era) ⇒ ApplyBlock era where Source #

Minimal complete definition

Nothing

Methods

applyBlock ∷ SingEP ep → ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → (NewEpochState era, [PredicateFailure (EraRule "BBODY" era)], [Event (EraRule "BBODY" era)]) Source #

Run the BBODY rule with globalAssertionPolicy. This function always succeeds, but whenever validation is turned on it is necessary to check for presence of predicate failures before a call can be marked successful. Therefore it is recommended to call applyBlockEither instead.

default applyBlock ∷ (STS (EraRule "BBODY" era), BaseM (EraRule "BBODY" era) ~ ShelleyBase, Environment (EraRule "BBODY" era) ~ BbodyEnv era, State (EraRule "BBODY" era) ~ ShelleyBbodyState era, Signal (EraRule "BBODY" era) ~ Block BHeaderView era, State (EraRule "LEDGERS" era) ~ LedgerState era) ⇒ SingEP ep → ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → (NewEpochState era, [PredicateFailure (EraRule "BBODY" era)], [Event (EraRule "BBODY" era)]) Source #

applyTick ∷ SingEP ep → Globals → NewEpochState era → SlotNo → (NewEpochState era, [Event (EraRule "TICK" era)]) Source #

Run the TICK rule with globalAssertionPolicy and without any validation, since it can't fail anyways.

default applyTick ∷ (STS (EraRule "TICK" era), BaseM (EraRule "TICK" era) ~ ShelleyBase, Environment (EraRule "TICK" era) ~ (), State (EraRule "TICK" era) ~ NewEpochState era, Signal (EraRule "TICK" era) ~ SlotNo) ⇒ SingEP ep → Globals → NewEpochState era → SlotNo → (NewEpochState era, [Event (EraRule "TICK" era)]) Source #

Instances

Instances details

ApplyBlock ShelleyEra Source #

Instance details

Defined in Cardano.Ledger.Shelley.API.Validation

Methods

applyBlock ∷ ∀ (ep ∷ EventPolicy). SingEP ep → ValidationPolicy → Globals → NewEpochState ShelleyEra → Block BHeaderView ShelleyEra → (NewEpochState ShelleyEra, [PredicateFailure (EraRule "BBODY" ShelleyEra)], [Event (EraRule "BBODY" ShelleyEra)]) Source #

applyTick ∷ ∀ (ep ∷ EventPolicy). SingEP ep → Globals → NewEpochState ShelleyEra → SlotNo → (NewEpochState ShelleyEra, [Event (EraRule "TICK" ShelleyEra)]) Source #

applyBlockEither ∷ ApplyBlock era ⇒ SingEP ep → ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → Either (BlockTransitionError era) (NewEpochState era, [Event (EraRule "BBODY" era)]) Source #

Same as applyBlock, except it produces a Left when there are failures present and Right with result otherwise.

applyBlockEitherNoEvents ∷ ApplyBlock era ⇒ ValidationPolicy → Globals → NewEpochState era → Block BHeaderView era → Either (BlockTransitionError era) (NewEpochState era) Source #

applyBlockNoValidaton ∷ ApplyBlock era ⇒ Globals → NewEpochState era → Block BHeaderView era → NewEpochState era Source #

Re-apply a ledger block to the same state it has been applied to before.

This function does no validation of whether the block applies successfully; the caller implicitly guarantees that they have previously called applyBlockTransition on the same block and that this was successful.

applyTickNoEvents ∷ ApplyBlock era ⇒ Globals → NewEpochState era → SlotNo → NewEpochState era Source #

Same as applyTick, but do not retain any ledger events

newtype TickTransitionError era Source #

Constructors

TickTransitionError (NonEmpty (PredicateFailure (EraRule "TICK" era)))

Instances

Instances details

Generic (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Associated Types type Rep (TickTransitionError era) ∷ Type → Type # Methods from ∷ TickTransitionError era → Rep (TickTransitionError era) x # to ∷ Rep (TickTransitionError era) x → TickTransitionError era #
Show (PredicateFailure (EraRule "TICK" era)) ⇒ Show (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods showsPrec ∷ Int → TickTransitionError era → ShowS # show ∷ TickTransitionError era → String # showList ∷ [TickTransitionError era] → ShowS #
Eq (PredicateFailure (EraRule "TICK" era)) ⇒ Eq (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods (==) ∷ TickTransitionError era → TickTransitionError era → Bool # (/=) ∷ TickTransitionError era → TickTransitionError era → Bool #
NoThunks (PredicateFailure (EraRule "TICK" era)) ⇒ NoThunks (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods noThunks ∷ Context → TickTransitionError era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → TickTransitionError era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (TickTransitionError era) → String Source #
type Rep (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation type Rep (TickTransitionError era) = D1 ('MetaData "TickTransitionError" "Cardano.Ledger.Shelley.API.Validation" "cardano-ledger-shelley-1.16.0.0-inplace" 'True) (C1 ('MetaCons "TickTransitionError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (PredicateFailure (EraRule "TICK" era))))))

newtype BlockTransitionError era Source #

Constructors

BlockTransitionError (NonEmpty (PredicateFailure (EraRule "BBODY" era)))

Instances

Instances details

Generic (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Associated Types type Rep (BlockTransitionError era) ∷ Type → Type # Methods from ∷ BlockTransitionError era → Rep (BlockTransitionError era) x # to ∷ Rep (BlockTransitionError era) x → BlockTransitionError era #
Show (PredicateFailure (EraRule "BBODY" era)) ⇒ Show (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods showsPrec ∷ Int → BlockTransitionError era → ShowS # show ∷ BlockTransitionError era → String # showList ∷ [BlockTransitionError era] → ShowS #
Eq (PredicateFailure (EraRule "BBODY" era)) ⇒ Eq (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods (==) ∷ BlockTransitionError era → BlockTransitionError era → Bool # (/=) ∷ BlockTransitionError era → BlockTransitionError era → Bool #
NoThunks (PredicateFailure (EraRule "BBODY" era)) ⇒ NoThunks (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods noThunks ∷ Context → BlockTransitionError era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → BlockTransitionError era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (BlockTransitionError era) → String Source #
type Rep (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation type Rep (BlockTransitionError era) = D1 ('MetaData "BlockTransitionError" "Cardano.Ledger.Shelley.API.Validation" "cardano-ledger-shelley-1.16.0.0-inplace" 'True) (C1 ('MetaCons "BlockTransitionError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (PredicateFailure (EraRule "BBODY" era))))))

chainChecks Source #

Arguments

∷ ∀ m. MonadError ChainPredicateFailure m
⇒ Version	Max major protocol version
→ ChainChecksPParams
→ BHeaderView
→ m ()