Safe Haskell	Safe-Inferred
Language	Haskell2010

Cooked.MockChain.Direct

Contents

Direct Emulation
Direct Interpretation of Operations

Description

This module provides a direct (as opposed to Staged) implementation of the MonadBlockChain specification. This rely on the emulator from cardano-node-emulator for transaction validation, although we have our own internal state. This choice might be revised in the future.

Synopsis

data MockChainBook = MockChainBook {
- mcbJournal :: [MockChainLogEntry]
- mcbAliases :: Map BuiltinByteString String
}
newtype MockChainT m a = MockChainT {
- unMockChain :: StateT MockChainSt (ExceptT MockChainError (WriterT MockChainBook m)) a
}
type MockChain = MockChainT Identity
combineMockChainT :: (forall a. m a -> m a -> m a) -> MockChainT m x -> MockChainT m x -> MockChainT m x
type MockChainReturn a b = (Either MockChainError (a, b), MockChainBook)
mapMockChainT :: (m (MockChainReturn a MockChainSt) -> n (MockChainReturn b MockChainSt)) -> MockChainT m a -> MockChainT n b
runMockChainTRaw :: MockChainT m a -> m (MockChainReturn a MockChainSt)
runMockChainTFrom :: Monad m => InitialDistribution -> MockChainT m a -> m (MockChainReturn a UtxoState)
runMockChainT :: Monad m => MockChainT m a -> m (MockChainReturn a UtxoState)
runMockChainFrom :: InitialDistribution -> MockChain a -> MockChainReturn a UtxoState
runMockChain :: MockChain a -> MockChainReturn a UtxoState

Direct Emulation

The MockChainT monad provides a direct emulator; that is, it gives us a simple way to run a full validation process directly, without relying on a deployed node. While simulated, the validation is performed by the cardano-ledger code, thus ensuring similar results on the real chain.

A MockChain:

stores and updates a MockChainSt
returns a UtxoState when run
emits entries in a MockChainBook

data MockChainBook Source #

This represents elements that can be emitted throughout a MockChain run. These elements are either log entries corresponding to internal events worth logging, or aliases for hashables corresponding to elements users wishes to be properly displayed when printed with PrettyCooked

Constructors

MockChainBook
Fields mcbJournal :: [MockChainLogEntry] Log entries generated by cooked-validators mcbAliases :: Map BuiltinByteString String Aliases stored by the user

Instances

Instances details

Monoid MockChainBook Source #
Instance details Defined in Cooked.MockChain.Direct Methods mempty :: MockChainBook # mappend :: MockChainBook -> MockChainBook -> MockChainBook # mconcat :: [MockChainBook] -> MockChainBook #
Semigroup MockChainBook Source #
Instance details Defined in Cooked.MockChain.Direct Methods (<>) :: MockChainBook -> MockChainBook -> MockChainBook # sconcat :: NonEmpty MockChainBook -> MockChainBook # stimes :: Integral b => b -> MockChainBook -> MockChainBook #
Monad m => MonadWriter MockChainBook (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods writer :: (a, MockChainBook) -> MockChainT m a # tell :: MockChainBook -> MockChainT m () # listen :: MockChainT m a -> MockChainT m (a, MockChainBook) # pass :: MockChainT m (a, MockChainBook -> MockChainBook) -> MockChainT m a #
Show a => PrettyCooked (MockChainReturn a UtxoState) Source #
Instance details Defined in Cooked.Pretty.Cooked Methods prettyCooked :: MockChainReturn a UtxoState -> DocCooked Source # prettyCookedOpt :: PrettyCookedOpts -> MockChainReturn a UtxoState -> DocCooked Source #

newtype MockChainT m a Source #

A MockChainT builds up a stack of monads on top of a given monad m to reflect the requirements of the simulation.

Constructors

MockChainT
Fields unMockChain :: StateT MockChainSt (ExceptT MockChainError (WriterT MockChainBook m)) a

Instances

Instances details

MonadFail StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods fail :: String -> StagedMockChain a #
Alternative StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods empty :: StagedMockChain a # (<\|>) :: StagedMockChain a -> StagedMockChain a -> StagedMockChain a # some :: StagedMockChain a -> StagedMockChain [a] # many :: StagedMockChain a -> StagedMockChain [a] #
MonadBlockChain StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods validateTxSkel :: TxSkel -> StagedMockChain CardanoTx Source #
MonadBlockChainBalancing StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods getParams :: StagedMockChain Params Source # utxosAt :: Address -> StagedMockChain [(TxOutRef, TxOut)] Source # datumFromHash :: DatumHash -> StagedMockChain (Maybe Datum) Source # scriptFromHash :: ScriptHash -> StagedMockChain (Maybe (Versioned Script)) Source # txOutByRef :: TxOutRef -> StagedMockChain (Maybe TxOut) Source # logEvent :: MockChainLogEntry -> StagedMockChain () Source #
MonadBlockChainWithoutValidation StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods allUtxos :: StagedMockChain [(TxOutRef, TxOut)] Source # setParams :: Params -> StagedMockChain () Source # currentSlot :: StagedMockChain Slot Source # awaitSlot :: Slot -> StagedMockChain Slot Source # define :: ToHash a => String -> a -> StagedMockChain a Source #
MonadTrans MockChainT Source #
Instance details Defined in Cooked.MockChain.Direct Methods lift :: Monad m => m a -> MockChainT m a #
MonadError MockChainError StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods throwError :: MockChainError -> StagedMockChain a # catchError :: StagedMockChain a -> (MockChainError -> StagedMockChain a) -> StagedMockChain a #
Monad m => MonadError MockChainError (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods throwError :: MockChainError -> MockChainT m a # catchError :: MockChainT m a -> (MockChainError -> MockChainT m a) -> MockChainT m a #
Monad m => MonadState MockChainSt (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods get :: MockChainT m MockChainSt # put :: MockChainSt -> MockChainT m () # state :: (MockChainSt -> (a, MockChainSt)) -> MockChainT m a #
Monad m => MonadWriter MockChainBook (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods writer :: (a, MockChainBook) -> MockChainT m a # tell :: MockChainBook -> MockChainT m () # listen :: MockChainT m a -> MockChainT m (a, MockChainBook) # pass :: MockChainT m (a, MockChainBook -> MockChainBook) -> MockChainT m a #
Monad m => MonadFail (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods fail :: String -> MockChainT m a #
(Monad m, Alternative m) => Alternative (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods empty :: MockChainT m a # (<\|>) :: MockChainT m a -> MockChainT m a -> MockChainT m a # some :: MockChainT m a -> MockChainT m [a] # many :: MockChainT m a -> MockChainT m [a] #
Monad m => Applicative (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods pure :: a -> MockChainT m a # (<>) :: MockChainT m (a -> b) -> MockChainT m a -> MockChainT m b # liftA2 :: (a -> b -> c) -> MockChainT m a -> MockChainT m b -> MockChainT m c # (>) :: MockChainT m a -> MockChainT m b -> MockChainT m b # (<*) :: MockChainT m a -> MockChainT m b -> MockChainT m a #
Functor m => Functor (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods fmap :: (a -> b) -> MockChainT m a -> MockChainT m b # (<$) :: a -> MockChainT m b -> MockChainT m a #
Monad m => Monad (MockChainT m) Source #	Custom monad instance made to increase the slot count automatically
Instance details Defined in Cooked.MockChain.Direct Methods (>>=) :: MockChainT m a -> (a -> MockChainT m b) -> MockChainT m b # (>>) :: MockChainT m a -> MockChainT m b -> MockChainT m b # return :: a -> MockChainT m a #
MonadPlus m => MonadPlus (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Staged Methods mzero :: MockChainT m a # mplus :: MockChainT m a -> MockChainT m a -> MockChainT m a #
Monad m => MonadBlockChain (MockChainT m) Source #	Most of the logic of the direct emulation happens here
Instance details Defined in Cooked.MockChain.Direct Methods validateTxSkel :: TxSkel -> MockChainT m CardanoTx Source #
Monad m => MonadBlockChainBalancing (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods getParams :: MockChainT m Params Source # utxosAt :: Address -> MockChainT m [(TxOutRef, TxOut)] Source # datumFromHash :: DatumHash -> MockChainT m (Maybe Datum) Source # scriptFromHash :: ScriptHash -> MockChainT m (Maybe (Versioned Script)) Source # txOutByRef :: TxOutRef -> MockChainT m (Maybe TxOut) Source # logEvent :: MockChainLogEntry -> MockChainT m () Source #
Monad m => MonadBlockChainWithoutValidation (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods allUtxos :: MockChainT m [(TxOutRef, TxOut)] Source # setParams :: Params -> MockChainT m () Source # currentSlot :: MockChainT m Slot Source # awaitSlot :: Slot -> MockChainT m Slot Source # define :: ToHash a => String -> a -> MockChainT m a Source #
InterpLtl (UntypedTweak InterpMockChain) MockChainBuiltin InterpMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods interpBuiltin :: MockChainBuiltin a -> StateT [Ltl (UntypedTweak InterpMockChain)] InterpMockChain a Source #