Safe Haskell	None
Language	Haskell98

Shelley.Spec.Ledger.PParams

Description

This module contains just the type of protocol parameters.

Synopsis

data PParams' f era = PParams {
- _minfeeA ∷ !(HKD f Natural)
- _minfeeB ∷ !(HKD f Natural)
- _maxBBSize ∷ !(HKD f Natural)
- _maxTxSize ∷ !(HKD f Natural)
- _maxBHSize ∷ !(HKD f Natural)
- _keyDeposit ∷ !(HKD f Coin)
- _poolDeposit ∷ !(HKD f Coin)
- _eMax ∷ !(HKD f EpochNo)
- _nOpt ∷ !(HKD f Natural)
- _a0 ∷ !(HKD f Rational)
- _rho ∷ !(HKD f UnitInterval)
- _tau ∷ !(HKD f UnitInterval)
- _d ∷ !(HKD f UnitInterval)
- _extraEntropy ∷ !(HKD f Nonce)
- _protocolVersion ∷ !(HKD f ProtVer)
- _minUTxOValue ∷ !(HKD f Coin)
- _minPoolCost ∷ !(HKD f Coin)
}
type PParams era = PParams' Identity era
emptyPParams ∷ PParams era
data ProtVer = ProtVer {
- pvMajor ∷ !Natural
- pvMinor ∷ !Natural
}
data PPUpdateEnv era = PPUpdateEnv SlotNo (GenDelegs era)
newtype ProposedPPUpdates era = ProposedPPUpdates (Map (KeyHash 'Genesis (Crypto era)) (PParamsUpdate era))
emptyPPPUpdates ∷ ProposedPPUpdates era
type PParamsUpdate era = PParams' StrictMaybe era
emptyPParamsUpdate ∷ PParamsUpdate era
data Update era = Update !(ProposedPPUpdates era) !EpochNo
updatePParams ∷ PParams era → PParamsUpdate era → PParams era

Documentation

data PParams' f era Source #

Protocol parameters.

We use the HKD type family so that the protocol parameters type and the type for the updates to the protocol parameters can share records fields. The protocol parameters will have type PParams' Identity, and the updates will have type PParams' StrictMaybe, though Identity will be hidden from use.

For example:

  myParameters =
    PParams
      { _minfeeA = 0,
        _minfeeB = 0,
        ...
      }

  myUpdate =
    PParamsUpdate
      { _minfeeA = SNothing,
        _minfeeB = SJust 42,
        ...
      }

Constructors

PParams

Fields

_minfeeA ∷ !(HKD f Natural)
The linear factor for the minimum fee calculation
_minfeeB ∷ !(HKD f Natural)
The constant factor for the minimum fee calculation
_maxBBSize ∷ !(HKD f Natural)
Maximal block body size
_maxTxSize ∷ !(HKD f Natural)
Maximal transaction size
_maxBHSize ∷ !(HKD f Natural)
Maximal block header size
_keyDeposit ∷ !(HKD f Coin)
The amount of a key registration deposit
_poolDeposit ∷ !(HKD f Coin)
The amount of a pool registration deposit
_eMax ∷ !(HKD f EpochNo)
epoch bound on pool retirement
_nOpt ∷ !(HKD f Natural)
Desired number of pools
_a0 ∷ !(HKD f Rational)
Pool influence
_rho ∷ !(HKD f UnitInterval)
Monetary expansion
_tau ∷ !(HKD f UnitInterval)
Treasury expansion
_d ∷ !(HKD f UnitInterval)
Decentralization parameter
_extraEntropy ∷ !(HKD f Nonce)
Extra entropy
_protocolVersion ∷ !(HKD f ProtVer)
Protocol version
_minUTxOValue ∷ !(HKD f Coin)
Minimum UTxO value
_minPoolCost ∷ !(HKD f Coin)
Minimum Stake Pool Cost

Instances

Instances details

Era era ⇒ ToCBOR (PParamsUpdate era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toCBOR ∷ PParamsUpdate era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (PParamsUpdate era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [PParamsUpdate era] → Size Source #
Era era ⇒ ToCBOR (PParams era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toCBOR ∷ PParams era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (PParams era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [PParams era] → Size Source #
Era era ⇒ FromCBOR (PParamsUpdate era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods fromCBOR ∷ Decoder s (PParamsUpdate era) Source # label ∷ Proxy (PParamsUpdate era) → Text Source #
Era era ⇒ FromCBOR (PParams era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods fromCBOR ∷ Decoder s (PParams era) Source # label ∷ Proxy (PParams era) → Text Source #
NoThunks (PParamsUpdate era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods noThunks ∷ Context → PParamsUpdate era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → PParamsUpdate era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (PParamsUpdate era) → String
NoThunks (PParams era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods noThunks ∷ Context → PParams era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → PParams era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (PParams era) → String
FromJSON (PParams era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods parseJSON ∷ Value → Parser (PParams era) parseJSONList ∷ Value → Parser [PParams era]
ToJSON (PParams era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toJSON ∷ PParams era → Value toEncoding ∷ PParams era → Encoding toJSONList ∷ [PParams era] → Value toEncodingList ∷ [PParams era] → Encoding
Eq (PParams' Identity era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods (==) ∷ PParams' Identity era → PParams' Identity era → Bool # (/=) ∷ PParams' Identity era → PParams' Identity era → Bool #
Eq (PParams' StrictMaybe era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods (==) ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Bool # (/=) ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Bool #
Ord (PParams' StrictMaybe era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods compare ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Ordering # (<) ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Bool # (<=) ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Bool # (>) ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Bool # (>=) ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → Bool # max ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → PParams' StrictMaybe era # min ∷ PParams' StrictMaybe era → PParams' StrictMaybe era → PParams' StrictMaybe era #
Show (PParams' Identity era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods showsPrec ∷ Int → PParams' Identity era → ShowS # show ∷ PParams' Identity era → String # showList ∷ [PParams' Identity era] → ShowS #
Show (PParams' StrictMaybe era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods showsPrec ∷ Int → PParams' StrictMaybe era → ShowS # show ∷ PParams' StrictMaybe era → String # showList ∷ [PParams' StrictMaybe era] → ShowS #
Generic (PParams' f era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Associated Types type Rep (PParams' f era) ∷ Type → Type # Methods from ∷ PParams' f era → Rep (PParams' f era) x # to ∷ Rep (PParams' f era) x → PParams' f era #
NFData (PParams' Identity era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods rnf ∷ PParams' Identity era → () #
NFData (PParams' StrictMaybe era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods rnf ∷ PParams' StrictMaybe era → () #
type Rep (PParams' f era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams type Rep (PParams' f era)

type PParams era = PParams' Identity era Source #

emptyPParams ∷ PParams era Source #

Returns a basic "empty" PParams structure with all zero values.

data ProtVer Source #

Constructors

ProtVer
Fields pvMajor ∷ !Natural pvMinor ∷ !Natural

Instances

Instances details

Eq ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods (==) ∷ ProtVer → ProtVer → Bool # (/=) ∷ ProtVer → ProtVer → Bool #
Ord ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods compare ∷ ProtVer → ProtVer → Ordering # (<) ∷ ProtVer → ProtVer → Bool # (<=) ∷ ProtVer → ProtVer → Bool # (>) ∷ ProtVer → ProtVer → Bool # (>=) ∷ ProtVer → ProtVer → Bool # max ∷ ProtVer → ProtVer → ProtVer # min ∷ ProtVer → ProtVer → ProtVer #
Show ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods showsPrec ∷ Int → ProtVer → ShowS # show ∷ ProtVer → String # showList ∷ [ProtVer] → ShowS #
Generic ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Associated Types type Rep ProtVer ∷ Type → Type # Methods from ∷ ProtVer → Rep ProtVer x # to ∷ Rep ProtVer x → ProtVer #
NFData ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods rnf ∷ ProtVer → () #
ToCBOR ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toCBOR ∷ ProtVer → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ProtVer → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ProtVer] → Size Source #
FromCBOR ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods fromCBOR ∷ Decoder s ProtVer Source # label ∷ Proxy ProtVer → Text Source #
NoThunks ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods noThunks ∷ Context → ProtVer → IO (Maybe ThunkInfo) wNoThunks ∷ Context → ProtVer → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy ProtVer → String
FromJSON ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods parseJSON ∷ Value → Parser ProtVer parseJSONList ∷ Value → Parser [ProtVer]
ToJSON ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toJSON ∷ ProtVer → Value toEncoding ∷ ProtVer → Encoding toJSONList ∷ [ProtVer] → Value toEncodingList ∷ [ProtVer] → Encoding
FromCBORGroup ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods fromCBORGroup ∷ Decoder s ProtVer Source #
ToCBORGroup ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toCBORGroup ∷ ProtVer → Encoding Source # encodedGroupSizeExpr ∷ (∀ x. ToCBOR x ⇒ Proxy x → Size) → Proxy ProtVer → Size Source # listLen ∷ ProtVer → Word Source # listLenBound ∷ Proxy ProtVer → Word Source #
type Rep ProtVer Source #
Instance details Defined in Shelley.Spec.Ledger.PParams type Rep ProtVer = D1 ('MetaData "ProtVer" "Shelley.Spec.Ledger.PParams" "shelley-spec-ledger-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ProtVer" 'PrefixI 'True) (S1 ('MetaSel ('Just "pvMajor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "pvMinor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural)))

data PPUpdateEnv era Source #

Constructors

PPUpdateEnv SlotNo (GenDelegs era)

Instances

Instances details

Eq (PPUpdateEnv era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods (==) ∷ PPUpdateEnv era → PPUpdateEnv era → Bool # (/=) ∷ PPUpdateEnv era → PPUpdateEnv era → Bool #
Show (PPUpdateEnv era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods showsPrec ∷ Int → PPUpdateEnv era → ShowS # show ∷ PPUpdateEnv era → String # showList ∷ [PPUpdateEnv era] → ShowS #
Generic (PPUpdateEnv era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Associated Types type Rep (PPUpdateEnv era) ∷ Type → Type # Methods from ∷ PPUpdateEnv era → Rep (PPUpdateEnv era) x # to ∷ Rep (PPUpdateEnv era) x → PPUpdateEnv era #
NoThunks (PPUpdateEnv era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods noThunks ∷ Context → PPUpdateEnv era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → PPUpdateEnv era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (PPUpdateEnv era) → String
type Rep (PPUpdateEnv era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams type Rep (PPUpdateEnv era) = D1 ('MetaData "PPUpdateEnv" "Shelley.Spec.Ledger.PParams" "shelley-spec-ledger-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PPUpdateEnv" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GenDelegs era))))

newtype ProposedPPUpdates era Source #

Update operation for protocol parameters structure @PParams

Constructors

ProposedPPUpdates (Map (KeyHash 'Genesis (Crypto era)) (PParamsUpdate era))

Instances

Instances details

Eq (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods (==) ∷ ProposedPPUpdates era → ProposedPPUpdates era → Bool # (/=) ∷ ProposedPPUpdates era → ProposedPPUpdates era → Bool #
Show (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods showsPrec ∷ Int → ProposedPPUpdates era → ShowS # show ∷ ProposedPPUpdates era → String # showList ∷ [ProposedPPUpdates era] → ShowS #
Generic (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Associated Types type Rep (ProposedPPUpdates era) ∷ Type → Type # Methods from ∷ ProposedPPUpdates era → Rep (ProposedPPUpdates era) x # to ∷ Rep (ProposedPPUpdates era) x → ProposedPPUpdates era #
NFData (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods rnf ∷ ProposedPPUpdates era → () #
Era era ⇒ ToCBOR (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.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 ⇒ FromCBOR (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods fromCBOR ∷ Decoder s (ProposedPPUpdates era) Source # label ∷ Proxy (ProposedPPUpdates era) → Text Source #
NoThunks (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods noThunks ∷ Context → ProposedPPUpdates era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → ProposedPPUpdates era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (ProposedPPUpdates era) → String
type Rep (ProposedPPUpdates era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams type Rep (ProposedPPUpdates era) = D1 ('MetaData "ProposedPPUpdates" "Shelley.Spec.Ledger.PParams" "shelley-spec-ledger-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ProposedPPUpdates" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (KeyHash 'Genesis (Crypto era)) (PParamsUpdate era)))))

emptyPPPUpdates ∷ ProposedPPUpdates era Source #

type PParamsUpdate era = PParams' StrictMaybe era Source #

emptyPParamsUpdate ∷ PParamsUpdate era Source #

data Update era Source #

Update Proposal

Constructors

Update !(ProposedPPUpdates era) !EpochNo

Instances

Instances details

HasField "update" (TxBody era) (StrictMaybe (Update era)) Source #
Instance details Defined in Shelley.Spec.Ledger.TxBody Methods getField ∷ TxBody era → StrictMaybe (Update era) #
Eq (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods (==) ∷ Update era → Update era → Bool # (/=) ∷ Update era → Update era → Bool #
Show (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods showsPrec ∷ Int → Update era → ShowS # show ∷ Update era → String # showList ∷ [Update era] → ShowS #
Generic (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Associated Types type Rep (Update era) ∷ Type → Type # Methods from ∷ Update era → Rep (Update era) x # to ∷ Rep (Update era) x → Update era #
Era era ⇒ ToCBOR (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods toCBOR ∷ Update era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Update era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Update era] → Size Source #
Era era ⇒ FromCBOR (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods fromCBOR ∷ Decoder s (Update era) Source # label ∷ Proxy (Update era) → Text Source #
NoThunks (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams Methods noThunks ∷ Context → Update era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → Update era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (Update era) → String
type Rep (Update era) Source #
Instance details Defined in Shelley.Spec.Ledger.PParams type Rep (Update era) = D1 ('MetaData "Update" "Shelley.Spec.Ledger.PParams" "shelley-spec-ledger-0.1.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)))

updatePParams ∷ PParams era → PParamsUpdate era → PParams era Source #