Merge branch 'main' into connor/#87

agora/Agora/Aeson/Orphans.hs

@@ -0,0 +1,146 @@
+{-# OPTIONS_GHC -Wno-orphans #-}
+
+module Agora.Aeson.Orphans (AsBase16Bytes (..)) where
+
+--------------------------------------------------------------------------------
+
+import Data.Coerce (Coercible, coerce)
+import Prelude
+
+--------------------------------------------------------------------------------
+
+import Codec.Serialise qualified as Codec
+import Data.Aeson qualified as Aeson
+import Data.Aeson.Types qualified as Aeson
+import Data.ByteString.Lazy qualified as Lazy
+import Data.Text qualified as T
+import Data.Text.Encoding qualified as T
+
+--------------------------------------------------------------------------------
+
+import Plutus.V1.Ledger.Api qualified as Plutus
+import Plutus.V1.Ledger.Bytes qualified as Plutus
+import Plutus.V1.Ledger.Value qualified as Plutus
+
+--------------------------------------------------------------------------------
+
+newtype AsBase16Bytes a = AsBase16Bytes {unAsBase16Bytes :: a}
+newtype AsBase16Codec a = AsBase16Codec {unAsBase16Codec :: a}
+
+deriving via
+  (Plutus.CurrencySymbol, Plutus.TokenName)
+  instance
+    Aeson.ToJSON Plutus.AssetClass
+
+deriving via
+  (Plutus.CurrencySymbol, Plutus.TokenName)
+  instance
+    Aeson.FromJSON Plutus.AssetClass
+
+deriving via
+  AsBase16Bytes Plutus.TxId
+  instance
+    Aeson.FromJSON Plutus.TxId
+
+deriving via
+  AsBase16Bytes Plutus.TxId
+  instance
+    Aeson.ToJSON Plutus.TxId
+
+deriving anyclass instance Aeson.FromJSON Plutus.TxOutRef
+deriving anyclass instance Aeson.ToJSON Plutus.TxOutRef
+
+instance (Coercible a Plutus.LedgerBytes) => Aeson.ToJSON (AsBase16Bytes a) where
+  toJSON =
+    Aeson.String
+      . Plutus.encodeByteString
+      . Plutus.bytes
+      . coerce @(AsBase16Bytes a) @Plutus.LedgerBytes
+
+instance (Coercible Plutus.LedgerBytes a) => Aeson.FromJSON (AsBase16Bytes a) where
+  parseJSON v =
+    Aeson.parseJSON @T.Text v
+      >>= either (Aeson.parserThrowError []) (pure . coerce @_ @(AsBase16Bytes a))
+        . Plutus.fromHex
+        . T.encodeUtf8
+
+instance (Codec.Serialise a) => Aeson.ToJSON (AsBase16Codec a) where
+  toJSON =
+    Aeson.String
+      . Plutus.encodeByteString
+      . Lazy.toStrict
+      . Codec.serialise @a
+      . (.unAsBase16Codec)
+
+instance (Codec.Serialise a) => Aeson.FromJSON (AsBase16Codec a) where
+  parseJSON v =
+    Aeson.parseJSON @T.Text v
+      >>= either (Aeson.parserThrowError [] . show) (pure . AsBase16Codec)
+        . Codec.deserialiseOrFail
+        . Lazy.fromStrict
+        . T.encodeUtf8
+
+--------------------------------------------------------------------------------
+
+deriving via
+  (AsBase16Bytes Plutus.CurrencySymbol)
+  instance
+    (Aeson.ToJSON Plutus.CurrencySymbol)
+deriving via
+  (AsBase16Bytes Plutus.CurrencySymbol)
+  instance
+    (Aeson.FromJSON Plutus.CurrencySymbol)
+
+deriving via
+  (AsBase16Bytes Plutus.TokenName)
+  instance
+    (Aeson.ToJSON Plutus.TokenName)
+deriving via
+  (AsBase16Bytes Plutus.TokenName)
+  instance
+    (Aeson.FromJSON Plutus.TokenName)
+
+deriving via
+  (AsBase16Bytes Plutus.ValidatorHash)
+  instance
+    (Aeson.ToJSON Plutus.ValidatorHash)
+deriving via
+  (AsBase16Bytes Plutus.ValidatorHash)
+  instance
+    (Aeson.FromJSON Plutus.ValidatorHash)
+
+deriving via
+  (AsBase16Codec Plutus.Validator)
+  instance
+    (Aeson.ToJSON Plutus.Validator)
+deriving via
+  (AsBase16Codec Plutus.Validator)
+  instance
+    (Aeson.FromJSON Plutus.Validator)
+
+deriving via
+  (AsBase16Codec Plutus.MintingPolicy)
+  instance
+    (Aeson.ToJSON Plutus.MintingPolicy)
+deriving via
+  (AsBase16Codec Plutus.MintingPolicy)
+  instance
+    (Aeson.FromJSON Plutus.MintingPolicy)
+
+deriving via
+  (AsBase16Codec Plutus.Script)
+  instance
+    (Aeson.ToJSON Plutus.Script)
+deriving via
+  (AsBase16Codec Plutus.Script)
+  instance
+    (Aeson.FromJSON Plutus.Script)
+
+deriving via
+  Integer
+  instance
+    (Aeson.ToJSON Plutus.POSIXTime)
+deriving via
+  Integer
+  instance
+    (Aeson.FromJSON Plutus.POSIXTime)

agora/Agora/Effect.hs

@@ -23,7 +23,7 @@ import Plutus.V1.Ledger.Value (CurrencySymbol)
 -}
 makeEffect ::
   forall (datum :: PType).
-  (PIsData datum, PTryFrom PData datum) =>
+  (PIsData datum, PTryFrom PData (PAsData datum)) =>
   CurrencySymbol ->
   (forall (s :: S). Term s PCurrencySymbol -> Term s datum -> Term s PTxOutRef -> Term s (PAsData PTxInfo) -> Term s POpaque) ->
   ClosedTerm PValidator
@@ -35,7 +35,7 @@ makeEffect gatCs' f =
     -- convert input datum, PData, into desierable type
     -- the way this conversion is performed should be defined
     -- by PTryFrom for each datum in effect script.
-    (datum', _) <- tctryFrom @datum datum
+    (pfromData -> datum', _) <- tctryFrom datum
 
     -- ensure purpose is Spending.
     PSpending txOutRef <- tcmatch $ pfromData ctx.purpose

agora/Agora/Effect/GovernorMutation.hs

@@ -0,0 +1,214 @@
+{-# LANGUAGE TemplateHaskell #-}
+
+{- |
+Module     : Agora.Effect.GovernorMutation
+Maintainer : connor@mlabs.city
+Description: An effect that mutates governor settings.
+
+An effect for mutating governor settings.
+-}
+module Agora.Effect.GovernorMutation (
+  -- * Haskell-land
+  MutateGovernorDatum (..),
+
+  -- * Plutarch-land
+  PMutateGovernorDatum (..),
+
+  -- * Scripts
+  mutateGovernorValidator,
+) where
+
+--------------------------------------------------------------------------------
+
+import Control.Applicative (Const)
+import GHC.Generics qualified as GHC
+import Generics.SOP (Generic, I (I))
+
+--------------------------------------------------------------------------------
+
+import Plutarch.Api.V1 (
+  PTxOutRef,
+  PValidator,
+  PValue,
+ )
+import Plutarch.Api.V1.Extra (pvalueOf)
+import Plutarch.DataRepr (
+  DerivePConstantViaData (..),
+  PDataFields,
+  PIsDataReprInstances (PIsDataReprInstances),
+ )
+import Plutarch.Lift (PConstantDecl, PLifted, PUnsafeLiftDecl)
+import Plutarch.TryFrom (PTryFrom (..))
+import Plutarch.Unsafe (punsafeCoerce)
+
+--------------------------------------------------------------------------------
+
+import Plutus.V1.Ledger.Api (TxOutRef)
+import Plutus.V1.Ledger.Value (AssetClass (..))
+import PlutusTx qualified
+
+--------------------------------------------------------------------------------
+
+import Agora.Effect (makeEffect)
+import Agora.Governor (
+  Governor,
+  GovernorDatum,
+  PGovernorDatum,
+  governorDatumValid,
+ )
+import Agora.Governor.Scripts (
+  authorityTokenSymbolFromGovernor,
+  governorSTAssetClassFromGovernor,
+ )
+import Agora.Utils (
+  isScriptAddress,
+  mustBePDJust,
+  mustBePJust,
+  ptryFindDatum,
+  tcassert,
+ )
+
+--------------------------------------------------------------------------------
+
+-- | Haskell-level datum for the governor mutation effect script.
+data MutateGovernorDatum = MutateGovernorDatum
+  { governorRef :: TxOutRef
+  -- ^ Referenced governor state UTXO should be updated by the effect.
+  , newDatum :: GovernorDatum
+  -- ^ The new settings for the governor.
+  }
+  deriving stock (Show, GHC.Generic)
+  deriving anyclass (Generic)
+
+PlutusTx.makeIsDataIndexed ''MutateGovernorDatum [('MutateGovernorDatum, 0)]
+
+--------------------------------------------------------------------------------
+
+-- | Plutarch-level version of 'MutateGovernorDatum'.
+newtype PMutateGovernorDatum (s :: S)
+  = PMutateGovernorDatum
+      ( Term
+          s
+          ( PDataRecord
+              '[ "governorRef" ':= PTxOutRef
+               , "newDatum" ':= PGovernorDatum
+               ]
+          )
+      )
+  deriving stock (GHC.Generic)
+  deriving anyclass (Generic)
+  deriving anyclass (PIsDataRepr)
+  deriving
+    (PlutusType, PIsData, PDataFields, PEq)
+    via (PIsDataReprInstances PMutateGovernorDatum)
+
+instance PUnsafeLiftDecl PMutateGovernorDatum where type PLifted PMutateGovernorDatum = MutateGovernorDatum
+deriving via (DerivePConstantViaData MutateGovernorDatum PMutateGovernorDatum) instance (PConstantDecl MutateGovernorDatum)
+
+-- TODO: Derive this.
+instance PTryFrom PData (PAsData PMutateGovernorDatum) where
+  type PTryFromExcess PData (PAsData PMutateGovernorDatum) = Const ()
+  ptryFrom' d k =
+    k (punsafeCoerce d, ())
+
+--------------------------------------------------------------------------------
+
+{- | Validator for the governor mutation effect.
+
+  This effect is implemented using the 'Agora.Effect.makeEffect' wrapper,
+   meaning that the burning of GAT is checked in said wrapper.
+
+  In order to locate the governor, the validator is parametrized with a 'Agora.Governor.Governor'.
+
+  All the information it needs to validate the effect is encoded in the 'MutateGovernorDatum',
+   so regardless what redeemer it's given, it will check:
+
+  - No token is minted/burnt other than GAT.
+  - Nothing is being paid to the the effect validator.
+  - The governor's state UTXO must be spent:
+
+      * It carries exactly one GST.
+      * It's referenced by 'governorRef' in the effect's datum.
+
+  - A new state UTXO is paid to the governor:
+
+      * It contains the GST.
+      * It has valid governor state datum.
+      * The datum is exactly the same as the 'newDatum'.
+-}
+mutateGovernorValidator :: Governor -> ClosedTerm PValidator
+mutateGovernorValidator gov = makeEffect (authorityTokenSymbolFromGovernor gov) $
+  \_gatCs (datum :: Term _ PMutateGovernorDatum) _ txInfo -> unTermCont $ do
+    datumF <- tcont $ pletFields @'["newDatum", "governorRef"] datum
+    txInfoF <- tcont $ pletFields @'["mint", "inputs", "outputs", "datums"] txInfo
+
+    let mint :: Term _ (PBuiltinList _)
+        mint = pto $ pto $ pto $ pfromData txInfoF.mint
+
+    tcassert "Nothing should be minted/burnt other than GAT" $
+      plength # mint #== 1
+
+    -- Only two script inputs are alloed: one from the effect, one from the governor.
+    tcassert "Only self and governor script inputs are allowed" $
+      pfoldr
+        # phoistAcyclic
+          ( plam $ \inInfo count ->
+              let address = pfield @"address" #$ pfield @"resolved" # inInfo
+               in pif
+                    (isScriptAddress # address)
+                    (count + 1)
+                    count
+          )
+        # (0 :: Term _ PInteger)
+        # pfromData txInfoF.inputs
+        #== 2
+
+    -- Find the governor input by looking for GST.
+    let inputWithGST =
+          mustBePJust # "Governor input not found" #$ pfind
+            # phoistAcyclic
+              ( plam $ \inInfo ->
+                  let value = pfield @"value" #$ pfield @"resolved" # inInfo
+                   in gstValueOf # value #== 1
+              )
+            # pfromData txInfoF.inputs
+
+    govInInfo <- tcont $ pletFields @'["outRef", "resolved"] $ inputWithGST
+
+    -- The effect can only modify the governor UTXO referenced in the datum.
+    tcassert "Can only modify the pinned governor" $
+      govInInfo.outRef #== datumF.governorRef
+
+    -- The transaction can only have one output, which should be sent to the governor.
+    tcassert "Only governor output is allowed" $
+      plength # pfromData txInfoF.outputs #== 1
+
+    let govAddress = pfield @"address" #$ govInInfo.resolved
+        govOutput' = pfromData $ phead # pfromData txInfoF.outputs
+
+    govOutput <- tcont $ pletFields @'["address", "value", "datumHash"] govOutput'
+
+    tcassert "No output to the governor" $
+      govOutput.address #== govAddress
+
+    tcassert "Governor output doesn't carry the GST" $
+      gstValueOf # govOutput.value #== 1
+
+    let governorOutputDatumHash =
+          mustBePDJust # "Governor output doesn't have datum" # govOutput.datumHash
+        governorOutputDatum =
+          pfromData @PGovernorDatum $
+            mustBePJust # "Governor output datum not found"
+              #$ ptryFindDatum # governorOutputDatumHash # txInfoF.datums
+
+    -- Ensure the output governor datum is what we want.
+    tcassert "Unexpected governor datum" $ datumF.newDatum #== governorOutputDatum
+    tcassert "New governor datum should be valid" $ governorDatumValid # governorOutputDatum
+
+    return $ popaque $ pconstant ()
+  where
+    -- Get the amount of GST in the a given value.
+    gstValueOf :: Term s (PValue :--> PInteger)
+    gstValueOf = phoistAcyclic $ plam $ \v -> pvalueOf # v # pconstant cs # pconstant tn
+      where
+        AssetClass (cs, tn) = governorSTAssetClassFromGovernor gov

agora/Agora/Effect/NoOp.hs

@@ -18,13 +18,13 @@ import Plutus.V1.Ledger.Value (CurrencySymbol)
 newtype PNoOp (s :: S) = PNoOp (Term s PUnit)
   deriving (PlutusType, PIsData) via (DerivePNewtype PNoOp PUnit)
 
-instance PTryFrom PData PNoOp where
-  type PTryFromExcess PData PNoOp = Const ()
+instance PTryFrom PData (PAsData PNoOp) where
+  type PTryFromExcess PData (PAsData PNoOp) = Const ()
   ptryFrom' _ cont =
     -- JUSTIFICATION:
     -- We don't care anything about data.
     -- It should always be reduced to Unit.
-    cont (pcon $ PNoOp (pconstant ()), ())
+    cont (pdata $ pcon $ PNoOp (pconstant ()), ())
 
 -- | Dummy effect which can only burn its GAT.
 noOpValidator :: CurrencySymbol -> ClosedTerm PValidator

agora/Agora/Effect/TreasuryWithdrawal.hs

@@ -18,7 +18,7 @@ import GHC.Generics qualified as GHC
 import Generics.SOP (Generic, I (I))
 
 import Agora.Effect (makeEffect)
-import Agora.Utils (findTxOutByTxOutRef, paddValue, tcassert, tclet, tcmatch)
+import Agora.Utils (findTxOutByTxOutRef, isPubKey, paddValue, tcassert, tclet, tcmatch)
 import Plutarch.Api.V1 (
   PCredential (..),
   PTuple,
@@ -82,8 +82,8 @@ deriving via
   instance
     (PConstantDecl TreasuryWithdrawalDatum)
 
-instance PTryFrom PData PTreasuryWithdrawalDatum where
-  type PTryFromExcess PData PTreasuryWithdrawalDatum = Const ()
+instance PTryFrom PData (PAsData PTreasuryWithdrawalDatum) where
+  type PTryFromExcess PData (PAsData PTreasuryWithdrawalDatum) = Const ()
   ptryFrom' opq cont =
     -- TODO: This should not use 'punsafeCoerce'.
     -- Blocked by 'PCredential', and 'PTuple'.
@@ -140,12 +140,6 @@ treasuryWithdrawalValidator currSymbol = makeEffect currSymbol $
         treasuryInputValuesSum = sumValues #$ ofTreasury # inputValues
         treasuryOutputValuesSum = sumValues #$ ofTreasury # outputValues
         receiverValuesSum = sumValues # datum.receivers
-        isPubkey = plam $ \cred ->
-          pmatch cred $
-            \case
-              PPubKeyCredential _ -> pcon PTrue
-              PScriptCredential _ -> pcon PFalse
-
         -- Constraints
         outputContentMatchesRecivers =
           pall # plam (\out -> pelem # out # outputValues)
@@ -165,7 +159,7 @@ treasuryWithdrawalValidator currSymbol = makeEffect currSymbol $
               ( \((pfield @"_0" #) . pfromData -> cred) ->
                   cred #== pfield @"credential" # effInput.address
                     #|| pelem # cred # datum.treasuries
-                    #|| isPubkey # pfromData cred
+                    #|| isPubKey # pfromData cred
               )
             # inputValues
 

agora/Agora/SafeMoney.hs

@@ -8,6 +8,9 @@ Tags and extras for "Plutarch.SafeMoney".
 module Agora.SafeMoney (
   ADATag,
   GTTag,
+  GovernorSTTag,
+  StakeSTTag,
+  ProposalSTTag,
   adaRef,
 ) where
 
@@ -18,7 +21,7 @@ import Plutus.V1.Ledger.Value (AssetClass (AssetClass))
 import Plutarch.SafeMoney
 
 --------------------------------------------------------------------------------
--- Example tags
+-- Tags
 
 -- | Governance token.
 data GTTag
@@ -26,6 +29,15 @@ data GTTag
 -- | ADA.
 data ADATag
 
+-- | Governor ST token.
+data GovernorSTTag
+
+-- | Stake ST token.
+data StakeSTTag
+
+-- | Proposal ST token.
+data ProposalSTTag
+
 --------------------------------------------------------------------------------
 
 -- | Resolves ada tags.

agora/Agora/ScriptInfo.hs

@@ -0,0 +1,63 @@
+{- |
+Module     : Agora.ScriptInfo
+Maintainer : emi@haskell.fyi
+Description: Exportable script bundles for off-chain consumption.
+
+Exportable script bundles for off-chain consumption.
+-}
+module Agora.ScriptInfo (
+  -- * Types
+  PolicyInfo (..),
+  ValidatorInfo (..),
+
+  -- * Introduction functions
+  mkValidatorInfo,
+  mkPolicyInfo,
+) where
+
+import Agora.Aeson.Orphans ()
+import Data.Aeson qualified as Aeson
+import GHC.Generics qualified as GHC
+import Plutarch.Api.V1 (PMintingPolicy, PValidator, mintingPolicySymbol, mkMintingPolicy, mkValidator, validatorHash)
+import Plutus.V1.Ledger.Api (MintingPolicy, Validator, ValidatorHash)
+import Plutus.V1.Ledger.Value (CurrencySymbol)
+
+-- | Bundle containing a 'Validator' and its hash.
+data ValidatorInfo = ValidatorInfo
+  { script :: Validator
+  -- ^ The validator script.
+  , hash :: ValidatorHash
+  -- ^ Hash of the validator.
+  }
+  deriving stock (Show, Eq, GHC.Generic)
+  deriving anyclass (Aeson.ToJSON, Aeson.FromJSON)
+
+-- | Create a 'ValidatorInfo' given a Plutarch term.
+mkValidatorInfo :: ClosedTerm PValidator -> ValidatorInfo
+mkValidatorInfo term =
+  ValidatorInfo
+    { script = validator
+    , hash = validatorHash validator
+    }
+  where
+    validator = mkValidator term
+
+-- | Bundle containing a 'MintingPolicy' and its symbol.
+data PolicyInfo = PolicyInfo
+  { policy :: MintingPolicy
+  -- ^ The minting policy.
+  , currencySymbol :: CurrencySymbol
+  -- ^ The symbol given by the minting policy.
+  }
+  deriving stock (Show, Eq, GHC.Generic)
+  deriving anyclass (Aeson.ToJSON, Aeson.FromJSON)
+
+-- | Create a 'PolicyInfo' given a Plutarch term.
+mkPolicyInfo :: ClosedTerm PMintingPolicy -> PolicyInfo
+mkPolicyInfo term =
+  PolicyInfo
+    { policy = policy
+    , currencySymbol = mintingPolicySymbol policy
+    }
+  where
+    policy = mkMintingPolicy term

agora/Agora/Treasury.hs

@@ -72,6 +72,7 @@ deriving via
      do so in a valid manner.
 -}
 treasuryValidator ::
+  -- | Governance Authority Token that can unlock this validator.
   CurrencySymbol ->
   ClosedTerm PValidator
 treasuryValidator gatCs' = plam $ \_datum redeemer ctx' -> unTermCont $ do

agora/Agora/Utils.hs

@@ -58,6 +58,8 @@ module Agora.Utils (
   validatorHashToAddress,
   pmergeBy,
   phalve,
+  isScriptAddress,
+  isPubKey,
 ) where
 
 --------------------------------------------------------------------------------
@@ -210,7 +212,7 @@ pfromMaybe = phoistAcyclic $
       PJust a' -> a'
       PNothing -> e
 
--- | Yield True if a given PMaybe is of form PJust _.
+-- | Yield True if a given PMaybe is of form @'PJust' _@.
 pisJust :: forall a s. Term s (PMaybe a :--> PBool)
 pisJust = phoistAcyclic $
   plam $ \v' ->
@@ -579,6 +581,19 @@ scriptHashFromAddress = phoistAcyclic $
       PScriptCredential ((pfield @"_0" #) -> h) -> pcon $ PJust h
       _ -> pcon PNothing
 
+-- | Return true if the given address is a script address.
+isScriptAddress :: Term s (PAddress :--> PBool)
+isScriptAddress = phoistAcyclic $
+  plam $ \addr -> pnot #$ isPubKey #$ pfromData $ pfield @"credential" # addr
+
+-- | Return true if the given credential is a pub-key-hash.
+isPubKey :: Term s (PCredential :--> PBool)
+isPubKey = phoistAcyclic $
+  plam $ \cred ->
+    pmatch cred $ \case
+      PScriptCredential _ -> pconstant False
+      _ -> pconstant True
+
 -- | Find all TxOuts sent to an Address
 findOutputsToAddress :: Term s (PBuiltinList (PAsData PTxOut) :--> PAddress :--> PBuiltinList (PAsData PTxOut))
 findOutputsToAddress = phoistAcyclic $