add vote tally to Proposal datum

agora.cabal

@@ -122,6 +122,7 @@ library
     Agora.MultiSig
     Agora.SafeMoney
     Agora.Stake
+    Agora.Effect
     Agora.Treasury
     Agora.Governor
     Agora.Proposal

agora/Agora/Effect.hs

@@ -0,0 +1,8 @@
+{- |
+Module     : Agora.Effect
+Maintainer : emi@haskell.fyi
+Description: Helpers for constructing effects
+
+Helpers for constructing effects.
+-}
+module Agora.Effect () where

agora/Agora/Proposal.hs

@@ -8,6 +8,8 @@ Proposal scripts encoding effects that operate on the system.
 module Agora.Proposal (
   ProposalDatum (..),
   ProposalStatus (..),
+  ProposalThresholds (..),
+  ProposalVotes (..),
   ResultTag (..),
 ) where
 
@@ -15,39 +17,79 @@ import Plutus.V1.Ledger.Api (DatumHash, PubKeyHash, ValidatorHash)
 
 --------------------------------------------------------------------------------
 
+import Agora.SafeMoney (Discrete, GTTag)
+
+--------------------------------------------------------------------------------
+
 {- | Encodes a result. Typically, for a Yes/No proposal, we encode it like this:
 
-   "No"  ~ EffectTag 0
+@
-   "Yes" ~ EffectTag 1
+"No"  ~ 'ResultTag' 0
+"Yes" ~ 'ResultTag' 1
+@
 -}
 newtype ResultTag = ResultTag {getResultTag :: Integer}
 
-{- | The "status" of the proposal. This is only useful for __actual__
+{- | The "status" of the proposal. This is only useful for state transitions,
-     state transitions, as opposed to time-based "phases".
+     as opposed to time-based "phases".
 
      If the proposal is 'VotingReady', for instance, that doesn't necessarily
      mean that voting is possible, as this also requires the timing to be right.
 -}
 data ProposalStatus
   = -- | A draft proposal represents a proposal that has yet to be realized.
+    --
     --   In effect, this means one which didn't have enough LQ to be a full
     --   proposal, and needs cosigners to enable that to happen. This is
     --   similar to a "temperature check", but only useful if multiple people
     --   want to pool governance tokens together. If the proposal doesn't get to
-    --   'VotingReady' on time, the proposal will **never** be able to get
+    --   'VotingReady' on time, the proposal will __never__ be able to get
     --   voted on.
     Draft
   | -- | The proposal has/had enough GT cosigned in order to be a fully fledged
-    --   proposal. This means that once the timing requirements align,
+    --   proposal.
+    --
+    --   This means that once the timing requirements align,
     --   proposal will be able to be voted on.
     VotingReady
-  | -- | The proposal has finished for whatever reason. This can mean it's been
+  | -- | The proposal has finished.
-    --   voted on and completed, but it can also mean the proposal failed due to
+    --
-    --   time constraints or didn't get to 'VotingReady' first.
+    --   This can mean it's been voted on and completed, but it can also mean
+    --   the proposal failed due to  time constraints or didn't
+    --   get to 'VotingReady' first.
     --
     --   TODO: The owner of the proposal may choose to reclaim their proposal.
     Finished
 
+{- | The threshold values for various state transitions to happen.
+     This data is stored centrally (in the Governor) and copied over
+     to Proposals when they are created.
+-}
+data ProposalThresholds = ProposalThresholds
+  { execute :: Discrete GTTag
+  -- ^ How much GT minimum must a particular 'ResultTag' accumulate to fulfil.
+  , draft :: Discrete GTTag
+  -- ^ How much GT required to "create" a proposal.
+  , vote :: Discrete GTTag
+  -- ^ How much GT required to allow voting to happen.
+  -- (i.e. to move into 'VotingReady')
+  }
+
+{- | Map which encodes the total tally for each result.
+   It's important that the 'shape' is consistent with the shape of 'effects'.
+
+   e.g. if the 'effects' field looks like the following:
+
+   @[('ResultTag' 0, []), ('ResultTag' 1, [(vh, dh)])]@
+
+   Then 'ProposalVotes' need be of the shape:
+
+   @[('ResultTag' 0, n), ('ResultTag' 1, m)]@
+-}
+newtype ProposalVotes = ProposalVotes
+  { getProposalVotes :: [(ResultTag, Integer)]
+  }
+
 -- | Haskell-level datum for Proposal scripts.
 data ProposalDatum = ProposalDatum
   { -- TODO: could we encode this more efficiently?
@@ -60,4 +102,8 @@ data ProposalDatum = ProposalDatum
   , proposers :: [PubKeyHash]
   -- ^ Who created the proposal initially.
   -- We may want to remove this.
+  , thresholds :: ProposalThresholds
+  -- ^ Thresholds copied over on initialization.
+  , votes :: ProposalVotes
+  -- ^ Vote tally on the proposal
   }