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 :: ExceptT MockChainError (StateT MockChainState (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
data MockChainReturn a = MockChainReturn {
- mcrValue :: Either MockChainError a
- mcrOutputs :: Map TxOutRef (TxSkelOut, Bool)
- mcrUtxoState :: UtxoState
- mcrJournal :: [MockChainLogEntry]
- mcrAliases :: Map BuiltinByteString String
}
runMockChainTRaw :: Monad m => MockChainT m a -> m (MockChainReturn a)
runMockChainTFrom :: Monad m => InitialDistribution -> MockChainT m a -> m (MockChainReturn a)
runMockChainT :: Monad m => MockChainT m a -> m (MockChainReturn a)
runMockChainFrom :: InitialDistribution -> MockChain a -> MockChainReturn a
runMockChain :: MockChain a -> MockChainReturn a

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 MockChainState
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 #

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. It writes a MockChainBook, updates and reads from a MockChainState and throws possible MockChainErrors.

Constructors

MockChainT
Fields unMockChain :: ExceptT MockChainError (StateT MockChainState (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 :: ToAddress a => a -> StagedMockChain [(TxOutRef, TxSkelOut)] Source # txOutByRef :: TxOutRef -> StagedMockChain (Maybe TxSkelOut) Source # logEvent :: MockChainLogEntry -> StagedMockChain () Source #
MonadBlockChainWithoutValidation StagedMockChain Source #
Instance details Defined in Cooked.MockChain.Staged Methods allUtxos :: StagedMockChain [(TxOutRef, TxSkelOut)] Source # setParams :: Params -> StagedMockChain () Source # waitNSlots :: Integral i => i -> StagedMockChain Slot Source # define :: ToHash a => String -> a -> StagedMockChain a Source # setConstitutionScript :: ToVersioned Script s => s -> StagedMockChain () Source # getConstitutionScript :: StagedMockChain (Maybe (Versioned Script)) Source # registerStakingCred :: ToCredential c => c -> Integer -> Integer -> StagedMockChain () 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 MockChainState (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods get :: MockChainT m MockChainState # put :: MockChainState -> MockChainT m () # state :: (MockChainState -> (a, MockChainState)) -> 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 :: ToAddress a => a -> MockChainT m [(TxOutRef, TxSkelOut)] Source # txOutByRef :: TxOutRef -> MockChainT m (Maybe TxSkelOut) Source # logEvent :: MockChainLogEntry -> MockChainT m () Source #
Monad m => MonadBlockChainWithoutValidation (MockChainT m) Source #
Instance details Defined in Cooked.MockChain.Direct Methods allUtxos :: MockChainT m [(TxOutRef, TxSkelOut)] Source # setParams :: Params -> MockChainT m () Source # waitNSlots :: Integral i => i -> MockChainT m Slot Source # define :: ToHash a => String -> a -> MockChainT m a Source # setConstitutionScript :: ToVersioned Script s => s -> MockChainT m () Source # getConstitutionScript :: MockChainT m (Maybe (Versioned Script)) Source # registerStakingCred :: ToCredential c => c -> Integer -> Integer -> MockChainT m () 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 #

type MockChain = MockChainT Identity Source #

Our MockChain naturally instantiate the inner monad with Identity

combineMockChainT :: (forall a. m a -> m a -> m a) -> MockChainT m x -> MockChainT m x -> MockChainT m x Source #

Combines two MockChainT together

data MockChainReturn a Source #

The returned type when running a MockChainT. This is both a reorganizing and filtering of the natural returned type ((Either MockChainError a, MockChainState), MockChainBook), which is much easier to query.

Constructors

MockChainReturn
Fields mcrValue :: Either MockChainError a The returned value of the run mcrOutputs :: Map TxOutRef (TxSkelOut, Bool) All the outputs used throughout the run mcrUtxoState :: UtxoState The resulting `UtxoState` of the run mcrJournal :: [MockChainLogEntry] The log entries emitted during the run mcrAliases :: Map BuiltinByteString String The aliases defined during the run

Instances

Instances details

Show a => PrettyCooked (MockChainReturn a) Source #
Instance details Defined in Cooked.Pretty.MockChain Methods prettyCookedOpt :: PrettyCookedOpts -> MockChainReturn a -> DocCooked Source # prettyCooked :: MockChainReturn a -> DocCooked Source #
Show a => PrettyCooked [MockChainReturn a] Source #
Instance details Defined in Cooked.Pretty.MockChain Methods prettyCookedOpt :: PrettyCookedOpts -> [MockChainReturn a] -> DocCooked Source # prettyCooked :: [MockChainReturn a] -> DocCooked Source #

runMockChainTRaw :: Monad m => MockChainT m a -> m (MockChainReturn a) Source #

Runs a MockChainT from a default MockChainState

runMockChainTFrom :: Monad m => InitialDistribution -> MockChainT m a -> m (MockChainReturn a) Source #

Runs a MockChainT from an initial MockChainState built from a given InitialDistribution.

runMockChainT :: Monad m => MockChainT m a -> m (MockChainReturn a) Source #

Executes a MockChainT from the canonical initial state and environment.

runMockChainFrom :: InitialDistribution -> MockChain a -> MockChainReturn a Source #

See runMockChainTFrom

runMockChain :: MockChain a -> MockChainReturn a Source #

See runMockChainT

Direct Interpretation of Operations