Add BLS tests

.gitignore

@@ -111,3 +111,4 @@ plutus-pab/test-node/alonzo-purple/db
 
 # Test results
 **/test-report-xml
+**/allure-report

README.md

@@ -4,14 +4,14 @@
 </div>
 
 
-Antaeus is an end-to-end testing framework designed for Cardano Haskell APIs. It leverages [cardano-testnet](https://github.com/input-output-hk/cardano-node/tree/master/cardano-testnet) to configure and launch a local Cardano testnet, and [cardano-api](https://github.com/input-output-hk/cardano-node/tree/master/cardano-api) to build transactions and query the ledger state. The primary focus of these tests is on functionality involving Plutus scripts.
+Antaeus is a framework for end-to-end testing Cardano Haskell APIs. It leverages [cardano-testnet](https://github.com/input-output-hk/cardano-node/tree/master/cardano-testnet) to configure and launch a local Cardano testnet, and [cardano-api](https://github.com/input-output-hk/cardano-node/tree/master/cardano-api) to build transactions and query the ledger state. The primary focus of these tests is on functionality involving Plutus scripts.
 
 
-Tests can be executed on either private or public testnets. They are grouped by target protocol version (e.g. Babbage PV8) and share each instance of testnet during execution.
+Tests can be executed on either a local private testnet or any public network. They are grouped by target protocol version (e.g. Babbage PV8) and share an instance of private testnet for faster execution.
 
 #### How to run on private testnet
 
-By default, tests are configured to run in a local environment for their supported protocol version.
+By default, tests are configured to run on local private testnet environments with their supported protocol version.
 1. Optionally, enter `nix develop` shell for dependencies.
 2. Run `cabal build all`
 3. Run `cabal test e2e-tests`
@@ -32,9 +32,12 @@ Check these preconditions before following the private testnet steps above.
 
 ### Status
 
-Antaeus is currently under development, with a growing suite of tests covering:
+Antaeus has a growing suite of tests covering:
 
-- Plutus built-in functions `verifySchnorrSecp256k1Signature` and `verifyEcdsaSecp256k1Signature` across different protocol versions and expected outcomes (success or specific errors).
+- Plutus built-in functions:
+  - `verifySchnorrSecp256k1Signature` and `verifyEcdsaSecp256k1Signature` across different protocol versions and expected outcomes (success or specific errors).
+  - All 17 BLS builtin functions (e.g. `bls12_381_finalVerify`)
+  - All builtin hashing functions (e.g. `sha2_256`)
 - Spending locked funds using reference scripts, reference inputs, and providing datum as witness in the transaction body.
 - Minting tokens using reference scripts and providing script witness in the transaction body.
 - Examining each field in Plutus V1 and V2 `TxInfo`.
@@ -50,6 +53,7 @@ Run `allure serve <test-report-xml>` to generate and host the Allure report.
 
 We're working on adding the following features to Antaeus:
 
+- Voltaire governance actions (coming in Conway era using PlutusV3 language version)
 - CI execution with private testnet on commit (nix configuration coming soon).
 - Nightly CI test execution would be useful in public environments.
 

cabal.project

@@ -13,8 +13,8 @@ repository cardano-haskell-packages
 
 -- See CONTRIBUTING.adoc for how to update index-state
 index-state:
-  , hackage.haskell.org 2023-09-11T11:11:00Z
-  , cardano-haskell-packages 2023-09-11T11:11:00Z
+  , hackage.haskell.org 2023-09-15T11:11:00Z
+  , cardano-haskell-packages 2023-09-15T11:11:00Z
 packages: e2e-tests
 
 -- We never, ever, want this.
@@ -52,7 +52,7 @@ constraints:
 source-repository-package
     type: git
     location: https://github.com/james-iohk/cardano-node
-    tag: c9f0d2fdfc7b5a088252aafdd8594d1a542eed22
+    tag: 5e895e5f65fe9801caae47222f2b4a642c682d5d
     subdir:
       cardano-testnet
 

e2e-tests/e2e-tests.cabal

@@ -122,6 +122,26 @@ test-suite antaeus-test
     PlutusScripts.Always.Common
     PlutusScripts.Always.V_1_0
     PlutusScripts.Always.V_1_1
+    PlutusScripts.BLS
+    PlutusScripts.BLS.AggregateSigWithMultipleKeys.Common
+    PlutusScripts.BLS.AggregateSigWithMultipleKeys.V_1_1
+    PlutusScripts.BLS.AggregateSigWithSingleKey.Common
+    PlutusScripts.BLS.AggregateSigWithSingleKey.V_1_1
+    PlutusScripts.BLS.Common
+    PlutusScripts.BLS.Groth16.Common
+    PlutusScripts.BLS.Groth16.V_1_1
+    PlutusScripts.BLS.SchnorrG1.Common
+    PlutusScripts.BLS.SchnorrG1.V_1_1
+    PlutusScripts.BLS.SchnorrG2.Common
+    PlutusScripts.BLS.SchnorrG2.V_1_1
+    PlutusScripts.BLS.SimpleSignAndVerify.Common
+    PlutusScripts.BLS.SimpleSignAndVerify.V_1_1
+    PlutusScripts.BLS.VerifyOverG1.Common
+    PlutusScripts.BLS.VerifyOverG1.V_1_1
+    PlutusScripts.BLS.VerifyOverG2.Common
+    PlutusScripts.BLS.VerifyOverG2.V_1_1
+    PlutusScripts.BLS.Vrf.Common
+    PlutusScripts.BLS.Vrf.V_1_1
     PlutusScripts.Hashing.Common
     PlutusScripts.Hashing.V_1_0
     PlutusScripts.Hashing.V_1_1
@@ -133,6 +153,8 @@ test-suite antaeus-test
     PlutusScripts.V2TxInfo
     Spec.AlonzoFeatures
     Spec.BabbageFeatures
+    Spec.Builtins
+    Spec.Builtins.BLS
     Spec.Builtins.Hashing
     Spec.Builtins.SECP256k1
 

e2e-tests/test/PlutusScripts/BLS.hs

@@ -0,0 +1,16 @@
+{-# OPTIONS_GHC -Wno-missing-import-lists #-}
+
+-- | Reexports from modules from the 'BLS' folder
+module PlutusScripts.BLS (
+  module Export,
+) where
+
+import PlutusScripts.BLS.AggregateSigWithMultipleKeys.V_1_1 as Export
+import PlutusScripts.BLS.AggregateSigWithSingleKey.V_1_1 as Export
+import PlutusScripts.BLS.Groth16.V_1_1 as Export
+import PlutusScripts.BLS.SchnorrG1.V_1_1 as Export
+import PlutusScripts.BLS.SchnorrG2.V_1_1 as Export
+import PlutusScripts.BLS.SimpleSignAndVerify.V_1_1 as Export
+import PlutusScripts.BLS.VerifyOverG1.V_1_1 as Export
+import PlutusScripts.BLS.VerifyOverG2.V_1_1 as Export
+import PlutusScripts.BLS.Vrf.V_1_1 as Export

e2e-tests/test/PlutusScripts/BLS/AggregateSigWithMultipleKeys/Common.hs

@@ -0,0 +1,191 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DerivingStrategies #-}
+{-# LANGUAGE NumericUnderscores #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TemplateHaskell #-}
+{-# LANGUAGE TypeApplications #-}
+{-# HLINT ignore "Use underscore" #-}
+{-# LANGUAGE ViewPatterns #-}
+{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
+-- Not using all CardanoEra
+{-# OPTIONS_GHC -fno-warn-incomplete-patterns #-}
+
+module PlutusScripts.BLS.AggregateSigWithMultipleKeys.Common where
+
+import PlutusScripts.BLS.Common (byteStringToInteger)
+import PlutusScripts.Helpers (
+  bytesFromHex,
+ )
+import PlutusTx qualified
+import PlutusTx.Prelude qualified as P
+
+data BlsParams = BlsParams
+  { message :: P.BuiltinByteString
+  , pubKeys :: [P.BuiltinByteString]
+  , aggregateSignature :: P.BuiltinByteString
+  }
+PlutusTx.unstableMakeIsData ''BlsParams
+
+redeemerParams :: BlsParams
+redeemerParams =
+  BlsParams
+    { message =
+        P.toBuiltin $
+          bytesFromHex
+            "e345b7f2c017b16bb335c696bc0cc302f3db897fa25365a2ead1f149d87a97e8"
+    , pubKeys =
+        [ P.toBuiltin $
+            bytesFromHex
+              ( "83718f20d08471565b3a6ca6ea82c1928e8730f87e2afe460b74842f2880facd8e63b8abcdcd7350fe5813a08aa0efed"
+                  <> "13216b10de1c56dc059c3a8910bd97ae133046ae031d2a53a44e460ab71ebda94bab64ed7478cf1a91b6d3981e32fc95"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "814f825911bd066855333b74a3cc564d512503ee29ea1ec3bd57a3c07fa5768ad27ea1ddd8047f43fbc9a4ebda897c14"
+                  <> "06415fefbb8838b8782aa747e2fde7b1813d0f89fad06c8971041c9427abf848503e34e3ca033ba85d50b72ffac4be4a"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "9974c70513ed5538a8e55f5ce1a0267282b9e8431e25ae566950b2d0793a44a0a3c52110f4d83d694a5296615ee68573"
+                  <> "098c14d255783a9b1a169d2be1baefbef914a4f830a9099f720063914cc919064d2244582bb9f302eac39c8b195cf3d2"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "894a3a01d38169a38bea13097cf904dd3ff9dceefb51e8b539725a237ae55a361758be1cdf0e21a7b8db3599adaf2305"
+                  <> "050f1d8450b924a4b910ff536fc2f7960cd3251c2a457b975d46f7c0f74493cc9b5e8d2fed2e489363e641cc79933d1e"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "9646da0149ed140e33a99e1ffc5fe9c97c2368ca273544024993cdcb7aa04c0be936e6d4427747e62c4caea4fe1f69e5"
+                  <> "162fad222e0487f5556524c9d3db74921e1c0f5893f0e26c759e3873e8fd6637e6051f70ef9a3363cf284e8eee67bcf3"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "b75743fb2f8321ac56cee19aacd7e141a3592b7230992ea84d8800d45ad71924a477f61cf9d4a2783df59dac21cd17e7"
+                  <> "0e4ce5d526cbe73edc4a10b78fa56a2ef34d2009f2756d2d50188031e026a6a1dadcd5e753f5e7f7276048277d3819f1"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "873c1e7d525265afa8c037d33874261a90daaa2c6ed5e46ed043ec48a28b7111d0de65800aa72448c1fdb1026ba076bd"
+                  <> "04193bd2d04e0de63e7a008b8417420eb4920767a1d32f6330ed25bdb4dc7726d989d6cf192db6b32728bb388195ba27"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "b993f867f9f1f84c3c5c3e5b80013055da7705491c36a80e1201a6a503d7364000c50bc27e03477646874a3074cc4e39"
+                  <> "0febfea78a2b4d0e40c57d6deaf9fae430a19fcce0c03f43ff8f7e788de0c7b8ce1b69b69d1d026175c8f2730777866d"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "99836a204576636f34a4663cfa7e02a05cb2d4fd1b582427d199ac3ddac6f087968d2290198aa15e04f6e7e0d070b7dd"
+                  <> "03607db9c2e4b17709853c30b2f6490261599408fbbc17371de74d0a2a76ff10cd8c9b55461c444bbebc82547bb40c9f"
+              )
+        , P.toBuiltin $
+            bytesFromHex
+              ( "96f8d678f40dd83b2060e14372d0bc43a423fecac44f082afd89cb481b855885ac83fb366516dc74023cc41a0c606be2"
+                  <> "067ba826ea612f84c9f0e895d02bc04d6c34e201ff8c26cc22cb4c426c53f503d8948eafceb12e2f4b6ad49b4e051690"
+              )
+        ]
+    , aggregateSignature =
+        P.toBuiltin $
+          bytesFromHex
+            ( "b24d876661d0d1190c796bf7eaa7e02b807ff603093b1733"
+                <> "6289d4de0477f6c17afb487275cb9de44325016edfeda042"
+            )
+    }
+
+---- BLS aggregate signature with different keys and same message with public key over G2 ----
+
+{-
+-- * hashed_msg = G1HashToCurve(msg, "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_NUL_")
+-- * pk_deser_i = G1Decompress(pk_i) for i in [1, 10]
+-- * ds_scalar = SHA256(pk_1 || .. || pk_10)[..16] (where [..16] represent the first 16 bytes)
+-- * aggr_sig_deser = G2Decompress(aggr_sig)
+-- * aggr_pk = sum_{i\in[1,10]} ds_scalar^i * pk_deser_i
+-- * Check that pairing(aggr_pk, hashed_msg) = pairing(G1Generator, aggr_sig_deser)
+-}
+{-# INLINEABLE aggregateMultiKeyG2Script #-}
+aggregateMultiKeyG2Script
+  :: P.BuiltinByteString
+  -> P.BuiltinByteString
+  -> BlsParams
+  -> sc
+  -> Bool
+aggregateMultiKeyG2Script bs16Null dst BlsParams{..} _sc = do
+  let
+    hashedMsg = P.bls12_381_G1_hashToGroup message dst
+    pksDeser = P.map P.bls12_381_G2_uncompress pubKeys
+    -- scalar calcuates to (142819114285630344964654001480828217341 :: Integer)
+    dsScalar =
+      byteStringToInteger
+        ( P.sliceByteString
+            0
+            16
+            (P.sha2_256 (foldl1' P.appendByteString pubKeys))
+            `P.appendByteString` bs16Null
+        )
+    aggrSigDeser = P.bls12_381_G1_uncompress aggregateSignature
+    aggrPk = calcAggregatedPubkeys dsScalar pksDeser
+
+  P.bls12_381_finalVerify
+    (P.bls12_381_millerLoop hashedMsg aggrPk)
+    (P.bls12_381_millerLoop aggrSigDeser P.bls12_381_G2_generator)
+  where
+    -- PlutusTx.Foldable has no foldl1
+    foldl1' :: (a -> a -> a) -> [a] -> a
+    foldl1' _ [] = P.traceError "foldr1: empty list"
+    foldl1' _ [_] = P.traceError "foldr1: only one element in list"
+    foldl1' f (x : xs) = P.foldl f x xs
+
+    calcAggregatedPubkeys :: Integer -> [P.BuiltinBLS12_381_G2_Element] -> P.BuiltinBLS12_381_G2_Element
+    calcAggregatedPubkeys dsScalar' pksDeser' = do
+      let dsScalars = calcDsScalars pksDeser' [dsScalar']
+      go
+        1
+        (P.drop 1 pksDeser')
+        (P.drop 1 dsScalars)
+        (calcAggregatedPubkey (P.head pksDeser') (P.head dsScalars))
+
+    calcDsScalars :: [P.BuiltinBLS12_381_G2_Element] -> [Integer] -> [Integer]
+    calcDsScalars [] acc = acc
+    calcDsScalars (_ : xs) [x'] = calcDsScalars xs [x', x' P.* x']
+    calcDsScalars (_ : xs) acc@(x' : xs') = calcDsScalars xs (acc P.++ [last' xs' P.* x'])
+    calcDsScalars _ _ = P.traceError "calcDsScalars: unexpected"
+
+    go
+      :: Integer
+      -> [P.BuiltinBLS12_381_G2_Element]
+      -> [Integer]
+      -> P.BuiltinBLS12_381_G2_Element
+      -> P.BuiltinBLS12_381_G2_Element
+    go _ [] _ acc = acc
+    go i (x : xs) (x' : xs') acc = go (i P.+ 1) xs xs' (acc `P.bls12_381_G2_add` (calcAggregatedPubkey x x'))
+    go _ _ _ _ = P.traceError "go: unexpected"
+
+    calcAggregatedPubkey :: P.BuiltinBLS12_381_G2_Element -> Integer -> P.BuiltinBLS12_381_G2_Element
+    calcAggregatedPubkey pk ds = ds `P.bls12_381_G2_scalarMul` pk
+
+    -- PlutusTx.Prelude has no last
+    last' :: [a] -> a
+    last' [] = P.traceError "last: needs at least two elements"
+    last' [x] = x
+    last' (_ : xs) = last' xs
+
+{- An alternative implementation of calcAggregatedPubkeys which uses a different
+-- means of scalar exponentiation. It results in a slightly smaller script using less CPU but
+-- considerably more memory, so the overall cost is a greater.
+-- Worth keeping for reference because it is simpler and more readble than the implementation used above.
+-}
+--      calcAggregatedPubkeys dsScalar' pksDeser' =
+--        go 1 (drop 1 pksDeser') (calc (head pksDeser') 0)
+--        where
+--          calc pk i = (dsScalar' `power` (i + 1)) `Tx.bls12_381_G2_scalarMul` pk
+--          go _ [] acc     = acc
+--          go i (x:xs) acc = go (i + 1) xs (acc `Tx.bls12_381_G2_add` (calc x i))
+--
+--      power :: Integer -> Integer -> Integer
+--      power x n
+--        | n == 0 = 1
+--        | n > 0 = x * power x (n - 1)
+--        | otherwise = 0

e2e-tests/test/PlutusScripts/BLS/AggregateSigWithMultipleKeys/V_1_1.hs

@@ -0,0 +1,56 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE NumericUnderscores #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TemplateHaskell #-}
+{-# LANGUAGE TypeApplications #-}
+-- Not using all CardanoEra
+{-# OPTIONS_GHC -fno-warn-incomplete-patterns #-}
+{-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:target-version=1.1.0 #-}
+
+module PlutusScripts.BLS.AggregateSigWithMultipleKeys.V_1_1 where
+
+import Cardano.Api qualified as C
+import Cardano.Api.Shelley qualified as C
+import Helpers.ScriptUtils (IsScriptContext (mkUntypedMintingPolicy))
+import PlutusCore.Core qualified as PLC
+import PlutusLedgerApi.Common (SerialisedScript, serialiseCompiledCode)
+import PlutusLedgerApi.V3 qualified as PlutusV3
+import PlutusScripts.BLS.AggregateSigWithMultipleKeys.Common (
+  aggregateMultiKeyG2Script,
+  redeemerParams,
+ )
+import PlutusScripts.BLS.Common (blsAssetName, blsSigBls12381G2XmdSha256SswuRoNul, byteString16Null)
+import PlutusScripts.Helpers qualified as H
+import PlutusTx qualified
+
+verifyBlsAggregateSigMultiKeyG2PolicyV3 :: SerialisedScript
+verifyBlsAggregateSigMultiKeyG2PolicyV3 =
+  serialiseCompiledCode $
+    $$( PlutusTx.compile
+          [||\a b -> mkUntypedMintingPolicy @PlutusV3.ScriptContext (aggregateMultiKeyG2Script a b)||]
+      )
+      `PlutusTx.unsafeApplyCode` PlutusTx.liftCode PLC.plcVersion110 byteString16Null
+      `PlutusTx.unsafeApplyCode` PlutusTx.liftCode PLC.plcVersion110 blsSigBls12381G2XmdSha256SswuRoNul
+
+verifyBlsAggregateSigMultiKeyG2PolicyScriptV3 :: C.PlutusScript C.PlutusScriptV3
+verifyBlsAggregateSigMultiKeyG2PolicyScriptV3 = C.PlutusScriptSerialised verifyBlsAggregateSigMultiKeyG2PolicyV3
+
+verifyBlsAggregateSigMultiKeyG2AssetIdV3 :: C.AssetId
+verifyBlsAggregateSigMultiKeyG2AssetIdV3 = C.AssetId (H.policyIdV3 verifyBlsAggregateSigMultiKeyG2PolicyV3) blsAssetName
+
+verifyBlsAggregateSigMultiKeyG2Redeemer :: C.HashableScriptData
+verifyBlsAggregateSigMultiKeyG2Redeemer = H.toScriptData redeemerParams
+
+verifyBlsAggregateSigMultiKeyG2MintWitnessV3
+  :: C.CardanoEra era
+  -> (C.PolicyId, C.ScriptWitness C.WitCtxMint era)
+verifyBlsAggregateSigMultiKeyG2MintWitnessV3 era =
+  ( H.policyIdV3 verifyBlsAggregateSigMultiKeyG2PolicyV3
+  , H.mintScriptWitness
+      era
+      H.plutusL3
+      (Left verifyBlsAggregateSigMultiKeyG2PolicyScriptV3)
+      verifyBlsAggregateSigMultiKeyG2Redeemer
+  )