3b94062dbb
* add `MutateDatum` redeemer * add `datumNFT` to `Governor` so that we can identify the datum * Lift `GovernorDatum` and `GovernorRedeemer`
97 lines
2.6 KiB
Haskell
97 lines
2.6 KiB
Haskell
{-# LANGUAGE TemplateHaskell #-}
|
|
|
|
{- |
|
|
Module : Agora.Governor
|
|
Maintainer : emi@haskell.fyi
|
|
Description: Governor entity scripts acting as authority of entire system.
|
|
|
|
Governor entity scripts acting as authority of entire system.
|
|
-}
|
|
module Agora.Governor (
|
|
-- * Haskell-land
|
|
GovernorDatum (..),
|
|
GovernorRedeemer (..),
|
|
Governor (..),
|
|
|
|
-- * Plutarch-land
|
|
|
|
-- * Scripts
|
|
governorPolicy,
|
|
governorValidator,
|
|
) where
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
import GHC.Generics qualified as GHC
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
import Agora.Proposal (ProposalId, ProposalThresholds)
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
import Plutarch (popaque)
|
|
import Plutarch.Api.V1 (PMintingPolicy, PValidator)
|
|
import PlutusTx qualified
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
import Plutus.V1.Ledger.Value (AssetClass)
|
|
import PlutusTx qualified
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- | Datum for the Governor script.
|
|
data GovernorDatum = GovernorDatum
|
|
{ proposalThresholds :: ProposalThresholds
|
|
-- ^ Gets copied over upon creation of a 'Agora.Proposal.ProposalDatum'.
|
|
, nextProposalId :: ProposalId
|
|
-- ^ What tag the next proposal will get upon creating.
|
|
}
|
|
deriving stock (Show, GHC.Generic)
|
|
|
|
PlutusTx.makeIsDataIndexed ''GovernorDatum [('GovernorDatum, 0)]
|
|
|
|
{- | Redeemer for Governor script. The governor has two primary
|
|
responsibilities:
|
|
|
|
1. The gating of Proposal creation.
|
|
2. The gating of minting authority tokens.
|
|
-}
|
|
data GovernorRedeemer
|
|
= -- | Checks that a proposal was created lawfully, and allows it.
|
|
CreateProposal
|
|
| -- | Checks that a SINGLE proposal finished correctly,
|
|
-- and allows minting GATs for each effect script.
|
|
MintGATs
|
|
-- | Allow effects to mutate the datum
|
|
| MutateDatum
|
|
deriving stock (Show, GHC.Generic)
|
|
|
|
PlutusTx.makeIsDataIndexed
|
|
''GovernorRedeemer
|
|
[('CreateProposal,0)
|
|
,('MintGATs, 1)
|
|
,('MutateDatum, 2)
|
|
]
|
|
|
|
-- | Parameters for creating Governor scripts.
|
|
data Governor
|
|
= Governor {
|
|
-- | NFT that identifies the governor datum
|
|
datumNFT :: AssetClass
|
|
}
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- | Policy for Governors.
|
|
governorPolicy :: Governor -> ClosedTerm PMintingPolicy
|
|
governorPolicy _ =
|
|
plam $ \_redeemer _ctx' -> P.do
|
|
popaque (pconstant ())
|
|
|
|
-- | Validator for Governors.
|
|
governorValidator :: Governor -> ClosedTerm PValidator
|
|
governorValidator _ =
|
|
plam $ \_datum _redeemer _ctx' -> P.do
|
|
popaque (pconstant ())
|