Merge pull request #392 from geniusyield/389-gov

feat: governance voting & proposal procedures, refactor transaction build sc…
geniusyield · Jan 14, 2025 · 89f1962 · 89f1962
2 parents 07d9065 + e3fabc0
commit 89f1962
Show file tree

Hide file tree

Showing 47 changed files with 845 additions and 291 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,9 @@
 * Adds additional certificates such as those related to governance, drep participation, stake pool registration, etc.
 * Tracks node version 10.1.3 and corresponding updated CLB version.
 * Update default value of `GYAwaitTxParameters` to now have 100 max attempts.
+* `GYInScript` and `GYStakeValScript` are now defined as a type synonyms around `GYBuildPlutusScript` whereas `GYMintScript` is a type synonym around `GYBuildScript` which now also includes simple scripts (besides plutus scripts). Pattern synonyms are provided for backwards compatibility. These and related functions such as `stakeValidatorVersionFromWitness`, `gyStakeValScriptToSerialisedScript` are now exported from `GeniusYield.Types.BuildScript` instead of `GeniusYield.Types.Script`.
+* `GYTxWdrlWitness`, `GYTxCertWitness` are now defined as a type synonyms around generic `GYTxBuildWitness` and now also includes simple scripts. Pattern synonyms are provided to maintain backwards compatibility.
+* Adds support for governance actions, namely proposal procedures & voting procedures.
 
 ## 0.7.0
 

diff --git a/atlas-cardano.cabal b/atlas-cardano.cabal
@@ -36,6 +36,7 @@ common common
     LambdaCase
     MultiWayIf
     OverloadedStrings
+    PatternSynonyms
     RecordWildCards
     RoleAnnotations
     TypeFamilyDependencies
@@ -129,13 +130,16 @@ library
     GeniusYield.Types.Blueprint.Schema
     GeniusYield.Types.Blueprint.TH
     GeniusYield.Types.Blueprint.Validator
+    GeniusYield.Types.BuildScript
+    GeniusYield.Types.BuildWitness
     GeniusYield.Types.Certificate
     GeniusYield.Types.Credential
     GeniusYield.Types.Datum
     GeniusYield.Types.Delegatee
     GeniusYield.Types.DRep
     GeniusYield.Types.Epoch
     GeniusYield.Types.Era
+    GeniusYield.Types.Governance
     GeniusYield.Types.KeyHash
     GeniusYield.Types.Key
     GeniusYield.Types.Key.Class
@@ -371,6 +375,7 @@ test-suite atlas-privnet-tests
     GeniusYield.Test.Privnet.Blueprint
     GeniusYield.Test.Privnet.Committee
     GeniusYield.Test.Privnet.DRep
+    GeniusYield.Test.Privnet.Gov
     GeniusYield.Test.Privnet.SimpleScripts
     GeniusYield.Test.Privnet.Stake
     GeniusYield.Test.Privnet.Stake.Key

diff --git a/src/GeniusYield/Api/TestTokens.hs b/src/GeniusYield/Api/TestTokens.hs
@@ -30,6 +30,6 @@ mintTestTokens tn amt = do
 
   let txSkeleton =
         mustHaveInput (GYTxIn utxo GYTxInWitnessKey)
-          <> mustMint (GYMintScript policy) unitRedeemer tn amt'
+          <> mustMint (GYBuildPlutusScript $ GYBuildPlutusScriptInlined policy) unitRedeemer tn amt'
 
   return (GYToken (mintingPolicyId policy) tn, txSkeleton)
diff --git a/src/GeniusYield/Imports.hs b/src/GeniusYield/Imports.hs
@@ -1,4 +1,3 @@
-{-# LANGUAGE PatternSynonyms #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 {- |

diff --git a/src/GeniusYield/Providers/Blockfrost.hs b/src/GeniusYield/Providers/Blockfrost.hs
@@ -44,7 +44,6 @@ import Data.Time.Clock.POSIX qualified as Time
 import GeniusYield.Imports
 import GeniusYield.Providers.Common
 import GeniusYield.Types
-import GeniusYield.Types.ProtocolParameters (ApiProtocolParameters)
 import GeniusYield.Utils (serialiseToBech32WithPrefix)
 import Money qualified
 import Ouroboros.Consensus.HardFork.History (EraParams (eraGenesisWin))

diff --git a/src/GeniusYield/Providers/Maestro.hs b/src/GeniusYield/Providers/Maestro.hs
@@ -50,7 +50,6 @@ import GHC.Natural (wordToNatural)
 import GeniusYield.Imports
 import GeniusYield.Providers.Common
 import GeniusYield.Types
-import GeniusYield.Types.ProtocolParameters (ApiProtocolParameters)
 import Maestro.Client.V1 qualified as Maestro
 import Maestro.Client.V1.Accounts qualified as Maestro
 import Maestro.Types.V1 qualified as Maestro

diff --git a/src/GeniusYield/Providers/Node.hs b/src/GeniusYield/Providers/Node.hs
@@ -32,7 +32,6 @@ import Data.Text qualified as Txt
 import GeniusYield.CardanoApi.Query
 import GeniusYield.Providers.Common (SubmitTxException (SubmitTxException), makeLastEraEndUnbounded)
 import GeniusYield.Types
-import GeniusYield.Types.ProtocolParameters (ApiProtocolParameters)
 import Ouroboros.Network.Protocol.LocalTxSubmission.Type (SubmitResult (..))
 
 -------------------------------------------------------------------------------

diff --git a/src/GeniusYield/Test/Privnet/Examples/Gift.hs b/src/GeniusYield/Test/Privnet/Examples/Gift.hs
@@ -1,5 +1,4 @@
 {-# LANGUAGE LambdaCase #-}
-{-# LANGUAGE PatternSynonyms #-}
 
 {- |
 Module      : GeniusYield.Test.Privnet.Examples.Gift
@@ -610,7 +609,7 @@ grabGifts validator = do
                   { gyTxInTxOutRef = oref
                   , gyTxInWitness =
                       GYTxInWitnessScript
-                        (GYInScript validator)
+                        (GYBuildPlutusScriptInlined validator)
                         (datumFromPlutus' od)
                         unitRedeemer
                   }
@@ -639,7 +638,7 @@ grabGiftsRef ref validator = do
                   { gyTxInTxOutRef = oref
                   , gyTxInWitness =
                       GYTxInWitnessScript
-                        (GYInReference ref $ validatorToScript validator)
+                        (GYBuildPlutusScriptReference ref $ validatorToScript validator)
                         (datumFromPlutus' od)
                         unitRedeemer
                   }

diff --git a/src/GeniusYield/Test/Privnet/Examples/Misc.hs b/src/GeniusYield/Test/Privnet/Examples/Misc.hs
@@ -42,7 +42,7 @@ tests setup =
           txBodyMint <-
             buildTxBody $
               mustHaveInput (GYTxIn utxoAsParam GYTxInWitnessKey)
-                <> mustMint (GYMintReference refScript policyAsScript) unitRedeemer tn amt
+                <> mustMint (GYBuildPlutusScript $ GYBuildPlutusScriptReference refScript policyAsScript) unitRedeemer tn amt
           signAndSubmitConfirmed_ txBodyMint
 
         -- wait a tiny bit.

diff --git a/src/GeniusYield/Test/Privnet/Examples/Oracle.hs b/src/GeniusYield/Test/Privnet/Examples/Oracle.hs
@@ -56,7 +56,7 @@ tests setup =
                     { gyTxInTxOutRef = ref
                     , gyTxInWitness =
                         GYTxInWitnessScript
-                          (GYInScript @PlutusV2 readOracleValidatorV2)
+                          (GYBuildPlutusScriptInlined @PlutusV2 readOracleValidatorV2)
                           (datumFromPlutusData (d :: ()))
                           unitRedeemer
                     }
@@ -107,7 +107,7 @@ tests setup =
                     { gyTxInTxOutRef = ref
                     , gyTxInWitness =
                         GYTxInWitnessScript
-                          (GYInScript @PlutusV2 readOracleValidatorV2)
+                          (GYBuildPlutusScriptInlined @PlutusV2 readOracleValidatorV2)
                           (datumFromPlutusData (d :: ()))
                           unitRedeemer
                     }

diff --git a/src/GeniusYield/Test/Privnet/Examples/Treat.hs b/src/GeniusYield/Test/Privnet/Examples/Treat.hs
@@ -108,7 +108,7 @@ grabTreats validator = do
                   { gyTxInTxOutRef = oref
                   , gyTxInWitness =
                       GYTxInWitnessScript
-                        (GYInScript validator)
+                        (GYBuildPlutusScriptInlined validator)
                         (datumFromPlutus' od)
                         unitRedeemer
                   }

diff --git a/src/GeniusYield/Test/Utils.hs b/src/GeniusYield/Test/Utils.hs
@@ -1,5 +1,3 @@
-{-# LANGUAGE PatternSynonyms #-}
-
 {- |
 Module      : GeniusYield.Test.Utils
 Copyright   : (c) 2023 GYELD GMBH
@@ -218,7 +216,7 @@ mintTestAssets tokens = do
     buildTxBody @PlutusV2 $
       foldMap
         ( \(tk, amt) ->
-            mustMint (GYMintScript $ fakePolicy tk) unitRedeemer (fakeCoinName tk) $ toInteger amt
+            mustMint (GYBuildPlutusScript $ GYBuildPlutusScriptInlined $ fakePolicy tk) unitRedeemer (fakeCoinName tk) $ toInteger amt
         )
         tokens
   signAndSubmitConfirmed_ txBody