Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.PParams

Contents

PParam
Orphan instances

Description

This module contains just the type of protocol parameters.

Synopsis

emptyShelleyPParams ∷ Era era ⇒ ShelleyPParams Identity era
emptyShelleyPParamsUpdate ∷ ShelleyPParams StrictMaybe era
data ShelleyPParams (f ∷ Type → Type) era = ShelleyPParams {
- sppMinFeeA ∷ !(HKD f Coin)
- sppMinFeeB ∷ !(HKD f Coin)
- sppMaxBBSize ∷ !(HKD f Word32)
- sppMaxTxSize ∷ !(HKD f Word32)
- sppMaxBHSize ∷ !(HKD f Word16)
- sppKeyDeposit ∷ !(HKD f Coin)
- sppPoolDeposit ∷ !(HKD f (CompactForm Coin))
- sppEMax ∷ !(HKD f EpochInterval)
- sppNOpt ∷ !(HKD f Word16)
- sppA0 ∷ !(HKD f NonNegativeInterval)
- sppRho ∷ !(HKD f UnitInterval)
- sppTau ∷ !(HKD f UnitInterval)
- sppD ∷ !(HKD f UnitInterval)
- sppExtraEntropy ∷ !(HKD f Nonce)
- sppProtocolVersion ∷ !(HKD f ProtVer)
- sppMinUTxOValue ∷ !(HKD f Coin)
- sppMinPoolCost ∷ !(HKD f Coin)
}
emptyPParams ∷ EraPParams era ⇒ PParams era
type family HKD (f ∷ Type → Type) a where ...
newtype ProposedPPUpdates era = ProposedPPUpdates (Map (KeyHash 'GenesisRole) (PParamsUpdate era))
emptyPPPUpdates ∷ ProposedPPUpdates era
data Update era = Update !(ProposedPPUpdates era) !EpochNo
upgradeUpdate ∷ (EraPParams era, EraPParams (PreviousEra era)) ⇒ UpgradePParams StrictMaybe era → Update (PreviousEra era) → Update era
pvCanFollow ∷ ProtVer → ProtVer → Bool
hasLegalProtVerUpdate ∷ (AtMostEra "Babbage" era, EraPParams era) ⇒ PParams era → PParamsUpdate era → Bool
shelleyPParams ∷ (EraPParams era, AtMostEra "Mary" era, AtMostEra "Alonzo" era, AtMostEra "Babbage" era) ⇒ [PParam era]
ppA0 ∷ EraPParams era ⇒ PParam era
ppD ∷ (EraPParams era, AtMostEra "Alonzo" era) ⇒ PParam era
ppEMax ∷ EraPParams era ⇒ PParam era
ppExtraEntropy ∷ (EraPParams era, AtMostEra "Alonzo" era) ⇒ PParam era
ppMaxBBSize ∷ EraPParams era ⇒ PParam era
ppKeyDeposit ∷ EraPParams era ⇒ PParam era
ppMinFeeA ∷ EraPParams era ⇒ PParam era
ppMinFeeB ∷ EraPParams era ⇒ PParam era
ppMinPoolCost ∷ EraPParams era ⇒ PParam era
ppMaxBHSize ∷ EraPParams era ⇒ PParam era
ppMaxTxSize ∷ EraPParams era ⇒ PParam era
ppNOpt ∷ EraPParams era ⇒ PParam era
ppProtocolVersion ∷ (EraPParams era, AtMostEra "Babbage" era) ⇒ PParam era
ppPoolDeposit ∷ EraPParams era ⇒ PParam era
ppRho ∷ EraPParams era ⇒ PParam era
ppTau ∷ EraPParams era ⇒ PParam era

Documentation

emptyShelleyPParams ∷ Era era ⇒ ShelleyPParams Identity era Source #

emptyShelleyPParamsUpdate ∷ ShelleyPParams StrictMaybe era Source #

data ShelleyPParams (f ∷ Type → Type) era Source #

Protocol parameters.

Constructors

ShelleyPParams

Fields

sppMinFeeA ∷ !(HKD f Coin)
The linear factor for the minimum fee calculation
sppMinFeeB ∷ !(HKD f Coin)
The constant factor for the minimum fee calculation
sppMaxBBSize ∷ !(HKD f Word32)
Maximal block body size
sppMaxTxSize ∷ !(HKD f Word32)
Maximal transaction size
sppMaxBHSize ∷ !(HKD f Word16)
Maximal block header size
sppKeyDeposit ∷ !(HKD f Coin)
The amount of a key registration deposit
sppPoolDeposit ∷ !(HKD f (CompactForm Coin))
The amount of a pool registration deposit
sppEMax ∷ !(HKD f EpochInterval)
epoch bound on pool retirement
sppNOpt ∷ !(HKD f Word16)
Desired number of pools
sppA0 ∷ !(HKD f NonNegativeInterval)
Pool influence
sppRho ∷ !(HKD f UnitInterval)
Monetary expansion
sppTau ∷ !(HKD f UnitInterval)
Treasury expansion
sppD ∷ !(HKD f UnitInterval)
Decentralization parameter
sppExtraEntropy ∷ !(HKD f Nonce)
Extra entropy
sppProtocolVersion ∷ !(HKD f ProtVer)
Protocol version
sppMinUTxOValue ∷ !(HKD f Coin)
Minimum UTxO value
sppMinPoolCost ∷ !(HKD f Coin)
Minimum Stake Pool Cost

Instances

Instances details

NFData (ShelleyPParams StrictMaybe era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

rnf ∷ ShelleyPParams StrictMaybe era → () #

NFData (ShelleyPParams Identity era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

rnf ∷ ShelleyPParams Identity era → () #

Generic (ShelleyPParams f era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Associated Types

type Rep (ShelleyPParams f era)

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

from ∷ ShelleyPParams f era → Rep (ShelleyPParams f era) x #

to ∷ Rep (ShelleyPParams f era) x → ShelleyPParams f era #

Show (ShelleyPParams StrictMaybe era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

showsPrec ∷ Int → ShelleyPParams StrictMaybe era → ShowS #

show ∷ ShelleyPParams StrictMaybe era → String #

showList ∷ [ShelleyPParams StrictMaybe era] → ShowS #

Show (ShelleyPParams Identity era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

showsPrec ∷ Int → ShelleyPParams Identity era → ShowS #

show ∷ ShelleyPParams Identity era → String #

showList ∷ [ShelleyPParams Identity era] → ShowS #

Eq (ShelleyPParams StrictMaybe era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

(==) ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Bool #

(/=) ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Bool #

Eq (ShelleyPParams Identity era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

(==) ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Bool #

(/=) ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Bool #

Ord (ShelleyPParams StrictMaybe era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

compare ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Ordering #

(<) ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Bool #

(<=) ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Bool #

(>) ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Bool #

(>=) ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → Bool #

max ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era #

min ∷ ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era → ShelleyPParams StrictMaybe era #

Ord (ShelleyPParams Identity era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

compare ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Ordering #

(<) ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Bool #

(<=) ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Bool #

(>) ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Bool #

(>=) ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → Bool #

max ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → ShelleyPParams Identity era #

min ∷ ShelleyPParams Identity era → ShelleyPParams Identity era → ShelleyPParams Identity era #

NoThunks (ShelleyPParams StrictMaybe era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

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

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

showTypeOf ∷ Proxy (ShelleyPParams StrictMaybe era) → String Source #

NoThunks (ShelleyPParams Identity era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

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

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

showTypeOf ∷ Proxy (ShelleyPParams Identity era) → String Source #

type Rep (ShelleyPParams f era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

emptyPParams ∷ EraPParams era ⇒ PParams era Source #

type family HKD (f ∷ Type → Type) a where ... Source #

Higher Kinded Data

Equations

HKD Identity a = a
HKD f a = f a

newtype ProposedPPUpdates era Source #

Update operation for protocol parameters structure PParams

Constructors

ProposedPPUpdates (Map (KeyHash 'GenesisRole) (PParamsUpdate era))

Instances

Instances details

EraPParams era ⇒ ToJSON (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

toJSON ∷ ProposedPPUpdates era → Value Source #

toEncoding ∷ ProposedPPUpdates era → Encoding Source #

toJSONList ∷ [ProposedPPUpdates era] → Value Source #

toEncodingList ∷ [ProposedPPUpdates era] → Encoding Source #

omitField ∷ ProposedPPUpdates era → Bool Source #

(Era era, FromCBOR (PParamsUpdate era)) ⇒ FromCBOR (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

fromCBOR ∷ Decoder s (ProposedPPUpdates era) Source #

label ∷ Proxy (ProposedPPUpdates era) → Text Source #

(Era era, ToCBOR (PParamsUpdate era)) ⇒ ToCBOR (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

toCBOR ∷ ProposedPPUpdates era → Encoding Source #

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

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

(Era era, DecCBOR (PParamsUpdate era)) ⇒ DecCBOR (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

decCBOR ∷ Decoder s (ProposedPPUpdates era) Source #

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

label ∷ Proxy (ProposedPPUpdates era) → Text Source #

(Era era, EncCBOR (PParamsUpdate era)) ⇒ EncCBOR (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

encCBOR ∷ ProposedPPUpdates era → Encoding Source #

NFData (PParamsUpdate era) ⇒ NFData (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

rnf ∷ ProposedPPUpdates era → () #

Monoid (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

mempty ∷ ProposedPPUpdates era #

mappend ∷ ProposedPPUpdates era → ProposedPPUpdates era → ProposedPPUpdates era #

mconcat ∷ [ProposedPPUpdates era] → ProposedPPUpdates era #

Semigroup (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

(<>) ∷ ProposedPPUpdates era → ProposedPPUpdates era → ProposedPPUpdates era #

sconcat ∷ NonEmpty (ProposedPPUpdates era) → ProposedPPUpdates era #

stimes ∷ Integral b ⇒ b → ProposedPPUpdates era → ProposedPPUpdates era #

Generic (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Associated Types

type Rep (ProposedPPUpdates era)

Instance details

Defined in Cardano.Ledger.Shelley.PParams

type Rep (ProposedPPUpdates era) = D1 ('MetaData "ProposedPPUpdates" "Cardano.Ledger.Shelley.PParams" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "ProposedPPUpdates" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (KeyHash 'GenesisRole) (PParamsUpdate era)))))

Methods

from ∷ ProposedPPUpdates era → Rep (ProposedPPUpdates era) x #

to ∷ Rep (ProposedPPUpdates era) x → ProposedPPUpdates era #

Show (PParamsUpdate era) ⇒ Show (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

showsPrec ∷ Int → ProposedPPUpdates era → ShowS #

show ∷ ProposedPPUpdates era → String #

showList ∷ [ProposedPPUpdates era] → ShowS #

Eq (PParamsUpdate era) ⇒ Eq (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

(==) ∷ ProposedPPUpdates era → ProposedPPUpdates era → Bool #

(/=) ∷ ProposedPPUpdates era → ProposedPPUpdates era → Bool #

NoThunks (PParamsUpdate era) ⇒ NoThunks (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

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

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

showTypeOf ∷ Proxy (ProposedPPUpdates era) → String Source #

type Rep (ProposedPPUpdates era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

type Rep (ProposedPPUpdates era) = D1 ('MetaData "ProposedPPUpdates" "Cardano.Ledger.Shelley.PParams" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "ProposedPPUpdates" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (KeyHash 'GenesisRole) (PParamsUpdate era)))))

emptyPPPUpdates ∷ ProposedPPUpdates era Source #

data Update era Source #

Update Proposal

Constructors

Update !(ProposedPPUpdates era) !EpochNo

Instances

Instances details

(Era era, DecCBOR (PParamsUpdate era)) ⇒ DecCBOR (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

decCBOR ∷ Decoder s (Update era) Source #

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

label ∷ Proxy (Update era) → Text Source #

(Era era, EncCBOR (PParamsUpdate era)) ⇒ EncCBOR (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

encCBOR ∷ Update era → Encoding Source #

NFData (PParamsUpdate era) ⇒ NFData (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

rnf ∷ Update era → () #

Generic (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Associated Types

type Rep (Update era)

Instance details

Defined in Cardano.Ledger.Shelley.PParams

type Rep (Update era) = D1 ('MetaData "Update" "Cardano.Ledger.Shelley.PParams" "cardano-ledger-shelley-1.18.0.0-inplace" 'False) (C1 ('MetaCons "Update" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ProposedPPUpdates era)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo)))

Methods

from ∷ Update era → Rep (Update era) x #

to ∷ Rep (Update era) x → Update era #

Show (PParamsUpdate era) ⇒ Show (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

showsPrec ∷ Int → Update era → ShowS #

show ∷ Update era → String #

showList ∷ [Update era] → ShowS #

Eq (PParamsUpdate era) ⇒ Eq (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

(==) ∷ Update era → Update era → Bool #

(/=) ∷ Update era → Update era → Bool #

NoThunks (PParamsUpdate era) ⇒ NoThunks (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

Methods

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

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

showTypeOf ∷ Proxy (Update era) → String Source #

type Rep (Update era) Source #

Instance details

Defined in Cardano.Ledger.Shelley.PParams

type Rep (Update era) = D1 ('MetaData "Update" "Cardano.Ledger.Shelley.PParams" "cardano-ledger-shelley-1.18.0.0-inplace" 'False) (C1 ('MetaCons "Update" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ProposedPPUpdates era)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo)))

upgradeUpdate ∷ (EraPParams era, EraPParams (PreviousEra era)) ⇒ UpgradePParams StrictMaybe era → Update (PreviousEra era) → Update era Source #

pvCanFollow Source #

Arguments

∷ ProtVer	Previous protocol version
→ ProtVer	New protocol version
→ Bool

Check whether the new protocol version is a legitimate version bump with respect to the previous one.

hasLegalProtVerUpdate ∷ (AtMostEra "Babbage" era, EraPParams era) ⇒ PParams era → PParamsUpdate era → Bool Source #

Check whether PParamsUpdate contains a valid ProtVer update. When a protocol version update is not included in PParamsUpdate it is considered a legal update.

shelleyPParams ∷ (EraPParams era, AtMostEra "Mary" era, AtMostEra "Alonzo" era, AtMostEra "Babbage" era) ⇒ [PParam era] Source #

PParam

ppA0 ∷ EraPParams era ⇒ PParam era Source #

ppD ∷ (EraPParams era, AtMostEra "Alonzo" era) ⇒ PParam era Source #

ppEMax ∷ EraPParams era ⇒ PParam era Source #

ppExtraEntropy ∷ (EraPParams era, AtMostEra "Alonzo" era) ⇒ PParam era Source #

ppMaxBBSize ∷ EraPParams era ⇒ PParam era Source #

ppKeyDeposit ∷ EraPParams era ⇒ PParam era Source #

ppMinFeeA ∷ EraPParams era ⇒ PParam era Source #

ppMinFeeB ∷ EraPParams era ⇒ PParam era Source #

ppMinPoolCost ∷ EraPParams era ⇒ PParam era Source #

ppMaxBHSize ∷ EraPParams era ⇒ PParam era Source #

ppMaxTxSize ∷ EraPParams era ⇒ PParam era Source #

ppNOpt ∷ EraPParams era ⇒ PParam era Source #

ppProtocolVersion ∷ (EraPParams era, AtMostEra "Babbage" era) ⇒ PParam era Source #

ppPoolDeposit ∷ EraPParams era ⇒ PParam era Source #

ppRho ∷ EraPParams era ⇒ PParam era Source #

ppTau ∷ EraPParams era ⇒ PParam era Source #

Orphan instances

EraPParams ShelleyEra Source #

Instance details

Associated Types

type PParamsHKD f ShelleyEra
Instance details Defined in Cardano.Ledger.Shelley.PParams type PParamsHKD f ShelleyEra = ShelleyPParams f ShelleyEra
type UpgradePParams f ShelleyEra
Instance details Defined in Cardano.Ledger.Shelley.PParams type UpgradePParams f ShelleyEra = Void
type DowngradePParams f ShelleyEra
Instance details Defined in Cardano.Ledger.Shelley.PParams type DowngradePParams f ShelleyEra = Void