Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Protocol.TPraos.API

Description

Integration between the Shelley ledger and its corresponding (Transitional Praos) protocol.

In particular, this code supports extracting the components of the ledger state needed for protocol execution, both now and in a 2k-slot window.

Synopsis

class (Crypto c, Signable (KES c) (BHBody c), Signable (VRF c) Seed) ⇒ PraosCrypto c
class (STS (EraRule "TICKF" era), BaseM (EraRule "TICKF" era) ~ ShelleyBase, Environment (EraRule "TICKF" era) ~ (), State (EraRule "TICKF" era) ~ NewEpochState era, Signal (EraRule "TICKF" era) ~ SlotNo, EraGov era) ⇒ GetLedgerView era where
- currentLedgerView ∷ NewEpochState era → LedgerView
- futureLedgerView ∷ MonadError (FutureLedgerViewError era) m ⇒ Globals → NewEpochState era → SlotNo → m LedgerView
data LedgerView = LedgerView {
- lvD ∷ UnitInterval
- lvExtraEntropy ∷ ~Nonce
- lvPoolDistr ∷ PoolDistr
- lvGenDelegs ∷ GenDelegs
- lvChainChecks ∷ ChainChecksPParams
}
mkInitialShelleyLedgerView ∷ FromByronTranslationContext → LedgerView
newtype FutureLedgerViewError era = FutureLedgerViewError (NonEmpty (PredicateFailure (EraRule "TICKF" era)))
data ChainDepState = ChainDepState {
- csProtocol ∷ !PrtclState
- csTickn ∷ !TicknState
- csLabNonce ∷ !Nonce
}
newtype ChainTransitionError c = ChainTransitionError (NonEmpty (PredicateFailure (PRTCL c)))
tickChainDepState ∷ Globals → LedgerView → Bool → ChainDepState → ChainDepState
updateChainDepState ∷ ∀ c m. (PraosCrypto c, MonadError (ChainTransitionError c) m) ⇒ Globals → LedgerView → BHeader c → ChainDepState → m ChainDepState
reupdateChainDepState ∷ ∀ c. PraosCrypto c ⇒ Globals → LedgerView → BHeader c → ChainDepState → ChainDepState
initialChainDepState ∷ Nonce → Map (KeyHash 'Genesis) GenDelegPair → ChainDepState
checkLeaderValue ∷ ∀ v. VRFAlgorithm v ⇒ OutputVRF v → Rational → ActiveSlotCoeff → Bool
getLeaderSchedule ∷ (EraPParams era, VRFAlgorithm v, ContextVRF v ~ (), Signable v Seed) ⇒ Globals → NewEpochState era → ChainDepState → KeyHash 'StakePool → SignKeyVRF v → PParams era → Set SlotNo

Documentation

class (Crypto c, Signable (KES c) (BHBody c), Signable (VRF c) Seed) ⇒ PraosCrypto c Source #

Instances

Instances details

PraosCrypto StandardCrypto Source #
Instance details Defined in Cardano.Protocol.TPraos.API

class (STS (EraRule "TICKF" era), BaseM (EraRule "TICKF" era) ~ ShelleyBase, Environment (EraRule "TICKF" era) ~ (), State (EraRule "TICKF" era) ~ NewEpochState era, Signal (EraRule "TICKF" era) ~ SlotNo, EraGov era) ⇒ GetLedgerView era where Source #

Minimal complete definition

Nothing

Methods

currentLedgerView ∷ NewEpochState era → LedgerView Source #

default currentLedgerView ∷ ProtVerAtMost era 6 ⇒ NewEpochState era → LedgerView Source #

futureLedgerView ∷ MonadError (FutureLedgerViewError era) m ⇒ Globals → NewEpochState era → SlotNo → m LedgerView Source #

default futureLedgerView ∷ (MonadError (FutureLedgerViewError era) m, ProtVerAtMost era 6) ⇒ Globals → NewEpochState era → SlotNo → m LedgerView Source #

Instances

Instances details

GetLedgerView AllegraEra Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods currentLedgerView ∷ NewEpochState AllegraEra → LedgerView Source # futureLedgerView ∷ MonadError (FutureLedgerViewError AllegraEra) m ⇒ Globals → NewEpochState AllegraEra → SlotNo → m LedgerView Source #
GetLedgerView AlonzoEra Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods currentLedgerView ∷ NewEpochState AlonzoEra → LedgerView Source # futureLedgerView ∷ MonadError (FutureLedgerViewError AlonzoEra) m ⇒ Globals → NewEpochState AlonzoEra → SlotNo → m LedgerView Source #
GetLedgerView BabbageEra Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods currentLedgerView ∷ NewEpochState BabbageEra → LedgerView Source # futureLedgerView ∷ MonadError (FutureLedgerViewError BabbageEra) m ⇒ Globals → NewEpochState BabbageEra → SlotNo → m LedgerView Source #
GetLedgerView ConwayEra Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods currentLedgerView ∷ NewEpochState ConwayEra → LedgerView Source # futureLedgerView ∷ MonadError (FutureLedgerViewError ConwayEra) m ⇒ Globals → NewEpochState ConwayEra → SlotNo → m LedgerView Source #
GetLedgerView MaryEra Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods currentLedgerView ∷ NewEpochState MaryEra → LedgerView Source # futureLedgerView ∷ MonadError (FutureLedgerViewError MaryEra) m ⇒ Globals → NewEpochState MaryEra → SlotNo → m LedgerView Source #
GetLedgerView ShelleyEra Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods currentLedgerView ∷ NewEpochState ShelleyEra → LedgerView Source # futureLedgerView ∷ MonadError (FutureLedgerViewError ShelleyEra) m ⇒ Globals → NewEpochState ShelleyEra → SlotNo → m LedgerView Source #

data LedgerView Source #

Data required by the Transitional Praos protocol from the Shelley ledger.

Constructors

LedgerView
Fields lvD ∷ UnitInterval lvExtraEntropy ∷ ~Nonce lvPoolDistr ∷ PoolDistr lvGenDelegs ∷ GenDelegs lvChainChecks ∷ ChainChecksPParams

Instances

Instances details

Generic LedgerView Source #
Instance details Defined in Cardano.Protocol.TPraos.API Associated Types type Rep LedgerView ∷ Type → Type # Methods from ∷ LedgerView → Rep LedgerView x # to ∷ Rep LedgerView x → LedgerView #
Show LedgerView Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods showsPrec ∷ Int → LedgerView → ShowS # show ∷ LedgerView → String # showList ∷ [LedgerView] → ShowS #
Eq LedgerView Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods (==) ∷ LedgerView → LedgerView → Bool # (/=) ∷ LedgerView → LedgerView → Bool #
NoThunks LedgerView Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods noThunks ∷ Context → LedgerView → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → LedgerView → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy LedgerView → String Source #
type Rep LedgerView Source #
Instance details Defined in Cardano.Protocol.TPraos.API type Rep LedgerView = D1 ('MetaData "LedgerView" "Cardano.Protocol.TPraos.API" "cardano-protocol-tpraos-1.4.0.0-inplace" 'False) (C1 ('MetaCons "LedgerView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lvD") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UnitInterval) :: S1 ('MetaSel ('Just "lvExtraEntropy") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Nonce)) :: (S1 ('MetaSel ('Just "lvPoolDistr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PoolDistr) :: (S1 ('MetaSel ('Just "lvGenDelegs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GenDelegs) :: S1 ('MetaSel ('Just "lvChainChecks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChainChecksPParams)))))

mkInitialShelleyLedgerView ∷ FromByronTranslationContext → LedgerView Source #

We construct a LedgerView using the Shelley genesis config in the same way as translateToShelleyLedgerState.

newtype FutureLedgerViewError era Source #

Constructors

FutureLedgerViewError (NonEmpty (PredicateFailure (EraRule "TICKF" era)))

Instances

Instances details

Show (PredicateFailure (EraRule "TICKF" era)) ⇒ Show (FutureLedgerViewError era) Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods showsPrec ∷ Int → FutureLedgerViewError era → ShowS # show ∷ FutureLedgerViewError era → String # showList ∷ [FutureLedgerViewError era] → ShowS #
Eq (PredicateFailure (EraRule "TICKF" era)) ⇒ Eq (FutureLedgerViewError era) Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods (==) ∷ FutureLedgerViewError era → FutureLedgerViewError era → Bool # (/=) ∷ FutureLedgerViewError era → FutureLedgerViewError era → Bool #

Chain state operations

The chain state is an amalgam of the protocol state and the ticked nonce.

data ChainDepState Source #

Constructors

ChainDepState
Fields csProtocol ∷ !PrtclState csTickn ∷ !TicknState csLabNonce ∷ !Nonce Nonce constructed from the hash of the last applied block header.

Instances

Instances details

Generic ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Associated Types type Rep ChainDepState ∷ Type → Type # Methods from ∷ ChainDepState → Rep ChainDepState x # to ∷ Rep ChainDepState x → ChainDepState #
Show ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods showsPrec ∷ Int → ChainDepState → ShowS # show ∷ ChainDepState → String # showList ∷ [ChainDepState] → ShowS #
FromCBOR ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods fromCBOR ∷ Decoder s ChainDepState Source # label ∷ Proxy ChainDepState → Text Source #
ToCBOR ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods toCBOR ∷ ChainDepState → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ChainDepState → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ChainDepState] → Size Source #
DecCBOR ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods decCBOR ∷ Decoder s ChainDepState Source # dropCBOR ∷ Proxy ChainDepState → Decoder s () Source # label ∷ Proxy ChainDepState → Text Source #
EncCBOR ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods encCBOR ∷ ChainDepState → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy ChainDepState → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [ChainDepState] → Size Source #
Eq ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods (==) ∷ ChainDepState → ChainDepState → Bool # (/=) ∷ ChainDepState → ChainDepState → Bool #
NoThunks ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods noThunks ∷ Context → ChainDepState → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ChainDepState → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ChainDepState → String Source #
type Rep ChainDepState Source #
Instance details Defined in Cardano.Protocol.TPraos.API type Rep ChainDepState = D1 ('MetaData "ChainDepState" "Cardano.Protocol.TPraos.API" "cardano-protocol-tpraos-1.4.0.0-inplace" 'False) (C1 ('MetaCons "ChainDepState" 'PrefixI 'True) (S1 ('MetaSel ('Just "csProtocol") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PrtclState) :: (S1 ('MetaSel ('Just "csTickn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TicknState) :: S1 ('MetaSel ('Just "csLabNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce))))

newtype ChainTransitionError c Source #

Constructors

ChainTransitionError (NonEmpty (PredicateFailure (PRTCL c)))

Instances

Instances details

Generic (ChainTransitionError c) Source #
Instance details Defined in Cardano.Protocol.TPraos.API Associated Types type Rep (ChainTransitionError c) ∷ Type → Type # Methods from ∷ ChainTransitionError c → Rep (ChainTransitionError c) x # to ∷ Rep (ChainTransitionError c) x → ChainTransitionError c #
Crypto c ⇒ Show (ChainTransitionError c) Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods showsPrec ∷ Int → ChainTransitionError c → ShowS # show ∷ ChainTransitionError c → String # showList ∷ [ChainTransitionError c] → ShowS #
Crypto c ⇒ Eq (ChainTransitionError c) Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods (==) ∷ ChainTransitionError c → ChainTransitionError c → Bool # (/=) ∷ ChainTransitionError c → ChainTransitionError c → Bool #
Crypto c ⇒ NoThunks (ChainTransitionError c) Source #
Instance details Defined in Cardano.Protocol.TPraos.API Methods noThunks ∷ Context → ChainTransitionError c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ChainTransitionError c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ChainTransitionError c) → String Source #
type Rep (ChainTransitionError c) Source #
Instance details Defined in Cardano.Protocol.TPraos.API type Rep (ChainTransitionError c) = D1 ('MetaData "ChainTransitionError" "Cardano.Protocol.TPraos.API" "cardano-protocol-tpraos-1.4.0.0-inplace" 'True) (C1 ('MetaCons "ChainTransitionError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (PredicateFailure (PRTCL c))))))

tickChainDepState Source #

Arguments

∷ Globals
→ LedgerView
→ Bool	Are we in a new epoch?
→ ChainDepState
→ ChainDepState

Tick the chain state to a new epoch.

updateChainDepState ∷ ∀ c m. (PraosCrypto c, MonadError (ChainTransitionError c) m) ⇒ Globals → LedgerView → BHeader c → ChainDepState → m ChainDepState Source #

Update the chain state based upon a new block header.

This also updates the last applied block hash.

reupdateChainDepState ∷ ∀ c. PraosCrypto c ⇒ Globals → LedgerView → BHeader c → ChainDepState → ChainDepState Source #

Re-update the chain state based upon a new block header.

This function does no validation of whether the header is internally valid or consistent with the chain it is being applied to; the caller must ensure that this is valid through having previously applied it.

initialChainDepState ∷ Nonce → Map (KeyHash 'Genesis) GenDelegPair → ChainDepState Source #

Construct an initial chain state given an initial nonce and a set of genesis delegates.

checkLeaderValue ∷ ∀ v. VRFAlgorithm v ⇒ OutputVRF v → Rational → ActiveSlotCoeff → Bool Source #

Check that the certified VRF output, when used as a natural, is valid for being slot leader.

getLeaderSchedule ∷ (EraPParams era, VRFAlgorithm v, ContextVRF v ~ (), Signable v Seed) ⇒ Globals → NewEpochState era → ChainDepState → KeyHash 'StakePool → SignKeyVRF v → PParams era → Set SlotNo Source #

Get the (private) leader schedule for this epoch.

Given a private VRF key, returns the set of slots in which this node is eligible to lead.