Skip to content

Commit

Permalink
Merge pull request #484 from input-output-hk/ch/protocol-parameters-u…
Browse files Browse the repository at this point in the history 
…pdate-help-texts

Complete help texts for `create-protocol-parameters-update`
  • Loading branch information
@CarlosLopezDeLara
CarlosLopezDeLara authored Nov 27, 2023
2 parents 25604ae + 63a7680 commit d4c1a35
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 38 deletions.
38 changes: 19 additions & 19 deletions cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2866,25 +2866,25 @@ pPoolVotingThresholds =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "pool-voting-threshold-motion-no-confidence"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for stake pool votes on motions no confidence."
]
pCommitteeNormal =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "pool-voting-threshold-committee-normal"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for stake pool votes on normal committee updates."
]
pCommitteeNoConfidence =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "pool-voting-threshold-committee-no-confidence"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for stake pool votes on committee updates when the committee is in a state of no confidence."
]
pHardForkInitiation =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "pool-voting-threshold-hard-fork-initiation"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for stake pool votes on hard fork initiations."
]

pDRepVotingThresholds :: Parser Ledger.DRepVotingThresholds
Expand All @@ -2905,101 +2905,101 @@ pDRepVotingThresholds =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-motion-no-confidence"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on motions of no confidence."
]
pCommitteeNormal =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-committee-normal"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on normal committee updates."
]
pCommitteeNoConfidence =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-committee-no-confidence"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on committee updates when the committee is in a state of no confidence."
]
pUpdateToConstitution =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-update-to-constitution"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on constitution updates."
]
pHardForkInitiation =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-hard-fork-initiation"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on hard fork initiations."
]
pPPNetworkGroup =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-pp-network-group"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on protocol parameters for parameters in the 'network' group."
]
pPPEconomicGroup =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-pp-economic-group"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on protocol parameters for parameters in the 'economic' group."
]
pPPTechnicalGroup =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-pp-technical-group"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on protocol parameters for parameters in the 'technical' group."
]
pPPGovGroup =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-pp-governance-group"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on protocol parameters for parameters in the 'governance' group."
]
pTreasuryWithdrawal =
Opt.option (toUnitIntervalOrErr <$> readRationalUnitInterval) $ mconcat
[ Opt.long "drep-voting-threshold-treasury-withdrawal"
, Opt.metavar "RATIONAL"
, Opt.help "TODO"
, Opt.help "Acceptance threshold for DRep votes on treasury withdrawals."
]

pMinCommitteeSize :: Parser Natural
pMinCommitteeSize =
Opt.option Opt.auto $ mconcat
[ Opt.long "min-committee-size"
, Opt.metavar "INT"
, Opt.help "TODO"
, Opt.help "Minimal size of the constitutional committee."
]

pCommitteeTermLength :: Parser EpochNo
pCommitteeTermLength =
fmap EpochNo $ Opt.option Opt.auto $ mconcat
[ Opt.long "committee-term-length"
, Opt.metavar "INT"
, Opt.help "TODO"
, Opt.help "Maximal term length for members of the constitutional committee, in epochs."
]

pGovActionLifetime :: Parser EpochNo
pGovActionLifetime =
fmap EpochNo $ Opt.option (bounded "EPOCH") $ mconcat
[ Opt.long "governance-action-lifetime"
, Opt.metavar "NATURAL"
, Opt.help "TODO"
, Opt.help "Maximal lifetime of governance actions, in epochs."
]

pDRepDeposit :: Parser Lovelace
pDRepDeposit =
Opt.option (readerFromParsecParser parseLovelace) $ mconcat
[ Opt.long "drep-deposit"
, Opt.metavar "LOVELACE"
, Opt.help "TODO"
, Opt.help "DRep deposit amount."
]

pDRepActivity :: Parser EpochNo
pDRepActivity =
fmap EpochNo $ Opt.option (bounded "EPOCH") $ mconcat
[ Opt.long "drep-activity"
, Opt.metavar "NATURAL"
, Opt.help "TODO"
, Opt.help "DRep activity period, in epochs."
]

parseTxOutShelleyBasedEra
Expand Down
55 changes: 36 additions & 19 deletions ...i-golden/files/golden/help/conway_governance_action_create-protocol-parameters-update.cli
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,43 +128,60 @@ Available options:
Cost in lovelace per unit of UTxO storage (from
Babbage era).
--pool-voting-threshold-motion-no-confidence RATIONAL
TODO
Acceptance threshold for stake pool votes on motions
no confidence.
--pool-voting-threshold-committee-normal RATIONAL
TODO
Acceptance threshold for stake pool votes on normal
committee updates.
--pool-voting-threshold-committee-no-confidence RATIONAL
TODO
Acceptance threshold for stake pool votes on
committee updates when the committee is in a state of
no confidence.
--pool-voting-threshold-hard-fork-initiation RATIONAL
TODO
Acceptance threshold for stake pool votes on hard
fork initiations.
--drep-voting-threshold-motion-no-confidence RATIONAL
TODO
Acceptance threshold for DRep votes on motions of no
confidence.
--drep-voting-threshold-committee-normal RATIONAL
TODO
Acceptance threshold for DRep votes on normal
committee updates.
--drep-voting-threshold-committee-no-confidence RATIONAL
TODO
Acceptance threshold for DRep votes on committee
updates when the committee is in a state of no
confidence.
--drep-voting-threshold-update-to-constitution RATIONAL
TODO
Acceptance threshold for DRep votes on constitution
updates.
--drep-voting-threshold-hard-fork-initiation RATIONAL
TODO
Acceptance threshold for DRep votes on hard fork
initiations.
--drep-voting-threshold-pp-network-group RATIONAL
TODO
Acceptance threshold for DRep votes on protocol
parameters for parameters in the 'network' group.
--drep-voting-threshold-pp-economic-group RATIONAL
TODO
Acceptance threshold for DRep votes on protocol
parameters for parameters in the 'economic' group.
--drep-voting-threshold-pp-technical-group RATIONAL
TODO
Acceptance threshold for DRep votes on protocol
parameters for parameters in the 'technical' group.
--drep-voting-threshold-pp-governance-group RATIONAL
TODO
Acceptance threshold for DRep votes on protocol
parameters for parameters in the 'governance' group.
--drep-voting-threshold-treasury-withdrawal RATIONAL
TODO
--min-committee-size INT TODO
Acceptance threshold for DRep votes on treasury
withdrawals.
--min-committee-size INT Minimal size of the constitutional committee.
--committee-term-length INT
TODO
Maximal term length for members of the constitutional
committee, in epochs.
--governance-action-lifetime NATURAL
TODO
Maximal lifetime of governance actions, in epochs.
--new-governance-action-deposit NATURAL
Proposed new value of the deposit required to submit
a governance action.
--drep-deposit LOVELACE TODO
--drep-activity NATURAL TODO
--drep-deposit LOVELACE DRep deposit amount.
--drep-activity NATURAL DRep activity period, in epochs.
--cost-model-file FILE Filepath of the JSON formatted cost model
--out-file FILE The output file.
-h,--help Show this help text

0 comments on commit d4c1a35

Please sign in to comment.