Test.Cleveland.Internal.Abstract

Abstract cleveland interface not bound to a particular implementation.

The interface may look a bit untyped and unsafe in some places. For example, in order to call a contract one should supply a simple address rather than a contract ref, so it is easy to pass a value of wrong type. Also it is easy to call a non-existing entrypoint.

Subjectively, it makes writing test scenarios easier because you have to prove less to the compiler. It also makes implementation of cleveland engine a bit easier. Of course, it also makes it easier to make certain mistakes. However, we expect users of this interface to also use the functionality of the Test.Cleveland.Internal.Pure module and convert cleveland scenarios to purely testable scenarios for integrational testing engine. In this case errors should be detected almost as quickly as they would reported by the compiler, at least before trying to run scenario on a live network.

Also this interface uses Address rather than EpAddress. I (@gromak) concluded that EpAddress can not be passed to tezos-client. For key addresses it just does not make sense and for contract addresses I get such errors:

  bad contract notation
  Invalid contract notation "KT1VrFpBPwBTm3hsK7DB7SPmY8fTHJ3vY6sJ%mint"

Documentation

data ContractHandle (cp :: Type) (st :: Type) (vd :: Type)

Handle to a contract.

This is what you get when originating a contract and that allows further operations with the contract within the test framework.

Note that this is part of the testing framework and exists solely in Haskell world, so it has no IsoValue and related instances and cannot be used in Lorentz code.

Constructors

(NiceParameter cp, NiceStorage st, NiceViewsDescriptor vd) => ContractHandle

Fields

• chContractName :: Text
• chAddress :: Address

Instances

(cp' ~ cp, vd ~ vd') => ToTAddress cp' vd' (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toTAddress :: ContractHandle cp st vd -> TAddress cp' vd'

ToContractRef arg (TAddress cp vd) => ToContractRef arg (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toContractRef :: ContractHandle cp st vd -> ContractRef arg

st ~ st' => ToStorageType st' (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

pickNiceStorage :: ContractHandle cp st vd -> Dict (NiceStorage st')

Show (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

showsPrec :: Int -> ContractHandle cp st vd -> ShowS

show :: ContractHandle cp st vd -> String

showList :: [ContractHandle cp st vd] -> ShowS

Buildable (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

build :: ContractHandle cp st vd -> Builder

ToAddress (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toAddress :: ContractHandle cp st vd -> Address

data OriginateData param st vd

Constructors

OriginateData

Fields

• odName :: AliasHint

  Alias for the originated contract.

• odBalance :: Mutez

  Initial balance.

• odStorage :: st

  Initial storage.

• odContract :: Contract param st vd

  The contract itself.

  We are using Lorentz version here which is convenient. However, keep in mind that if someone wants to test a contract from .tz file, they should use UntypedOriginateData.

data TransferData

Information about transfer operation.

Constructors

forall v addr.(NiceParameter v, ToAddress addr) => TransferData

Fields

• tdTo :: addr

  Receiver address for this transaction.

• tdAmount :: Mutez

  Amount to be transferred.

• tdEntrypoint :: EpName

  An entrypoint to be called. Consider using ep in testing scenarios.

• tdParameter :: v

  Parameter that will be used for a contract call. Set to () for transfers to key addresses.

newtype Sender

Designates the special sender address.

Transfers and some other operations will occur on behalf of this address. This is initialized to moneybag address and then can be locally modified.

Operations in ClevelandOpsImpl are affected by this address.

Constructors

Sender

Fields

• unSender :: Address

newtype Moneybag

Designates the address that gifts money to new addresses.

Once a new address is allocated in a test scenario, we have to transfer some money to it so that it is able to serve as transactions sender. Moneybag serves as a source of that money.

We do not use Sender for this purpose because in most situations changing moneybag is not necessary. If a user wraps a large piece of their script with withSender call and that changes the moneybag - this behaviour may be undesired and unexpected to the user.

Constructors

Moneybag

Fields

• unMoneybag :: Address

data UntypedOriginateData

Untyped version of OriginateData. It can be used for interaction with raw Michelson contracts

Constructors

UntypedOriginateData

Fields

• uodName :: AliasHint

  Alias for the originated contract.

• uodBalance :: Mutez

  Initial balance.

• uodStorage :: Value

  Initial storage.

• uodContract :: Contract

  The contract itself.

data RunCode cp st vd

The data needed to call the /run_code RPC endpoint.

Constructors

RunCode

Fields

• rcContract :: Contract cp st vd
• rcStorage :: MaybeRPC st
• rcParameter :: MaybeRPC cp
• rcAmount :: Mutez

  The value that will be returned by the AMOUNT instruction.

• rcBalance :: Mutez

  The balance that will be returned by the BALANCE instruction.

• rcSource :: Maybe Address

  The value that will be returned by the SOURCE instruction.

data ClevelandInput

Designates an operation input.

Instances

OperationInfoDescriptor ClevelandInput

Defined in Test.Cleveland.Internal.Abstract

Associated Types

type TransferInfo ClevelandInput

type OriginationInfo ClevelandInput

type RevealInfo ClevelandInput

type OriginationInfo ClevelandInput

Defined in Test.Cleveland.Internal.Abstract

type OriginationInfo ClevelandInput = UntypedOriginateData

type RevealInfo ClevelandInput

Defined in Test.Cleveland.Internal.Abstract

type RevealInfo ClevelandInput = PublicKey

type TransferInfo ClevelandInput

Defined in Test.Cleveland.Internal.Abstract

type TransferInfo ClevelandInput = TransferData

newtype DefaultAliasCounter

Counter which is used to provide different default aliases.

Constructors

DefaultAliasCounter

Fields

• unDefaultAliasCounter :: Natural

Instances

Show DefaultAliasCounter

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> DefaultAliasCounter -> ShowS

show :: DefaultAliasCounter -> String

showList :: [DefaultAliasCounter] -> ShowS

data SpecificOrDefaultAliasHint

An alias hint with default value that can be used to define unique alias automatically.

Constructors

SpecificAliasHint AliasHint

DefaultAliasHint

Instances

Show SpecificOrDefaultAliasHint

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> SpecificOrDefaultAliasHint -> ShowS

show :: SpecificOrDefaultAliasHint -> String

showList :: [SpecificOrDefaultAliasHint] -> ShowS

IsString SpecificOrDefaultAliasHint

Defined in Test.Cleveland.Internal.Abstract

Methods

fromString :: String -> SpecificOrDefaultAliasHint

Default SpecificOrDefaultAliasHint

Defined in Test.Cleveland.Internal.Abstract

Methods

def :: SpecificOrDefaultAliasHint

Actions

data ClevelandOpsImpl m

A record data type with operations creating primitives.

Constructors

ClevelandOpsImpl

Fields

• coiRunOperationBatch :: HasCallStack => [OperationInfo ClevelandInput] -> m [OperationInfo Result]

  Perform a batch of operations.

data ClevelandMiscImpl m

A record data type with all base methods one can use during a cleveland test.

Constructors

ClevelandMiscImpl

Fields

• cmiRunIO :: forall res. HasCallStack => IO res -> m res

  Runs an IO action.

• cmiResolveAddress :: HasCallStack => AliasHint -> m Address

  Get the address of the implicit account / contract associated with the given alias.

• cmiGenKey :: HasCallStack => SpecificOrDefaultAliasHint -> m Address

  Generate a secret key and store it with given alias. If a key with this alias already exists, the corresponding address will be returned and no state will be changed.

• cmiGenFreshKey :: HasCallStack => SpecificOrDefaultAliasHint -> m Address

  Generate a secret key and store it with given alias. Unlike cmiGenKey this function overwrites the existing key when given alias is already stored.

• cmiSignBytes :: HasCallStack => ByteString -> Address -> m Signature

  Get the signature of the preapplied operation.

• cmiOriginateLargeUntyped :: HasCallStack => Sender -> UntypedOriginateData -> m Address

  Originate a new raw Michelson contract that doesn't fit into the origination size limit, by executing multiple operation steps.

  Note that this is not part of ClevelandOpsImpl because large origination is _not_ a primitive operation. Also, it cannot appear in a batch (it simply may not fit).

• cmiComment :: HasCallStack => Text -> m ()

  Print the given string verbatim as a comment. At the moment, this is a no-op in emulator tests.

• cmiGetBalance :: HasCallStack => Address -> m Mutez

  Get the balance of the given address.

• cmiGetSomeStorage :: HasCallStack => Address -> m SomeAnnotatedValue
• cmiGetBigMapValueMaybe :: forall k v. (HasCallStack, NiceComparable k, NicePackedValue k, NiceUnpackedValue v) => BigMapId k v -> k -> m (Maybe v)

  Retrieve a big_map value, given a big_map ID and a key. Returns Nothing when the big_map ID does not exist, or it exists but does not contain the given key.

• cmiGetAllBigMapValuesMaybe :: forall k v. (HasCallStack, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m (Maybe [v])

  Retrieve all big_map values, given a big_map ID. Returns Nothing when the big_map ID does not exist.

• cmiGetPublicKey :: HasCallStack => Address -> m PublicKey

  Get the public key associated with the given address. Fail if the given address is not an implicit account.

• cmiGetDelegate :: HasCallStack => Address -> m (Maybe KeyHash)

  Get the delegate for the given contract. Fails on implicit contracts.

• cmiRegisterDelegate :: HasCallStack => Address -> m ()

  Register the given address as a valid delegate.

• cmiGetChainId :: HasCallStack => m ChainId

  Get the chain's ChainId.

• cmiAdvanceTime :: forall unit. (HasCallStack, KnownDivRat unit Second) => Time unit -> m ()

  Advance at least the given amount of time, or until a new block is baked, whichever happens last.

  On a real network, this is implemented using threadDelay, so it's advisable to use small amounts of time only.

• cmiAdvanceToLevel :: HasCallStack => (Natural -> Natural) -> m ()

  Advance at least to the level returned by the callback, accepting current level.

• cmiGetNow :: HasCallStack => m Timestamp

  Get the timestamp observed by the last block to be baked.

• cmiGetLevel :: HasCallStack => m Natural

  Get the current level observed by the last block to be baked.

• cmiFailure :: forall a. HasCallStack => Builder -> m a

  Fails the test with the given error message.

• cmiThrow :: forall a. HasCallStack => SomeException -> m a

  Rethrow arbitrary error without affecting the call stack. Used internally. You probably want to use cmiFailure

• cmiGetApproximateBlockInterval :: HasCallStack => m (Time Second)

  Get approximate block interval in seconds. Note, that this value is minimal bound and real intervals can be larger.

• cmiAttempt :: forall a e. (Exception e, HasCallStack) => m a -> m (Either e a)

  Attempts to perform an action, returning either the result of the action or an exception.

• cmiMarkAddressRefillable :: Address -> m ()

  Marks a given address as "refillable", i.e. if the address lacks funds for the next operation, some funds will automatically be transferred to it.

• cmiEmulatedImpl :: m (Maybe (EmulatedImpl m))

  Produce EmulatedImpl if possible. Used to run emulated actions in polymorphic context.

• cmiRunCode :: forall cp st vd. (HasCallStack, HasRPCRepr st, IsoValue (AsRPC st)) => Sender -> RunCode cp st vd -> m (AsRPC st)

  Execute a contract's code without originating it. The chain's state will not be modified.

data EmulatedImpl m

A record data type with all base methods one can use during cleveland, but which are available only when running on an emulated environment (e.g. Morley.Michelson.Runtime) and not on a real network.

Constructors

EmulatedImpl

Fields

• eiBranchout :: [(Text, m ())] -> m ()

  Execute multiple testing scenarios independently.

  • Actions performed before eiBranchout will be observed by all branches.
  • Actions performed in branches will _not_ be observed by any actions performed after eiBranchout.
  • Actions performed in one branch will _not_ be observed by another branch.
  • The test succeeds IFF all branches succeed.
  • If any branch fails, the test ends immediately and the remaining branches won't be executed.

  The following property holds:

  pre >> branchout [a, b, c] = branchout [pre >> a, pre >> b, pre >> c]

  The list of branches must be non-empty.

• eiGetStorage :: forall st addr. (HasCallStack, ToStorageType st addr) => addr -> m st

  Retrieve a contract's full storage, including the contents of its big_maps. This function can only be used in emulator-only tests.

• eiGetMorleyLogs :: forall a. m a -> m (LogsInfo, a)

  Returns the result of the action with the logs it produced

• eiSetVotingPowers :: VotingPowers -> m ()

  Change voting power distribution.

mapClevelandOpsImplExceptions :: (forall a. HasCallStack => m a -> m a) -> ClevelandOpsImpl m -> ClevelandOpsImpl m

Runs a handler over every action.

mapClevelandMiscImplExceptions :: (forall a. HasCallStack => m a -> m a) -> ClevelandMiscImpl m -> ClevelandMiscImpl m

Runs a handler over every action (except cmiAttempt and cmiThrow), possibly transforming exceptions thrown by those actions.

Batching

data BatchResultMismatch

A batch returned invalid output, e.g. origination address when transaction was supplied.

Constructors

BatchResultMismatch Text

Carries expected operation type in lowercase

Instances

Buildable BatchResultMismatch

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: BatchResultMismatch -> Builder

data ClevelandOpsBatch a

Where the batched operations occur.

Note that this is not a Monad, rather an Applicative - use -XApplicativeDo extension for nicer experience.

Instances

(TypeError (((('Text "Attempt to use monad capabilities within a batch" :$$: 'Text "In case you are using a do-block, make sure that") :$$: 'Text "\8226 `ApplicativeDo` extension is enabled") :$$: 'Text "\8226 there is a return statement in the end") :$$: 'Text "\8226 returned value picks variables in the order in which they are defined") :: Constraint) => Monad ClevelandOpsBatch

Defined in Test.Cleveland.Internal.Abstract

Methods

(>>=) :: ClevelandOpsBatch a -> (a -> ClevelandOpsBatch b) -> ClevelandOpsBatch b

(>>) :: ClevelandOpsBatch a -> ClevelandOpsBatch b -> ClevelandOpsBatch b

return :: a -> ClevelandOpsBatch a

Functor ClevelandOpsBatch

Defined in Test.Cleveland.Internal.Abstract

Methods

fmap :: (a -> b) -> ClevelandOpsBatch a -> ClevelandOpsBatch b

(<$) :: a -> ClevelandOpsBatch b -> ClevelandOpsBatch a

Applicative ClevelandOpsBatch

Defined in Test.Cleveland.Internal.Abstract

Methods

pure :: a -> ClevelandOpsBatch a

(<*>) :: ClevelandOpsBatch (a -> b) -> ClevelandOpsBatch a -> ClevelandOpsBatch b

liftA2 :: (a -> b -> c) -> ClevelandOpsBatch a -> ClevelandOpsBatch b -> ClevelandOpsBatch c

(*>) :: ClevelandOpsBatch a -> ClevelandOpsBatch b -> ClevelandOpsBatch b

(<*) :: ClevelandOpsBatch a -> ClevelandOpsBatch b -> ClevelandOpsBatch a

MonadOps ClevelandOpsBatch

Defined in Test.Cleveland.Internal.Actions

Methods

withOpsCap :: (ClevelandOpsImpl ClevelandOpsBatch -> ClevelandOpsBatch a) -> ClevelandOpsBatch a

runBatched :: (HasCallStack, Functor m) => ClevelandOpsImpl m -> ClevelandOpsBatch a -> m a

Run a series of operations within a batch.

Example:

contract <- runBatched impl $ do
  -- this block is executed within ClevelandOpsBatch
  contract <- runSingleOperation batchedOpsImpl "origination" ...
  for_ [1..3] i ->
    runSingleOperation batchedOpsImpl "transfer" ...
  return contract

See ClevelandOpsBatch for some precautions.

batchedOpsImpl :: ClevelandOpsImpl ClevelandOpsBatch

ClevelandOpsImpl suitable for methods executed within a batch.

runOperationBatchM :: (HasCallStack, Buildable e, Functor m) => Proxy e -> ClevelandOpsImpl m -> BatchingM (OperationInfo ClevelandInput) (OperationInfo Result) e a -> m a

Version of coiRunOperationBatch that uses BatchingM.

This is an internal function.

Invariant: all errors described by e must be internal and should not occur in practice (we require e type to be specified explicitly to hinder incorrect usage).

runSingleOperation :: (HasCallStack, Functor m) => ClevelandOpsImpl m -> Text -> OperationInfo ClevelandInput -> (OperationInfo Result -> Maybe a) -> m a

Helper that runs a single operation using ClevelandOpsImpl.

Validation

data TransferFailure

Failures that could be expected in the execution of a transfer. These can be caught and handled with attempt.

Constructors

TransferFailure

Fields

• tfAddress :: Address
• tfReason :: TransferFailureReason

Instances

Eq TransferFailure

Defined in Test.Cleveland.Internal.Abstract

Methods

(==) :: TransferFailure -> TransferFailure -> Bool

(/=) :: TransferFailure -> TransferFailure -> Bool

Show TransferFailure

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> TransferFailure -> ShowS

show :: TransferFailure -> String

showList :: [TransferFailure] -> ShowS

Exception TransferFailure

Defined in Test.Cleveland.Internal.Abstract

Methods

toException :: TransferFailure -> SomeException

fromException :: SomeException -> Maybe TransferFailure

displayException :: TransferFailure -> String

Buildable TransferFailure

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: TransferFailure -> Builder

data TransferFailureReason

Constructors

FailedWith ExpressionOrTypedValue (Maybe InstrCallStack)

Expect that interpretation of contract with the given address ended with FAILWITH.

EmptyTransaction

Expect failure due to an attempt to transfer 0tz towards a simple address.

BadParameter

Expect failure due to an attempt to call a contract with an invalid parameter.

MutezArithError MutezArithErrorType

Expect failure due to an arithmetic over-/underflow

ShiftOverflow

Expect that interpretation of contract with the given address ended with an overflow error.

GasExhaustion

Instances

Eq TransferFailureReason

Defined in Test.Cleveland.Internal.Abstract

Methods

(==) :: TransferFailureReason -> TransferFailureReason -> Bool

(/=) :: TransferFailureReason -> TransferFailureReason -> Bool

Show TransferFailureReason

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> TransferFailureReason -> ShowS

show :: TransferFailureReason -> String

showList :: [TransferFailureReason] -> ShowS

Buildable TransferFailureReason

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: TransferFailureReason -> Builder

data FailedInBranch

When an exception is thrown in a branchout branch, we wrap it in this constructor to remember in _which_ branch it was thrown. We use this information to provide better error messages when a test fails.

Constructors

FailedInBranch ScenarioBranchName SomeException

Instances

Show FailedInBranch

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> FailedInBranch -> ShowS

show :: FailedInBranch -> String

showList :: [FailedInBranch] -> ShowS

Exception FailedInBranch

Defined in Test.Cleveland.Internal.Abstract

Methods

toException :: FailedInBranch -> SomeException

fromException :: SomeException -> Maybe FailedInBranch

displayException :: FailedInBranch -> String

Buildable FailedInBranch

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: FailedInBranch -> Builder

newtype ScenarioBranchName

When using branchout function for building test scenarios - names of branches we are currently within.

Constructors

ScenarioBranchName

Fields

• unTestBranch :: [Text]

Instances

Eq ScenarioBranchName

Defined in Test.Cleveland.Internal.Abstract

Methods

(==) :: ScenarioBranchName -> ScenarioBranchName -> Bool

(/=) :: ScenarioBranchName -> ScenarioBranchName -> Bool

Show ScenarioBranchName

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> ScenarioBranchName -> ShowS

show :: ScenarioBranchName -> String

showList :: [ScenarioBranchName] -> ShowS

Buildable ScenarioBranchName

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: ScenarioBranchName -> Builder

data GenericTestError

Constructors

UnexpectedSuccess

Instances

Show GenericTestError

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> GenericTestError -> ShowS

show :: GenericTestError -> String

showList :: [GenericTestError] -> ShowS

Exception GenericTestError

Defined in Test.Cleveland.Internal.Abstract

Methods

toException :: GenericTestError -> SomeException

fromException :: SomeException -> Maybe GenericTestError

displayException :: GenericTestError -> String

Buildable GenericTestError

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: GenericTestError -> Builder

data ExpressionOrTypedValue where

Representation of Expression we got from the RPC or a typed value we got from the emulator.

Constructors

EOTVExpression :: Expression -> ExpressionOrTypedValue

EOTVTypedValue :: (SingI t, ConstantScope t) => Value t -> ExpressionOrTypedValue

Instances

Eq ExpressionOrTypedValue

Defined in Test.Cleveland.Internal.Abstract

Methods

(==) :: ExpressionOrTypedValue -> ExpressionOrTypedValue -> Bool

(/=) :: ExpressionOrTypedValue -> ExpressionOrTypedValue -> Bool

Show ExpressionOrTypedValue

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> ExpressionOrTypedValue -> ShowS

show :: ExpressionOrTypedValue -> String

showList :: [ExpressionOrTypedValue] -> ShowS

Buildable ExpressionOrTypedValue

Defined in Test.Cleveland.Internal.Abstract

Methods

build :: ExpressionOrTypedValue -> Builder

Helpers

auto :: SpecificOrDefaultAliasHint

Helper to use automatically determined unique alias.

ep :: HasCallStack => Text -> EpName

A short partial constructor for EpName. It is supposed to be applied to string constants, so programmer is responsible for validity. And this code is for tests anyway, so each failure is a programmer mistake.

It is intentionally here and not in some deeper module because the name is really short and more suitable for writing scenarios.

mkDefaultAlias :: Natural -> AliasHint

Morley client re-exports

data AliasHint

Instances

Show AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> AliasHint -> ShowS

show :: AliasHint -> String

showList :: [AliasHint] -> ShowS

IsString AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

fromString :: String -> AliasHint

Semigroup AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

(<>) :: AliasHint -> AliasHint -> AliasHint

sconcat :: NonEmpty AliasHint -> AliasHint

stimes :: Integral b => b -> AliasHint -> AliasHint

Monoid AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

mempty :: AliasHint

mappend :: AliasHint -> AliasHint -> AliasHint

mconcat :: [AliasHint] -> AliasHint

Buildable AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

build :: AliasHint -> Builder

Capability records

data ClevelandCaps m

A record with all the capabilities available to any cleveland test.

Constructors

ClevelandCaps

Fields

• ccSender :: Sender
• ccMoneybag :: Moneybag
• ccMiscCap :: ClevelandMiscImpl m
• ccOpsCap :: Sender -> ClevelandOpsImpl m

Instances

Monad m => HasClevelandCaps (ClevelandCaps m)

Defined in Test.Cleveland.Internal.Abstract

Associated Types

type ClevelandBaseMonad (ClevelandCaps m) :: Type -> Type

Methods

clevelandCapsL :: Lens' (ClevelandCaps m) (ClevelandCaps (ClevelandBaseMonad (ClevelandCaps m)))

type ClevelandBaseMonad (ClevelandCaps m)

Defined in Test.Cleveland.Internal.Abstract

type ClevelandBaseMonad (ClevelandCaps m) = m

data EmulatedCaps m

A record with all the capabilities available to a cleveland test on the emulator.

Constructors

EmulatedCaps

Fields

• ecEmulatedCap :: EmulatedImpl m
• ecClevelandCaps :: ClevelandCaps m

Instances

Monad m => HasEmulatedCaps (EmulatedCaps m)

Defined in Test.Cleveland.Internal.Abstract

Methods

getEmulatedCap :: EmulatedCaps m -> EmulatedImpl (ClevelandBaseMonad (EmulatedCaps m))

Monad m => HasClevelandCaps (EmulatedCaps m)

Defined in Test.Cleveland.Internal.Abstract

Associated Types

type ClevelandBaseMonad (EmulatedCaps m) :: Type -> Type

Methods

clevelandCapsL :: Lens' (EmulatedCaps m) (ClevelandCaps (ClevelandBaseMonad (EmulatedCaps m)))

type ClevelandBaseMonad (EmulatedCaps m)

Defined in Test.Cleveland.Internal.Abstract

type ClevelandBaseMonad (EmulatedCaps m) = m

class Monad (ClevelandBaseMonad caps) => HasClevelandCaps caps where

A proof that the given caps record contains the basic cleveland capabilities.

Associated Types

type ClevelandBaseMonad caps :: Type -> Type

This will be either PureM or ClientM.

Methods

clevelandCapsL :: Lens' caps (ClevelandCaps (ClevelandBaseMonad caps))

Instances

Monad m => HasClevelandCaps (EmulatedCaps m)

Defined in Test.Cleveland.Internal.Abstract

Associated Types

type ClevelandBaseMonad (EmulatedCaps m) :: Type -> Type

Methods

clevelandCapsL :: Lens' (EmulatedCaps m) (ClevelandCaps (ClevelandBaseMonad (EmulatedCaps m)))

Monad m => HasClevelandCaps (ClevelandCaps m)

Defined in Test.Cleveland.Internal.Abstract

Associated Types

type ClevelandBaseMonad (ClevelandCaps m) :: Type -> Type

Methods

clevelandCapsL :: Lens' (ClevelandCaps m) (ClevelandCaps (ClevelandBaseMonad (ClevelandCaps m)))

senderL :: HasClevelandCaps caps => Lens' caps Sender

moneybagL :: HasClevelandCaps caps => Lens' caps Moneybag

getMiscCap :: HasClevelandCaps caps => caps -> ClevelandMiscImpl (ClevelandBaseMonad caps)

getOpsCap :: HasClevelandCaps caps => caps -> ClevelandOpsImpl (ClevelandBaseMonad caps)

class HasClevelandCaps caps => HasEmulatedCaps caps where

A proof that the given caps record contains the basic cleveland capabilities + the emulator capabiilities.

Methods

getEmulatedCap :: caps -> EmulatedImpl (ClevelandBaseMonad caps)

Instances

Monad m => HasEmulatedCaps (EmulatedCaps m)

Defined in Test.Cleveland.Internal.Abstract

Methods

getEmulatedCap :: EmulatedCaps m -> EmulatedImpl (ClevelandBaseMonad (EmulatedCaps m))

type MonadCleveland caps m = (m ~ ReaderT caps (ClevelandBaseMonad caps), HasClevelandCaps caps)

Constraint for a monad in which we can do cleveland actions.

type MonadEmulated caps m = (MonadCleveland caps m, HasEmulatedCaps caps)

Constraint for a monad in which we can do cleveland actions that can't be run on a real network. It requires the EmulatedImpl capability.

type ClevelandT m = ReaderT (ClevelandCaps m) m

Monad transformer that adds only the ClevelandCaps capabilities.

type EmulatedT m = ReaderT (EmulatedCaps m) m

Monad transformer that adds both ClevelandCaps and EmulatedCaps capabilities.

Log utilities

type LogsInfo = [ScenarioLogs]

data ScenarioLogs

Constructors

ScenarioLogs

Fields

• _slAddr :: Address
• _slLog :: MorleyLogs

Instances

Eq ScenarioLogs

Defined in Test.Cleveland.Internal.Abstract

Methods

(==) :: ScenarioLogs -> ScenarioLogs -> Bool

(/=) :: ScenarioLogs -> ScenarioLogs -> Bool

Show ScenarioLogs

Defined in Test.Cleveland.Internal.Abstract

Methods

showsPrec :: Int -> ScenarioLogs -> ShowS

show :: ScenarioLogs -> String

showList :: [ScenarioLogs] -> ShowS

MonadWriter LogsInfo PureM

Defined in Test.Cleveland.Internal.Pure

Methods

writer :: (a, LogsInfo) -> PureM a

tell :: LogsInfo -> PureM ()

listen :: PureM a -> PureM (a, LogsInfo)

pass :: PureM (a, LogsInfo -> LogsInfo) -> PureM a

slAddr :: Lens' ScenarioLogs Address

slLog :: Lens' ScenarioLogs MorleyLogs

logsL :: Lens' ScenarioLogs MorleyLogs

An alias for slLog with a clearer name

filterLogsByAddrL :: (ToAddress addr, Applicative f) => addr -> (MorleyLogs -> f MorleyLogs) -> ScenarioLogs -> f ScenarioLogs

Lens combinator specified for filtering logs by address from LogsInfo

logsForAddress :: (Each s s ScenarioLogs ScenarioLogs, ToAddress addr) => addr -> s -> [MorleyLogs]

Get logs for a given address from LogsInfo

collectLogs :: LogsInfo -> MorleyLogs

Collect logs produced by all contracts into the single list