Safe Haskell	None
Language	Haskell2010

Cardano.Api.ProtocolParameters

Contents

The updatable protocol parameters
The updatable protocol parameters
Deprecated
Errors
PraosNonce
Execution units, prices and cost models,
Update proposals to change the protocol parameters
Internal conversion functions
Data family instances
- Era-dependent protocol features

Description

The various Cardano protocol parameters, including:

the current values of updatable protocol parameters: ProtocolParameters
updates to protocol parameters: ProtocolParametersUpdate
update proposals that can be embedded in transactions: UpdateProposal
parameters fixed in the genesis file: GenesisParameters

Synopsis

data ProtocolParameters = ProtocolParameters {
- protocolParamProtocolVersion :: (Natural, Natural)
- protocolParamDecentralization :: Maybe Rational
- protocolParamExtraPraosEntropy :: Maybe PraosNonce
- protocolParamMaxBlockHeaderSize :: Natural
- protocolParamMaxBlockBodySize :: Natural
- protocolParamMaxTxSize :: Natural
- protocolParamTxFeeFixed :: Coin
- protocolParamTxFeePerByte :: Coin
- protocolParamMinUTxOValue :: Maybe Coin
- protocolParamStakeAddressDeposit :: Coin
- protocolParamStakePoolDeposit :: Coin
- protocolParamMinPoolCost :: Coin
- protocolParamPoolRetireMaxEpoch :: EpochInterval
- protocolParamStakePoolTargetNum :: Natural
- protocolParamPoolPledgeInfluence :: Rational
- protocolParamMonetaryExpansion :: Rational
- protocolParamTreasuryCut :: Rational
- protocolParamCostModels :: Map AnyPlutusScriptVersion CostModel
- protocolParamPrices :: Maybe ExecutionUnitPrices
- protocolParamMaxTxExUnits :: Maybe ExecutionUnits
- protocolParamMaxBlockExUnits :: Maybe ExecutionUnits
- protocolParamMaxValueSize :: Maybe Natural
- protocolParamCollateralPercent :: Maybe Natural
- protocolParamMaxCollateralInputs :: Maybe Natural
- protocolParamUTxOCostPerByte :: Maybe Coin
}
checkProtocolParameters :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersError ()
data EpochNo
newtype LedgerProtocolParameters era = LedgerProtocolParameters {
- unLedgerProtocolParameters :: PParams (ShelleyLedgerEra era)
}
data EraBasedProtocolParametersUpdate era where
- ShelleyEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams ShelleyEra -> DeprecatedAfterBabbagePParams ShelleyEra -> ShelleyToAlonzoPParams ShelleyEra -> EraBasedProtocolParametersUpdate ShelleyEra
- AllegraEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams AllegraEra -> ShelleyToAlonzoPParams AllegraEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AllegraEra
- MaryEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams MaryEra -> ShelleyToAlonzoPParams MaryEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate MaryEra
- AlonzoEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> ShelleyToAlonzoPParams AlonzoEra -> AlonzoOnwardsPParams AlonzoEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AlonzoEra
- BabbageEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams BabbageEra -> DeprecatedAfterBabbagePParams ShelleyEra -> IntroducedInBabbagePParams BabbageEra -> EraBasedProtocolParametersUpdate BabbageEra
- ConwayEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams ConwayEra -> IntroducedInBabbagePParams ConwayEra -> IntroducedInConwayPParams (ShelleyLedgerEra ConwayEra) -> EraBasedProtocolParametersUpdate ConwayEra
data AlonzoOnwardsPParams ledgerera = AlonzoOnwardsPParams {
- alCostModels :: StrictMaybe CostModels
- alPrices :: StrictMaybe Prices
- alMaxTxExUnits :: StrictMaybe ExUnits
- alMaxBlockExUnits :: StrictMaybe ExUnits
- alMaxValSize :: StrictMaybe Natural
- alCollateralPercentage :: StrictMaybe Natural
- alMaxCollateralInputs :: StrictMaybe Natural
}
data CommonProtocolParametersUpdate = CommonProtocolParametersUpdate {
- cppMinFeeA :: StrictMaybe Coin
- cppMinFeeB :: StrictMaybe Coin
- cppMaxBlockBodySize :: StrictMaybe Word32
- cppMaxTxSize :: StrictMaybe Word32
- cppMaxBlockHeaderSize :: StrictMaybe Word16
- cppKeyDeposit :: StrictMaybe Coin
- cppPoolDeposit :: StrictMaybe Coin
- cppPoolRetireMaxEpoch :: StrictMaybe EpochInterval
- cppStakePoolTargetNum :: StrictMaybe Natural
- cppPoolPledgeInfluence :: StrictMaybe NonNegativeInterval
- cppTreasuryExpansion :: StrictMaybe UnitInterval
- cppMonetaryExpansion :: StrictMaybe UnitInterval
- cppMinPoolCost :: StrictMaybe Coin
}
newtype DeprecatedAfterBabbagePParams ledgerera = DeprecatedAfterBabbagePParams (StrictMaybe ProtVer)
newtype DeprecatedAfterMaryPParams ledgerera = DeprecatedAfterMaryPParams (StrictMaybe Coin)
data ShelleyToAlonzoPParams ledgerera = ShelleyToAlonzoPParams (StrictMaybe Nonce) (StrictMaybe UnitInterval)
newtype IntroducedInBabbagePParams era = IntroducedInBabbagePParams (StrictMaybe CoinPerByte)
data IntroducedInConwayPParams era = IntroducedInConwayPParams {
- icPoolVotingThresholds :: StrictMaybe PoolVotingThresholds
- icDRepVotingThresholds :: StrictMaybe DRepVotingThresholds
- icMinCommitteeSize :: StrictMaybe Natural
- icCommitteeTermLength :: StrictMaybe EpochInterval
- icGovActionLifetime :: StrictMaybe EpochInterval
- icGovActionDeposit :: StrictMaybe Coin
- icDRepDeposit :: StrictMaybe Coin
- icDRepActivity :: StrictMaybe EpochInterval
- icMinFeeRefScriptCostPerByte :: StrictMaybe NonNegativeInterval
}
createEraBasedProtocolParamUpdate :: ShelleyBasedEra era -> EraBasedProtocolParametersUpdate era -> PParamsUpdate (ShelleyLedgerEra era)
convertToLedgerProtocolParameters :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersConversionError (LedgerProtocolParameters era)
createPParams :: ShelleyBasedEra era -> EraBasedProtocolParametersUpdate era -> PParams (ShelleyLedgerEra era)
data ProtocolParametersUpdate = ProtocolParametersUpdate {
- protocolUpdateProtocolVersion :: Maybe (Natural, Natural)
- protocolUpdateDecentralization :: Maybe Rational
- protocolUpdateExtraPraosEntropy :: Maybe (Maybe PraosNonce)
- protocolUpdateMaxBlockHeaderSize :: Maybe Word16
- protocolUpdateMaxBlockBodySize :: Maybe Word32
- protocolUpdateMaxTxSize :: Maybe Word32
- protocolUpdateTxFeeFixed :: Maybe Coin
- protocolUpdateTxFeePerByte :: Maybe Coin
- protocolUpdateMinUTxOValue :: Maybe Coin
- protocolUpdateStakeAddressDeposit :: Maybe Coin
- protocolUpdateStakePoolDeposit :: Maybe Coin
- protocolUpdateMinPoolCost :: Maybe Coin
- protocolUpdatePoolRetireMaxEpoch :: Maybe EpochInterval
- protocolUpdateStakePoolTargetNum :: Maybe Natural
- protocolUpdatePoolPledgeInfluence :: Maybe Rational
- protocolUpdateMonetaryExpansion :: Maybe Rational
- protocolUpdateTreasuryCut :: Maybe Rational
- protocolUpdateCostModels :: Map AnyPlutusScriptVersion CostModel
- protocolUpdatePrices :: Maybe ExecutionUnitPrices
- protocolUpdateMaxTxExUnits :: Maybe ExecutionUnits
- protocolUpdateMaxBlockExUnits :: Maybe ExecutionUnits
- protocolUpdateMaxValueSize :: Maybe Natural
- protocolUpdateCollateralPercent :: Maybe Natural
- protocolUpdateMaxCollateralInputs :: Maybe Natural
- protocolUpdateUTxOCostPerByte :: Maybe Coin
}
data ProtocolParametersError
- = PParamsErrorMissingMinUTxoValue !AnyCardanoEra
- | PParamsErrorMissingAlonzoProtocolParameter
data ProtocolParametersConversionError
- = PpceOutOfBounds !ProtocolParameterName !Rational
- | PpceVersionInvalid !ProtocolParameterVersion
- | PpceInvalidCostModel !CostModel !CostModelApplyError
- | PpceMissingParameter !ProtocolParameterName
data PraosNonce
makePraosNonce :: ByteString -> PraosNonce
data ExecutionUnits = ExecutionUnits {
- executionSteps :: Natural
- executionMemory :: Natural
}
data ExecutionUnitPrices = ExecutionUnitPrices {
- priceExecutionSteps :: Rational
- priceExecutionMemory :: Rational
}
newtype CostModels = CostModels {
- unCostModels :: Map AnyPlutusScriptVersion CostModel
}
newtype CostModel = CostModel [Int64]
fromAlonzoCostModels :: CostModels -> Map AnyPlutusScriptVersion CostModel
data UpdateProposal = UpdateProposal !(Map (Hash GenesisKey) ProtocolParametersUpdate) !EpochNo
makeShelleyUpdateProposal :: ProtocolParametersUpdate -> [Hash GenesisKey] -> EpochNo -> UpdateProposal
toLedgerNonce :: Maybe PraosNonce -> Nonce
toLedgerUpdate :: ShelleyBasedEra era -> UpdateProposal -> Either ProtocolParametersConversionError (Update (ShelleyLedgerEra era))
fromLedgerUpdate :: (ShelleyLedgerEra era ~ ledgerera, EraCrypto ledgerera ~ StandardCrypto) => ShelleyBasedEra era -> Update ledgerera -> UpdateProposal
toLedgerProposedPPUpdates :: ShelleyBasedEra era -> Map (Hash GenesisKey) ProtocolParametersUpdate -> Either ProtocolParametersConversionError (ProposedPPUpdates (ShelleyLedgerEra era))
fromLedgerProposedPPUpdates :: (ShelleyLedgerEra era ~ ledgerera, EraCrypto ledgerera ~ StandardCrypto) => ShelleyBasedEra era -> ProposedPPUpdates ledgerera -> Map (Hash GenesisKey) ProtocolParametersUpdate
toLedgerPParams :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersConversionError (PParams (ShelleyLedgerEra era))
toLedgerPParamsUpdate :: ShelleyBasedEra era -> ProtocolParametersUpdate -> Either ProtocolParametersConversionError (PParamsUpdate (ShelleyLedgerEra era))
fromLedgerPParams :: ShelleyBasedEra era -> PParams (ShelleyLedgerEra era) -> ProtocolParameters
fromLedgerPParamsUpdate :: ShelleyBasedEra era -> PParamsUpdate (ShelleyLedgerEra era) -> ProtocolParametersUpdate
toAlonzoPrices :: ExecutionUnitPrices -> Either ProtocolParametersConversionError Prices
fromAlonzoPrices :: Prices -> ExecutionUnitPrices
toAlonzoScriptLanguage :: AnyPlutusScriptVersion -> Language
fromAlonzoScriptLanguage :: Language -> AnyPlutusScriptVersion
toAlonzoCostModel :: CostModel -> Language -> Either ProtocolParametersConversionError CostModel
fromAlonzoCostModel :: CostModel -> CostModel
toAlonzoCostModels :: Map AnyPlutusScriptVersion CostModel -> Either ProtocolParametersConversionError CostModels
data family AsType t

The updatable protocol parameters

data ProtocolParameters Source #

Deprecated: Use the ledger's PParams (from module Cardano.Api.Ledger) type instead of ProtocolParameters. The type will be removed after Chang hard fork.

The values of the set of updatable protocol parameters. At any particular point on the chain there is a current set of parameters in use.

These parameters can be updated (at epoch boundaries) via an UpdateProposal, which contains a ProtocolParametersUpdate.

The ProtocolParametersUpdate is essentially a diff for the ProtocolParameters.

There are also parameters fixed in the Genesis file. See GenesisParameters.

Constructors

ProtocolParameters

Deprecated: Use the ledger's PParams (from module Cardano.Api.Ledger) type instead of ProtocolParameters. The type will be removed after Chang hard fork.

Fields

protocolParamProtocolVersion :: (Natural, Natural)
Protocol version, major and minor. Updating the major version is used to trigger hard forks. (Major , Minor )
protocolParamDecentralization :: Maybe Rational
The decentralization parameter. This is fraction of slots that belong to the BFT overlay schedule, rather than the Praos schedule. So 1 means fully centralised, while 0 means fully decentralised.
This is the "d" parameter from the design document.
Deprecated in Babbage
protocolParamExtraPraosEntropy :: Maybe PraosNonce
Extra entropy for the Praos per-epoch nonce.
This can be used to add extra entropy during the decentralisation process. If the extra entropy can be demonstrated to be generated randomly then this method can be used to show that the initial federated operators did not subtly bias the initial schedule so that they retain undue influence after decentralisation.
protocolParamMaxBlockHeaderSize :: Natural
The maximum permitted size of a block header.
This must be at least as big as the largest legitimate block headers but should not be too much larger, to help prevent DoS attacks.
Caution: setting this to be smaller than legitimate block headers is a sure way to brick the system!
protocolParamMaxBlockBodySize :: Natural
The maximum permitted size of the block body (that is, the block payload, without the block header).
This should be picked with the Praos network delta security parameter in mind. Making this too large can severely weaken the Praos consensus properties.
Caution: setting this to be smaller than a transaction that can change the protocol parameters is a sure way to brick the system!
protocolParamMaxTxSize :: Natural
The maximum permitted size of a transaction.
Typically this should not be too high a fraction of the block size, otherwise wastage from block fragmentation becomes a problem, and the current implementation does not use any sophisticated box packing algorithm.
protocolParamTxFeeFixed :: Coin
The constant factor for the minimum fee calculation.
protocolParamTxFeePerByte :: Coin
Per byte linear factor for the minimum fee calculation.
protocolParamMinUTxOValue :: Maybe Coin
The minimum permitted value for new UTxO entries, ie for transaction outputs.
protocolParamStakeAddressDeposit :: Coin
The deposit required to register a stake address.
protocolParamStakePoolDeposit :: Coin
The deposit required to register a stake pool.
protocolParamMinPoolCost :: Coin
The minimum value that stake pools are permitted to declare for their cost parameter.
protocolParamPoolRetireMaxEpoch :: EpochInterval
The maximum number of epochs into the future that stake pools are permitted to schedule a retirement.
protocolParamStakePoolTargetNum :: Natural
The equilibrium target number of stake pools.
This is the "k" incentives parameter from the design document.
protocolParamPoolPledgeInfluence :: Rational
The influence of the pledge in stake pool rewards.
This is the "a_0" incentives parameter from the design document.
protocolParamMonetaryExpansion :: Rational
The monetary expansion rate. This determines the fraction of the reserves that are added to the fee pot each epoch.
This is the "rho" incentives parameter from the design document.
protocolParamTreasuryCut :: Rational
The fraction of the fee pot each epoch that goes to the treasury.
This is the "tau" incentives parameter from the design document.
protocolParamCostModels :: Map AnyPlutusScriptVersion CostModel
Cost models for script languages that use them.
Introduced in Alonzo
protocolParamPrices :: Maybe ExecutionUnitPrices
Price of execution units for script languages that use them.
Introduced in Alonzo
protocolParamMaxTxExUnits :: Maybe ExecutionUnits
Max total script execution resources units allowed per tx
Introduced in Alonzo
protocolParamMaxBlockExUnits :: Maybe ExecutionUnits
Max total script execution resources units allowed per block
Introduced in Alonzo
protocolParamMaxValueSize :: Maybe Natural
Max size of a Value in a tx output.
Introduced in Alonzo
protocolParamCollateralPercent :: Maybe Natural
The percentage of the script contribution to the txfee that must be provided as collateral inputs when including Plutus scripts.
Introduced in Alonzo
protocolParamMaxCollateralInputs :: Maybe Natural
The maximum number of collateral inputs allowed in a transaction.
Introduced in Alonzo
protocolParamUTxOCostPerByte :: Maybe Coin
Cost in ada per byte of UTxO storage.
Introduced in Babbage

Instances

Instances details

FromJSON ProtocolParameters Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

parseJSON :: Value -> Parser ProtocolParameters #

parseJSONList :: Value -> Parser [ProtocolParameters] #

omittedField :: Maybe ProtocolParameters #

ToJSON ProtocolParameters Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

toJSON :: ProtocolParameters -> Value #

toEncoding :: ProtocolParameters -> Encoding #

toJSONList :: [ProtocolParameters] -> Value #

toEncodingList :: [ProtocolParameters] -> Encoding #

omitField :: ProtocolParameters -> Bool #

Generic ProtocolParameters Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

type Rep ProtocolParameters

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

from :: ProtocolParameters -> Rep ProtocolParameters x Source #

to :: Rep ProtocolParameters x -> ProtocolParameters Source #

Show ProtocolParameters Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

showsPrec :: Int -> ProtocolParameters -> ShowS Source #

show :: ProtocolParameters -> String Source #

showList :: [ProtocolParameters] -> ShowS Source #

Eq ProtocolParameters Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

(==) :: ProtocolParameters -> ProtocolParameters -> Bool Source #

(/=) :: ProtocolParameters -> ProtocolParameters -> Bool Source #

type Rep ProtocolParameters Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

checkProtocolParameters :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersError () Source #

Deprecated: Use the ledger's PParams (from module Cardano.Api.Ledger) type instead of ProtocolParameters. The type will be removed after Chang hard fork. PParams natively enforce these checks.

data EpochNo Source #

An epoch, i.e. the number of the epoch.

Instances

Instances details

FromJSON EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

parseJSON :: Value -> Parser EpochNo #

parseJSONList :: Value -> Parser [EpochNo] #

omittedField :: Maybe EpochNo #

ToJSON EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

toJSON :: EpochNo -> Value #

toEncoding :: EpochNo -> Encoding #

toJSONList :: [EpochNo] -> Value #

toEncodingList :: [EpochNo] -> Encoding #

omitField :: EpochNo -> Bool #

Enum EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

succ :: EpochNo -> EpochNo Source #

pred :: EpochNo -> EpochNo Source #

toEnum :: Int -> EpochNo Source #

fromEnum :: EpochNo -> Int Source #

enumFrom :: EpochNo -> [EpochNo] Source #

enumFromThen :: EpochNo -> EpochNo -> [EpochNo] Source #

enumFromTo :: EpochNo -> EpochNo -> [EpochNo] Source #

enumFromThenTo :: EpochNo -> EpochNo -> EpochNo -> [EpochNo] Source #

Generic EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep EpochNo
Instance details Defined in Cardano.Slotting.Slot type Rep EpochNo = D1 ('MetaData "EpochNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-886a3531c066a8cf893d904908b2d4b5847cecce4ba51139f879cc7ba241da23" 'True) (C1 ('MetaCons "EpochNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: EpochNo -> Rep EpochNo x Source #

to :: Rep EpochNo x -> EpochNo Source #

Show EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

showsPrec :: Int -> EpochNo -> ShowS Source #

show :: EpochNo -> String Source #

showList :: [EpochNo] -> ShowS Source #

FromCBOR EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

fromCBOR :: Decoder s EpochNo Source #

label :: Proxy EpochNo -> Text Source #

ToCBOR EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR :: EpochNo -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy EpochNo -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [EpochNo] -> Size Source #

DecCBOR EpochNo

Instance details

Defined in Cardano.Ledger.Binary.Decoding.DecCBOR

Methods

decCBOR :: Decoder s EpochNo Source #

dropCBOR :: Proxy EpochNo -> Decoder s () Source #

label :: Proxy EpochNo -> Text Source #

EncCBOR EpochNo

Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR :: EpochNo -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy EpochNo -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [EpochNo] -> Size Source #

NFData EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf :: EpochNo -> () Source #

Eq EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) :: EpochNo -> EpochNo -> Bool Source #

(/=) :: EpochNo -> EpochNo -> Bool Source #

Ord EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

compare :: EpochNo -> EpochNo -> Ordering Source #

(<) :: EpochNo -> EpochNo -> Bool Source #

(<=) :: EpochNo -> EpochNo -> Bool Source #

(>) :: EpochNo -> EpochNo -> Bool Source #

(>=) :: EpochNo -> EpochNo -> Bool Source #

max :: EpochNo -> EpochNo -> EpochNo Source #

min :: EpochNo -> EpochNo -> EpochNo Source #

NoThunks EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

noThunks :: Context -> EpochNo -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> EpochNo -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy EpochNo -> String #

Condense EpochNo

Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense :: EpochNo -> String Source #

Serialise EpochNo

Instance details

Defined in Cardano.Slotting.Slot

Methods

encode :: EpochNo -> Encoding

decode :: Decoder s EpochNo

encodeList :: [EpochNo] -> Encoding

decodeList :: Decoder s [EpochNo]

type Rep EpochNo

Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochNo = D1 ('MetaData "EpochNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-886a3531c066a8cf893d904908b2d4b5847cecce4ba51139f879cc7ba241da23" 'True) (C1 ('MetaCons "EpochNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

The updatable protocol parameters

newtype LedgerProtocolParameters era Source #

Constructors

LedgerProtocolParameters
Fields unLedgerProtocolParameters :: PParams (ShelleyLedgerEra era)

Instances

Instances details

IsShelleyBasedEra era => Show (LedgerProtocolParameters era) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> LedgerProtocolParameters era -> ShowS Source # show :: LedgerProtocolParameters era -> String Source # showList :: [LedgerProtocolParameters era] -> ShowS Source #
IsShelleyBasedEra era => Eq (LedgerProtocolParameters era) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: LedgerProtocolParameters era -> LedgerProtocolParameters era -> Bool Source # (/=) :: LedgerProtocolParameters era -> LedgerProtocolParameters era -> Bool Source #

data EraBasedProtocolParametersUpdate era where Source #

Each constructor corresponds to the set of protocol parameters available in a given era.

Constructors

ShelleyEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams ShelleyEra -> DeprecatedAfterBabbagePParams ShelleyEra -> ShelleyToAlonzoPParams ShelleyEra -> EraBasedProtocolParametersUpdate ShelleyEra
AllegraEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams AllegraEra -> ShelleyToAlonzoPParams AllegraEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AllegraEra
MaryEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams MaryEra -> ShelleyToAlonzoPParams MaryEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate MaryEra
AlonzoEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> ShelleyToAlonzoPParams AlonzoEra -> AlonzoOnwardsPParams AlonzoEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AlonzoEra
BabbageEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams BabbageEra -> DeprecatedAfterBabbagePParams ShelleyEra -> IntroducedInBabbagePParams BabbageEra -> EraBasedProtocolParametersUpdate BabbageEra
ConwayEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams ConwayEra -> IntroducedInBabbagePParams ConwayEra -> IntroducedInConwayPParams (ShelleyLedgerEra ConwayEra) -> EraBasedProtocolParametersUpdate ConwayEra

Instances

Instances details

Show (EraBasedProtocolParametersUpdate era) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> EraBasedProtocolParametersUpdate era -> ShowS Source # show :: EraBasedProtocolParametersUpdate era -> String Source # showList :: [EraBasedProtocolParametersUpdate era] -> ShowS Source #

data AlonzoOnwardsPParams ledgerera Source #

Constructors

AlonzoOnwardsPParams
Fields alCostModels :: StrictMaybe CostModels alPrices :: StrictMaybe Prices alMaxTxExUnits :: StrictMaybe ExUnits alMaxBlockExUnits :: StrictMaybe ExUnits alMaxValSize :: StrictMaybe Natural alCollateralPercentage :: StrictMaybe Natural alMaxCollateralInputs :: StrictMaybe Natural

Instances

Instances details

Show (AlonzoOnwardsPParams ledgerera) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> AlonzoOnwardsPParams ledgerera -> ShowS Source # show :: AlonzoOnwardsPParams ledgerera -> String Source # showList :: [AlonzoOnwardsPParams ledgerera] -> ShowS Source #

data CommonProtocolParametersUpdate Source #

Protocol parameters common to each era. This can only ever be reduced if parameters are deprecated.

Instances

Instances details

Show CommonProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> CommonProtocolParametersUpdate -> ShowS Source # show :: CommonProtocolParametersUpdate -> String Source # showList :: [CommonProtocolParametersUpdate] -> ShowS Source #

newtype DeprecatedAfterBabbagePParams ledgerera Source #

Constructors

DeprecatedAfterBabbagePParams (StrictMaybe ProtVer)

Instances

Instances details

Show (DeprecatedAfterBabbagePParams ledgerera) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> DeprecatedAfterBabbagePParams ledgerera -> ShowS Source # show :: DeprecatedAfterBabbagePParams ledgerera -> String Source # showList :: [DeprecatedAfterBabbagePParams ledgerera] -> ShowS Source #

newtype DeprecatedAfterMaryPParams ledgerera Source #

Constructors

DeprecatedAfterMaryPParams (StrictMaybe Coin)

Instances

Instances details

Show (DeprecatedAfterMaryPParams ledgerera) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> DeprecatedAfterMaryPParams ledgerera -> ShowS Source # show :: DeprecatedAfterMaryPParams ledgerera -> String Source # showList :: [DeprecatedAfterMaryPParams ledgerera] -> ShowS Source #

data ShelleyToAlonzoPParams ledgerera Source #

Constructors

ShelleyToAlonzoPParams
Fields (StrictMaybe Nonce) Extra entropy (StrictMaybe UnitInterval) Decentralization parameter

Instances

Instances details

Show (ShelleyToAlonzoPParams ledgerera) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ShelleyToAlonzoPParams ledgerera -> ShowS Source # show :: ShelleyToAlonzoPParams ledgerera -> String Source # showList :: [ShelleyToAlonzoPParams ledgerera] -> ShowS Source #

newtype IntroducedInBabbagePParams era Source #

Constructors

IntroducedInBabbagePParams (StrictMaybe CoinPerByte)

Coins per UTxO byte

Instances

Instances details

Show (IntroducedInBabbagePParams era) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> IntroducedInBabbagePParams era -> ShowS Source # show :: IntroducedInBabbagePParams era -> String Source # showList :: [IntroducedInBabbagePParams era] -> ShowS Source #

data IntroducedInConwayPParams era Source #

Instances

Instances details

Show (IntroducedInConwayPParams era) Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> IntroducedInConwayPParams era -> ShowS Source # show :: IntroducedInConwayPParams era -> String Source # showList :: [IntroducedInConwayPParams era] -> ShowS Source #

createEraBasedProtocolParamUpdate :: ShelleyBasedEra era -> EraBasedProtocolParametersUpdate era -> PParamsUpdate (ShelleyLedgerEra era) Source #

convertToLedgerProtocolParameters :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersConversionError (LedgerProtocolParameters era) Source #

Deprecated: Use the ledger's PParams (from module Cardano.Api.Ledger) type instead of ProtocolParameters. The type will be removed after Chang hard fork.

createPParams :: ShelleyBasedEra era -> EraBasedProtocolParametersUpdate era -> PParams (ShelleyLedgerEra era) Source #

Deprecated

data ProtocolParametersUpdate Source #

The representation of a change in the ProtocolParameters.

Constructors

ProtocolParametersUpdate

Fields

protocolUpdateProtocolVersion :: Maybe (Natural, Natural)
Protocol version, major and minor. Updating the major version is used to trigger hard forks.
protocolUpdateDecentralization :: Maybe Rational
The decentralization parameter. This is fraction of slots that belong to the BFT overlay schedule, rather than the Praos schedule. So 1 means fully centralised, while 0 means fully decentralised.
This is the "d" parameter from the design document.
protocolUpdateExtraPraosEntropy :: Maybe (Maybe PraosNonce)
Extra entropy for the Praos per-epoch nonce.
This can be used to add extra entropy during the decentralisation process. If the extra entropy can be demonstrated to be generated randomly then this method can be used to show that the initial federated operators did not subtly bias the initial schedule so that they retain undue influence after decentralisation.
protocolUpdateMaxBlockHeaderSize :: Maybe Word16
The maximum permitted size of a block header.
This must be at least as big as the largest legitimate block headers but should not be too much larger, to help prevent DoS attacks.
Caution: setting this to be smaller than legitimate block headers is a sure way to brick the system!
protocolUpdateMaxBlockBodySize :: Maybe Word32
The maximum permitted size of the block body (that is, the block payload, without the block header).
This should be picked with the Praos network delta security parameter in mind. Making this too large can severely weaken the Praos consensus properties.
Caution: setting this to be smaller than a transaction that can change the protocol parameters is a sure way to brick the system!
protocolUpdateMaxTxSize :: Maybe Word32
The maximum permitted size of a transaction.
Typically this should not be too high a fraction of the block size, otherwise wastage from block fragmentation becomes a problem, and the current implementation does not use any sophisticated box packing algorithm.
protocolUpdateTxFeeFixed :: Maybe Coin
The constant factor for the minimum fee calculation.
protocolUpdateTxFeePerByte :: Maybe Coin
The linear factor for the minimum fee calculation.
protocolUpdateMinUTxOValue :: Maybe Coin
The minimum permitted value for new UTxO entries, ie for transaction outputs.
protocolUpdateStakeAddressDeposit :: Maybe Coin
The deposit required to register a stake address.
protocolUpdateStakePoolDeposit :: Maybe Coin
The deposit required to register a stake pool.
protocolUpdateMinPoolCost :: Maybe Coin
The minimum value that stake pools are permitted to declare for their cost parameter.
protocolUpdatePoolRetireMaxEpoch :: Maybe EpochInterval
The maximum number of epochs into the future that stake pools are permitted to schedule a retirement.
protocolUpdateStakePoolTargetNum :: Maybe Natural
The equilibrium target number of stake pools.
This is the "k" incentives parameter from the design document.
protocolUpdatePoolPledgeInfluence :: Maybe Rational
The influence of the pledge in stake pool rewards.
This is the "a_0" incentives parameter from the design document.
protocolUpdateMonetaryExpansion :: Maybe Rational
The monetary expansion rate. This determines the fraction of the reserves that are added to the fee pot each epoch.
This is the "rho" incentives parameter from the design document.
protocolUpdateTreasuryCut :: Maybe Rational
The fraction of the fee pot each epoch that goes to the treasury.
This is the "tau" incentives parameter from the design document.
protocolUpdateCostModels :: Map AnyPlutusScriptVersion CostModel
Cost models for script languages that use them.
Introduced in Alonzo
protocolUpdatePrices :: Maybe ExecutionUnitPrices
Price of execution units for script languages that use them.
Introduced in Alonzo
protocolUpdateMaxTxExUnits :: Maybe ExecutionUnits
Max total script execution resources units allowed per tx
Introduced in Alonzo
protocolUpdateMaxBlockExUnits :: Maybe ExecutionUnits
Max total script execution resources units allowed per block
Introduced in Alonzo
protocolUpdateMaxValueSize :: Maybe Natural
Max size of a Value in a tx output.
Introduced in Alonzo
protocolUpdateCollateralPercent :: Maybe Natural
The percentage of the script contribution to the txfee that must be provided as collateral inputs when including Plutus scripts.
Introduced in Alonzo
protocolUpdateMaxCollateralInputs :: Maybe Natural
The maximum number of collateral inputs allowed in a transaction.
Introduced in Alonzo
protocolUpdateUTxOCostPerByte :: Maybe Coin
Cost in ada per byte of UTxO storage.
Introduced in Babbage

Instances

Instances details

Monoid ProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods mempty :: ProtocolParametersUpdate Source # mappend :: ProtocolParametersUpdate -> ProtocolParametersUpdate -> ProtocolParametersUpdate Source # mconcat :: [ProtocolParametersUpdate] -> ProtocolParametersUpdate Source #
Semigroup ProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (<>) :: ProtocolParametersUpdate -> ProtocolParametersUpdate -> ProtocolParametersUpdate Source # sconcat :: NonEmpty ProtocolParametersUpdate -> ProtocolParametersUpdate Source # stimes :: Integral b => b -> ProtocolParametersUpdate -> ProtocolParametersUpdate Source #
Show ProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ProtocolParametersUpdate -> ShowS Source # show :: ProtocolParametersUpdate -> String Source # showList :: [ProtocolParametersUpdate] -> ShowS Source #
FromCBOR ProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods fromCBOR :: Decoder s ProtocolParametersUpdate Source # label :: Proxy ProtocolParametersUpdate -> Text Source #
ToCBOR ProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods toCBOR :: ProtocolParametersUpdate -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ProtocolParametersUpdate -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ProtocolParametersUpdate] -> Size Source #
Eq ProtocolParametersUpdate Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: ProtocolParametersUpdate -> ProtocolParametersUpdate -> Bool Source # (/=) :: ProtocolParametersUpdate -> ProtocolParametersUpdate -> Bool Source #

Errors

data ProtocolParametersError Source #

Constructors

PParamsErrorMissingMinUTxoValue !AnyCardanoEra
PParamsErrorMissingAlonzoProtocolParameter

Instances

Instances details

Show ProtocolParametersError Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ProtocolParametersError -> ShowS Source # show :: ProtocolParametersError -> String Source # showList :: [ProtocolParametersError] -> ShowS Source #
Error ProtocolParametersError Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods prettyError :: ProtocolParametersError -> Doc ann Source #

data ProtocolParametersConversionError Source #

Constructors

PpceOutOfBounds !ProtocolParameterName !Rational
PpceVersionInvalid !ProtocolParameterVersion
PpceInvalidCostModel !CostModel !CostModelApplyError
PpceMissingParameter !ProtocolParameterName

Instances

Instances details

Data ProtocolParametersConversionError Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProtocolParametersConversionError -> c ProtocolParametersConversionError Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProtocolParametersConversionError Source # toConstr :: ProtocolParametersConversionError -> Constr Source # dataTypeOf :: ProtocolParametersConversionError -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProtocolParametersConversionError) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProtocolParametersConversionError) Source # gmapT :: (forall b. Data b => b -> b) -> ProtocolParametersConversionError -> ProtocolParametersConversionError Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProtocolParametersConversionError -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProtocolParametersConversionError -> r Source # gmapQ :: (forall d. Data d => d -> u) -> ProtocolParametersConversionError -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProtocolParametersConversionError -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProtocolParametersConversionError -> m ProtocolParametersConversionError Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProtocolParametersConversionError -> m ProtocolParametersConversionError Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProtocolParametersConversionError -> m ProtocolParametersConversionError Source #
Show ProtocolParametersConversionError Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ProtocolParametersConversionError -> ShowS Source # show :: ProtocolParametersConversionError -> String Source # showList :: [ProtocolParametersConversionError] -> ShowS Source #
Error ProtocolParametersConversionError Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods prettyError :: ProtocolParametersConversionError -> Doc ann Source #
Eq ProtocolParametersConversionError Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: ProtocolParametersConversionError -> ProtocolParametersConversionError -> Bool Source # (/=) :: ProtocolParametersConversionError -> ProtocolParametersConversionError -> Bool Source #

PraosNonce

data PraosNonce Source #

Instances

Instances details

FromJSON PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

parseJSON :: Value -> Parser PraosNonce #

parseJSONList :: Value -> Parser [PraosNonce] #

omittedField :: Maybe PraosNonce #

ToJSON PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

toJSON :: PraosNonce -> Value #

toEncoding :: PraosNonce -> Encoding #

toJSONList :: [PraosNonce] -> Value #

toEncodingList :: [PraosNonce] -> Encoding #

omitField :: PraosNonce -> Bool #

IsString PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

fromString :: String -> PraosNonce Source #

Generic PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

type Rep PraosNonce
Instance details Defined in Cardano.Api.ProtocolParameters type Rep PraosNonce = D1 ('MetaData "PraosNonce" "Cardano.Api.ProtocolParameters" "cardano-api-9.3.0.0-inplace-internal" 'True) (C1 ('MetaCons "PraosNonce" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPraosNonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash StandardCrypto ByteString))))

Methods

from :: PraosNonce -> Rep PraosNonce x Source #

to :: Rep PraosNonce x -> PraosNonce Source #

Show PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

showsPrec :: Int -> PraosNonce -> ShowS Source #

show :: PraosNonce -> String Source #

showList :: [PraosNonce] -> ShowS Source #

HasTypeProxy PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

data AsType PraosNonce
Instance details Defined in Cardano.Api.ProtocolParameters data AsType PraosNonce = AsPraosNonce

Methods

proxyToAsType :: Proxy PraosNonce -> AsType PraosNonce Source #

SerialiseAsRawBytes PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

serialiseToRawBytes :: PraosNonce -> ByteString Source #

deserialiseFromRawBytes :: AsType PraosNonce -> ByteString -> Either SerialiseAsRawBytesError PraosNonce Source #

FromCBOR PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

fromCBOR :: Decoder s PraosNonce Source #

label :: Proxy PraosNonce -> Text Source #

ToCBOR PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

toCBOR :: PraosNonce -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy PraosNonce -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [PraosNonce] -> Size Source #

Eq PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

(==) :: PraosNonce -> PraosNonce -> Bool Source #

(/=) :: PraosNonce -> PraosNonce -> Bool Source #

Ord PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

compare :: PraosNonce -> PraosNonce -> Ordering Source #

(<) :: PraosNonce -> PraosNonce -> Bool Source #

(<=) :: PraosNonce -> PraosNonce -> Bool Source #

(>) :: PraosNonce -> PraosNonce -> Bool Source #

(>=) :: PraosNonce -> PraosNonce -> Bool Source #

max :: PraosNonce -> PraosNonce -> PraosNonce Source #

min :: PraosNonce -> PraosNonce -> PraosNonce Source #

type Rep PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

type Rep PraosNonce = D1 ('MetaData "PraosNonce" "Cardano.Api.ProtocolParameters" "cardano-api-9.3.0.0-inplace-internal" 'True) (C1 ('MetaCons "PraosNonce" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPraosNonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash StandardCrypto ByteString))))

data AsType PraosNonce Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType PraosNonce = AsPraosNonce

makePraosNonce :: ByteString -> PraosNonce Source #

Execution units, prices and cost models,

data ExecutionUnits Source #

The units for how long a script executes for and how much memory it uses. This is used to declare the resources used by a particular use of a script.

This type is also used to describe the limits for the maximum overall execution units per transaction or per block.

Constructors

ExecutionUnits
Fields executionSteps :: Natural This corresponds roughly to the time to execute a script. executionMemory :: Natural This corresponds roughly to the peak memory used during script execution.

Instances

Instances details

FromJSON ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods parseJSON :: Value -> Parser ExecutionUnits # parseJSONList :: Value -> Parser [ExecutionUnits] # omittedField :: Maybe ExecutionUnits #
ToJSON ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods toJSON :: ExecutionUnits -> Value # toEncoding :: ExecutionUnits -> Encoding # toJSONList :: [ExecutionUnits] -> Value # toEncodingList :: [ExecutionUnits] -> Encoding # omitField :: ExecutionUnits -> Bool #
Show ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ExecutionUnits -> ShowS Source # show :: ExecutionUnits -> String Source # showList :: [ExecutionUnits] -> ShowS Source #
FromCBOR ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods fromCBOR :: Decoder s ExecutionUnits Source # label :: Proxy ExecutionUnits -> Text Source #
ToCBOR ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods toCBOR :: ExecutionUnits -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ExecutionUnits -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ExecutionUnits] -> Size Source #
Eq ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ExecutionUnits -> ExecutionUnits -> Bool Source # (/=) :: ExecutionUnits -> ExecutionUnits -> Bool Source #

data ExecutionUnitPrices Source #

The prices for ExecutionUnits as a fraction of a Coin.

These are used to determine the fee for the use of a script within a transaction, based on the ExecutionUnits needed by the use of the script.

Constructors

ExecutionUnitPrices
Fields priceExecutionSteps :: Rational priceExecutionMemory :: Rational

Instances

Instances details

FromJSON ExecutionUnitPrices Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods parseJSON :: Value -> Parser ExecutionUnitPrices # parseJSONList :: Value -> Parser [ExecutionUnitPrices] # omittedField :: Maybe ExecutionUnitPrices #
ToJSON ExecutionUnitPrices Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods toJSON :: ExecutionUnitPrices -> Value # toEncoding :: ExecutionUnitPrices -> Encoding # toJSONList :: [ExecutionUnitPrices] -> Value # toEncodingList :: [ExecutionUnitPrices] -> Encoding # omitField :: ExecutionUnitPrices -> Bool #
Show ExecutionUnitPrices Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ExecutionUnitPrices -> ShowS Source # show :: ExecutionUnitPrices -> String Source # showList :: [ExecutionUnitPrices] -> ShowS Source #
FromCBOR ExecutionUnitPrices Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods fromCBOR :: Decoder s ExecutionUnitPrices Source # label :: Proxy ExecutionUnitPrices -> Text Source #
ToCBOR ExecutionUnitPrices Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods toCBOR :: ExecutionUnitPrices -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ExecutionUnitPrices -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ExecutionUnitPrices] -> Size Source #
Eq ExecutionUnitPrices Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: ExecutionUnitPrices -> ExecutionUnitPrices -> Bool Source # (/=) :: ExecutionUnitPrices -> ExecutionUnitPrices -> Bool Source #

newtype CostModels Source #

Constructors

CostModels
Fields unCostModels :: Map AnyPlutusScriptVersion CostModel

Instances

Instances details

FromJSON CostModels Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods parseJSON :: Value -> Parser CostModels # parseJSONList :: Value -> Parser [CostModels] # omittedField :: Maybe CostModels #
ToJSON CostModels Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods toJSON :: CostModels -> Value # toEncoding :: CostModels -> Encoding # toJSONList :: [CostModels] -> Value # toEncodingList :: [CostModels] -> Encoding # omitField :: CostModels -> Bool #
Show CostModels Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> CostModels -> ShowS Source # show :: CostModels -> String Source # showList :: [CostModels] -> ShowS Source #
Eq CostModels Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: CostModels -> CostModels -> Bool Source # (/=) :: CostModels -> CostModels -> Bool Source #

newtype CostModel Source #

Constructors

CostModel [Int64]

Instances

Instances details

Data CostModel Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CostModel -> c CostModel Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CostModel Source # toConstr :: CostModel -> Constr Source # dataTypeOf :: CostModel -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CostModel) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CostModel) Source # gmapT :: (forall b. Data b => b -> b) -> CostModel -> CostModel Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CostModel -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CostModel -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CostModel -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CostModel -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CostModel -> m CostModel Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CostModel -> m CostModel Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CostModel -> m CostModel Source #
Show CostModel Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> CostModel -> ShowS Source # show :: CostModel -> String Source # showList :: [CostModel] -> ShowS Source #
FromCBOR CostModel Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods fromCBOR :: Decoder s CostModel Source # label :: Proxy CostModel -> Text Source #
ToCBOR CostModel Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods toCBOR :: CostModel -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy CostModel -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [CostModel] -> Size Source #
Eq CostModel Source #
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: CostModel -> CostModel -> Bool Source # (/=) :: CostModel -> CostModel -> Bool Source #

fromAlonzoCostModels :: CostModels -> Map AnyPlutusScriptVersion CostModel Source #

Update proposals to change the protocol parameters

data UpdateProposal Source #

Constructors

UpdateProposal !(Map (Hash GenesisKey) ProtocolParametersUpdate) !EpochNo

Instances

Instances details

Show UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

showsPrec :: Int -> UpdateProposal -> ShowS Source #

show :: UpdateProposal -> String Source #

showList :: [UpdateProposal] -> ShowS Source #

HasTypeProxy UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

data AsType UpdateProposal
Instance details Defined in Cardano.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal

Methods

proxyToAsType :: Proxy UpdateProposal -> AsType UpdateProposal Source #

SerialiseAsCBOR UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

serialiseToCBOR :: UpdateProposal -> ByteString Source #

deserialiseFromCBOR :: AsType UpdateProposal -> ByteString -> Either DecoderError UpdateProposal Source #

HasTextEnvelope UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

textEnvelopeType :: AsType UpdateProposal -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: UpdateProposal -> TextEnvelopeDescr Source #

FromCBOR UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

fromCBOR :: Decoder s UpdateProposal Source #

label :: Proxy UpdateProposal -> Text Source #

ToCBOR UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

toCBOR :: UpdateProposal -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy UpdateProposal -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [UpdateProposal] -> Size Source #

Eq UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

(==) :: UpdateProposal -> UpdateProposal -> Bool Source #

(/=) :: UpdateProposal -> UpdateProposal -> Bool Source #

data AsType UpdateProposal Source #

Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType UpdateProposal = AsUpdateProposal

makeShelleyUpdateProposal :: ProtocolParametersUpdate -> [Hash GenesisKey] -> EpochNo -> UpdateProposal Source #

Internal conversion functions

toLedgerNonce :: Maybe PraosNonce -> Nonce Source #

toLedgerUpdate :: ShelleyBasedEra era -> UpdateProposal -> Either ProtocolParametersConversionError (Update (ShelleyLedgerEra era)) Source #

fromLedgerUpdate :: (ShelleyLedgerEra era ~ ledgerera, EraCrypto ledgerera ~ StandardCrypto) => ShelleyBasedEra era -> Update ledgerera -> UpdateProposal Source #

toLedgerProposedPPUpdates :: ShelleyBasedEra era -> Map (Hash GenesisKey) ProtocolParametersUpdate -> Either ProtocolParametersConversionError (ProposedPPUpdates (ShelleyLedgerEra era)) Source #

fromLedgerProposedPPUpdates :: (ShelleyLedgerEra era ~ ledgerera, EraCrypto ledgerera ~ StandardCrypto) => ShelleyBasedEra era -> ProposedPPUpdates ledgerera -> Map (Hash GenesisKey) ProtocolParametersUpdate Source #

toLedgerPParams :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersConversionError (PParams (ShelleyLedgerEra era)) Source #

toLedgerPParamsUpdate :: ShelleyBasedEra era -> ProtocolParametersUpdate -> Either ProtocolParametersConversionError (PParamsUpdate (ShelleyLedgerEra era)) Source #

fromLedgerPParams :: ShelleyBasedEra era -> PParams (ShelleyLedgerEra era) -> ProtocolParameters Source #

Deprecated: Use the ledger's PParams (from module Cardano.Api.Ledger) type instead of ProtocolParameters. The type will be removed after Chang hard fork.

fromLedgerPParamsUpdate :: ShelleyBasedEra era -> PParamsUpdate (ShelleyLedgerEra era) -> ProtocolParametersUpdate Source #

toAlonzoPrices :: ExecutionUnitPrices -> Either ProtocolParametersConversionError Prices Source #

fromAlonzoPrices :: Prices -> ExecutionUnitPrices Source #

toAlonzoScriptLanguage :: AnyPlutusScriptVersion -> Language Source #

fromAlonzoScriptLanguage :: Language -> AnyPlutusScriptVersion Source #

toAlonzoCostModel :: CostModel -> Language -> Either ProtocolParametersConversionError CostModel Source #

fromAlonzoCostModel :: CostModel -> CostModel Source #

toAlonzoCostModels :: Map AnyPlutusScriptVersion CostModel -> Either ProtocolParametersConversionError CostModels Source #

Data family instances

data family AsType t Source #

A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.

Values of this type are passed to deserialisation functions for example.

Instances

Instances details

data AsType AddressAny Source #
Instance details Defined in Cardano.Api.Address data AsType AddressAny = AsAddressAny
data AsType ByronAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ByronAddr = AsByronAddr
data AsType ShelleyAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ShelleyAddr = AsShelleyAddr
data AsType StakeAddress Source #
Instance details Defined in Cardano.Api.Address data AsType StakeAddress = AsStakeAddress
data AsType BlockHeader Source #
Instance details Defined in Cardano.Api.Block data AsType BlockHeader = AsBlockHeader
data AsType DRepMetadata Source #
Instance details Defined in Cardano.Api.DRepMetadata data AsType DRepMetadata = AsDRepMetadata
data AsType AllegraEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AllegraEra = AsAllegraEra
data AsType AlonzoEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AlonzoEra = AsAlonzoEra
data AsType BabbageEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType BabbageEra = AsBabbageEra
data AsType ByronEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ByronEra = AsByronEra
data AsType ConwayEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ConwayEra = AsConwayEra
data AsType MaryEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType MaryEra = AsMaryEra
data AsType ShelleyEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ShelleyEra = AsShelleyEra
data AsType GovernancePoll Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePoll = AsGovernancePoll
data AsType GovernancePollAnswer Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType ByronKey Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKey = AsByronKey
data AsType ByronKeyLegacy Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType KesKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType KesKey = AsKesKey
data AsType VrfKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType VrfKey = AsVrfKey
data AsType CommitteeColdExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdExtendedKey = AsCommitteeColdExtendedKey
data AsType CommitteeColdKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotExtendedKey = AsCommitteeHotExtendedKey
data AsType CommitteeHotKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotKey = AsCommitteeHotKey
data AsType DRepExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepExtendedKey = AsDRepExtendedKey
data AsType DRepKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepKey = AsDRepKey
data AsType GenesisDelegateExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType GenesisKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisKey = AsGenesisKey
data AsType GenesisUTxOKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType PaymentExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentKey = AsPaymentKey
data AsType StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeKey = AsStakeKey
data AsType StakePoolKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakePoolKey = AsStakePoolKey
data AsType OperationalCertificate Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificate = AsOperationalCertificate
data AsType OperationalCertificateIssueCounter Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType PraosNonce Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType PraosNonce = AsPraosNonce
data AsType UpdateProposal Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal
data AsType PlutusScriptV1 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType PlutusScriptV2 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV3 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV3 = AsPlutusScriptV3
data AsType ScriptHash Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType SimpleScript' Source #
Instance details Defined in Cardano.Api.Script data AsType SimpleScript' = AsSimpleScript
data AsType HashableScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType ScriptData = AsScriptData
data AsType TextEnvelope Source #
Instance details Defined in Cardano.Api.SerialiseTextEnvelope data AsType TextEnvelope = AsTextEnvelope
data AsType ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronVote = AsByronVote
data AsType StakePoolMetadata Source #
Instance details Defined in Cardano.Api.StakePoolMetadata data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType TxId Source #
Instance details Defined in Cardano.Api.TxIn data AsType TxId = AsTxId
data AsType TxMetadata Source #
Instance details Defined in Cardano.Api.TxMetadata data AsType TxMetadata = AsTxMetadata
data AsType AssetName Source #
Instance details Defined in Cardano.Api.Value data AsType AssetName = AsAssetName
data AsType PolicyId Source #
Instance details Defined in Cardano.Api.Value data AsType PolicyId = AsPolicyId
data AsType (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Certificate era) Source #
Instance details Defined in Cardano.Api.Certificate data AsType (Certificate era) = AsCertificate
data AsType (Proposal era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.ProposalProcedure data AsType (Proposal era) = AsProposal
data AsType (VotingProcedure era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedure era) = AsVote
data AsType (VotingProcedures era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (Hash a) Source #
Instance details Defined in Cardano.Api.Hash data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (VerificationKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (PlutusScript lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (Script lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era) Source #
Instance details Defined in Cardano.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (KeyWitness era) Source #
Instance details Defined in Cardano.Api.Tx.Sign data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source #
Instance details Defined in Cardano.Api.Tx.Sign data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era) Source #
Instance details Defined in Cardano.Api.Tx.Sign data AsType (TxBody era) = AsTxBody (AsType era)

The updatable protocol parameters

Instances

Instances

The updatable protocol parameters

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Deprecated

Instances

Errors

Instances

Instances

PraosNonce

Instances

Execution units, prices and cost models,

Instances

Instances

Instances

Instances

Update proposals to change the protocol parameters

Instances

Internal conversion functions

Data family instances

Instances

Era-dependent protocol features