Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.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 NonNegativeInterval )
- _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
type family HKD f a where ...
class HKDFunctor f where
- hkdMap :: Proxy f -> (a -> b) -> HKD f a -> HKD f b
data PPUpdateEnv era = PPUpdateEnv SlotNo ( GenDelegs era)
newtype ProposedPPUpdates era = ProposedPPUpdates ( Map ( KeyHash ' Genesis ( Crypto era)) ( PParamsDelta 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 NonNegativeInterval )

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

ToJSON ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods toJSON :: PParams era -> Value Source # toEncoding :: PParams era -> Encoding Source # toJSONList :: [ PParams era] -> Value Source # toEncodingList :: [ PParams era] -> Encoding Source #
FromJSON ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods parseJSON :: Value -> Parser ( PParams era) Source # parseJSONList :: Value -> Parser [ PParams era] Source #
Era era => ToCBOR ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods toCBOR :: PParamsUpdate era -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( PParamsUpdate era) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ PParamsUpdate era] -> Size Source #
Era era => ToCBOR ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods toCBOR :: PParams era -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( PParams era) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ PParams era] -> Size Source #
Era era => FromCBOR ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods fromCBOR :: Decoder s ( PParamsUpdate era) Source # label :: Proxy ( PParamsUpdate era) -> Text Source #
Era era => FromCBOR ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods fromCBOR :: Decoder s ( PParams era) Source # label :: Proxy ( PParams era) -> Text Source #
Default ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods def :: PParams era Source #
NoThunks ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods noThunks :: Context -> PParamsUpdate era -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PParamsUpdate era -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PParamsUpdate era) -> String Source #
NoThunks ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods noThunks :: Context -> PParams era -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PParams era -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PParams era) -> String Source #
Eq ( PParams' Identity era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods (==) :: PParams' Identity era -> PParams' Identity era -> Bool Source # (/=) :: PParams' Identity era -> PParams' Identity era -> Bool Source #
Eq ( PParams' StrictMaybe era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods (==) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source # (/=) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source #
Ord ( PParams' StrictMaybe era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods compare :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Ordering Source # (<) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source # (<=) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source # (>) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source # (>=) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source # max :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> PParams' StrictMaybe era Source # min :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> PParams' StrictMaybe era Source #
Show ( PParams' Identity era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods showsPrec :: Int -> PParams' Identity era -> ShowS Source # show :: PParams' Identity era -> String Source # showList :: [ PParams' Identity era] -> ShowS Source #
Show ( PParams' StrictMaybe era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods showsPrec :: Int -> PParams' StrictMaybe era -> ShowS Source # show :: PParams' StrictMaybe era -> String Source # showList :: [ PParams' StrictMaybe era] -> ShowS Source #
Generic ( PParams' f era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Associated Types type Rep ( PParams' f era) :: Type -> Type Source # Methods from :: PParams' f era -> Rep ( PParams' f era) x Source # to :: Rep ( PParams' f era) x -> PParams' f era Source #
NFData ( PParams' Identity era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods rnf :: PParams' Identity era -> () Source #
NFData ( PParams' StrictMaybe era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods rnf :: PParams' StrictMaybe era -> () Source #
type Rep ( PParams' f era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams type Rep ( PParams' f era) = D1 (' MetaData "PParams'" "Cardano.Ledger.Shelley.PParams" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' False ) ( C1 (' MetaCons "PParams" ' PrefixI ' True ) (((( S1 (' MetaSel (' Just "_minfeeA") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )) :: S1 (' MetaSel (' Just "_minfeeB") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural ))) :: ( S1 (' MetaSel (' Just "_maxBBSize") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )) :: S1 (' MetaSel (' Just "_maxTxSize") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )))) :: (( S1 (' MetaSel (' Just "_maxBHSize") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )) :: S1 (' MetaSel (' Just "_keyDeposit") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Coin ))) :: ( S1 (' MetaSel (' Just "_poolDeposit") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Coin )) :: S1 (' MetaSel (' Just "_eMax") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f EpochNo ))))) :: ((( S1 (' MetaSel (' Just "_nOpt") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )) :: S1 (' MetaSel (' Just "_a0") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f NonNegativeInterval ))) :: ( S1 (' MetaSel (' Just "_rho") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f UnitInterval )) :: S1 (' MetaSel (' Just "_tau") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f UnitInterval )))) :: (( S1 (' MetaSel (' Just "_d") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f UnitInterval )) :: S1 (' MetaSel (' Just "_extraEntropy") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Nonce ))) :: ( S1 (' MetaSel (' Just "_protocolVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f ProtVer )) :: ( S1 (' MetaSel (' Just "_minUTxOValue") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Coin )) :: S1 (' MetaSel (' Just "_minPoolCost") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Coin ))))))))

type PParams era = PParams' Identity era Source #

emptyPParams :: PParams era Source #

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

type family HKD f a where ... Source #

Higher Kinded Data

Equations

HKD Identity a = a
HKD f a = f a

class HKDFunctor f where Source #

Methods

hkdMap :: Proxy f -> (a -> b) -> HKD f a -> HKD f b Source #

Instances

Instances details

HKDFunctor Maybe Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods hkdMap :: Proxy Maybe -> (a -> b) -> HKD Maybe a -> HKD Maybe b Source #
HKDFunctor Identity Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods hkdMap :: Proxy Identity -> (a -> b) -> HKD Identity a -> HKD Identity b Source #
HKDFunctor StrictMaybe Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods hkdMap :: Proxy StrictMaybe -> (a -> b) -> HKD StrictMaybe a -> HKD StrictMaybe b Source #

data PPUpdateEnv era Source #

Constructors

PPUpdateEnv SlotNo ( GenDelegs era)

Instances

Instances details

Eq ( PPUpdateEnv era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods (==) :: PPUpdateEnv era -> PPUpdateEnv era -> Bool Source # (/=) :: PPUpdateEnv era -> PPUpdateEnv era -> Bool Source #
Show ( PPUpdateEnv era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods showsPrec :: Int -> PPUpdateEnv era -> ShowS Source # show :: PPUpdateEnv era -> String Source # showList :: [ PPUpdateEnv era] -> ShowS Source #
Generic ( PPUpdateEnv era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Associated Types type Rep ( PPUpdateEnv era) :: Type -> Type Source # Methods from :: PPUpdateEnv era -> Rep ( PPUpdateEnv era) x Source # to :: Rep ( PPUpdateEnv era) x -> PPUpdateEnv era Source #
NoThunks ( PPUpdateEnv era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods noThunks :: Context -> PPUpdateEnv era -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PPUpdateEnv era -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PPUpdateEnv era) -> String Source #
type Rep ( PPUpdateEnv era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams type Rep ( PPUpdateEnv era) = D1 (' MetaData "PPUpdateEnv" "Cardano.Ledger.Shelley.PParams" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' 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)) ( PParamsDelta era))

Instances

Instances details

Eq ( PParamsDelta era) => Eq ( ProposedPPUpdates era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods (==) :: ProposedPPUpdates era -> ProposedPPUpdates era -> Bool Source # (/=) :: ProposedPPUpdates era -> ProposedPPUpdates era -> Bool Source #
Show ( PParamsDelta era) => Show ( ProposedPPUpdates era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods showsPrec :: Int -> ProposedPPUpdates era -> ShowS Source # show :: ProposedPPUpdates era -> String Source # showList :: [ ProposedPPUpdates era] -> ShowS Source #
Generic ( ProposedPPUpdates era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Associated Types type Rep ( ProposedPPUpdates era) :: Type -> Type Source # Methods from :: ProposedPPUpdates era -> Rep ( ProposedPPUpdates era) x Source # to :: Rep ( ProposedPPUpdates era) x -> ProposedPPUpdates era Source #
NFData ( PParamsDelta era) => NFData ( ProposedPPUpdates era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods rnf :: ProposedPPUpdates era -> () Source #
( Era era, ToCBOR ( PParamsDelta era)) => ToCBOR ( ProposedPPUpdates era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods toCBOR :: ProposedPPUpdates era -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( ProposedPPUpdates era) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ProposedPPUpdates era] -> Size Source #
( Era era, FromCBOR ( PParamsDelta 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 #
NoThunks ( PParamsDelta 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-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' True ) ( C1 (' MetaCons "ProposedPPUpdates" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Map ( KeyHash ' Genesis ( Crypto era)) ( PParamsDelta 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 Cardano.Ledger.Shelley.TxBody Methods getField :: TxBody era -> StrictMaybe ( Update era) Source #
Eq ( PParamsDelta era) => Eq ( Update era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods (==) :: Update era -> Update era -> Bool Source # (/=) :: Update era -> Update era -> Bool Source #
Show ( PParamsDelta era) => Show ( Update era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods showsPrec :: Int -> Update era -> ShowS Source # show :: Update era -> String Source # showList :: [ Update era] -> ShowS Source #
Generic ( Update era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Associated Types type Rep ( Update era) :: Type -> Type Source # Methods from :: Update era -> Rep ( Update era) x Source # to :: Rep ( Update era) x -> Update era Source #
NFData ( PParamsDelta era) => NFData ( Update era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods rnf :: Update era -> () Source #
( Era era, ToCBOR ( PParamsDelta era)) => ToCBOR ( Update era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods toCBOR :: Update era -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( Update era) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Update era] -> Size Source #
( Era era, FromCBOR ( PParamsDelta era)) => FromCBOR ( Update era) Source #
Instance details Defined in Cardano.Ledger.Shelley.PParams Methods fromCBOR :: Decoder s ( Update era) Source # label :: Proxy ( Update era) -> Text Source #
NoThunks ( PParamsDelta 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-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' 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 #