plutus-contract-1.1.0.0
Safe HaskellNone
LanguageHaskell2010

Plutus.Contract.Trace

Description

A trace is a sequence of actions by simulated wallets that can be run on the mockchain. This module contains the functions needed to build traces.

Synopsis

Documentation

data TraceError e Source #

Error produced while running a trace. Either a contract-specific error (of type e), or an AssertionError from the emulator.

Constructors

TraceAssertionError AssertionError 
TContractError e 
HookError EndpointError 

Instances

Instances details
Eq e => Eq (TraceError e) Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

(==) :: TraceError e -> TraceError e -> Bool Source #

(/=) :: TraceError e -> TraceError e -> Bool Source #

Show e => Show (TraceError e) Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

showsPrec :: Int -> TraceError e -> ShowS Source #

show :: TraceError e -> String Source #

showList :: [TraceError e] -> ShowS Source #

AsAssertionError (TraceError e) Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

_AssertionError :: Prism' (TraceError e) AssertionError Source #

_GenericAssertion :: Prism' (TraceError e) Text Source #

AsTraceError (TraceError e) e Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

_TraceError :: Prism' (TraceError e) (TraceError e) Source #

_TraceAssertionError :: Prism' (TraceError e) AssertionError Source #

_TContractError :: Prism' (TraceError e) e Source #

_HookError :: Prism' (TraceError e) EndpointError Source #

data EndpointError Source #

Constructors

EndpointNotActive (Maybe Wallet) EndpointDescription 

Instances

Instances details
Eq EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

(==) :: EndpointError -> EndpointError -> Bool Source #

(/=) :: EndpointError -> EndpointError -> Bool Source #

Show EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

showsPrec :: Int -> EndpointError -> ShowS Source #

show :: EndpointError -> String Source #

showList :: [EndpointError] -> ShowS Source #

Generic EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

Associated Types

type Rep EndpointError :: Type -> Type Source #

Methods

from :: EndpointError -> Rep EndpointError x Source #

to :: Rep EndpointError x -> EndpointError Source #

ToJSON EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

toJSON :: EndpointError -> Value Source #

toEncoding :: EndpointError -> Encoding Source #

toJSONList :: [EndpointError] -> Value Source #

toEncodingList :: [EndpointError] -> Encoding Source #

FromJSON EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

parseJSON :: Value -> Parser EndpointError Source #

parseJSONList :: Value -> Parser [EndpointError] Source #

Pretty EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

pretty :: EndpointError -> Doc ann Source #

prettyList :: [EndpointError] -> Doc ann Source #

type Rep EndpointError Source # 
Instance details

Defined in Plutus.Contract.Trace

type Rep EndpointError = D1 ('MetaData "EndpointError" "Plutus.Contract.Trace" "plutus-contract-1.1.0.0-KZTRXOViW1GCXNPMdYqx30" 'False) (C1 ('MetaCons "EndpointNotActive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Wallet)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EndpointDescription)))

class AsTraceError r e | r -> e where Source #

Minimal complete definition

_TraceError

Methods

_TraceError :: Prism' r (TraceError e) Source #

_TraceAssertionError :: Prism' r AssertionError Source #

_TContractError :: Prism' r e Source #

_HookError :: Prism' r EndpointError Source #

Instances

Instances details
AsTraceError (TraceError e) e Source # 
Instance details

Defined in Plutus.Contract.Trace

Methods

_TraceError :: Prism' (TraceError e) (TraceError e) Source #

_TraceAssertionError :: Prism' (TraceError e) AssertionError Source #

_TContractError :: Prism' (TraceError e) e Source #

_HookError :: Prism' (TraceError e) EndpointError Source #

toNotifyError :: ContractInstanceId -> EndpointError -> NotificationError Source #

Handle contract requests

handleAdjustUnbalancedTx :: (Member (LogObserve (LogMessage Text)) effs, Member (LogMsg RequestHandlerLogMsg) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleSlotNotifications :: (Member (LogObserve (LogMessage Text)) effs, Member (LogMsg RequestHandlerLogMsg) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleTimeNotifications :: (Member (LogObserve (LogMessage Text)) effs, Member (LogMsg RequestHandlerLogMsg) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleOwnAddressesQueries :: (Member (LogObserve (LogMessage Text)) effs, Member WalletEffect effs) => RequestHandler effs PABReq PABResp Source #

handleCurrentNodeClientSlotQueries :: (Member (LogObserve (LogMessage Text)) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleCurrentChainIndexSlotQueries :: (Member (LogObserve (LogMessage Text)) effs, Member ChainIndexQueryEffect effs) => RequestHandler effs PABReq PABResp Source #

handleCurrentTimeQueries :: (Member (LogObserve (LogMessage Text)) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleCurrentNodeClientTimeRangeQueries :: (Member (LogObserve (LogMessage Text)) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleTimeToSlotConversions :: (Member (LogObserve (LogMessage Text)) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

handleUnbalancedTransactions :: (Member (LogObserve (LogMessage Text)) effs, Member (LogMsg RequestHandlerLogMsg) effs, Member WalletEffect effs) => RequestHandler effs PABReq PABResp Source #

handlePendingTransactions :: (Member (LogObserve (LogMessage Text)) effs, Member (LogMsg RequestHandlerLogMsg) effs, Member WalletEffect effs) => RequestHandler effs PABReq PABResp Source #

Submit the wallet's pending transactions to the blockchain.

handleChainIndexQueries :: (Member (LogObserve (LogMessage Text)) effs, Member ChainIndexQueryEffect effs) => RequestHandler effs PABReq PABResp Source #

handleOwnInstanceIdQueries :: (Member (LogObserve (LogMessage Text)) effs, Member (Reader ContractInstanceId) effs) => RequestHandler effs PABReq PABResp Source #

handleYieldedUnbalancedTx :: (Member (LogObserve (LogMessage Text)) effs, Member WalletEffect effs) => RequestHandler effs PABReq PABResp Source #

handleGetParams :: (Member (LogObserve (LogMessage Text)) effs, Member NodeClientEffect effs) => RequestHandler effs PABReq PABResp Source #

Initial distributions of emulated chains

type InitialDistribution = Map Wallet Value Source #

defaultDist :: InitialDistribution Source #

defaultDistFor :: [Wallet] -> InitialDistribution Source #

Wallets

data Wallet Source #

A wallet identifier

Constructors

Wallet 

Fields

Instances

Instances details
Eq Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

(==) :: Wallet -> Wallet -> Bool Source #

(/=) :: Wallet -> Wallet -> Bool Source #

Data Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Wallet -> c Wallet Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Wallet Source #

toConstr :: Wallet -> Constr Source #

dataTypeOf :: Wallet -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Wallet) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Wallet) Source #

gmapT :: (forall b. Data b => b -> b) -> Wallet -> Wallet Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Wallet -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Wallet -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> Wallet -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Wallet -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Wallet -> m Wallet Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Wallet -> m Wallet Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Wallet -> m Wallet Source #

Ord Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

compare :: Wallet -> Wallet -> Ordering Source #

(<) :: Wallet -> Wallet -> Bool Source #

(<=) :: Wallet -> Wallet -> Bool Source #

(>) :: Wallet -> Wallet -> Bool Source #

(>=) :: Wallet -> Wallet -> Bool Source #

max :: Wallet -> Wallet -> Wallet Source #

min :: Wallet -> Wallet -> Wallet Source #

Show Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

showsPrec :: Int -> Wallet -> ShowS Source #

show :: Wallet -> String Source #

showList :: [Wallet] -> ShowS Source #

Generic Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Associated Types

type Rep Wallet :: Type -> Type Source #

Methods

from :: Wallet -> Rep Wallet x Source #

to :: Rep Wallet x -> Wallet Source #

ToJSON Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

toJSON :: Wallet -> Value Source #

toEncoding :: Wallet -> Encoding Source #

toJSONList :: [Wallet] -> Value Source #

toEncodingList :: [Wallet] -> Encoding Source #

ToJSONKey Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

toJSONKey :: ToJSONKeyFunction Wallet Source #

toJSONKeyList :: ToJSONKeyFunction [Wallet] Source #

FromJSON Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

parseJSON :: Value -> Parser Wallet Source #

parseJSONList :: Value -> Parser [Wallet] Source #

HasSymTokens Wallet Source # 
Instance details

Defined in Plutus.Contract.Test.ContractModel.Interface

Methods

getAllSymTokens :: Wallet -> Set SymToken Source #

ToHttpApiData Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

toUrlPiece :: Wallet -> Text Source #

toEncodedUrlPiece :: Wallet -> Builder Source #

toHeader :: Wallet -> ByteString Source #

toQueryParam :: Wallet -> Text Source #

FromHttpApiData Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

parseUrlPiece :: Text -> Either Text Wallet Source #

parseHeader :: ByteString -> Either Text Wallet Source #

parseQueryParam :: Text -> Either Text Wallet Source #

ToSchema Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

declareNamedSchema :: Proxy Wallet -> Declare (Definitions Schema) NamedSchema Source #

Pretty Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

Methods

pretty :: Wallet -> Doc ann Source #

prettyList :: [Wallet] -> Doc ann Source #

type Rep Wallet Source # 
Instance details

Defined in Wallet.Emulator.Wallet

type Rep Wallet = D1 ('MetaData "Wallet" "Wallet.Emulator.Wallet" "plutus-contract-1.1.0.0-KZTRXOViW1GCXNPMdYqx30" 'False) (C1 ('MetaCons "Wallet" 'PrefixI 'True) (S1 ('MetaSel ('Just "prettyWalletName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "getWalletId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WalletId)))

mockWalletAddress :: Wallet -> CardanoAddress Source #

Get the cardano address of a mock wallet. (Fails if the wallet is not a mock wallet).

mockWalletPaymentPubKey :: Wallet -> PaymentPubKey Source #

The public key of a mock wallet. (Fails if the wallet is not a mock wallet).

mockWalletPaymentPubKeyHash :: Wallet -> PaymentPubKeyHash Source #

The payment public key hash of a mock wallet. (Fails if the wallet is not a mock wallet).

knownWallets :: [Wallet] Source #

knownWallet :: Integer -> Wallet Source #