Rename committeeQuorum to committeeThreshold

eras/conway/impl/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.13.0.0
 
+* Rename `committeeQuorum` to `committeeThreshold` #4053
 * Changed `GovActionState` to have 1 field (`gasProposalProcedure`) rather than 3 (`gasDeposit`, `gasAction`, `gasReturnAddr`)
   * the old field names (`gasDeposit`, `gasAction`, `gasReturnAddr`) become functions, and the lenses
   * (`gasDepositL`, `gasActionL`, `gasReturnAddrL`) have the same type, but behave differently.

eras/conway/impl/src/Cardano/Ledger/Conway/Governance.hs

@@ -30,7 +30,7 @@ module Cardano.Ledger.Conway.Governance (
   ConwayGovState (..),
   Committee (..),
   committeeMembersL,
-  committeeQuorumL,
+  committeeThresholdL,
   GovAction (..),
   GovActionState (..),
   GovActionIx (..),
@@ -667,7 +667,7 @@ ensCommitteeMembers ::
   EnactState era ->
   Maybe (Map (Credential 'ColdCommitteeRole (EraCrypto era)) EpochNo, UnitInterval)
 ensCommitteeMembers ens = case ens ^. ensCommitteeL of
-  SJust Committee {..} -> Just (committeeMembers, committeeQuorum)
+  SJust Committee {..} -> Just (committeeMembers, committeeThreshold)
   SNothing -> Nothing
 
 class EraGov era => ConwayEraGov era where
@@ -813,7 +813,7 @@ votingCommitteeThresholdInternal pp committee = \case
   InfoAction {} -> NoVotingThreshold
   where
     threshold =
-      case committeeQuorum <$> committee of
+      case committeeThreshold <$> committee of
         -- if the committee size is smaller than the mnimimum given in pparams,
         -- we treat it as if we had no committe
         SJust t | committeeSize >= minSize -> VotingThreshold t

eras/conway/impl/src/Cardano/Ledger/Conway/Governance/Procedures.hs

@@ -57,7 +57,7 @@ module Cardano.Ledger.Conway.Governance.Procedures (
   pProcReturnAddrL,
   pProcAnchorL,
   committeeMembersL,
-  committeeQuorumL,
+  committeeThresholdL,
   gasDRepVotesL,
   gasStakePoolVotesL,
   gasCommitteeVotesL,
@@ -546,8 +546,8 @@ toProposalProcedurePairs proposalProcedure@(ProposalProcedure _ _ _ _) =
 data Committee era = Committee
   { committeeMembers :: !(Map (Credential 'ColdCommitteeRole (EraCrypto era)) EpochNo)
   -- ^ Committee members with epoch number when each of them expires
-  , committeeQuorum :: !UnitInterval
-  -- ^ Quorum of the committee that is necessary for a successful vote
+  , committeeThreshold :: !UnitInterval
+  -- ^ Threshold of the committee that is necessary for a successful vote
   }
   deriving (Eq, Show, Generic)
 
@@ -561,8 +561,8 @@ instance Default (Committee era) where
 committeeMembersL :: Lens' (Committee era) (Map (Credential 'ColdCommitteeRole (EraCrypto era)) EpochNo)
 committeeMembersL = lens committeeMembers (\c m -> c {committeeMembers = m})
 
-committeeQuorumL :: Lens' (Committee era) UnitInterval
-committeeQuorumL = lens committeeQuorum (\c q -> c {committeeQuorum = q})
+committeeThresholdL :: Lens' (Committee era) UnitInterval
+committeeThresholdL = lens committeeThreshold (\c q -> c {committeeThreshold = q})
 
 instance Era era => DecCBOR (Committee era) where
   decCBOR =
@@ -573,11 +573,11 @@ instance Era era => DecCBOR (Committee era) where
   {-# INLINE decCBOR #-}
 
 instance Era era => EncCBOR (Committee era) where
-  encCBOR Committee {committeeMembers, committeeQuorum} =
+  encCBOR Committee {committeeMembers, committeeThreshold} =
     encode $
       Rec (Committee @era)
         !> To committeeMembers
-        !> To committeeQuorum
+        !> To committeeThreshold
 
 instance EraPParams era => ToJSON (Committee era) where
   toJSON = object . toCommitteePairs
@@ -589,13 +589,13 @@ instance Era era => FromJSON (Committee era) where
       parseCommittee o =
         Committee
           <$> (forceElemsToWHNF <$> o .: "members")
-          <*> o .: "quorum"
+          <*> o .: "threshold"
 
 toCommitteePairs :: (KeyValue e a, EraPParams era) => Committee era -> [a]
 toCommitteePairs committee@(Committee _ _) =
   let Committee {..} = committee
    in [ "members" .= committeeMembers
-      , "quorum" .= committeeQuorum
+      , "threshold" .= committeeThreshold
       ]
 
 data GovActionPurpose
@@ -802,7 +802,7 @@ data GovAction era
       !(Set (Credential 'ColdCommitteeRole (EraCrypto era)))
       -- | Constitutional committee members to be added
       !(Map (Credential 'ColdCommitteeRole (EraCrypto era)) EpochNo)
-      -- | New quorum
+      -- | New Threshold
       !UnitInterval
   | NewConstitution
       -- | Previous governance action id of `NewConstitution` type, which corresponds to

eras/conway/impl/src/Cardano/Ledger/Conway/Rules/Enact.hs

@@ -90,9 +90,9 @@ enactmentTransition = do
         st
           & ensCommitteeL .~ SNothing
           & ensPrevCommitteeL .~ SJust (GovPurposeId govActionId)
-      UpdateCommittee _ membersToRemove membersToAdd newQuorum -> do
+      UpdateCommittee _ membersToRemove membersToAdd newThreshold -> do
         st
-          & ensCommitteeL %~ SJust . updatedCommittee membersToRemove membersToAdd newQuorum
+          & ensCommitteeL %~ SJust . updatedCommittee membersToRemove membersToAdd newThreshold
           & ensPrevCommitteeL .~ SJust (GovPurposeId govActionId)
       NewConstitution _ c ->
         st
@@ -106,14 +106,14 @@ updatedCommittee ::
   UnitInterval ->
   StrictMaybe (Committee era) ->
   Committee era
-updatedCommittee membersToRemove membersToAdd newQuorum committee =
+updatedCommittee membersToRemove membersToAdd newThreshold committee =
   case committee of
-    SNothing -> Committee membersToAdd newQuorum
+    SNothing -> Committee membersToAdd newThreshold
     SJust (Committee currentMembers _) ->
       let newCommitteeMembers =
             Map.union
               membersToAdd
               (currentMembers `Map.withoutKeys` membersToRemove)
        in Committee
             newCommitteeMembers
-            newQuorum
+            newThreshold

eras/conway/impl/src/Cardano/Ledger/Conway/TxInfo.hs

@@ -424,12 +424,12 @@ transGovAction proxy = \case
       (transMap transRewardAccount transCoinToLovelace withdrawals)
       (transGovPolicy govPolicy)
   NoConfidence pGovActionId -> PV3.NoConfidence (transPrevGovActionId pGovActionId)
-  UpdateCommittee pGovActionId ccToRemove ccToAdd quorum ->
+  UpdateCommittee pGovActionId ccToRemove ccToAdd threshold ->
     PV3.UpdateCommittee
       (transPrevGovActionId pGovActionId)
       (map (PV3.ColdCommitteeCredential . transCred) $ Set.toList ccToRemove)
       (transMap (PV3.ColdCommitteeCredential . transCred) transEpochNo ccToAdd)
-      (transBoundedRational quorum)
+      (transBoundedRational threshold)
   NewConstitution pGovActionId constitution ->
     PV3.NewConstitution
       (transPrevGovActionId pGovActionId)

eras/conway/impl/test/data/conway-genesis.json

@@ -36,7 +36,7 @@
       "keyHash-4e88cc2d27c364aaf90648a87dfb95f8ee103ba67fa1f12f5e86c42a": 1,
       "scriptHash-4e88cc2d27c364aaf90648a87dfb95f8ee103ba67fa1f12f5e86c42a": 2
     },
-    "quorum": 0.5
+    "threshold": 0.5
   },
   "delegs": {
     "keyHash-4e88cc2d27c364aaf90648a87dfb95f8ee103ba67fa1f12f5e86c42a": {

libs/cardano-ledger-api/src/Cardano/Ledger/Api/State/Query.hs

@@ -186,7 +186,7 @@ queryCommitteeMembersState ::
   NewEpochState era ->
   Maybe (CommitteeMembersState (EraCrypto era))
 queryCommitteeMembersState coldCredsFilter hotCredsFilter statusFilter nes = do
-  (comMembers, comQuorum) <- getCommitteeMembers nes
+  (comMembers, comThreshold) <- getCommitteeMembers (queryGovState nes)
   let nextComMembers =
         maybe Map.empty fst (getNextEpochCommitteeMembers (queryGovState nes))
   let comStateMembers =
@@ -260,7 +260,7 @@ queryCommitteeMembersState coldCredsFilter hotCredsFilter statusFilter nes = do
   pure
     CommitteeMembersState
       { csCommittee = cms
-      , csQuorum = comQuorum
+      , csThreshold = comThreshold
       , csEpochNo = currentEpoch
       }
 

libs/cardano-ledger-api/src/Cardano/Ledger/Api/State/Query/CommitteeMembersState.hs

@@ -148,7 +148,7 @@ toCommitteeMemberStatePairs c@(CommitteeMemberState _ _ _ _) =
 
 data CommitteeMembersState c = CommitteeMembersState
   { csCommittee :: !(Map (Credential 'ColdCommitteeRole c) (CommitteeMemberState c))
-  , csQuorum :: !UnitInterval
+  , csThreshold :: !UnitInterval
   , csEpochNo :: !EpochNo
   -- ^ Current epoch number. This is necessary to interpret committee member states
   }
@@ -162,7 +162,7 @@ instance Crypto c => EncCBOR (CommitteeMembersState c) where
      in encode $
           Rec (CommitteeMembersState @c)
             !> To csCommittee
-            !> To csQuorum
+            !> To csThreshold
             !> To csEpochNo
 
 instance Crypto c => DecCBOR (CommitteeMembersState c) where
@@ -181,6 +181,6 @@ toCommitteeMembersStatePairs :: (KeyValue e a, Crypto c) => CommitteeMembersStat
 toCommitteeMembersStatePairs c@(CommitteeMembersState _ _ _) =
   let CommitteeMembersState {..} = c
    in [ "committee" .= csCommittee
-      , "quorum" .= csQuorum
+      , "threshold" .= csThreshold
       , "epoch" .= csEpochNo
       ]

libs/cardano-ledger-api/test/Test/Cardano/Ledger/Api/State/QuerySpec.hs

@@ -221,7 +221,7 @@ propActiveAuthorized ::
   Expectation
 propActiveAuthorized nes = do
   withCommitteeInfo nes $
-    \(Committee comMembers comQuorum) (CommitteeState comStateMembers) _ noFilterResult -> do
+    \(Committee comMembers comThreshold) (CommitteeState comStateMembers) _ noFilterResult -> do
       let activeAuthorized =
             Map.mapMaybe
               ( \case
@@ -243,7 +243,7 @@ propActiveAuthorized nes = do
       Map.intersection comStateMembers activeAuthorized
         `shouldSatisfy` all isJust
       csEpochNo noFilterResult `shouldBe` epochNo
-      csQuorum noFilterResult `shouldBe` comQuorum
+      csThreshold noFilterResult `shouldBe` comThreshold
 
 propFilters ::
   forall era.

libs/cardano-ledger-test/src/Test/Cardano/Ledger/Constrained/Vars.hs

@@ -1975,7 +1975,7 @@ committeeT :: forall era. Era era => RootTarget era (Committee era) (Committee e
 committeeT =
   Invert "Committee" (typeRep @(Committee era)) Committee
     :$ Lensed commMembers committeeMembersL
-    :$ Lensed commQuorum committeeQuorumL
+    :$ Lensed commQuorum committeeThresholdL
 
 {-
 prevGovActionIdsT =