cardano-ledger-shelley-1.11.0.0: Shelley Ledger Executable Model
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Ledger.Shelley.Governance

Contents

Synopsis

Documentation

class (EraPParams era, Eq (GovState era), Show (GovState era), NoThunks (GovState era), NFData (GovState era), EncCBOR (GovState era), DecCBOR (GovState era), DecShareCBOR (GovState era), ToCBOR (GovState era), FromCBOR (GovState era), Default (GovState era), ToJSON (GovState era)) ⇒ EraGov era where Source #

Minimal complete definition

curPParamsGovStateL, prevPParamsGovStateL, futurePParamsGovStateL, obligationGovState

Associated Types

type GovState era = (r ∷ Type) | r → era Source #

Methods

emptyGovState ∷ GovState era Source #

Construct empty governance state

getProposedPPUpdates ∷ GovState era → Maybe (ProposedPPUpdates era) Source #

Returns Nothing for all eras starting with Conway, otherwise returns proposed pparams updates

curPParamsGovStateL ∷ Lens' (GovState era) (PParams era) Source #

Lens for accessing current protocol parameters

prevPParamsGovStateL ∷ Lens' (GovState era) (PParams era) Source #

Lens for accessing the previous protocol parameters

futurePParamsGovStateL ∷ Lens' (GovState era) (FuturePParams era) Source #

Lens for accessing the future protocol parameters.

This lens will produce DefinitePParamsUpdate whenever we are absolutely sure that the new PParams will be updated. Which means there will be no chance of a DefinitePParamsUpdate value until we are past the point of no return, which is 2 stability windows before the end of the epoch. This lens is mostly intended for ledger usage and nextEpochUpdatedPParams should be used instead whenever definite results are desired.

obligationGovState ∷ GovState era → Obligations Source #

Instances

Instances details
Crypto c ⇒ EraGov (ShelleyEra c) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Associated Types

type GovState (ShelleyEra c) = (r ∷ Type) Source #

Methods

emptyGovState ∷ GovState (ShelleyEra c) Source #

getProposedPPUpdates ∷ GovState (ShelleyEra c) → Maybe (ProposedPPUpdates (ShelleyEra c)) Source #

curPParamsGovStateL ∷ Lens' (GovState (ShelleyEra c)) (PParams (ShelleyEra c)) Source #

prevPParamsGovStateL ∷ Lens' (GovState (ShelleyEra c)) (PParams (ShelleyEra c)) Source #

futurePParamsGovStateL ∷ Lens' (GovState (ShelleyEra c)) (FuturePParams (ShelleyEra c)) Source #

obligationGovState ∷ GovState (ShelleyEra c) → Obligations Source #

data ShelleyGovState era Source #

Constructors

ShelleyGovState 

Fields

Instances

Instances details
EraPParams era ⇒ ToJSON (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

toJSON ∷ ShelleyGovState era → Value Source #

toEncoding ∷ ShelleyGovState era → Encoding Source #

toJSONList ∷ [ShelleyGovState era] → Value Source #

toEncodingList ∷ [ShelleyGovState era] → Encoding Source #

omitField ∷ ShelleyGovState era → Bool Source #

Generic (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Associated Types

type Rep (ShelleyGovState era) ∷ Type → Type Source #

Methods

from ∷ ShelleyGovState era → Rep (ShelleyGovState era) x Source #

to ∷ Rep (ShelleyGovState era) x → ShelleyGovState era Source #

(Show (PParamsUpdate era), Show (PParams era)) ⇒ Show (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

showsPrec ∷ Int → ShelleyGovState era → ShowS Source #

show ∷ ShelleyGovState era → String Source #

showList ∷ [ShelleyGovState era] → ShowS Source #

(Era era, DecCBOR (PParamsUpdate era), DecCBOR (PParams era)) ⇒ FromCBOR (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

fromCBOR ∷ Decoder s (ShelleyGovState era) Source #

label ∷ Proxy (ShelleyGovState era) → Text Source #

(Era era, EncCBOR (PParamsUpdate era), EncCBOR (PParams era)) ⇒ ToCBOR (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

toCBOR ∷ ShelleyGovState era → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (ShelleyGovState era) → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGovState era] → Size Source #

(Era era, DecCBOR (PParamsUpdate era), DecCBOR (PParams era)) ⇒ DecCBOR (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

decCBOR ∷ Decoder s (ShelleyGovState era) Source #

dropCBOR ∷ Proxy (ShelleyGovState era) → Decoder s () Source #

label ∷ Proxy (ShelleyGovState era) → Text Source #

(Era era, DecCBOR (PParamsUpdate era), DecCBOR (PParams era)) ⇒ DecShareCBOR (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Associated Types

type Share (ShelleyGovState era) Source #

Methods

getShare ∷ ShelleyGovState era → Share (ShelleyGovState era) Source #

decShareCBOR ∷ Share (ShelleyGovState era) → Decoder s (ShelleyGovState era) Source #

decSharePlusCBOR ∷ StateT (Share (ShelleyGovState era)) (Decoder s) (ShelleyGovState era) Source #

(Era era, EncCBOR (PParamsUpdate era), EncCBOR (PParams era)) ⇒ EncCBOR (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

encCBOR ∷ ShelleyGovState era → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (ShelleyGovState era) → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGovState era] → Size Source #

EraPParams era ⇒ Default (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

def ∷ ShelleyGovState era Source #

(NFData (PParamsUpdate era), NFData (PParams era)) ⇒ NFData (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

rnf ∷ ShelleyGovState era → () Source #

(Eq (PParamsUpdate era), Eq (PParams era)) ⇒ Eq (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

(==) ∷ ShelleyGovState era → ShelleyGovState era → Bool Source #

(/=) ∷ ShelleyGovState era → ShelleyGovState era → Bool Source #

(NoThunks (PParamsUpdate era), NoThunks (PParams era)) ⇒ NoThunks (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

noThunks ∷ Context → ShelleyGovState era → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ShelleyGovState era → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ShelleyGovState era) → String Source #

type Rep (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

type Rep (ShelleyGovState era) = D1 ('MetaData "ShelleyGovState" "Cardano.Ledger.Shelley.Governance" "cardano-ledger-shelley-1.11.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyGovState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sgsCurProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ProposedPPUpdates era)) :*: S1 ('MetaSel ('Just "sgsFutureProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ProposedPPUpdates era))) :*: (S1 ('MetaSel ('Just "sgsCurPParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era)) :*: (S1 ('MetaSel ('Just "sgsPrevPParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era)) :*: S1 ('MetaSel ('Just "sgsFuturePParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (FuturePParams era))))))
type Share (ShelleyGovState era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

type Share (ShelleyGovState era) = ()

emptyShelleyGovState ∷ EraPParams era ⇒ ShelleyGovState era Source #

data FuturePParams era Source #

Constructors

NoPParamsUpdate

This indicates that there is definitely not going to be an update to PParams expected at the next epoch boundary.

DefinitePParamsUpdate !(PParams era)

This case specifies the PParams that will be adopted at the next epoch boundary.

PotentialPParamsUpdate (Maybe (PParams era))

With this case there is no guarantee that these will be the new PParams, users should not rely on this value to be computed efficiently and should use nextEpochPParams instead. The field is lazy on purpose, since we truly need to compute this field only towards the end of the epoch, which is done by solidifyFuturePParams two stability windows before the end of the epoch.

Instances

Instances details
ToJSON (PParams era) ⇒ ToJSON (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

toJSON ∷ FuturePParams era → Value Source #

toEncoding ∷ FuturePParams era → Encoding Source #

toJSONList ∷ [FuturePParams era] → Value Source #

toEncodingList ∷ [FuturePParams era] → Encoding Source #

omitField ∷ FuturePParams era → Bool Source #

Generic (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Associated Types

type Rep (FuturePParams era) ∷ Type → Type Source #

Methods

from ∷ FuturePParams era → Rep (FuturePParams era) x Source #

to ∷ Rep (FuturePParams era) x → FuturePParams era Source #

Show (PParams era) ⇒ Show (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

showsPrec ∷ Int → FuturePParams era → ShowS Source #

show ∷ FuturePParams era → String Source #

showList ∷ [FuturePParams era] → ShowS Source #

(Typeable era, DecCBOR (PParams era)) ⇒ DecCBOR (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

decCBOR ∷ Decoder s (FuturePParams era) Source #

dropCBOR ∷ Proxy (FuturePParams era) → Decoder s () Source #

label ∷ Proxy (FuturePParams era) → Text Source #

(Typeable era, EncCBOR (PParams era)) ⇒ EncCBOR (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

encCBOR ∷ FuturePParams era → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (FuturePParams era) → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [FuturePParams era] → Size Source #

Default (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

def ∷ FuturePParams era Source #

NFData (PParams era) ⇒ NFData (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

rnf ∷ FuturePParams era → () Source #

Eq (PParams era) ⇒ Eq (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

(==) ∷ FuturePParams era → FuturePParams era → Bool Source #

(/=) ∷ FuturePParams era → FuturePParams era → Bool Source #

NoThunks (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

Methods

noThunks ∷ Context → FuturePParams era → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → FuturePParams era → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (FuturePParams era) → String Source #

type Rep (FuturePParams era) Source # 
Instance details

Defined in Cardano.Ledger.Shelley.Governance

type Rep (FuturePParams era) = D1 ('MetaData "FuturePParams" "Cardano.Ledger.Shelley.Governance" "cardano-ledger-shelley-1.11.0.0-inplace" 'False) (C1 ('MetaCons "NoPParamsUpdate" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DefinitePParamsUpdate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era))) :+: C1 ('MetaCons "PotentialPParamsUpdate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (PParams era))))))

solidifyFuturePParams ∷ FuturePParams era → FuturePParams era Source #

knownFuturePParams ∷ FuturePParams era → Maybe (PParams era) Source #

Return new PParams only when it is known that there was an update proposed and it is guaranteed to be applied

nextEpochPParams ∷ EraGov era ⇒ GovState era → PParams era Source #

This function is guaranteed to produce PParams that will be adopted at the next epoch boundary, whenever this function is applied to the GovState that was produced by ledger at any point that is two stability windows before the end of the epoch. If you need to know if there were actual changes to those PParams then use nextEpochUpdatedPParams instead.

nextEpochUpdatedPParams ∷ EraGov era ⇒ GovState era → StrictMaybe (PParams era) Source #

This function is guaranteed to return updated PParams when it is called during the last two stability windows of the epoch and there were proposals to update PParams that all relevant parties reached consensus on. In other words whenever there is a definite update to PParams coming on the epoch boundary those PParams will be returned, otherwise it will return Nothing. This function is inexpensive and can be invoked at any time without danger of forcing some suspended computation.

proposalsL ∷ Lens' (ShelleyGovState era) (ProposedPPUpdates era) Source #

futureProposalsL ∷ Lens' (ShelleyGovState era) (ProposedPPUpdates era) Source #

curPParamsShelleyGovStateL ∷ Lens' (ShelleyGovState era) (PParams era) Source #

prevPParamsShelleyGovStateL ∷ Lens' (ShelleyGovState era) (PParams era) Source #

futurePParamsShelleyGovStateL ∷ Lens' (ShelleyGovState era) (FuturePParams era) Source #

Deprecations

proposals ∷ ShelleyGovState era → ProposedPPUpdates era Source #

Deprecated: In favor of sgsCurProposals

futureProposals ∷ ShelleyGovState era → ProposedPPUpdates era Source #

Deprecated: In favor of sgsFutureProposals

sgovPp ∷ ShelleyGovState era → PParams era Source #

Deprecated: In favor of sgsCurPParams

sgovPrevPp ∷ ShelleyGovState era → PParams era Source #

Deprecated: In favor of sgsPrevPParams