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 (STS (EraRule "TICK" era), BaseM (EraRule "TICK" era) ~ ShelleyBase, Environment (EraRule "TICK" era) ~ (), State (EraRule "TICK" era) ~ NewEpochState era, Signal (EraRule "TICK" era) ~ SlotNo, 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 (EraCrypto era)) era, EncCBORGroup (TxSeq era), State (EraRule "LEDGERS" era) ~ LedgerState era) ⇒ ApplyBlock era where
- applyTickOpts ∷ ApplySTSOpts ep → Globals → NewEpochState era → SlotNo → EventReturnType ep (EraRule "TICK" era) (NewEpochState era)
- applyBlockOpts ∷ ∀ ep m. (EventReturnTypeRep ep, MonadError (BlockTransitionError era) m) ⇒ ApplySTSOpts ep → Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → m (EventReturnType ep (EraRule "BBODY" era) (NewEpochState era))
- reapplyBlock ∷ Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → NewEpochState era
applyBlock ∷ (ApplyBlock era, MonadError (BlockTransitionError era) m) ⇒ Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → m (NewEpochState era)
applyTick ∷ 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 ∷ ∀ c m. MonadError ChainPredicateFailure m ⇒ Version → ChainChecksPParams → BHeaderView c → m ()
type ShelleyEraCrypto c = (Crypto c, DSignable c (Hash c EraIndependentTxBody))

Documentation

class (STS (EraRule "TICK" era), BaseM (EraRule "TICK" era) ~ ShelleyBase, Environment (EraRule "TICK" era) ~ (), State (EraRule "TICK" era) ~ NewEpochState era, Signal (EraRule "TICK" era) ~ SlotNo, 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 (EraCrypto era)) era, EncCBORGroup (TxSeq era), State (EraRule "LEDGERS" era) ~ LedgerState era) ⇒ ApplyBlock era where Source #

Minimal complete definition

Nothing

Methods

applyTickOpts ∷ ApplySTSOpts ep → Globals → NewEpochState era → SlotNo → EventReturnType ep (EraRule "TICK" era) (NewEpochState era) Source #

Apply the header level ledger transition.

This handles checks and updates that happen on a slot tick, as well as a few header level checks, such as size constraints.

applyBlockOpts ∷ ∀ ep m. (EventReturnTypeRep ep, MonadError (BlockTransitionError era) m) ⇒ ApplySTSOpts ep → Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → m (EventReturnType ep (EraRule "BBODY" era) (NewEpochState era)) Source #

Apply the block level ledger transition.

default applyBlockOpts ∷ ∀ ep m. (EventReturnTypeRep ep, MonadError (BlockTransitionError era) m, EraGov era) ⇒ ApplySTSOpts ep → Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → m (EventReturnType ep (EraRule "BBODY" era) (NewEpochState era)) Source #

reapplyBlock ∷ Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) 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.

default reapplyBlock ∷ EraGov era ⇒ Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → NewEpochState era Source #

Instances

Instances details

(Crypto c, DSignable c (Hash c EraIndependentTxBody)) ⇒ ApplyBlock (ShelleyEra c) Source #

Instance details

Defined in Cardano.Ledger.Shelley.API.Validation

Methods

applyTickOpts ∷ ∀ (ep ∷ EventPolicy). ApplySTSOpts ep → Globals → NewEpochState (ShelleyEra c) → SlotNo → EventReturnType ep (EraRule "TICK" (ShelleyEra c)) (NewEpochState (ShelleyEra c)) Source #

applyBlockOpts ∷ ∀ (ep ∷ EventPolicy) m. (EventReturnTypeRep ep, MonadError (BlockTransitionError (ShelleyEra c)) m) ⇒ ApplySTSOpts ep → Globals → NewEpochState (ShelleyEra c) → Block (BHeaderView (EraCrypto (ShelleyEra c))) (ShelleyEra c) → m (EventReturnType ep (EraRule "BBODY" (ShelleyEra c)) (NewEpochState (ShelleyEra c))) Source #

reapplyBlock ∷ Globals → NewEpochState (ShelleyEra c) → Block (BHeaderView (EraCrypto (ShelleyEra c))) (ShelleyEra c) → NewEpochState (ShelleyEra c) Source #

applyBlock ∷ (ApplyBlock era, MonadError (BlockTransitionError era) m) ⇒ Globals → NewEpochState era → Block (BHeaderView (EraCrypto era)) era → m (NewEpochState era) Source #

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

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 Source # Methods from ∷ TickTransitionError era → Rep (TickTransitionError era) x Source # to ∷ Rep (TickTransitionError era) x → TickTransitionError era Source #
Show (PredicateFailure (EraRule "TICK" era)) ⇒ Show (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods showsPrec ∷ Int → TickTransitionError era → ShowS Source # show ∷ TickTransitionError era → String Source # showList ∷ [TickTransitionError era] → ShowS Source #
Eq (PredicateFailure (EraRule "TICK" era)) ⇒ Eq (TickTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods (==) ∷ TickTransitionError era → TickTransitionError era → Bool Source # (/=) ∷ TickTransitionError era → TickTransitionError era → Bool Source #
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.11.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 Source # Methods from ∷ BlockTransitionError era → Rep (BlockTransitionError era) x Source # to ∷ Rep (BlockTransitionError era) x → BlockTransitionError era Source #
Show (PredicateFailure (EraRule "BBODY" era)) ⇒ Show (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods showsPrec ∷ Int → BlockTransitionError era → ShowS Source # show ∷ BlockTransitionError era → String Source # showList ∷ [BlockTransitionError era] → ShowS Source #
Eq (PredicateFailure (EraRule "BBODY" era)) ⇒ Eq (BlockTransitionError era) Source #
Instance details Defined in Cardano.Ledger.Shelley.API.Validation Methods (==) ∷ BlockTransitionError era → BlockTransitionError era → Bool Source # (/=) ∷ BlockTransitionError era → BlockTransitionError era → Bool Source #
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.11.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

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

type ShelleyEraCrypto c = (Crypto c, DSignable c (Hash c EraIndependentTxBody)) Source #

Deprecated: Constraint synonyms are being removed