Merge pull request #5112 from input-output-hk/jordan/cip-0094-on-chai…

…n-spo-polls Add new interim governance commands: {create, answer, verify}-poll
IntersectMBO · Apr 17, 2023 · cf61eb3 · cf61eb3
2 parents d8e0b71 + 4723350
commit cf61eb3
Show file tree

Hide file tree

Showing 34 changed files with 1,575 additions and 6 deletions.
diff --git a/cardano-api/ChangeLog.md b/cardano-api/ChangeLog.md
@@ -84,6 +84,7 @@
 
 - New generators in `gen` sublibrary: `genPositiveLovelace`, `genPositiveQuantity` and
   `genSignedNonZeroQuantity`. ([PR 5013](https://github.com/input-output-hk/cardano-node/pull/5013))
+- New 'Governance.Poll' API implementing [CIP-0094](https://github.com/cardano-foundation/CIPs/pull/496) ([PR 5050](https://github.com/input-output-hk/cardano-node/pull/5050))
 
 ### Bugs
 

diff --git a/cardano-api/cardano-api.cabal b/cardano-api/cardano-api.cabal
@@ -67,6 +67,7 @@ library
                         Cardano.Api.Fees
                         Cardano.Api.Genesis
                         Cardano.Api.GenesisParameters
+                        Cardano.Api.Governance.Poll
                         Cardano.Api.Hash
                         Cardano.Api.HasTypeProxy
                         Cardano.Api.InMode

diff --git a/cardano-api/gen/Test/Gen/Cardano/Api/Typed.hs b/cardano-api/gen/Test/Gen/Cardano/Api/Typed.hs
@@ -110,34 +110,43 @@ module Test.Gen.Cardano.Api.Typed
   , genWitnessNetworkIdOrByronAddress
 
   , genRational
+
+  , genGovernancePoll
+  , genGovernancePollAnswer
+  , genGovernancePollWitness
   ) where
 
 import           Cardano.Api hiding (txIns)
 import qualified Cardano.Api as Api
 import           Cardano.Api.Byron (KeyWitness (ByronKeyWitness),
                    WitnessNetworkIdOrByronAddress (..))
 import           Cardano.Api.Shelley (Hash (..), KESPeriod (KESPeriod),
+                   GovernancePoll (..), GovernancePollAnswer (..), GovernancePollWitness (..),
                    OperationalCertificateIssueCounter (OperationalCertificateIssueCounter),
                    PlutusScript (PlutusScriptSerialised), ProtocolParameters (ProtocolParameters),
                    ReferenceScript (..), ReferenceTxInsScriptsInlineDatumsSupportedInEra (..),
                    StakeCredential (StakeCredentialByKey), StakePoolKey,
                    refInsScriptsAndInlineDatsSupportedInEra)
 
 
+import           Control.Applicative (optional)
 import           Data.ByteString (ByteString)
 import qualified Data.ByteString as BS
 import qualified Data.ByteString.Short as SBS
 import           Data.Coerce
 import           Data.Int (Int64)
 import           Data.Map.Strict (Map)
+import           Data.Maybe (fromMaybe)
 import           Data.Ratio (Ratio, (%))
 import           Data.String
 import           Data.Word (Word64)
 import           Numeric.Natural (Natural)
 
 import qualified Cardano.Binary as CBOR
+import qualified Cardano.Crypto.DSIGN as DSIGN
 import qualified Cardano.Crypto.Hash as Crypto
 import qualified Cardano.Crypto.Seed as Crypto
+import qualified Cardano.Crypto.VRF as VRF
 import qualified Cardano.Ledger.Shelley.TxBody as Ledger (EraIndependentTxBody)
 import qualified Test.Cardano.Ledger.Alonzo.PlutusScripts as Plutus
 
@@ -149,6 +158,7 @@ import qualified Cardano.Crypto.Hash.Class as CRYPTO
 import           Cardano.Ledger.Alonzo.Language (Language (..))
 import qualified Cardano.Ledger.Alonzo.Scripts as Alonzo
 import           Cardano.Ledger.SafeHash (unsafeMakeSafeHash)
+import           Cardano.Ledger.Keys (VKey(..))
 
 import           Test.Cardano.Chain.UTxO.Gen (genVKWitness)
 import           Test.Cardano.Crypto.Gen (genProtocolMagicId)
@@ -980,3 +990,48 @@ genHashScriptData = ScriptDataHash . unsafeMakeSafeHash . mkDummyHash <$> Gen.in
 
 genScriptDataSupportedInAlonzoEra :: Gen (ScriptDataSupportedInEra AlonzoEra)
 genScriptDataSupportedInAlonzoEra = pure ScriptDataInAlonzoEra
+
+genGovernancePoll :: Gen GovernancePoll
+genGovernancePoll =
+  GovernancePoll
+    <$> Gen.text (Range.linear 1 255) Gen.unicodeAll
+    <*> Gen.list (Range.constant 1 10) (Gen.text (Range.linear 1 255) Gen.unicodeAll)
+    <*> optional (Gen.word (Range.constant 0 100))
+
+genGovernancePollAnswer :: Gen GovernancePollAnswer
+genGovernancePollAnswer =
+  GovernancePollAnswer
+    <$> genGovernancePollHash
+    <*> Gen.word (Range.constant 0 10)
+ where
+   genGovernancePollHash =
+     GovernancePollHash . mkDummyHash <$> Gen.int (Range.linear 0 10)
+
+genGovernancePollWitness :: Gen GovernancePollWitness
+genGovernancePollWitness =
+  Gen.choice
+    [ GovernancePollWitnessVRF
+        <$> fmap
+              unsafeDeserialiseVerKeyVRF
+              (Gen.bytes $ Range.singleton 32)
+        <*> fmap
+              unsafeDeserialiseCertVRF
+              (Gen.bytes $ Range.singleton 80)
+    , GovernancePollWitnessColdKey
+        <$> fmap
+              (VKey . unsafeDeserialiseVerKeyDSIGN)
+              (Gen.bytes $ Range.singleton 32)
+        <*> fmap
+              (DSIGN.SignedDSIGN . unsafeDeserialiseSigDSIGN)
+              (Gen.bytes $ Range.singleton 64)
+    ]
+ where
+  unsafeDeserialiseVerKeyVRF =
+    fromMaybe (error "unsafeDeserialiseVerKeyVRF") . VRF.rawDeserialiseVerKeyVRF
+  unsafeDeserialiseCertVRF =
+    fromMaybe (error "unsafeDeserialiseCertVRF") . VRF.rawDeserialiseCertVRF
+
+  unsafeDeserialiseVerKeyDSIGN =
+    fromMaybe (error "unsafeDeserialiseVerKeyDSIGN") . DSIGN.rawDeserialiseVerKeyDSIGN
+  unsafeDeserialiseSigDSIGN =
+    fromMaybe (error "unsafeDeserialiseSigDSIGN") . DSIGN.rawDeserialiseSigDSIGN
diff --git a/cardano-api/src/Cardano/Api.hs b/cardano-api/src/Cardano/Api.hs
@@ -334,10 +334,14 @@ module Cardano.Api (
     -- * Transaction metadata
     -- | Embedding additional structured data within transactions.
     TxMetadata(..),
+    AsTxMetadata(..),
 
     -- ** Constructing metadata
     TxMetadataValue(..),
     makeTransactionMetadata,
+    mergeTransactionMetadata,
+    metaTextChunks,
+    metaBytesChunks,
 
     -- ** Validating metadata
     validateTxMetadata,