cardano-ledger-test-9.9.9.9: Testing harness, tests and benchmarks for Shelley style cardano ledgers
Safe HaskellNone
LanguageHaskell2010

Test.Cardano.Ledger.Examples.STSTestUtils

Synopsis

Documentation

class EraTest era ⇒ EraModel era where Source #

Minimal complete definition

applyTx, applyCert, always, never, collateralReturnTxBodyT, validTxOut

Methods

applyTx ∷ Int → SlotNo → Model era → Tx 'TopTx era → Model era Source #

applyCert ∷ Model era → TxCert era → Model era Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data era, ExUnits))] → Redeemers era Source #

mkRedeemers ∷ [(PlutusPurpose AsIx era, (Data era, ExUnits))] → Redeemers era Source #

newScriptIntegrityHash ∷ PParams era → [Language] → Redeemers era → TxDats era → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx era Source #

always ∷ Natural → Script era Source #

never ∷ Natural → Script era Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx era) (StrictMaybe (TxOut era)) Source #

validTxOut ∷ Map ScriptHash (Script era) → TxOut era → Bool Source #

Instances

Instances details
EraModel AllegraEra Source # 
Instance details

Defined in Test.Cardano.Ledger.Generic.Instances

Methods

applyTx ∷ Int → SlotNo → Model AllegraEra → Tx 'TopTx AllegraEra → Model AllegraEra Source #

applyCert ∷ Model AllegraEra → TxCert AllegraEra → Model AllegraEra Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data AllegraEra, ExUnits))] → Redeemers AllegraEra Source #

mkRedeemers ∷ [(PlutusPurpose AsIx AllegraEra, (Data AllegraEra, ExUnits))] → Redeemers AllegraEra Source #

newScriptIntegrityHash ∷ PParams AllegraEra → [Language] → Redeemers AllegraEra → TxDats AllegraEra → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx AllegraEra Source #

always ∷ Natural → Script AllegraEra Source #

never ∷ Natural → Script AllegraEra Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx AllegraEra) (StrictMaybe (TxOut AllegraEra)) Source #

validTxOut ∷ Map ScriptHash (Script AllegraEra) → TxOut AllegraEra → Bool Source #

EraModel AlonzoEra Source # 
Instance details

Defined in Test.Cardano.Ledger.Generic.Instances

Methods

applyTx ∷ Int → SlotNo → Model AlonzoEra → Tx 'TopTx AlonzoEra → Model AlonzoEra Source #

applyCert ∷ Model AlonzoEra → TxCert AlonzoEra → Model AlonzoEra Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data AlonzoEra, ExUnits))] → Redeemers AlonzoEra Source #

mkRedeemers ∷ [(PlutusPurpose AsIx AlonzoEra, (Data AlonzoEra, ExUnits))] → Redeemers AlonzoEra Source #

newScriptIntegrityHash ∷ PParams AlonzoEra → [Language] → Redeemers AlonzoEra → TxDats AlonzoEra → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx AlonzoEra Source #

always ∷ Natural → Script AlonzoEra Source #

never ∷ Natural → Script AlonzoEra Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx AlonzoEra) (StrictMaybe (TxOut AlonzoEra)) Source #

validTxOut ∷ Map ScriptHash (Script AlonzoEra) → TxOut AlonzoEra → Bool Source #

EraModel BabbageEra Source # 
Instance details

Defined in Test.Cardano.Ledger.Generic.Instances

Methods

applyTx ∷ Int → SlotNo → Model BabbageEra → Tx 'TopTx BabbageEra → Model BabbageEra Source #

applyCert ∷ Model BabbageEra → TxCert BabbageEra → Model BabbageEra Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data BabbageEra, ExUnits))] → Redeemers BabbageEra Source #

mkRedeemers ∷ [(PlutusPurpose AsIx BabbageEra, (Data BabbageEra, ExUnits))] → Redeemers BabbageEra Source #

newScriptIntegrityHash ∷ PParams BabbageEra → [Language] → Redeemers BabbageEra → TxDats BabbageEra → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx BabbageEra Source #

always ∷ Natural → Script BabbageEra Source #

never ∷ Natural → Script BabbageEra Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx BabbageEra) (StrictMaybe (TxOut BabbageEra)) Source #

validTxOut ∷ Map ScriptHash (Script BabbageEra) → TxOut BabbageEra → Bool Source #

EraModel ConwayEra Source # 
Instance details

Defined in Test.Cardano.Ledger.Generic.Instances

Methods

applyTx ∷ Int → SlotNo → Model ConwayEra → Tx 'TopTx ConwayEra → Model ConwayEra Source #

applyCert ∷ Model ConwayEra → TxCert ConwayEra → Model ConwayEra Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data ConwayEra, ExUnits))] → Redeemers ConwayEra Source #

mkRedeemers ∷ [(PlutusPurpose AsIx ConwayEra, (Data ConwayEra, ExUnits))] → Redeemers ConwayEra Source #

newScriptIntegrityHash ∷ PParams ConwayEra → [Language] → Redeemers ConwayEra → TxDats ConwayEra → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx ConwayEra Source #

always ∷ Natural → Script ConwayEra Source #

never ∷ Natural → Script ConwayEra Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx ConwayEra) (StrictMaybe (TxOut ConwayEra)) Source #

validTxOut ∷ Map ScriptHash (Script ConwayEra) → TxOut ConwayEra → Bool Source #

EraModel MaryEra Source # 
Instance details

Defined in Test.Cardano.Ledger.Generic.Instances

Methods

applyTx ∷ Int → SlotNo → Model MaryEra → Tx 'TopTx MaryEra → Model MaryEra Source #

applyCert ∷ Model MaryEra → TxCert MaryEra → Model MaryEra Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data MaryEra, ExUnits))] → Redeemers MaryEra Source #

mkRedeemers ∷ [(PlutusPurpose AsIx MaryEra, (Data MaryEra, ExUnits))] → Redeemers MaryEra Source #

newScriptIntegrityHash ∷ PParams MaryEra → [Language] → Redeemers MaryEra → TxDats MaryEra → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx MaryEra Source #

always ∷ Natural → Script MaryEra Source #

never ∷ Natural → Script MaryEra Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx MaryEra) (StrictMaybe (TxOut MaryEra)) Source #

validTxOut ∷ Map ScriptHash (Script MaryEra) → TxOut MaryEra → Bool Source #

EraModel ShelleyEra Source # 
Instance details

Defined in Test.Cardano.Ledger.Generic.Instances

Methods

applyTx ∷ Int → SlotNo → Model ShelleyEra → Tx 'TopTx ShelleyEra → Model ShelleyEra Source #

applyCert ∷ Model ShelleyEra → TxCert ShelleyEra → Model ShelleyEra Source #

mkRedeemersFromTags ∷ [((PlutusPurposeTag, Word32), (Data ShelleyEra, ExUnits))] → Redeemers ShelleyEra Source #

mkRedeemers ∷ [(PlutusPurpose AsIx ShelleyEra, (Data ShelleyEra, ExUnits))] → Redeemers ShelleyEra Source #

newScriptIntegrityHash ∷ PParams ShelleyEra → [Language] → Redeemers ShelleyEra → TxDats ShelleyEra → StrictMaybe ScriptIntegrityHash Source #

mkPlutusPurposePointer ∷ PlutusPurposeTag → Word32 → PlutusPurpose AsIx ShelleyEra Source #

always ∷ Natural → Script ShelleyEra Source #

never ∷ Natural → Script ShelleyEra Source #

collateralReturnTxBodyT ∷ Lens' (TxBody 'TopTx ShelleyEra) (StrictMaybe (TxOut ShelleyEra)) Source #

validTxOut ∷ Map ScriptHash (Script ShelleyEra) → TxOut ShelleyEra → Bool Source #

data PlutusPurposeTag Source #

Constructors

Spending 
Minting 
Certifying 
Rewarding 
Voting 
Proposing 

Instances

Instances details
Bounded PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Methods

minBound ∷ PlutusPurposeTag #

maxBound ∷ PlutusPurposeTag #

Enum PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Methods

succ ∷ PlutusPurposeTag → PlutusPurposeTag #

pred ∷ PlutusPurposeTag → PlutusPurposeTag #

toEnum ∷ Int → PlutusPurposeTag #

fromEnum ∷ PlutusPurposeTag → Int #

enumFrom ∷ PlutusPurposeTag → [PlutusPurposeTag] #

enumFromThen ∷ PlutusPurposeTag → PlutusPurposeTag → [PlutusPurposeTag] #

enumFromTo ∷ PlutusPurposeTag → PlutusPurposeTag → [PlutusPurposeTag] #

enumFromThenTo ∷ PlutusPurposeTag → PlutusPurposeTag → PlutusPurposeTag → [PlutusPurposeTag] #

Generic PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Associated Types

type Rep PlutusPurposeTag 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

type Rep PlutusPurposeTag = D1 ('MetaData "PlutusPurposeTag" "Test.Cardano.Ledger.Examples.STSTestUtils" "cardano-ledger-test-9.9.9.9-inplace" 'False) ((C1 ('MetaCons "Spending" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "Minting" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Certifying" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "Rewarding" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "Voting" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Proposing" 'PrefixI 'False) (U1 ∷ Type → Type))))

Methods

from ∷ PlutusPurposeTag → Rep PlutusPurposeTag x #

to ∷ Rep PlutusPurposeTag x → PlutusPurposeTag #

Show PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Methods

showsPrec ∷ Int → PlutusPurposeTag → ShowS #

show ∷ PlutusPurposeTag → String #

showList ∷ [PlutusPurposeTag] → ShowS #

Eq PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Methods

(==) ∷ PlutusPurposeTag → PlutusPurposeTag → Bool #

(/=) ∷ PlutusPurposeTag → PlutusPurposeTag → Bool #

Ord PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Methods

compare ∷ PlutusPurposeTag → PlutusPurposeTag → Ordering #

(<) ∷ PlutusPurposeTag → PlutusPurposeTag → Bool #

(<=) ∷ PlutusPurposeTag → PlutusPurposeTag → Bool #

(>) ∷ PlutusPurposeTag → PlutusPurposeTag → Bool #

(>=) ∷ PlutusPurposeTag → PlutusPurposeTag → Bool #

max ∷ PlutusPurposeTag → PlutusPurposeTag → PlutusPurposeTag #

min ∷ PlutusPurposeTag → PlutusPurposeTag → PlutusPurposeTag #

ToExpr PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

Methods

toExpr ∷ PlutusPurposeTag → Expr Source #

listToExpr ∷ [PlutusPurposeTag] → Expr Source #

type Rep PlutusPurposeTag Source # 
Instance details

Defined in Test.Cardano.Ledger.Examples.STSTestUtils

type Rep PlutusPurposeTag = D1 ('MetaData "PlutusPurposeTag" "Test.Cardano.Ledger.Examples.STSTestUtils" "cardano-ledger-test-9.9.9.9-inplace" 'False) ((C1 ('MetaCons "Spending" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "Minting" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Certifying" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "Rewarding" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "Voting" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "Proposing" 'PrefixI 'False) (U1 ∷ Type → Type))))

initUTxO ∷ (AllegraEraScript era, AlonzoEraTxOut era, EraModel era) ⇒ UTxO era Source #

mkGenesisTxIn ∷ HasCallStack ⇒ Integer → TxIn Source #

mkTxDats ∷ Era era ⇒ Data era → TxDats era Source #

mkSingleRedeemer ∷ AlonzoEraScript era ⇒ PlutusPurpose AsIx era → Data era → Redeemers era Source #

someAddr ∷ Addr Source #

someKeys ∷ KeyPair 'Payment Source #

someScriptAddr ∷ EraScript era ⇒ Script era → Addr Source #

testBBODY ∷ (HasCallStack, Eq (State (EraRule "LEDGERS" era)), ToExpr (PredicateFailure (EraRule "BBODY" era)), ToExpr (State (EraRule "LEDGERS" era)), BaseM (EraRule "BBODY" era) ~ ShelleyBase, Environment (EraRule "BBODY" era) ~ BbodyEnv era, State (EraRule "BBODY" era) ~ ShelleyBbodyState era, Signal (EraRule "BBODY" era) ~ Block BHeaderView era, STS (EraRule "BBODY" era)) ⇒ ShelleyBbodyState era → Block BHeaderView era → Either (NonEmpty (PredicateFailure (EraRule "BBODY" era))) (ShelleyBbodyState era) → PParams era → Expectation Source #

runLEDGER ∷ (BaseM (EraRule "LEDGER" era) ~ ShelleyBase, STS (EraRule "LEDGER" era), Environment (EraRule "LEDGER" era) ~ LedgerEnv era, State (EraRule "LEDGER" era) ~ LedgerState era, Tx 'TopTx era ~ Signal (EraRule "LEDGER" era)) ⇒ LedgerState era → PParams era → Tx 'TopTx era → Either (NonEmpty (PredicateFailure (EraRule "LEDGER" era))) (State (EraRule "LEDGER" era)) Source #

testUTXOW ∷ (Reflect era, HasCallStack, ShelleyEraTest era, BaseM (EraRule "UTXOW" era) ~ ShelleyBase, Environment (EraRule "UTXOW" era) ~ UtxoEnv era, STS (EraRule "UTXOW" era), Tx 'TopTx era ~ Signal (EraRule "UTXOW" era), State (EraRule "UTXOW" era) ~ UTxOState era, ToExpr (PredicateFailure (EraRule "UTXOW" era))) ⇒ UTxO era → PParams era → Tx 'TopTx era → Either (NonEmpty (PredicateFailure (EraRule "UTXOW" era))) (State (EraRule "UTXOW" era)) → Expectation Source #

Use an equality test on the expected and computed [PredicateFailure]

testUTXOWsubset ∷ (Reflect era, BaseM (EraRule "UTXOW" era) ~ ShelleyBase, Environment (EraRule "UTXOW" era) ~ UtxoEnv era, State (EraRule "UTXOW" era) ~ UTxOState era, Tx 'TopTx era ~ Signal (EraRule "UTXOW" era), STS (EraRule "UTXOW" era), ToExpr (PredicateFailure (EraRule "UTXOW" era)), ShelleyEraTest era) ⇒ UTxO era → PParams era → Tx 'TopTx era → Either (NonEmpty (PredicateFailure (EraRule "UTXOW" era))) (State (EraRule "UTXOW" era)) → Expectation Source #

Use a subset test on the expected and computed [PredicateFailure]

testUTXOspecialCase ∷ (Reflect era, HasCallStack, BaseM (EraRule "UTXOW" era) ~ ShelleyBase, Environment (EraRule "UTXOW" era) ~ UtxoEnv era, State (EraRule "UTXOW" era) ~ UTxOState era, Tx 'TopTx era ~ Signal (EraRule "UTXOW" era), STS (EraRule "UTXOW" era)) ⇒ UTxO era → PParams era → Tx 'TopTx era → Either (NonEmpty (PredicateFailure (EraRule "UTXOW" era))) (State (EraRule "UTXOW" era)) → Expectation Source #

Use a test where any two (ValidationTagMismatch x y) failures match regardless of x and y

alwaysFailsHash ∷ (ShelleyEraScript era, EraModel era) ⇒ Natural → ScriptHash Source #

alwaysSucceedsHash ∷ (ShelleyEraScript era, EraModel era) ⇒ Natural → ScriptHash Source #

timelockScript ∷ AllegraEraScript era ⇒ SlotNo → Script era Source #

timelockHash ∷ AllegraEraScript era ⇒ SlotNo → ScriptHash Source #

timelockStakeCred ∷ AllegraEraScript era ⇒ Credential 'Staking Source #

genericCont ∷ (Eq (t x), Eq y, ToExpr y, HasCallStack, ToExpr (t x)) ⇒ String → Either (t x) y → Either (t x) y → Expectation Source #

A small example of what a continuation for runSTS might look like