Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Cleveland actions.
Synopsis
- class (MonadTransfer m, MonadOriginate m) => MonadOps m
- class (forall mod am emit a. (SingI emit, DoTransfer mod, a ~ FTransferResult emit) => TransferFunc mod emit am (m a)) => MonadTransfer m
- class (forall ct bal large a. OFConstraint ct large (m a) => OriginateFunc ct bal large (m a)) => MonadOriginate m
- withSender :: MonadCleveland caps m => ImplicitAddress -> m a -> m a
- withMoneybag :: MonadCleveland caps m => ImplicitAddress -> m a -> m a
- runIO :: (HasCallStack, MonadCleveland caps m) => IO res -> m res
- resolveAddress :: (HasCallStack, MonadCleveland caps m) => Alias kind -> m (KindedAddress kind)
- refillable :: MonadCleveland caps m => m ImplicitAddress -> m ImplicitAddress
- newAddress :: (HasCallStack, MonadCleveland caps m) => SpecificOrDefaultAlias -> m ImplicitAddress
- newAddresses :: forall n n' caps m. (HasCallStack, MonadCleveland caps m, IsoNatPeano n n') => SizedList n SpecificOrDefaultAlias -> m (SizedList n ImplicitAddress)
- newFreshAddress :: (HasCallStack, MonadCleveland caps m) => SpecificOrDefaultAlias -> m ImplicitAddress
- enumAliases :: forall n n'. (SingIPeano n, IsoNatPeano n n') => ImplicitAlias -> SizedList n SpecificOrDefaultAlias
- signBytes :: (HasCallStack, MonadCleveland caps m) => ByteString -> ImplicitAddress -> m Signature
- signBinary :: (HasCallStack, BytesLike bs, MonadCleveland caps m) => bs -> ImplicitAddress -> m (TSignature bs)
- originate :: forall contract r. (HasCallStack, OriginateFunc contract 'NoBalance 'NotLarge r) => ContractAlias -> ContractStorage contract -> contract -> r
- data Large = Large
- transfer :: forall addr r. (HasCallStack, TransferFunc ('Incomplete (InitialTransferMode addr)) 'TransferIgnoreResult 'HasNoAmount r, ToL1Address addr) => addr -> r
- data WithContractEvents = WithContractEvents
- calling :: forall mname. EntrypointRef mname -> forall epArg param. (NiceParameter epArg, HasEntrypointArg param (EntrypointRef mname) epArg) => epArg -> GenericCall ('Checked param)
- unsafeCalling :: EpName -> forall epArg. NiceParameter epArg => epArg -> GenericCall 'Unchecked
- inBatch :: (HasCallStack, MonadCleveland caps m) => ClevelandOpsBatch a -> m a
- importUntypedContract :: (HasCallStack, MonadCleveland caps m) => FilePath -> m Contract
- importContract :: (HasCallStack, NiceParameter param, NiceStorage st, NiceViewsDescriptor vd, DemoteViewsDescriptor vd, MonadCleveland caps m) => FilePath -> m (Contract param st vd)
- noViews :: forall {k1} {k2} contract (cp :: k1) (st :: k2). contract cp st () -> contract cp st ()
- comment :: (HasCallStack, MonadCleveland caps m) => Text -> m ()
- getBalance :: (HasCallStack, MonadCleveland caps m, ToL1Address addr) => addr -> m Mutez
- getStorage :: forall st addr caps m. (HasCallStack, MonadCleveland caps m, ToStorageType st addr, IsoValue (AsRPC st)) => addr -> m (AsRPC st)
- getFullStorage :: forall st addr caps m. (HasCallStack, MonadEmulated caps m, ToStorageType st addr) => addr -> m st
- getSomeStorage :: forall addr caps m. (HasCallStack, MonadCleveland caps m, ToContractAddress addr) => addr -> m SomeAnnotatedValue
- getAllBigMapValues :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m [v]
- getAllBigMapValuesMaybe :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m (Maybe [v])
- getBigMapSize :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m Natural
- getBigMapSizeMaybe :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m (Maybe Natural)
- getBigMapValueMaybe :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NicePackedValue k, NiceUnpackedValue v) => BigMapId k v -> k -> m (Maybe v)
- getBigMapValue :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NicePackedValue k, NiceUnpackedValue v, Buildable k) => BigMapId k v -> k -> m v
- getMorleyLogs :: forall a caps m. MonadEmulated caps m => m a -> m (LogsInfo, a)
- getMorleyLogs_ :: MonadEmulated caps m => m () -> m LogsInfo
- getPublicKey :: (HasCallStack, MonadCleveland caps m) => ImplicitAddress -> m PublicKey
- getChainId :: (HasCallStack, MonadCleveland caps m) => m ChainId
- advanceTime :: forall unit caps m. (HasCallStack, MonadCleveland caps m, KnownDivRat unit Second) => Time unit -> m ()
- advanceLevel :: forall caps m. (HasCallStack, MonadCleveland caps m) => Natural -> m ()
- advanceToLevel :: forall caps m. (HasCallStack, MonadCleveland caps m) => Natural -> m ()
- getNow :: (HasCallStack, MonadCleveland caps m) => m Timestamp
- getLevel :: (HasCallStack, MonadCleveland caps m) => m Natural
- getApproximateBlockInterval :: (HasCallStack, MonadCleveland caps m) => m (Time Second)
- getMinBlockTime :: (HasCallStack, MonadCleveland caps m) => m Natural
- runCode :: (HasCallStack, MonadCleveland caps m, HasRPCRepr st, IsoValue (AsRPC st)) => RunCode cp st vd -> m (AsRPC st)
- branchout :: forall caps m. MonadEmulated caps m => [(Text, m ())] -> m ()
- offshoot :: forall caps m. MonadEmulated caps m => Text -> m () -> m ()
- getDelegate :: (HasCallStack, MonadCleveland caps m, ToContractAddress addr) => addr -> m (Maybe KeyHash)
- registerDelegate :: (HasCallStack, MonadCleveland caps m) => ImplicitAddress -> m ()
- setVotingPowers :: MonadEmulated caps m => VotingPowers -> m ()
- whenEmulation :: MonadCleveland caps m => (forall caps1 m1. (EqBaseMonad caps caps1, MonadEmulated caps1 m1) => m1 ()) -> m ()
- whenNetwork :: MonadCleveland caps m => (forall caps1 m1. (EqBaseMonad caps caps1, MonadNetwork caps1 m1) => m1 ()) -> m ()
- ifEmulation :: forall a caps m. MonadCleveland caps m => (forall caps1 m1. (EqBaseMonad caps caps1, MonadEmulated caps1 m1) => m1 a) -> (forall caps1 m1. (EqBaseMonad caps caps1, MonadNetwork caps1 m1) => m1 a) -> m a
- getMorleyClientEnv :: MonadNetwork caps m => m MorleyClientEnv
- failure :: forall a caps m. (HasCallStack, MonadCleveland caps m) => Builder -> m a
- assert :: (HasCallStack, MonadCleveland caps m) => Bool -> Builder -> m ()
- (@==) :: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) => a -> a -> m ()
- (@/=) :: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) => a -> a -> m ()
- (@@==) :: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) => m a -> a -> m ()
- (@@/=) :: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) => m a -> a -> m ()
- checkCompares :: forall a b caps m. (HasCallStack, MonadCleveland caps m, Buildable a, Buildable b) => a -> (a -> b -> Bool) -> b -> m ()
- checkComparesWith :: forall a b caps m. (HasCallStack, MonadCleveland caps m) => (a -> Text) -> a -> (a -> b -> Bool) -> (b -> Text) -> b -> m ()
- evalJust :: (HasCallStack, MonadCleveland caps m) => Builder -> Maybe a -> m a
- evalRight :: (HasCallStack, MonadCleveland caps m) => (a -> Builder) -> Either a b -> m b
- attempt :: forall e caps m a. (HasCallStack, MonadCleveland caps m, Exception e) => m a -> m (Either e a)
- catchTransferFailure :: (HasCallStack, MonadCleveland caps m) => m a -> m TransferFailure
- checkTransferFailure :: (HasCallStack, MonadCleveland caps m) => TransferFailure -> TransferFailurePredicate -> m ()
- expectTransferFailure :: (HasCallStack, MonadCleveland caps m) => TransferFailurePredicate -> m a -> m ()
- expectFailedWith :: forall err a caps m. (HasCallStack, MonadCleveland caps m, NiceConstant err) => err -> m a -> m ()
- expectError :: forall err a caps m. (HasCallStack, MonadCleveland caps m, IsError err) => err -> m a -> m ()
- expectCustomError :: forall arg a tag caps m. (HasCallStack, MonadCleveland caps m, IsError (CustomError tag), MustHaveErrorArg tag (MText, arg)) => Label tag -> arg -> m a -> m ()
- expectCustomError_ :: (HasCallStack, MonadCleveland caps m, IsError (CustomError tag), MustHaveErrorArg tag (MText, ())) => Label tag -> m a -> m ()
- expectCustomErrorNoArg :: (HasCallStack, MonadCleveland caps m, IsError (CustomError tag), MustHaveErrorArg tag MText) => Label tag -> m a -> m ()
- expectNumericError :: forall err a caps m. (HasCallStack, MonadCleveland caps m, IsError err) => ErrorTagMap -> err -> m a -> m ()
- clarifyErrors :: forall caps m a. MonadCleveland caps m => Builder -> m a -> m a
- data TransferFailurePredicate
- shiftOverflow :: TransferFailurePredicate
- emptyTransaction :: TransferFailurePredicate
- badParameter :: TransferFailurePredicate
- gasExhaustion :: TransferFailurePredicate
- failedWith :: SomeConstant -> TransferFailurePredicate
- addressIs :: ToAddress addr => addr -> TransferFailurePredicate
- constant :: forall err. NiceConstant err => err -> SomeConstant
- lerror :: forall err. IsError err => err -> SomeConstant
- customError :: forall arg tag. (IsError (CustomError tag), MustHaveErrorArg tag (MText, arg)) => Label tag -> arg -> SomeConstant
- customError_ :: (IsError (CustomError tag), MustHaveErrorArg tag (MText, ())) => Label tag -> SomeConstant
- customErrorNoArg :: (IsError (CustomError tag), MustHaveErrorArg tag MText) => Label tag -> SomeConstant
- numericError :: forall err. IsError err => ErrorTagMap -> err -> SomeConstant
Documentation
class (MonadTransfer m, MonadOriginate m) => MonadOps m Source #
Synonym typeclass for monads where network operations can occur.
This has instances for MonadCleveland
and ClevelandOpsBatch
contexts.
Practically, if you want to use transfer
or originate
in a monad, add a
MonadOps
constraint on it, f. ex.:
callEp1 :: MonadOps m => ContractHandle MyParam () () -> Integer -> m () callEp1 ch = transfer ch . calling (ep @"Entrypoint1")
Instances
(MonadTransfer m, MonadOriginate m) => MonadOps m Source # | |
Defined in Test.Cleveland.Internal.Actions |
class (forall mod am emit a. (SingI emit, DoTransfer mod, a ~ FTransferResult emit) => TransferFunc mod emit am (m a)) => MonadTransfer m Source #
A convenient synonym class to require the terminating instance for a given monad without leaking too much implementation detail.
Instances
(forall (mod :: TransferMode) (am :: HasAmount) (emit :: TransferResult) a. (SingI emit, DoTransfer mod, a ~ FTransferResult emit) => TransferFunc mod emit am (m a)) => MonadTransfer m Source # | |
Defined in Test.Cleveland.Internal.Actions.Transfer |
class (forall ct bal large a. OFConstraint ct large (m a) => OriginateFunc ct bal large (m a)) => MonadOriginate m Source #
A convenient synonym class to require the terminating instance for a given monad without leaking too much implementation detail.
Instances
(forall ct (bal :: HasBalance) (large :: LargeOrigination) (a :: k). OFConstraint ct large (m a) => OriginateFunc ct bal large (m a)) => MonadOriginate (m :: k -> Type) Source # | |
Defined in Test.Cleveland.Internal.Actions.Originate |
withSender :: MonadCleveland caps m => ImplicitAddress -> m a -> m a Source #
Update the current sender on whose behalf transfers and originations are invoked.
withMoneybag :: MonadCleveland caps m => ImplicitAddress -> m a -> m a Source #
Update the current moneybag that transfers money on the newly created addresses. For the rare occasions when this is necessary.
runIO :: (HasCallStack, MonadCleveland caps m) => IO res -> m res Source #
Runs an IO
action.
resolveAddress :: (HasCallStack, MonadCleveland caps m) => Alias kind -> m (KindedAddress kind) Source #
Get the address of the implicit account / contract associated with the given alias.
refillable :: MonadCleveland caps m => m ImplicitAddress -> m ImplicitAddress Source #
Simple combinator that marks address as "refillable".
If a refillable address lacks funds for the next operation, some funds will automatically be transferred to it.
newAddress :: (HasCallStack, MonadCleveland caps m) => SpecificOrDefaultAlias -> m ImplicitAddress Source #
If the given alias is already associated with an existing address, that address will be reused and returned. Otherwise, generate a new secret key and record it with given alias.
If the account has too low of a balance, a small amount of XTZ will be transferred to it.
Notes:
- By default, the XTZ is transferred from the account associated with the
moneybag
alias. This can be overridden with the--cleveland-moneybag-alias
command line option, theTASTY_CLEVELAND_MONEYBAG_ALIAS
env var, orwithMoneybag
.
newAddresses :: forall n n' caps m. (HasCallStack, MonadCleveland caps m, IsoNatPeano n n') => SizedList n SpecificOrDefaultAlias -> m (SizedList n ImplicitAddress) Source #
Batched version of newAddress
newFreshAddress :: (HasCallStack, MonadCleveland caps m) => SpecificOrDefaultAlias -> m ImplicitAddress Source #
Generate a new secret key and record it with given alias. If the alias is already known, the key will be overwritten. The address is guaranteed to be fresh, i. e. no operations on it have been made.
enumAliases :: forall n n'. (SingIPeano n, IsoNatPeano n n') => ImplicitAlias -> SizedList n SpecificOrDefaultAlias Source #
Create a list of similarly named SpecificAlias
es.
For example,
>>>
enumAliases @2 "operator" `isEquivalentTo` "operator-0" :< "operator-1" :< Nil
True
signBytes :: (HasCallStack, MonadCleveland caps m) => ByteString -> ImplicitAddress -> m Signature Source #
Get the signature of the preapplied operation.
signBinary :: (HasCallStack, BytesLike bs, MonadCleveland caps m) => bs -> ImplicitAddress -> m (TSignature bs) Source #
Type-safer version of signBytes
.
originate :: forall contract r. (HasCallStack, OriginateFunc contract 'NoBalance 'NotLarge r) => ContractAlias -> ContractStorage contract -> contract -> r Source #
Originate a new contract with given data.
Can accept untypted or Lorentz contracts as-is. With typed Michelson contracts,
you need to wrap the contract in TypedContract
specifying its Haskell-land
parameter, storage types and view descriptors, e.g.
originate "typed contract" defaultStorage $ TypedContract @Param @Storage @() michelsonContract
Storage type can be auto-deduced in most cases, so you can skip it with @_
.
After the mandatory arguments, you can add Large
or a Mutez
value, e.g.
by using tz
quasi-quoter:
originate "contract" initialStorage contract Large originate "contract" initialStorage contract [tz|123micro|] originate "contract" initialStorage contract [tz|123micro|] Large
The order is arbitrary, but each can be specified at most once.
Mark a contract that doesn't fit into the origination size limit. This will execute multiple origination steps.
Such origination cannot be batched (it simply may not fit).
Instances
(ModifyOriginationData (ContractOriginateData ct), OriginateFunc ct bal 'IsLarge r, CheckDupLarge isLarge, isLarge ~ 'NotLarge) => OriginateFunc ct bal isLarge (Large -> r) Source # | |
Defined in Test.Cleveland.Internal.Actions.Originate originate'r :: ContractOriginateData ct isLarge -> Large -> r Source # |
transfer :: forall addr r. (HasCallStack, TransferFunc ('Incomplete (InitialTransferMode addr)) 'TransferIgnoreResult 'HasNoAmount r, ToL1Address addr) => addr -> r Source #
Base method for making a transfer.
You can specify additional arguments after the destination address to modify
optional transfer arguments. Those can either be Mutez
to specify transfer
amount (0 by default), or a specially constructed call descriptor. The order
is arbitrary, but it is usually more convenient to specify transfer amount
first. For example:
transfer addr [tz|123u|] $ calling (ep @"Entrypoint") () transfer addr [tz|123u|]
If the call isn't specified, then the default entrypoint will be called with
()
, i.e.
transfer addr
is functionally the same as
transfer addr $ calling def ()
If the address in the first argument is untyped, the transfer is unchecked.
Unchecked transfers must use unsafeCalling
for the call specification. You
can also use unsafeCalling
with typed address to force an unchecked
transfer.
See Test.Cleveland.Internal.Actions.Transfer for further explanation of the interface.
By default, the sender is the account associated with the moneybag
alias.
This can be overridden with the --cleveland-moneybag-alias
command line
option, the TASTY_CLEVELAND_MONEYBAG_ALIAS
env var, or withSender
.
data WithContractEvents Source #
transfer
flag to signal we want contract events emitted by EMIT
returned. Passed in the variadic part of transfer
, e.g.
transfer addr [tz|123u|] WithContractEvents $ calling (ep @"Entrypoint") ()
Instances
(TransferFunc mode 'TransferWithEmits am r, NoDuplicateEmit emit, emit ~ 'TransferIgnoreResult) => TransferFunc mode emit am (WithContractEvents -> r) Source # | |
Defined in Test.Cleveland.Internal.Actions.Transfer transfer'r :: GenericTransferData mode -> WithContractEvents -> r Source # |
calling :: forall mname. EntrypointRef mname -> forall epArg param. (NiceParameter epArg, HasEntrypointArg param (EntrypointRef mname) epArg) => epArg -> GenericCall ('Checked param) Source #
Safely call an entrypoint specified by the first argument with the provided parameter.
The first character of the entrypoint name must be capitalized.
This is "safe" in the sense that the contract is checked if it indeed has the specified entrypoint and the entrypoint in question accepts the argument provided, a type error is raised otherwise.
transfer addr $ calling (ep @"Entrypoint") ()
Use CallDefault
or def
to call the default entrypoint.
transfer addr $ calling def ()
Notice that type variables for entrypoint argument and full parameter are specified after the entrypoint. This is done so more for readability. F. ex.:
transfer addr $ calling def @Integer 123
This does also marginally simplify type inference in the case of partial application.
unsafeCalling :: EpName -> forall epArg. NiceParameter epArg => epArg -> GenericCall 'Unchecked Source #
Unsafely call an entrypoint specified by the first argument with the provided parameter.
This is "unsafe" in the sense that there is no check that the contract indeed has the specified entrypoint or that the entrypoint in question accepts the argument provided.
Also, no compile-time checks are performed on the entrypoint name, so it can be malformed.
transfer addr $ unsafeCalling (ep @"Entrypoint") ()
Overloaded labels are supported with unsafeCalling
, so you can specify the
entrypoint as an overloaded label:
transfer addr $ unsafeCalling #entrypoint ()
Use DefEpName
or def
to call the default entrypoint.
Notice that the type variable for the entrypoint argument is specified after the entrypoint. This is done so more for readability. F. ex.:
transfer addr $ calling def @Integer 123
This does also marginally simplify type inference in the case of partial application.
inBatch :: (HasCallStack, MonadCleveland caps m) => ClevelandOpsBatch a -> m a Source #
Run operations in a batch.
Best used with the ApplicativeDo
GHC extension.
Example:
contract <- inBatch $ do contract <- originate ... for_ [1..3] i -> transfer ... return contract
Batched operations should be applied to chain faster, but note that batches have their own limits. For instance, at the moment of writing, the gas limit on a batch is 10x of gas limit applied to a single operation.
A context of a batch is only Applicative
, not Monad
. This means that:
- Return values of one function cannot be passed to another function in the same batch, it can only be returned;
- Sometimes the compiler does not recognize that only
Applicative
context is required, in case of any issues with that - follow the error messages.
importUntypedContract :: (HasCallStack, MonadCleveland caps m) => FilePath -> m Contract Source #
Import an untyped contract from file.
importContract :: (HasCallStack, NiceParameter param, NiceStorage st, NiceViewsDescriptor vd, DemoteViewsDescriptor vd, MonadCleveland caps m) => FilePath -> m (Contract param st vd) Source #
Import a contract from file.
The compiler must be able to infer the types of parameter, storage and views.
In case there are no views or you don't care, you can use noViews
.
noViews :: forall {k1} {k2} contract (cp :: k1) (st :: k2). contract cp st () -> contract cp st () #
comment :: (HasCallStack, MonadCleveland caps m) => Text -> m () Source #
Print the given string verbatim as a comment. At the moment, this is a no-op in emulator tests.
getBalance :: (HasCallStack, MonadCleveland caps m, ToL1Address addr) => addr -> m Mutez Source #
Get the balance of the given address.
getStorage :: forall st addr caps m. (HasCallStack, MonadCleveland caps m, ToStorageType st addr, IsoValue (AsRPC st)) => addr -> m (AsRPC st) Source #
Retrieve a contract's storage in its "RPC representation" (i.e., all its big_maps will be replaced by big_map IDs).
If the storage is of a user-defined type, then deriveRPC
/
deriveManyRPC
should be used to create an RPC representation of the storage
type.
data MyStorage = MyStorage { field1 :: Natural, field2 :: BigMap Integer MText } deriveRPC "MyStorage"
getFullStorage :: forall st addr caps m. (HasCallStack, MonadEmulated caps m, ToStorageType st addr) => addr -> m st Source #
Retrieve a contract's full storage, including the contents of its big_maps.
This function can only be used in emulator-only tests.
getSomeStorage :: forall addr caps m. (HasCallStack, MonadCleveland caps m, ToContractAddress addr) => addr -> m SomeAnnotatedValue Source #
Similar to getStorage
, but doesn't require knowing
the storage type in advance.
Use the optics in AnnotatedValue
to
read data from the storage.
getAllBigMapValues :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m [v] Source #
Like getAllBigMapValuesMaybe
, but fails the tests instead of returning Nothing
.
getAllBigMapValuesMaybe :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m (Maybe [v]) Source #
Retrieve all big_map values, given a big_map ID.
Returns Nothing
when the big_map ID does not exist.
getBigMapSize :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m Natural Source #
Like getBigMapSizeMaybe
, but fails the tests instead of returning Nothing
.
getBigMapSizeMaybe :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NiceUnpackedValue v) => BigMapId k v -> m (Maybe Natural) Source #
Retrieve a big_map size, given a big_map ID.
Returns Nothing
when the big_map ID does not exist.
O(n), because it's implemented with getBigMapValues
.
getBigMapValueMaybe :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NicePackedValue k, NiceUnpackedValue v) => BigMapId k v -> k -> m (Maybe v) Source #
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.
getBigMapValue :: forall k v caps m. (HasCallStack, MonadCleveland caps m, NiceComparable k, NicePackedValue k, NiceUnpackedValue v, Buildable k) => BigMapId k v -> k -> m v Source #
Like getBigMapValueMaybe
, but fails the tests instead of returning Nothing
.
getMorleyLogs :: forall a caps m. MonadEmulated caps m => m a -> m (LogsInfo, a) Source #
Returns the result of the action with the logs it produced. Logs are messages
printed by the Lorentz instruction printComment
.
This function can be combined either with lens-based accessors or helper functions to get more specific information about logs.
Examples:
(logsInfo, _) <- getMorleyLogs scenario
logsInfo ^.. each . logsL == [MorleyLogs ["log"], MorleyLogs ["log2"]]
logsInfo ^.. each . filterLogsByAddrL addr
== [MorleyLogs ["log"]]
(logsInfo, _) <- getMorleyLogs scenario
collectLogs logsInfo == MorleyLogs ["log", "log2"]
logsForAddress logsInfo
== [MorleyLogs ["log"]]
getMorleyLogs_ :: MonadEmulated caps m => m () -> m LogsInfo Source #
Version of getMorleyLogs
for actions that don't return a result.
getPublicKey :: (HasCallStack, MonadCleveland caps m) => ImplicitAddress -> m PublicKey Source #
Get the public key associated with given address. Fail if given address is not an implicit account.
getChainId :: (HasCallStack, MonadCleveland caps m) => m ChainId Source #
Get the chain's ChainId
.
advanceTime :: forall unit caps m. (HasCallStack, MonadCleveland caps m, KnownDivRat unit Second) => Time unit -> m () Source #
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.
advanceLevel :: forall caps m. (HasCallStack, MonadCleveland caps m) => Natural -> m () Source #
Wait till the provided number of levels is past.
advanceToLevel :: forall caps m. (HasCallStack, MonadCleveland caps m) => Natural -> m () Source #
Wait till the provided level is reached.
getNow :: (HasCallStack, MonadCleveland caps m) => m Timestamp Source #
Get the timestamp observed by the last block to be baked.
getLevel :: (HasCallStack, MonadCleveland caps m) => m Natural Source #
Get the current level observed by the last block to be baked.
getApproximateBlockInterval :: (HasCallStack, MonadCleveland caps m) => m (Time Second) Source #
Get approximate block interval in seconds. Note, that this value is minimal bound and real intervals can be larger, see http://tezos.gitlab.io/active/consensus.html#minimal-block-delay-function for more information about block delays.
getMinBlockTime :: (HasCallStack, MonadCleveland caps m) => m Natural Source #
Get minimal block delay in seconds. This is essentially the same as
getApproximateBlockInterval
, but returns a Natural
instead of Time
Second
.
Can be useful when testing code using MIN_BLOCK_TIME
instruction.
runCode :: (HasCallStack, MonadCleveland caps m, HasRPCRepr st, IsoValue (AsRPC st)) => RunCode cp st vd -> m (AsRPC st) Source #
Execute a contract's code without originating it. The chain's state will not be modified.
Notes:
- If the contract's code emits operations, they will not be executed.
- The sender's account won't be debited.
- When running an _originated_ contract, the
BALANCE
instruction returns the sum of the contract's balance before the transfer operation + the amount of tz being transferred. In other words, this invariant holds:BALANCE >= AMOUNT
. However, sincerunCode
allows overriding theBALANCE
instruction, then this invariant no longer holds. It's possible thatBALANCE < AMOUNT
.
branchout :: forall caps m. MonadEmulated caps m => [(Text, m ())] -> m () Source #
Execute multiple testing scenarios independently.
- Actions performed before
branchout
will be observed by all branches. - Actions performed in branches will _not_ be observed by any actions performed after
branchout
. - 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.
offshoot :: forall caps m. MonadEmulated caps m => Text -> m () -> m () Source #
getDelegate :: (HasCallStack, MonadCleveland caps m, ToContractAddress addr) => addr -> m (Maybe KeyHash) Source #
Get the delegate for the given contract. Fails on implicit contracts.
registerDelegate :: (HasCallStack, MonadCleveland caps m) => ImplicitAddress -> m () Source #
Register the given address as a valid delegate.
setVotingPowers :: MonadEmulated caps m => VotingPowers -> m () Source #
Updates voting power accessible via VOTING_POWER
and similar
instructions.
whenEmulation :: MonadCleveland caps m => (forall caps1 m1. (EqBaseMonad caps caps1, MonadEmulated caps1 m1) => m1 ()) -> m () Source #
Perform an action if we are currently in emulation mode.
See also ifEmulation
note on constraints.
whenNetwork :: MonadCleveland caps m => (forall caps1 m1. (EqBaseMonad caps caps1, MonadNetwork caps1 m1) => m1 ()) -> m () Source #
Perform an action if we are currently in network mode.
See also ifEmulation
note on constraints.
ifEmulation :: forall a caps m. MonadCleveland caps m => (forall caps1 m1. (EqBaseMonad caps caps1, MonadEmulated caps1 m1) => m1 a) -> (forall caps1 m1. (EqBaseMonad caps caps1, MonadNetwork caps1 m1) => m1 a) -> m a Source #
Perform one action if we are currently in emulation mode, another otherwise
Functions passed as the first two arguments are universally quantified over
the outer monad, so if additional constraints are required beyond
MonadEmulated
or MonadCleveland
, those constraints have to go on the base
monad, e.g.
someFunction :: (MonadCleveland caps m, MonadFail (ClevelandBaseMonad caps)) => m () someFunction = whenEmulation do Just x <- pure (Just 1 :: Maybe Int) -- this would error without MonadFail runIO $ print x
getMorleyClientEnv :: MonadNetwork caps m => m MorleyClientEnv Source #
Get a MorleyClientEnv
when running a test on network. Useful to run
f.ex. tezos-client
inside a network test.
This is considered a pretty low-level function, so it's better to avoid it in most cases.
Assertions
failure :: forall a caps m. (HasCallStack, MonadCleveland caps m) => Builder -> m a Source #
Fails the test with the given error message.
assert :: (HasCallStack, MonadCleveland caps m) => Bool -> Builder -> m () Source #
Fails the test with the given error message if the given condition is false.
:: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) | |
=> a | The actual value. |
-> a | The expected value. |
-> m () |
x @== expected
fails the test if x
is not equal to expected
.
(@/=) :: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) => a -> a -> m () infix 1 Source #
Fails the test if the two given values are equal.
:: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) | |
=> m a | The actual value. |
-> a | The expected value. |
-> m () |
Monadic version of @==
.
getBalance addr @@== 10
(@@/=) :: (HasCallStack, MonadCleveland caps m, Eq a, Buildable a) => m a -> a -> m () infix 1 Source #
Monadic version of @/=
.
getBalance addr @@/= 10
checkCompares :: forall a b caps m. (HasCallStack, MonadCleveland caps m, Buildable a, Buildable b) => a -> (a -> b -> Bool) -> b -> m () Source #
Fails the test if the comparison operator fails when applied to the given arguments. Prints an error message with both arguments.
Example:
checkCompares 2 (>) 1
checkComparesWith :: forall a b caps m. (HasCallStack, MonadCleveland caps m) => (a -> Text) -> a -> (a -> b -> Bool) -> (b -> Text) -> b -> m () Source #
Like checkCompares
, but with an explicit show function.
This function does not have any constraint on the type parameters a
and b
.
For example, to print with pretty
:
checkComparesWith pretty a (<) pretty b
evalJust :: (HasCallStack, MonadCleveland caps m) => Builder -> Maybe a -> m a Source #
evalRight :: (HasCallStack, MonadCleveland caps m) => (a -> Builder) -> Either a b -> m b Source #
Exception handling
attempt :: forall e caps m a. (HasCallStack, MonadCleveland caps m, Exception e) => m a -> m (Either e a) Source #
Attempt to run an action and return its result or, if interpretation fails, an error.
catchTransferFailure :: (HasCallStack, MonadCleveland caps m) => m a -> m TransferFailure Source #
Asserts that a transfer should fail, and returns the exception.
checkTransferFailure :: (HasCallStack, MonadCleveland caps m) => TransferFailure -> TransferFailurePredicate -> m () Source #
Check whether a given predicate holds for a given TransferFailure
.
expectTransferFailure :: (HasCallStack, MonadCleveland caps m) => TransferFailurePredicate -> m a -> m () Source #
Asserts that a transfer should fail, and runs some TransferFailurePredicate
s over the
exception.
expectTransferFailure (failedWith (constant @MText "NOT_ADMIN")) $ call contractAddr (Call @"Ep") arg
call contractAddr (Call @"Ep") arg & expectTransferFailure ( failedWith (customError #tag 3) && addressIs contractAddr )
expectFailedWith :: forall err a caps m. (HasCallStack, MonadCleveland caps m, NiceConstant err) => err -> m a -> m () Source #
Asserts that interpretation of a contract ended with FAILWITH
, returning the given constant
value.
expectError :: forall err a caps m. (HasCallStack, MonadCleveland caps m, IsError err) => err -> m a -> m () Source #
Asserts that interpretation of a contract ended with FAILWITH
, returning the given lorentz
error.
expectCustomError :: forall arg a tag caps m. (HasCallStack, MonadCleveland caps m, IsError (CustomError tag), MustHaveErrorArg tag (MText, arg)) => Label tag -> arg -> m a -> m () Source #
Asserts that interpretation of a contract ended with FAILWITH
, returning the given custom
lorentz error.
expectCustomError_ :: (HasCallStack, MonadCleveland caps m, IsError (CustomError tag), MustHaveErrorArg tag (MText, ())) => Label tag -> m a -> m () Source #
Version of expectCustomError
for error with unit
argument.
expectCustomErrorNoArg :: (HasCallStack, MonadCleveland caps m, IsError (CustomError tag), MustHaveErrorArg tag MText) => Label tag -> m a -> m () Source #
Version of expectCustomError
specialized for expecting NoErrorArg
s.
expectNumericError :: forall err a caps m. (HasCallStack, MonadCleveland caps m, IsError err) => ErrorTagMap -> err -> m a -> m () Source #
Asserts that interpretation of a contract ended with FAILWITH
, returning the given lorentz
numeric error.
clarifyErrors :: forall caps m a. MonadCleveland caps m => Builder -> m a -> m a Source #
Prefix scenario-custom error messages (i.e. CustomTestError
either from pure or non-pure
implementation), potentially thrown from the given code block.
The prefix will be put at a separate line before the main text, if text is multiline, otherwise
it will be separated from the main text with :
.
This affects errors produced by functions like failure
, assert
, @==
, etc.
Errors related to events in the chain will not be touched.
Example:
for [1..10] \i -> clarifyErrors ("For i=" +| i |+ "") $ askContract i @@== i * 2
TransferFailure predicates
data TransferFailurePredicate Source #
A predicate that checks whether a transfer operation failed for the expected reason.
Predicates can be combined using the &&
and ||
operators.
TransferFailurePredicate (TransferFailure -> Validation Builder ()) | A predicate that either returns () or, if it fails, a message explaining what the expected outcome was. |
AndPredicate (NonEmpty TransferFailurePredicate) | |
OrPredicate (NonEmpty TransferFailurePredicate) |
shiftOverflow :: TransferFailurePredicate Source #
Asserts that interpretation of a contract failed due to an overflow error.
emptyTransaction :: TransferFailurePredicate Source #
Asserts that an action failed due to an attempt to transfer 0tz towards a simple address.
badParameter :: TransferFailurePredicate Source #
Asserts that an action failed due to an attempt to call a contract with an invalid parameter.
gasExhaustion :: TransferFailurePredicate Source #
Asserts that interpretation of a contract failed due to gas exhaustion.
failedWith :: SomeConstant -> TransferFailurePredicate Source #
Asserts that interpretation of a contract ended with FAILWITH
, throwing the given error.
This function should be used together with one of the "FAILWITH
constructors"
(e.g. constant
, customError
).
:: ToAddress addr | |
=> addr | The expected address. |
-> TransferFailurePredicate |
Asserts that the error occurred while interpreting the contract with the given address.
FAILWITH
errors
constant :: forall err. NiceConstant err => err -> SomeConstant Source #
A constant michelson value that a contract threw with FAILWITH
.
customError :: forall arg tag. (IsError (CustomError tag), MustHaveErrorArg tag (MText, arg)) => Label tag -> arg -> SomeConstant Source #
A custom lorentz error.
customError_ :: (IsError (CustomError tag), MustHaveErrorArg tag (MText, ())) => Label tag -> SomeConstant Source #
A custom lorentz error with a unit
argument.
customErrorNoArg :: (IsError (CustomError tag), MustHaveErrorArg tag MText) => Label tag -> SomeConstant Source #
A custom lorentz error with no argument.
numericError :: forall err. IsError err => ErrorTagMap -> err -> SomeConstant Source #
A lorentz numeric error.