Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Alonzo.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 )
- _minPoolCost :: !( HKD f Coin )
- _coinsPerUTxOWord :: !( HKD f Coin )
- _costmdls :: !( HKD f CostModels )
- _prices :: !( HKD f Prices )
- _maxTxExUnits :: !( HKD f ExUnits )
- _maxBlockExUnits :: !( HKD f ExUnits )
- _maxValSize :: !( HKD f Natural )
- _collateralPercentage :: !( HKD f Natural )
- _maxCollateralInputs :: !( HKD f Natural )
}
type PParams era = PParams' Identity era
emptyPParams :: PParams era
type PParamsUpdate era = PParams' StrictMaybe era
emptyPParamsUpdate :: PParamsUpdate era
updatePParams :: PParams era -> PParamsUpdate era -> PParams era
getLanguageView :: forall era. HasField "_costmdls" ( PParams era) CostModels => PParams era -> Language -> LangDepView
data LangDepView = LangDepView {
- tag :: ByteString
- params :: ByteString
}
encodeLangViews :: Set LangDepView -> Encoding
retractPP :: HKD f Coin -> PParams' f era2 -> PParams' f era1
extendPP :: PParams' f era1 -> HKD f Coin -> HKD f CostModels -> HKD f Prices -> HKD f ExUnits -> HKD f ExUnits -> HKD f Natural -> HKD f Natural -> HKD f Natural -> PParams' f era2

Documentation

data PParams' f era Source #

Protocol parameters. Shelley parameters + additional ones

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 )

Maximum number of epochs in the future a pool retirement is allowed to be scheduled for.
_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. Note that the scale is inverted here - a value of 0 indicates full decentralisation, where 1 indicates full federalisation.
_extraEntropy :: !( HKD f Nonce )

Extra entropy
_protocolVersion :: !( HKD f ProtVer )

Protocol version
_minPoolCost :: !( HKD f Coin )

Minimum Stake Pool Cost
_coinsPerUTxOWord :: !( HKD f Coin )

Cost in lovelace per word (8 bytes) of UTxO storage (instead of _minUTxOValue)
_costmdls :: !( HKD f CostModels )

Cost models for non-native script languages
_prices :: !( HKD f Prices )

Prices of execution units (for non-native script languages)
_maxTxExUnits :: !( HKD f ExUnits )

Max total script execution resources units allowed per tx
_maxBlockExUnits :: !( HKD f ExUnits )

Max total script execution resources units allowed per block
_maxValSize :: !( HKD f Natural )

Max size of a Value in an output
_collateralPercentage :: !( HKD f Natural )

Percentage of the txfee which must be provided as collateral when including non-native scripts.
_maxCollateralInputs :: !( HKD f Natural )

Maximum number of collateral inputs allowed in a transaction

Instances

Instances details

ToJSON ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.Genesis Methods toJSON :: PParams era -> Value Source # toEncoding :: PParams era -> Encoding Source # toJSONList :: [ PParams era] -> Value Source # toEncodingList :: [ PParams era] -> Encoding Source #
ToJSON ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.Genesis Methods toJSON :: PParamsUpdate era -> Value Source # toEncoding :: PParamsUpdate era -> Encoding Source # toJSONList :: [ PParamsUpdate era] -> Value Source # toEncodingList :: [ PParamsUpdate era] -> Encoding Source #
FromJSON ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.Genesis Methods parseJSON :: Value -> Parser ( PParams era) Source # parseJSONList :: Value -> Parser [ PParams era] Source #
Era era => ToCBOR ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.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 => ToCBOR ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.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 => FromCBOR ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods fromCBOR :: Decoder s ( PParams era) Source # label :: Proxy ( PParams era) -> Text Source #
Era era => FromCBOR ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods fromCBOR :: Decoder s ( PParamsUpdate era) Source # label :: Proxy ( PParamsUpdate era) -> Text Source #
Default ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods def :: PParams era Source #
NoThunks ( PParams era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods noThunks :: Context -> PParams era -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PParams era -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PParams era) -> String Source #
NoThunks ( PParamsUpdate era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods noThunks :: Context -> PParamsUpdate era -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PParamsUpdate era -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PParamsUpdate era) -> String Source #
Eq ( PParams' Identity era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.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.Alonzo.PParams Methods (==) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source # (/=) :: PParams' StrictMaybe era -> PParams' StrictMaybe era -> Bool Source #
Ord ( PParams' StrictMaybe era) Source #	Since ExUnits does not have an Ord instance, we have to roll this Ord instance by hand. IF THE ORDER OR TYPES OF THE FIELDS OF PParams changes, this instance may need adusting.
Instance details Defined in Cardano.Ledger.Alonzo.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.Alonzo.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.Alonzo.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.Alonzo.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.Alonzo.PParams Methods rnf :: PParams' Identity era -> () Source #
NFData ( PParams' StrictMaybe era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods rnf :: PParams' StrictMaybe era -> () Source #
type Rep ( PParams' f era) Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams type Rep ( PParams' f era) = D1 (' MetaData "PParams'" "Cardano.Ledger.Alonzo.PParams" "cardano-ledger-alonzo-0.1.0.0-xW3meaGVQP43dxJ76zbGD" ' 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 "_minPoolCost") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Coin )) :: ( S1 (' MetaSel (' Just "_coinsPerUTxOWord") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Coin )) :: S1 (' MetaSel (' Just "_costmdls") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f CostModels ))))) :: (( S1 (' MetaSel (' Just "_prices") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Prices )) :: ( S1 (' MetaSel (' Just "_maxTxExUnits") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f ExUnits )) :: S1 (' MetaSel (' Just "_maxBlockExUnits") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f ExUnits )))) :: ( S1 (' MetaSel (' Just "_maxValSize") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )) :: ( S1 (' MetaSel (' Just "_collateralPercentage") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural )) :*: S1 (' MetaSel (' Just "_maxCollateralInputs") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( HKD f Natural ))))))))

type PParams era = PParams' Identity era Source #

emptyPParams :: PParams era Source #

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

type PParamsUpdate era = PParams' StrictMaybe era Source #

emptyPParamsUpdate :: PParamsUpdate era Source #

updatePParams :: PParams era -> PParamsUpdate era -> PParams era Source #

Update operation for protocol parameters structure @PParams

getLanguageView :: forall era. HasField "_costmdls" ( PParams era) CostModels => PParams era -> Language -> LangDepView Source #

data LangDepView Source #

Constructors

LangDepView
Fields tag :: ByteString params :: ByteString

Instances

Instances details

Eq LangDepView Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods (==) :: LangDepView -> LangDepView -> Bool Source # (/=) :: LangDepView -> LangDepView -> Bool Source #
Ord LangDepView Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods compare :: LangDepView -> LangDepView -> Ordering Source # (<) :: LangDepView -> LangDepView -> Bool Source # (<=) :: LangDepView -> LangDepView -> Bool Source # (>) :: LangDepView -> LangDepView -> Bool Source # (>=) :: LangDepView -> LangDepView -> Bool Source # max :: LangDepView -> LangDepView -> LangDepView Source # min :: LangDepView -> LangDepView -> LangDepView Source #
Show LangDepView Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods showsPrec :: Int -> LangDepView -> ShowS Source # show :: LangDepView -> String Source # showList :: [ LangDepView ] -> ShowS Source #
Generic LangDepView Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Associated Types type Rep LangDepView :: Type -> Type Source # Methods from :: LangDepView -> Rep LangDepView x Source # to :: Rep LangDepView x -> LangDepView Source #
NoThunks LangDepView Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams Methods noThunks :: Context -> LangDepView -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> LangDepView -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy LangDepView -> String Source #
type Rep LangDepView Source #
Instance details Defined in Cardano.Ledger.Alonzo.PParams type Rep LangDepView = D1 (' MetaData "LangDepView" "Cardano.Ledger.Alonzo.PParams" "cardano-ledger-alonzo-0.1.0.0-xW3meaGVQP43dxJ76zbGD" ' False ) ( C1 (' MetaCons "LangDepView" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "tag") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString ) :*: S1 (' MetaSel (' Just "params") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )))

encodeLangViews :: Set LangDepView -> Encoding Source #

retractPP :: HKD f Coin -> PParams' f era2 -> PParams' f era1 Source #

Turn an PParams' into a Shelley.Params'

extendPP :: PParams' f era1 -> HKD f Coin -> HKD f CostModels -> HKD f Prices -> HKD f ExUnits -> HKD f ExUnits -> HKD f Natural -> HKD f Natural -> HKD f Natural -> PParams' f era2 Source #

Given the missing pieces Turn a Shelley.PParams' into an Params'