Safe Haskell	None
Language	Haskell2010

Cardano.Node.Emulator.API

Contents

Updating the blockchain
Querying the blockchain
Transactions
Logging
Types

Description

If you want to run the node emulator without using the Contract monad, this module provides a simple MTL-based interface.

Synopsis

queueTx :: MonadEmulator m => CardanoTx -> m ()
nextSlot :: MonadEmulator m => m ()
currentSlot :: MonadEmulator m => m Slot
awaitSlot :: MonadEmulator m => Slot -> m ()
utxosAt :: MonadEmulator m => CardanoAddress -> m UtxoIndex
utxosAtPlutus :: MonadEmulator m => CardanoAddress -> m (Map TxOutRef DecoratedTxOut)
utxoAtTxOutRef :: MonadEmulator m => TxIn -> m (Maybe TxOut)
utxoAtTxOutRefPlutus :: MonadEmulator m => TxOutRef -> m (Maybe DecoratedTxOut)
fundsAt :: MonadEmulator m => CardanoAddress -> m Value
lookupDatum :: MonadEmulator m => DatumHash -> m (Maybe Datum)
balanceTx :: MonadEmulator m => UtxoIndex -> CardanoAddress -> CardanoBuildTx -> m CardanoTx
signTx :: (MonadEmulator m, Foldable f) => f PaymentPrivateKey -> CardanoTx -> m CardanoTx
submitUnbalancedTx :: (MonadEmulator m, Foldable f) => UtxoIndex -> CardanoAddress -> f PaymentPrivateKey -> CardanoBuildTx -> m CardanoTx
submitTxConfirmed :: (MonadEmulator m, Foldable f) => UtxoIndex -> CardanoAddress -> f PaymentPrivateKey -> CardanoBuildTx -> m CardanoTx
payToAddress :: MonadEmulator m => (CardanoAddress, PaymentPrivateKey) -> CardanoAddress -> Value -> m TxId
logDebug :: (ToJSON a, MonadEmulator m) => a -> m ()
logInfo :: (ToJSON a, MonadEmulator m) => a -> m ()
logWarn :: (ToJSON a, MonadEmulator m) => a -> m ()
logError :: (ToJSON a, MonadEmulator m) => a -> m ()
data EmulatorState = EmulatorState !ChainState !AddressMap !(Map DatumHash Datum)
esChainState :: Lens' EmulatorState ChainState
esAddressMap :: Lens' EmulatorState AddressMap
esDatumMap :: Lens' EmulatorState (Map DatumHash Datum)
data EmulatorError
- = BalancingError !BalancingError
- | ValidationError !ValidationErrorInPhase
- | ToCardanoError !ToCardanoError
type EmulatorLogs = Seq (LogMessage EmulatorMsg)
data EmulatorMsg
- = GenericMsg Value
- | TxBalanceMsg TxBalanceMsg
- | ChainEvent ChainEvent
data LogMessage a = LogMessage {
- _logLevel :: LogLevel
- _logMessageContent :: a
}
type MonadEmulator m = (MonadRWS Params EmulatorLogs EmulatorState m, MonadError EmulatorError m)
type EmulatorT m = ExceptT EmulatorError (RWST Params EmulatorLogs EmulatorState m)
type EmulatorM = EmulatorT Identity
emptyEmulatorState :: EmulatorState
emptyEmulatorStateWithInitialDist :: Map CardanoAddress Value -> EmulatorState
getParams :: MonadEmulator m => m Params

Updating the blockchain

queueTx :: MonadEmulator m => CardanoTx -> m () Source #

Queue the transaction, it will be processed when nextSlot is called.

nextSlot :: MonadEmulator m => m () Source #

Process the queued transactions and increase the slot number.

currentSlot :: MonadEmulator m => m Slot Source #

Get the current slot number of the emulated node.

awaitSlot :: MonadEmulator m => Slot -> m () Source #

Call nextSlot until the current slot number equals or exceeds the given slot number.

Querying the blockchain

utxosAt :: MonadEmulator m => CardanoAddress -> m UtxoIndex Source #

Query the unspent transaction outputs at the given address.

utxosAtPlutus :: MonadEmulator m => CardanoAddress -> m (Map TxOutRef DecoratedTxOut) Source #

Query the unspent transaction outputs at the given address (using Plutus types).

utxoAtTxOutRef :: MonadEmulator m => TxIn -> m (Maybe TxOut) Source #

Resolve the transaction output reference.

utxoAtTxOutRefPlutus :: MonadEmulator m => TxOutRef -> m (Maybe DecoratedTxOut) Source #

Resolve the transaction output reference (using Plutus types).

fundsAt :: MonadEmulator m => CardanoAddress -> m Value Source #

Query the total value of the unspent transaction outputs at the given address.

lookupDatum :: MonadEmulator m => DatumHash -> m (Maybe Datum) Source #

Resolve a datum hash to an actual datum, if known.

Transactions

balanceTx Source #

Arguments

:: MonadEmulator m
=> UtxoIndex	Just the transaction inputs, not the entire `UTxO`.
-> CardanoAddress	Wallet address
-> CardanoBuildTx
-> m CardanoTx

Balance an unbalanced transaction, using funds from the given wallet if needed, and returning any remaining value to the same wallet.

signTx Source #

Arguments

:: (MonadEmulator m, Foldable f)
=> f PaymentPrivateKey	Signatures
-> CardanoTx
-> m CardanoTx

Sign a transaction with the given signatures.

submitUnbalancedTx Source #

Arguments

:: (MonadEmulator m, Foldable f)
=> UtxoIndex	Just the transaction inputs, not the entire `UTxO`.
-> CardanoAddress	Wallet address
-> f PaymentPrivateKey	Signatures
-> CardanoBuildTx
-> m CardanoTx

Balance a transaction, sign it with the given signatures, and finally queue it.

submitTxConfirmed Source #

Arguments

:: (MonadEmulator m, Foldable f)
=> UtxoIndex	Just the transaction inputs, not the entire `UTxO`.
-> CardanoAddress
-> f PaymentPrivateKey
-> CardanoBuildTx
-> m CardanoTx

payToAddress :: MonadEmulator m => (CardanoAddress, PaymentPrivateKey) -> CardanoAddress -> Value -> m TxId Source #

Create a transaction that transfers funds from one address to another, and sign and submit it.

Logging

logDebug :: (ToJSON a, MonadEmulator m) => a -> m () Source #

Log a message at the Debug level

logInfo :: (ToJSON a, MonadEmulator m) => a -> m () Source #

Log a message at the Info level

logWarn :: (ToJSON a, MonadEmulator m) => a -> m () Source #

Log a message at the Warning level

logError :: (ToJSON a, MonadEmulator m) => a -> m () Source #

Log a message at the Error level

Types

data EmulatorState Source #

Constructors

EmulatorState !ChainState !AddressMap !(Map DatumHash Datum)

Instances

Instances details

Show EmulatorState Source #
Instance details Defined in Cardano.Node.Emulator.Internal.API Methods showsPrec :: Int -> EmulatorState -> ShowS Source # show :: EmulatorState -> String Source # showList :: [EmulatorState] -> ShowS Source #
IsRunnable EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods awaitSlot :: SlotNo -> EmulatorM ()
HasChainIndex EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods getChainIndex :: EmulatorM ChainIndex getChainState :: EmulatorM ChainState
type Realized EmulatorM a
Instance details Defined in Cardano.Node.Emulator.Test type Realized EmulatorM a = a

esChainState :: Lens' EmulatorState ChainState Source #

esAddressMap :: Lens' EmulatorState AddressMap Source #

esDatumMap :: Lens' EmulatorState (Map DatumHash Datum) Source #

data EmulatorError Source #

Constructors

BalancingError !BalancingError
ValidationError !ValidationErrorInPhase
ToCardanoError !ToCardanoError

Instances

Instances details

Show EmulatorError Source #
Instance details Defined in Cardano.Node.Emulator.Internal.API Methods showsPrec :: Int -> EmulatorError -> ShowS Source # show :: EmulatorError -> String Source # showList :: [EmulatorError] -> ShowS Source #
Exception EmulatorError Source #
Instance details Defined in Cardano.Node.Emulator.Internal.API Methods toException :: EmulatorError -> SomeException Source # fromException :: SomeException -> Maybe EmulatorError Source # displayException :: EmulatorError -> String Source #
IsRunnable EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods awaitSlot :: SlotNo -> EmulatorM ()
HasChainIndex EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods getChainIndex :: EmulatorM ChainIndex getChainState :: EmulatorM ChainState
type Realized EmulatorM a
Instance details Defined in Cardano.Node.Emulator.Test type Realized EmulatorM a = a

type EmulatorLogs = Seq (LogMessage EmulatorMsg) Source #

data EmulatorMsg Source #

Constructors

GenericMsg Value
TxBalanceMsg TxBalanceMsg
ChainEvent ChainEvent

Instances

Instances details

Eq EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages Methods (==) :: EmulatorMsg -> EmulatorMsg -> Bool Source # (/=) :: EmulatorMsg -> EmulatorMsg -> Bool Source #
Show EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages Methods showsPrec :: Int -> EmulatorMsg -> ShowS Source # show :: EmulatorMsg -> String Source # showList :: [EmulatorMsg] -> ShowS Source #
Generic EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages Associated Types type Rep EmulatorMsg :: Type -> Type Source # Methods from :: EmulatorMsg -> Rep EmulatorMsg x Source # to :: Rep EmulatorMsg x -> EmulatorMsg Source #
FromJSON EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages Methods parseJSON :: Value -> Parser EmulatorMsg parseJSONList :: Value -> Parser [EmulatorMsg]
ToJSON EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages Methods toJSON :: EmulatorMsg -> Value toEncoding :: EmulatorMsg -> Encoding toJSONList :: [EmulatorMsg] -> Value toEncodingList :: [EmulatorMsg] -> Encoding
Pretty EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages Methods pretty :: EmulatorMsg -> Doc ann prettyList :: [EmulatorMsg] -> Doc ann
IsRunnable EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods awaitSlot :: SlotNo -> EmulatorM ()
HasChainIndex EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods getChainIndex :: EmulatorM ChainIndex getChainState :: EmulatorM ChainState
type Rep EmulatorMsg Source #
Instance details Defined in Cardano.Node.Emulator.LogMessages type Rep EmulatorMsg = D1 ('MetaData "EmulatorMsg" "Cardano.Node.Emulator.LogMessages" "cardano-node-emulator-1.2.0.0-1RjxyDmnwHSAn2KgGdAUXD" 'False) (C1 ('MetaCons "GenericMsg" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :+: (C1 ('MetaCons "TxBalanceMsg" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxBalanceMsg)) :+: C1 ('MetaCons "ChainEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChainEvent))))
type Realized EmulatorM a
Instance details Defined in Cardano.Node.Emulator.Test type Realized EmulatorM a = a

data LogMessage a #

Constructors

LogMessage
Fields _logLevel :: LogLevel _logMessageContent :: a

Instances

Instances details

Functor LogMessage
Instance details Defined in Control.Monad.Freer.Extras.Log Methods fmap :: (a -> b) -> LogMessage a -> LogMessage b Source # (<$) :: a -> LogMessage b -> LogMessage a Source #
Foldable LogMessage
Instance details Defined in Control.Monad.Freer.Extras.Log Methods fold :: Monoid m => LogMessage m -> m Source # foldMap :: Monoid m => (a -> m) -> LogMessage a -> m Source # foldMap' :: Monoid m => (a -> m) -> LogMessage a -> m Source # foldr :: (a -> b -> b) -> b -> LogMessage a -> b Source # foldr' :: (a -> b -> b) -> b -> LogMessage a -> b Source # foldl :: (b -> a -> b) -> b -> LogMessage a -> b Source # foldl' :: (b -> a -> b) -> b -> LogMessage a -> b Source # foldr1 :: (a -> a -> a) -> LogMessage a -> a Source # foldl1 :: (a -> a -> a) -> LogMessage a -> a Source # toList :: LogMessage a -> [a] Source # null :: LogMessage a -> Bool Source # length :: LogMessage a -> Int Source # elem :: Eq a => a -> LogMessage a -> Bool Source # maximum :: Ord a => LogMessage a -> a Source # minimum :: Ord a => LogMessage a -> a Source # sum :: Num a => LogMessage a -> a Source # product :: Num a => LogMessage a -> a Source #
Traversable LogMessage
Instance details Defined in Control.Monad.Freer.Extras.Log Methods traverse :: Applicative f => (a -> f b) -> LogMessage a -> f (LogMessage b) Source # sequenceA :: Applicative f => LogMessage (f a) -> f (LogMessage a) Source # mapM :: Monad m => (a -> m b) -> LogMessage a -> m (LogMessage b) Source # sequence :: Monad m => LogMessage (m a) -> m (LogMessage a) Source #
IsRunnable EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods awaitSlot :: SlotNo -> EmulatorM ()
HasChainIndex EmulatorM Source #
Instance details Defined in Cardano.Node.Emulator.Test Methods getChainIndex :: EmulatorM ChainIndex getChainState :: EmulatorM ChainState
Eq a => Eq (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Methods (==) :: LogMessage a -> LogMessage a -> Bool Source # (/=) :: LogMessage a -> LogMessage a -> Bool Source #
Ord a => Ord (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Methods compare :: LogMessage a -> LogMessage a -> Ordering Source # (<) :: LogMessage a -> LogMessage a -> Bool Source # (<=) :: LogMessage a -> LogMessage a -> Bool Source # (>) :: LogMessage a -> LogMessage a -> Bool Source # (>=) :: LogMessage a -> LogMessage a -> Bool Source # max :: LogMessage a -> LogMessage a -> LogMessage a Source # min :: LogMessage a -> LogMessage a -> LogMessage a Source #
Show a => Show (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Methods showsPrec :: Int -> LogMessage a -> ShowS Source # show :: LogMessage a -> String Source # showList :: [LogMessage a] -> ShowS Source #
Generic (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Associated Types type Rep (LogMessage a) :: Type -> Type Source # Methods from :: LogMessage a -> Rep (LogMessage a) x Source # to :: Rep (LogMessage a) x -> LogMessage a Source #
FromJSON a => FromJSON (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Methods parseJSON :: Value -> Parser (LogMessage a) parseJSONList :: Value -> Parser [LogMessage a]
ToJSON a => ToJSON (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Methods toJSON :: LogMessage a -> Value toEncoding :: LogMessage a -> Encoding toJSONList :: [LogMessage a] -> Value toEncodingList :: [LogMessage a] -> Encoding
Pretty a => Pretty (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log Methods pretty :: LogMessage a -> Doc ann prettyList :: [LogMessage a] -> Doc ann
type Realized EmulatorM a
Instance details Defined in Cardano.Node.Emulator.Test type Realized EmulatorM a = a
type Rep (LogMessage a)
Instance details Defined in Control.Monad.Freer.Extras.Log type Rep (LogMessage a) = D1 ('MetaData "LogMessage" "Control.Monad.Freer.Extras.Log" "freer-extras-1.2.0.0-1q4AUo79Td5ISTeTXorMWT" 'False) (C1 ('MetaCons "LogMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "_logLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogLevel) :*: S1 ('MetaSel ('Just "_logMessageContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)))

type MonadEmulator m = (MonadRWS Params EmulatorLogs EmulatorState m, MonadError EmulatorError m) Source #

type EmulatorT m = ExceptT EmulatorError (RWST Params EmulatorLogs EmulatorState m) Source #

type EmulatorM = EmulatorT Identity Source #

emptyEmulatorState :: EmulatorState Source #

emptyEmulatorStateWithInitialDist :: Map CardanoAddress Value -> EmulatorState Source #

getParams :: MonadEmulator m => m Params Source #