Move Vote to core BaseTypes

Author: teodanciu

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

@@ -90,6 +90,7 @@ import Cardano.Ledger.BaseTypes (
   ProtVer,
   ToKeyValuePairs (..),
   UnitInterval,
+  Vote (..),
   maybeToStrictMaybe,
  )
 import Cardano.Ledger.Binary (
@@ -100,12 +101,10 @@ import Cardano.Ledger.Binary (
   Interns,
   ToCBOR (toCBOR),
   decNoShareCBOR,
-  decodeEnumBounded,
   decodeMapByKey,
   decodeNullStrictMaybe,
   decodeRecordNamed,
   decodeRecordNamedT,
-  encodeEnum,
   encodeListLen,
   encodeNullStrictMaybe,
   encodeWord8,
@@ -373,24 +372,6 @@ instance NoThunks Voter
 
 instance NFData Voter
 
-data Vote
-  = VoteNo
-  | VoteYes
-  | Abstain
-  deriving (Ord, Generic, Eq, Show, Enum, Bounded)
-
-instance ToJSON Vote
-
-instance NoThunks Vote
-
-instance NFData Vote
-
-instance DecCBOR Vote where
-  decCBOR = decodeEnumBounded
-
-instance EncCBOR Vote where
-  encCBOR = encodeEnum
-
 newtype VotingProcedures era = VotingProcedures
   { unVotingProcedures :: Map Voter (Map GovActionId (VotingProcedure era))
   }

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/Arbitrary.hs

@@ -562,10 +562,6 @@ instance Arbitrary Voter where
       ]
   shrink = genericShrink
 
-instance Arbitrary Vote where
-  arbitrary = arbitraryBoundedEnum
-  shrink = shrinkBoundedEnum
-
 instance Arbitrary (TxBody ConwayEra) where
   arbitrary =
     ConwayTxBody

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/TreeDiff.hs

@@ -71,8 +71,6 @@ instance ToExpr (PParamsHKD StrictMaybe era) => ToExpr (GovActionState era)
 
 instance ToExpr Voter
 
-instance ToExpr Vote
-
 instance Era era => ToExpr (VotingProcedures era)
 
 instance ToExpr (VotingProcedure era)

libs/cardano-ledger-core/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 1.19.0.0
 
+* Add `FromJSON` instance to `Vote`
+* Move `Vote` to `BaseTypes` module
 * Add `poolParamsCount`, `decCBORGroupPoolParams`, `encCBORGroupPoolParams` to `StakePool` module
 * Remove `DecCBORGroup` and `EncCBORGroup` instances for `PoolParams`
 * Remove the `UMap` module and the `umap` benchmarks cabal target.

libs/cardano-ledger-core/src/Cardano/Ledger/BaseTypes.hs

@@ -57,6 +57,7 @@ module Cardano.Ledger.BaseTypes (
   module Data.Maybe.Strict,
   BlocksMade (..),
   kindObject,
+  Vote (..),
 
   -- * Indices
   TxIx (..),
@@ -106,6 +107,8 @@ import Cardano.Ledger.Binary (
   FromCBOR,
   ToCBOR,
   cborError,
+  decodeEnumBounded,
+  encodeEnum,
   ifDecoderVersionAtLeast,
  )
 import Cardano.Ledger.Binary.Coders (
@@ -970,3 +973,23 @@ newtype KeyValuePairs a = KeyValuePairs {unKeyValuePairs :: a}
 instance ToKeyValuePairs a => ToJSON (KeyValuePairs a) where
   toJSON = object . toKeyValuePairs . unKeyValuePairs
   toEncoding = pairs . mconcat . toKeyValuePairs . unKeyValuePairs
+
+data Vote
+  = VoteNo
+  | VoteYes
+  | Abstain
+  deriving (Ord, Generic, Eq, Show, Enum, Bounded)
+
+instance ToJSON Vote
+
+instance FromJSON Vote
+
+instance NoThunks Vote
+
+instance NFData Vote
+
+instance DecCBOR Vote where
+  decCBOR = decodeEnumBounded
+
+instance EncCBOR Vote where
+  encCBOR = encodeEnum

libs/cardano-ledger-core/testlib/Test/Cardano/Ledger/Core/Arbitrary.hs

@@ -517,6 +517,10 @@ deriving instance (Era era, Arbitrary (PParamsHKD Identity era)) => Arbitrary (P
 
 deriving instance (Era era, Arbitrary (PParamsHKD StrictMaybe era)) => Arbitrary (PParamsUpdate era)
 
+instance Arbitrary BaseTypes.Vote where
+  arbitrary = arbitraryBoundedEnum
+  shrink = shrinkBoundedEnum
+
 ------------------------------------------------------------------------------------------
 -- Cardano.Ledger.DRep -------------------------------------------------------------------
 ------------------------------------------------------------------------------------------

libs/cardano-ledger-core/testlib/Test/Cardano/Ledger/TreeDiff.hs

@@ -179,6 +179,8 @@ instance ToExpr TxId
 
 instance ToExpr ChainAccountState
 
+instance ToExpr Vote
+
 -- CertState
 instance ToExpr DRep