Safe Haskell	Safe-Inferred
Language	Haskell2010

Cooked.Skeleton.Proposal

Contents

Data types
Optics
Smart constructors
Utilities

Description

This module exposes the proposals constructs used in a TxSkel and their associated utilities. To issue proposals in a skeleton, the usual way is to invoke txSkelProposals = [simpleProposal script govAction1, simpleProposal pk govAction2, ... ]

Synopsis

data ParamChange where
- FeePerByte :: Integer -> ParamChange
- FeeFixed :: Integer -> ParamChange
- MaxBlockBodySize :: Integer -> ParamChange
- MaxTxSize :: Integer -> ParamChange
- MaxBlockHeaderSize :: Integer -> ParamChange
- KeyDeposit :: Integer -> ParamChange
- PoolDeposit :: Integer -> ParamChange
- PoolRetirementMaxEpoch :: Integer -> ParamChange
- PoolNumber :: Integer -> ParamChange
- PoolInfluence :: Rational -> ParamChange
- MonetaryExpansion :: Rational -> ParamChange
- TreasuryCut :: Rational -> ParamChange
- MinPoolCost :: Integer -> ParamChange
- CoinsPerUTxOByte :: Integer -> ParamChange
- CostModels :: {..} -> ParamChange
- Prices :: {..} -> ParamChange
- MaxTxExUnits :: {..} -> ParamChange
- MaxBlockExUnits :: {..} -> ParamChange
- MaxValSize :: Integer -> ParamChange
- CollateralPercentage :: Integer -> ParamChange
- MaxCollateralInputs :: Integer -> ParamChange
- PoolVotingThresholds :: {..} -> ParamChange
- DRepVotingThresholds :: {..} -> ParamChange
- CommitteeMinSize :: Integer -> ParamChange
- CommitteeMaxTermLength :: Integer -> ParamChange
- GovActionLifetime :: Integer -> ParamChange
- GovActionDeposit :: Integer -> ParamChange
- DRepRegistrationDeposit :: Integer -> ParamChange
- DRepActivity :: Integer -> ParamChange
- MinFeeRefScriptCostPerByte :: Rational -> ParamChange
data GovernanceAction :: UserKind -> Type where
- ParameterChange :: [ParamChange] -> GovernanceAction IsScript
- TreasuryWithdrawals :: Map Credential Lovelace -> GovernanceAction IsScript
- HardForkInitiation :: ProtocolVersion -> GovernanceAction IsNone
- NoConfidence :: GovernanceAction IsNone
- UpdateCommittee :: [ColdCommitteeCredential] -> Map ColdCommitteeCredential Integer -> Rational -> GovernanceAction IsNone
- NewConstitution :: Constitution -> GovernanceAction IsNone
data TxSkelProposal where
- TxSkelProposal :: (Typeable kind, ToCredential cred) => {..} -> TxSkelProposal
txSkelProposalAnchorL :: Lens' TxSkelProposal TxSkelAnchor
txSkelProposalMConstitutionAT :: forall kind. Typeable kind => AffineTraversal' TxSkelProposal (Maybe (User kind Redemption))
txSkelProposalReturnCredentialL :: Lens' TxSkelProposal Credential
txSkelProposalGovernanceActionAT :: forall req. Typeable req => AffineTraversal' TxSkelProposal (GovernanceAction req)
txSkelProposalConstitutionAT :: AffineTraversal' TxSkelProposal (User IsScript Redemption)
simpleProposal :: (ToCredential cred, Typeable kind) => cred -> GovernanceAction kind -> TxSkelProposal
fillConstitution :: (ToVScript script, Typeable script) => script -> TxSkelProposal -> TxSkelProposal

Data types

data ParamChange where Source #

These are all the protocol parameters. They are taken from https://github.com/IntersectMBO/cardano-ledger/blob/c4fbc05999866fea7c0cb1b211fd5288f286b95d/eras/conway/impl/cddl-files/conway.cddl#L381-L412 and will most likely change in future eras.

Constructors

FeePerByte :: Integer -> ParamChange	The linear factor for the minimum fee calculation
FeeFixed :: Integer -> ParamChange	The constant factor for the minimum fee calculation
MaxBlockBodySize :: Integer -> ParamChange	Maximal block body size
MaxTxSize :: Integer -> ParamChange	Maximal transaction size
MaxBlockHeaderSize :: Integer -> ParamChange	Maximal block header size
KeyDeposit :: Integer -> ParamChange	The amount of a key registration deposit
PoolDeposit :: Integer -> ParamChange	The amount of a pool registration deposit
PoolRetirementMaxEpoch :: Integer -> ParamChange	Maximum number of epochs in the future a pool retirement is allowed to be scheduled future for.
PoolNumber :: Integer -> ParamChange	Desired number of pools
PoolInfluence :: Rational -> ParamChange	Pool influence
MonetaryExpansion :: Rational -> ParamChange	Monetary expansion
TreasuryCut :: Rational -> ParamChange	Treasury expansion
MinPoolCost :: Integer -> ParamChange	Minimum Stake Pool Cost
CoinsPerUTxOByte :: Integer -> ParamChange	Cost in lovelace per byte of UTxO storage
CostModels	Cost models for non-native script languages
Fields :: { cmPlutusV1Costs :: [Integer] , cmPlutusV2Costs :: [Integer] , cmPlutusV3Costs :: [Integer] } -> ParamChange
Prices	Prices of execution units
Fields :: { pMemoryCost :: Rational , pStepCost :: Rational } -> ParamChange
MaxTxExUnits	Max total script execution resources units allowed per tx
Fields :: { mteuMemory :: Integer , mteuSteps :: Integer } -> ParamChange
MaxBlockExUnits	Max total script execution resources units allowed per block
Fields :: { mbeuMemory :: Integer , mbeuSteps :: Integer } -> ParamChange
MaxValSize :: Integer -> ParamChange	Max size of a Value in an output
CollateralPercentage :: Integer -> ParamChange	Percentage of the txfee which must be provided as collateral when including non-native scripts.
MaxCollateralInputs :: Integer -> ParamChange	Maximum number of collateral inputs allowed in a transaction
PoolVotingThresholds	Thresholds for pool votes
Fields :: { pvtMotionNoConfidence :: Rational , pvtCommitteeNormal :: Rational , pvtCommitteeNoConfidence :: Rational , pvtHardFork :: Rational , pvtSecurityGroup :: Rational } -> ParamChange
DRepVotingThresholds	Thresholds for DRep votes
Fields :: { drvtMotionNoConfidence :: Rational , drvtCommitteeNormal :: Rational , drvtCommitteeNoConfidence :: Rational , drvtUpdateConstitution :: Rational , drvtHardForkInitialization :: Rational , drvtNetworkGroup :: Rational , drvtEconomicGroup :: Rational , drvtTechnicalGroup :: Rational , drvtGovernanceGroup :: Rational , drvtTreasuryWithdrawal :: Rational } -> ParamChange
CommitteeMinSize :: Integer -> ParamChange	Minimum size of the Constitutional Committee
CommitteeMaxTermLength :: Integer -> ParamChange	The Constitutional Committee Term limit in number of Slots
GovActionLifetime :: Integer -> ParamChange	Gov action lifetime in number of Epochs
GovActionDeposit :: Integer -> ParamChange	The amount of the Gov Action deposit
DRepRegistrationDeposit :: Integer -> ParamChange	The amount of a DRep registration deposit
DRepActivity :: Integer -> ParamChange	The number of Epochs that a DRep can perform no activity without losing their `Active` status.
MinFeeRefScriptCostPerByte :: Rational -> ParamChange	Reference scripts fee for the minimum fee calculation

Instances

Instances details

Show ParamChange Source #
Instance details Defined in Cooked.Skeleton.Proposal Methods showsPrec :: Int -> ParamChange -> ShowS # show :: ParamChange -> String # showList :: [ParamChange] -> ShowS #
PrettyCooked ParamChange Source #
Instance details Defined in Cooked.Pretty.Skeleton Methods prettyCookedOpt :: PrettyCookedOpts -> ParamChange -> DocCooked Source # prettyCooked :: ParamChange -> DocCooked Source #
Eq ParamChange Source #
Instance details Defined in Cooked.Skeleton.Proposal Methods (==) :: ParamChange -> ParamChange -> Bool # (/=) :: ParamChange -> ParamChange -> Bool #

data GovernanceAction :: UserKind -> Type where Source #

This lists the various possible governance actions. Only two of these action need to be witnessed by the constitution script, which are annotated by IsScript.

Instances

Instances details

Show (GovernanceAction a) Source #
Instance details Defined in Cooked.Skeleton.Proposal Methods showsPrec :: Int -> GovernanceAction a -> ShowS # show :: GovernanceAction a -> String # showList :: [GovernanceAction a] -> ShowS #
PrettyCooked (GovernanceAction a) Source #
Instance details Defined in Cooked.Pretty.Skeleton Methods prettyCookedOpt :: PrettyCookedOpts -> GovernanceAction a -> DocCooked Source # prettyCooked :: GovernanceAction a -> DocCooked Source #
Eq (GovernanceAction a) Source #
Instance details Defined in Cooked.Skeleton.Proposal Methods (==) :: GovernanceAction a -> GovernanceAction a -> Bool # (/=) :: GovernanceAction a -> GovernanceAction a -> Bool #

data TxSkelProposal where Source #

This bundles a governance action into an actual proposal

Constructors

TxSkelProposal

Fields

:: (Typeable kind, ToCredential cred)
=> { txSkelProposalReturnCredential :: cred
The credential that should be used for a return account
, txSkelProposalGovernanceAction :: GovernanceAction kind
The proposed action gov action, either witnessed or simple
, txSkelProposalConstitution :: Maybe (User kind Redemption)
The constitution witness of this proposal, when paired with a witnessed governance action. Is the governance action is simple, only Nothing can be provided there.
, txSkelProposalAnchor :: TxSkelAnchor
An optional anchor to be given as additional data. It should correspond to the URL of a web page
} -> TxSkelProposal

Instances

Instances details

Show TxSkelProposal Source #
Instance details Defined in Cooked.Skeleton.Proposal Methods showsPrec :: Int -> TxSkelProposal -> ShowS # show :: TxSkelProposal -> String # showList :: [TxSkelProposal] -> ShowS #
PrettyCookedList TxSkelProposal Source #
Instance details Defined in Cooked.Pretty.Skeleton Methods prettyCookedOptList :: PrettyCookedOpts -> TxSkelProposal -> [DocCooked] Source # prettyCookedOptListMaybe :: PrettyCookedOpts -> TxSkelProposal -> [Maybe DocCooked] Source # prettyCookedListMaybe :: TxSkelProposal -> [Maybe DocCooked] Source # prettyCookedList :: TxSkelProposal -> [DocCooked] Source #
Eq TxSkelProposal Source #
Instance details Defined in Cooked.Skeleton.Proposal Methods (==) :: TxSkelProposal -> TxSkelProposal -> Bool # (/=) :: TxSkelProposal -> TxSkelProposal -> Bool #

Optics

txSkelProposalAnchorL :: Lens' TxSkelProposal TxSkelAnchor Source #

A lens to get or set the anchor of a TxSkelProposal

txSkelProposalMConstitutionAT :: forall kind. Typeable kind => AffineTraversal' TxSkelProposal (Maybe (User kind Redemption)) Source #

Focuses on the optional constitution of a TxSkelProposal

txSkelProposalReturnCredentialL :: Lens' TxSkelProposal Credential Source #

Focuses on the return credential from a TxSkelProposal

txSkelProposalGovernanceActionAT :: forall req. Typeable req => AffineTraversal' TxSkelProposal (GovernanceAction req) Source #

Focuses on the governance action of a TxSkelProposal

txSkelProposalConstitutionAT :: AffineTraversal' TxSkelProposal (User IsScript Redemption) Source #

Focuses on the constitution of a TxSkelProposal

Smart constructors

simpleProposal :: (ToCredential cred, Typeable kind) => cred -> GovernanceAction kind -> TxSkelProposal Source #

Builds a TxSkelProposal from a credential and a gov action. Does not set any constitution (when applicable) nor anchor.

Utilities

fillConstitution :: (ToVScript script, Typeable script) => script -> TxSkelProposal -> TxSkelProposal Source #

Sets the constitution script with an empty redeemer when empty. This will not tamper with an existing constitution script and redeemer.

ParameterChange :: [ParamChange] -> GovernanceAction IsScript
TreasuryWithdrawals :: Map Credential Lovelace -> GovernanceAction IsScript
HardForkInitiation :: ProtocolVersion -> GovernanceAction IsNone
NoConfidence :: GovernanceAction IsNone
UpdateCommittee :: [ColdCommitteeCredential] -> Map ColdCommitteeCredential Integer -> Rational -> GovernanceAction IsNone
NewConstitution :: Constitution -> GovernanceAction IsNone