-
Notifications
You must be signed in to change notification settings - Fork 158
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- round trip test for translating exunits to/from plutus - test whether evaluateTransactionExecutionUnits provides enough exUnits - fixed ex unit translation
- Loading branch information
Showing
6 changed files
with
215 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| {-# LANGUAGE BangPatterns #-} | ||
| {-# LANGUAGE DataKinds #-} | ||
| {-# LANGUAGE RankNTypes #-} | ||
| {-# LANGUAGE TypeApplications #-} | ||
|
|
||
| module Test.Cardano.Ledger.Alonzo.Tools (tests, testExUnitCalculation) where | ||
|
|
||
| import Cardano.Ledger.Alonzo.Language (Language (..)) | ||
| import Cardano.Ledger.Alonzo.PParams (PParams, PParams' (..), ProtVer (..)) | ||
| import Cardano.Ledger.Alonzo.Rules.Utxos (UTXOS) | ||
| import Cardano.Ledger.Alonzo.Scripts (CostModel, ExUnits (..), defaultCostModel) | ||
| import Cardano.Ledger.Alonzo.Tools (evaluateTransactionExecutionUnits) | ||
| import Cardano.Ledger.Alonzo.Tx | ||
| ( IsValidating (..), | ||
| ValidatedTx (..), | ||
| ) | ||
| import Cardano.Ledger.Alonzo.TxInfo (exBudgetToExUnits, transExUnits) | ||
| import Cardano.Ledger.Alonzo.TxWitness (RdmrPtr, Redeemers (..), txrdmrs) | ||
| import Cardano.Ledger.Coin (Coin (..)) | ||
| import Cardano.Ledger.Keys (GenDelegs (..)) | ||
| import Cardano.Ledger.SafeHash (hashAnnotated) | ||
| import qualified Cardano.Ledger.Tx as Core | ||
| import Cardano.Slotting.EpochInfo (EpochInfo, fixedEpochInfo) | ||
| import Cardano.Slotting.Slot (EpochSize (..), SlotNo (..)) | ||
| import Cardano.Slotting.Time (SystemStart, mkSlotLength) | ||
| import Control.State.Transition.Extended (TRC (..)) | ||
| import Data.Array (Array, array) | ||
| import Data.Default.Class (Default (..)) | ||
| import Data.Map (Map) | ||
| import qualified Data.Map as Map | ||
| import Data.Maybe (fromJust) | ||
| import Data.Word (Word64) | ||
| import GHC.Records (getField) | ||
| import Shelley.Spec.Ledger.LedgerState (UTxOState (..)) | ||
| import Shelley.Spec.Ledger.STS.Utxo (UtxoEnv (..)) | ||
| import Shelley.Spec.Ledger.UTxO (UTxO, makeWitnessVKey) | ||
| import Test.Cardano.Ledger.Examples.TwoPhaseValidation (A, datumExample1, initUTxO, someKeys, testSystemStart, validatingBody, validatingRedeemersEx1) | ||
| import Test.Cardano.Ledger.Generic.Proof (Evidence (Mock), Proof (Alonzo)) | ||
| import Test.Cardano.Ledger.Generic.Updaters | ||
| import Test.Shelley.Spec.Ledger.Utils (applySTSTest, runShelleyBase) | ||
| import Test.Tasty (TestTree, testGroup) | ||
| import Test.Tasty.HUnit (testCase) | ||
| import Test.Tasty.QuickCheck (Gen, Property, chooseBoundedIntegral, counterexample, testProperty) | ||
|
|
||
| tests :: TestTree | ||
| tests = | ||
| testGroup "ExUnit tools" $ | ||
| [ testProperty "Plutus ExUnit translation round-trip" exUnitsTranslationRoundTrip, | ||
| testCase "calculate ExUnits" exampleExUnitCalc | ||
| ] | ||
|
|
||
| genExUnits :: Gen ExUnits | ||
| genExUnits = ExUnits <$> genUnit <*> genUnit | ||
| where | ||
| genUnit :: Gen Word64 | ||
| genUnit = chooseBoundedIntegral (0, 2 ^ (63 :: Word64) - 1) | ||
|
|
||
| -- ExUnits should remain intact when translating to and from the plutus type | ||
| exUnitsTranslationRoundTrip :: Gen Property | ||
| exUnitsTranslationRoundTrip = do | ||
| e <- genExUnits | ||
| let result = (exBudgetToExUnits . transExUnits) e | ||
| pure $ | ||
| counterexample | ||
| ( "Before: " <> show (Just e) | ||
| <> "\n After: " | ||
| <> show result | ||
| ) | ||
| $ result == Just e | ||
|
|
||
| -- checks plutus script validation against a tx which has had | ||
| -- its ex units replaced by the output of evaluateTransactionExecutionUnits | ||
| testExUnitCalculation :: | ||
| MonadFail m => | ||
| Core.Tx A -> | ||
| UTxOState A -> | ||
| UtxoEnv A -> | ||
| EpochInfo m -> | ||
| SystemStart -> | ||
| Array Language CostModel -> | ||
| m () | ||
| testExUnitCalculation tx utxoState ue ei ss costmdls = do | ||
| tx' <- updateTxExUnits tx utxo ei ss costmdls | ||
| _ <- | ||
| failLeft $ | ||
| runShelleyBase $ | ||
| applySTSTest @(UTXOS A) (TRC (ue, utxoState, vtx tx')) | ||
| pure () | ||
| where | ||
| utxo = _utxo utxoState | ||
|
|
||
| -- nonFreeCostModel = CostModel $ 1000 <$ fromJust defaultCostModelParams | ||
|
|
||
| exampleExUnitCalc :: IO () | ||
| exampleExUnitCalc = | ||
| testExUnitCalculation | ||
| exampleTx | ||
| ustate | ||
| uenv | ||
| exampleEpochInfo | ||
| testSystemStart | ||
| costmodels | ||
|
|
||
| exampleTx :: Core.Tx A | ||
| exampleTx = | ||
| let pf = Alonzo Mock | ||
| in newTx | ||
| Override | ||
| pf | ||
| [ Body (validatingBody pf), | ||
| Witnesses' | ||
| [ AddrWits [makeWitnessVKey (hashAnnotated (validatingBody pf)) (someKeys pf)], | ||
| ScriptWits [always 3 pf], | ||
| DataWits [datumExample1], | ||
| RdmrWits validatingRedeemersEx1 | ||
| ] | ||
| ] | ||
|
|
||
| exampleEpochInfo :: Monad m => EpochInfo m | ||
| exampleEpochInfo = fixedEpochInfo (EpochSize 100) (mkSlotLength 1) | ||
|
|
||
| uenv :: UtxoEnv A | ||
| uenv = UtxoEnv (SlotNo 0) pparams mempty (GenDelegs mempty) | ||
|
|
||
| costmodels :: Array Language CostModel | ||
| costmodels = array (PlutusV1, PlutusV1) [(PlutusV1, fromJust defaultCostModel)] | ||
|
|
||
| ustate :: UTxOState A | ||
| ustate = | ||
| UTxOState | ||
| { _utxo = initUTxO (Alonzo Mock), | ||
| _deposited = Coin 0, | ||
| _fees = Coin 0, | ||
| _ppups = def | ||
| } | ||
|
|
||
| -- Requires ex units, but there are no fees | ||
| pparams :: PParams A | ||
| pparams = | ||
| newPParams | ||
| (Alonzo Mock) | ||
| [ Costmdls $ Map.singleton PlutusV1 $ fromJust defaultCostModel, | ||
| MaxValSize 1000000000, | ||
| MaxTxExUnits $ ExUnits 100000000 100000000, | ||
| MaxBlockExUnits $ ExUnits 100000000 100000000, | ||
| ProtocolVersion $ ProtVer 5 0 | ||
| ] | ||
|
|
||
| updateTxExUnits :: | ||
| MonadFail m => | ||
| Core.Tx A -> | ||
| UTxO A -> | ||
| EpochInfo m -> | ||
| SystemStart -> | ||
| Array Language CostModel -> | ||
| m (Core.Tx A) | ||
| updateTxExUnits tx utxo ei ss costmdls = do | ||
| -- rdmrs :: Map RdmrPtr ExUnits | ||
| rdmrs <- | ||
| traverse failLeft | ||
| =<< evaluateTransactionExecutionUnits tx utxo ei ss costmdls | ||
| pure (replaceRdmrs tx rdmrs) | ||
|
|
||
| replaceRdmrs :: Core.Tx A -> Map RdmrPtr ExUnits -> Core.Tx A | ||
| replaceRdmrs tx rdmrs = tx {Core.wits = wits'} | ||
| where | ||
| wits' = (Core.wits tx) {txrdmrs = newrdmrs} | ||
| newrdmrs = foldr replaceRdmr (txrdmrs (Core.wits tx)) (Map.assocs rdmrs) | ||
|
|
||
| replaceRdmr :: (RdmrPtr, ExUnits) -> Redeemers A -> Redeemers A | ||
| replaceRdmr (ptr, ex) x@(Redeemers r) = | ||
| case Map.lookup ptr r of | ||
| Just (dat, _ex) -> Redeemers $ Map.insert ptr (dat, ex) r | ||
| Nothing -> x | ||
|
|
||
| failLeft :: MonadFail m => Show e => Either e a -> m a | ||
| failLeft (Right a) = pure a | ||
| failLeft (Left e) = fail (show e) | ||
|
|
||
| vtx :: Core.Tx A -> ValidatedTx A | ||
| vtx tx = | ||
| ValidatedTx | ||
| { body = getField @"body" tx, | ||
| wits = getField @"wits" tx, | ||
| isValidating = IsValidating True, | ||
| auxiliaryData = getField @"auxiliaryData" tx | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters