rename ProposalTag to ProposalId, add docs for result tags

agora/Agora/Governor.hs

@@ -18,7 +18,7 @@ module Agora.Governor (
   governorValidator,
 ) where
 
-import Agora.Proposal (ProposalTag, ProposalThresholds)
+import Agora.Proposal (ProposalId, ProposalThresholds)
 import Plutarch (popaque)
 import Plutarch.Api.V1 (PMintingPolicy, PValidator)
 
@@ -26,7 +26,7 @@ import Plutarch.Api.V1 (PMintingPolicy, PValidator)
 data GovernorDatum = GovernorDatum
   { proposalThresholds :: ProposalThresholds
   -- ^ Gets copied over upon creation of a 'Agora.Proposal.ProposalDatum'.
-  , nextProposalTag :: ProposalTag
+  , nextProposalId :: ProposalId
   -- ^ What tag the next proposal will get upon creating.
   }
 

agora/Agora/Proposal.hs

@@ -14,7 +14,7 @@ module Agora.Proposal (
   ProposalStatus (..),
   ProposalThresholds (..),
   ProposalVotes (..),
-  ProposalTag (..),
+  ProposalId (..),
   ResultTag (..),
 
   -- * Plutarch-land
@@ -22,7 +22,7 @@ module Agora.Proposal (
   PProposalStatus (..),
   PProposalThresholds (..),
   PProposalVotes (..),
-  PProposalTag (..),
+  PProposalId (..),
   PResultTag (..),
 
   -- * Scripts
@@ -143,7 +143,7 @@ data ProposalDatum = ProposalDatum
   { -- TODO: could we encode this more efficiently?
   -- This is shaped this way for future proofing.
   -- See https://github.com/Liqwid-Labs/agora/issues/39
-  effects :: [(ResultTag, [(ValidatorHash, DatumHash)])]
+  effects :: AssocMap.Map ResultTag [(ValidatorHash, DatumHash)]
   -- ^ Effect lookup table. First by result, then by effect hash.
   , status :: ProposalStatus
   -- ^ The status the proposal is in.
@@ -160,10 +160,10 @@ PlutusTx.makeIsDataIndexed ''ProposalDatum [('ProposalDatum, 0)]
 
 {- | Identifies a Proposal, issued upon creation of a proposal.
      In practice, this number starts at zero, and increments by one
-     for each proposal. The 100th proposal will be @'ProposalTag' 99@.
-     This counter lives in the 'Governor', see 'nextProposalTag'.
+     for each proposal. The 100th proposal will be @'ProposalId' 99@.
+     This counter lives in the 'Governor', see 'nextProposalId'.
 -}
-newtype ProposalTag = ProposalTag {proposalTag :: Integer}
+newtype ProposalId = ProposalId {proposalTag :: Integer}
   deriving newtype (PlutusTx.ToData, PlutusTx.FromData, PlutusTx.UnsafeFromData)
   deriving stock (Eq, Show, GHC.Generic)
 
@@ -183,15 +183,15 @@ deriving via
   instance
     (PConstant ResultTag)
 
--- | Plutarch-level version of 'PProposalTag'.
-newtype PProposalTag (s :: S) = PProposalTag (Term s PInteger)
-  deriving (PlutusType, PIsData, PEq, POrd) via (DerivePNewtype PProposalTag PInteger)
+-- | Plutarch-level version of 'PProposalId'.
+newtype PProposalId (s :: S) = PProposalId (Term s PInteger)
+  deriving (PlutusType, PIsData, PEq, POrd) via (DerivePNewtype PProposalId PInteger)
 
-instance PUnsafeLiftDecl PProposalTag where type PLifted PProposalTag = ProposalTag
+instance PUnsafeLiftDecl PProposalId where type PLifted PProposalId = ProposalId
 deriving via
-  (DerivePConstantViaNewtype ProposalTag PProposalTag PInteger)
+  (DerivePConstantViaNewtype ProposalId PProposalId PInteger)
   instance
-    (PConstant ProposalTag)
+    (PConstant ProposalId)
 
 -- | Plutarch-level version of 'ProposalStatus'.
 data PProposalStatus (s :: S)

agora/Agora/Stake.hs

@@ -56,7 +56,7 @@ import Plutus.V1.Ledger.Value (AssetClass (AssetClass))
 
 --------------------------------------------------------------------------------
 
-import Agora.Proposal (PProposalTag, PResultTag, ProposalTag (..), ResultTag (..))
+import Agora.Proposal (PProposalId, PResultTag, ProposalId (..), ResultTag (..))
 import Agora.SafeMoney (GTTag)
 import Agora.Utils (
   anyInput,
@@ -119,8 +119,8 @@ data ProposalLock = ProposalLock
   { vote :: ResultTag
   -- ^ What was voted on. This allows retracting votes to
   --   undo their vote.
-  , proposalTag :: ProposalTag
-  -- ^ Identifies the proposal. See 'ProposalTag' for further
+  , proposalId :: ProposalId
+  -- ^ Identifies the proposal. See 'ProposalId' for further
   -- comments on its significance.
   }
   deriving stock (Show, GHC.Generic)
@@ -222,7 +222,7 @@ newtype PProposalLock (s :: S) = PProposalLock
       s
       ( PDataRecord
           '[ "vote" ':= PResultTag
-           , "proposalTag" ':= PProposalTag
+           , "proposalTag" ':= PProposalId
            ]
       )
   }