Safe Haskell	Safe-Inferred
Language	Haskell2010

Morley.Michelson.Runtime

Contents

High level interface for end user
Other helpers
Re-exports
For testing

Description

Executor and typechecker of a contract in Morley language.

Synopsis

originateContract :: ("dbPath" :! FilePath) -> ("tcOpts" :? TypeCheckOptions) -> ("originator" :? ImplicitAddress) -> ("alias" :? ContractAlias) -> ("delegate" :? KeyHash) -> ("csod" :! ContractSimpleOriginationData Contract) -> ("verbose" :? Bool) -> IO ContractAddress
runContract :: CommonRunOptions -> ContractSimpleOriginationData Contract -> TxData -> IO SomeStorage
transfer :: CommonRunOptions -> SomeAddressOrAlias -> TxData -> IO ()
runCode :: RunCodeParameters cp epArg st -> Either (InterpretError Void) ([Operation], Value st)
runView :: CommonRunOptions -> ContractSpecification (ContractSimpleOriginationData Contract) -> ViewName -> SomeAddressOrAlias -> TxParam -> IO SomeValue
data RunCodeParameters cp epArg st = RunCodeParameters {
- rcScript :: Contract cp st
- rcStorage :: Value st
- rcInput :: Value epArg
- rcEntryPoint :: EntrypointCallT cp epArg
- rcAmount :: Mutez
- rcBalance :: Mutez
- rcChainId :: ChainId
- rcNow :: Timestamp
- rcLevel :: Natural
- rcMinBlockTime :: Natural
- rcSource :: L1Address
- rcSender :: L1Address
- rcKnownContracts :: Map ContractAddress ContractState
- rcSelf :: Maybe ContractAddress
- rcDelegate :: Maybe KeyHash
- rcVotingPowers :: VotingPowers
}
runCodeParameters :: Contract cp st -> Value st -> EntrypointCallT cp epArg -> Value epArg -> RunCodeParameters cp epArg st
resolveRunCodeBigMaps :: SingI t => BigMapFinder -> Value -> Either TcError (Value t)
mkBigMapFinder :: ExecutorM BigMapFinder
data CommonRunOptions = CommonRunOptions {
- croNow :: Maybe Timestamp
- croLevel :: Natural
- croMinBlockTime :: Natural
- croMaxSteps :: RemainingSteps
- croDBPath :: FilePath
- croTCOpts :: TypeCheckOptions
- croVerbose :: Bool
- croDryRun :: Bool
}
data ContractSpecification a
- = ContractSpecAddressOrAlias ContractAddressOrAlias
- | ContractSpecOrigination a
data ContractSimpleOriginationData a = ContractSimpleOriginationData {
- csodContract :: a
- csodStorage :: Value
- csodBalance :: Mutez
}
parseContract :: MichelsonSource -> Text -> Either ParserException (Contract' ParsedOp)
parseExpandContract :: MichelsonSource -> Text -> Either ParserException Contract
readAndParseContract :: Maybe FilePath -> IO (Contract' ParsedOp)
prepareContract :: Maybe FilePath -> IO Contract
data ContractState = forall cp st.(ParameterScope cp, StorageScope st) => ContractState {
- csBalance :: Mutez
- csContract :: Contract cp st
- csStorage :: Value st
- csDelegate :: Maybe KeyHash
}
data VotingPowers
mkVotingPowers :: [(KeyHash, Natural)] -> VotingPowers
mkVotingPowersFromMap :: Map KeyHash Natural -> VotingPowers
data TxData = TxData {
- tdSenderAddress :: L1Address
- tdParameter :: TxParam
- tdEntrypoint :: EpName
- tdAmount :: Mutez
}
data TxParam where
- TxTypedParam :: forall t. ParameterScope t => Value t -> TxParam
- TxUntypedParam :: Value -> TxParam
data ExecutorOp
- = OriginateOp OriginationOperation
- | TransferOp TransferOperation
- | SetDelegateOp SetDelegateOperation
- | EmitOp EmitOperation
data ExecutorRes = ExecutorRes {
- _erGState :: GState
- _erUpdates :: [GStateUpdate]
- _erInterpretResults :: [(Address, SomeInterpretResult)]
- _erRemainingSteps :: RemainingSteps
}
erGState :: Lens' ExecutorRes GState
erUpdates :: Lens' ExecutorRes [GStateUpdate]
erInterpretResults :: Lens' ExecutorRes [(Address, SomeInterpretResult)]
erRemainingSteps :: Lens' ExecutorRes RemainingSteps
data ExecutorError' a = ExecutorError {
- eeCallStack :: [ExecutorOp]
- eeError :: ExecutorErrorPrim a
}
data ExecutorErrorPrim a
- = EEUnknownContract a
- | EEInterpreterFailed a (InterpretError Void)
- | EEViewLookupError a ViewLookupError
- | EEViewArgTcError a TcError
- | EEUnknownAddressAlias SomeAlias
- | EEUnknownL1AddressAlias Text
- | EEAmbiguousAlias Text ImplicitAddress ContractAddress
- | EEUnknownSender a
- | EEUnknownManager a
- | EENotEnoughFunds a Mutez
- | EEEmptyImplicitContract a
- | EEZeroTransaction a
- | EEFailedToApplyUpdates GStateUpdateError
- | EEIllTypedParameter a TcError
- | EEDeprecatedType TcError
- | EEUnexpectedParameterType a (MismatchError T)
- | EEUnknownEntrypoint EpName
- | EETransactionFromContract a Mutez
- | EEWrongParameterType a
- | EEOperationReplay ExecutorOp
- | EEGlobalOperationSourceNotImplicit Address
- | EEGlobalEmitOp
type ExecutorError = ExecutorError' Address
type ExecutorM = ReaderT ExecutorEnv (StateT ExecutorState (Except ExecutorError))
runExecutorM :: Timestamp -> Natural -> Natural -> RemainingSteps -> TypeCheckOptions -> GState -> ExecutorM a -> Either ExecutorError (ExecutorRes, a)
runExecutorMWithDB :: CommonRunOptions -> ExecutorM a -> IO (ExecutorRes, a)
executeGlobalOperations :: [ExecutorOp] -> ExecutorM [EmitOperation]
executeGlobalOrigination :: OriginationOperation -> ExecutorM ContractAddress
executeOrigination :: ("isGlobalOp" :! Bool) -> OriginationOperation -> ExecutorM ContractAddress
executeTransfer :: ("isGlobalOp" :! Bool) -> TransferOperation -> ExecutorM [ExecutorOp]
data ExecutorState = ExecutorState {
- _esGState :: GState
- _esRemainingSteps :: RemainingSteps
- _esSourceAddress :: Maybe L1Address
- _esLog :: ExecutorLog
- _esOperationHash :: ~OperationHash
- _esPrevCounters :: HashSet GlobalCounter
}
esGState :: Lens' ExecutorState GState
esRemainingSteps :: Lens' ExecutorState RemainingSteps
esSourceAddress :: Lens' ExecutorState (Maybe L1Address)
esLog :: Lens' ExecutorState ExecutorLog
esOperationHash :: Lens' ExecutorState OperationHash
esPrevCounters :: Lens' ExecutorState (HashSet GlobalCounter)
data ExecutorLog = ExecutorLog {
- _elUpdates :: [GStateUpdate]
- _elInterpreterResults :: [(Address, SomeInterpretResult)]
}
data SomeInterpretResult = forall st.SomeInterpretResult {
- unSomeInterpretResult :: InterpretResult st
}
elInterpreterResults :: Lens' ExecutorLog [(Address, SomeInterpretResult)]
elUpdates :: Lens' ExecutorLog [GStateUpdate]

High level interface for end user

originateContract :: ("dbPath" :! FilePath) -> ("tcOpts" :? TypeCheckOptions) -> ("originator" :? ImplicitAddress) -> ("alias" :? ContractAlias) -> ("delegate" :? KeyHash) -> ("csod" :! ContractSimpleOriginationData Contract) -> ("verbose" :? Bool) -> IO ContractAddress Source #

Originate a contract. Returns the address of the originated contract.

runContract :: CommonRunOptions -> ContractSimpleOriginationData Contract -> TxData -> IO SomeStorage Source #

Run a contract. The contract is originated first (if it's not already) and then we pretend that we send a transaction to it.

transfer :: CommonRunOptions -> SomeAddressOrAlias -> TxData -> IO () Source #

Send a transaction to given address with given parameters.

runCode :: RunCodeParameters cp epArg st -> Either (InterpretError Void) ([Operation], Value st) Source #

Emulate run_code RPC endpoint to an extent. Unlike runContract, runs the contract through the emulator directly, without doing any operations. This includes not doing the origination operation, and not applying the operations produced by the transfer.

runView :: CommonRunOptions -> ContractSpecification (ContractSimpleOriginationData Contract) -> ViewName -> SomeAddressOrAlias -> TxParam -> IO SomeValue Source #

Run a contract view. The contract is originated first (if it's not already) and then we pretend that we send a transaction to it.

data RunCodeParameters cp epArg st Source #

Data required for calling runCode.

Constructors

RunCodeParameters

Fields

rcScript :: Contract cp st
Contract code to run
rcStorage :: Value st
Initial contract storage
rcInput :: Value epArg
Parameter to call the contract
rcEntryPoint :: EntrypointCallT cp epArg
Entrypoint to call. Use mkEntrypointCall to construct.
rcAmount :: Mutez
Transfer amount
rcBalance :: Mutez
Contract initial balance
rcChainId :: ChainId
Chain id
rcNow :: Timestamp
The result of NOW instruction
rcLevel :: Natural
The result of LEVEL instruction
rcMinBlockTime :: Natural
The result of MIN_BLOCK_TIME instruction
rcSource :: L1Address
Transfer source
rcSender :: L1Address
Transfer sender
rcKnownContracts :: Map ContractAddress ContractState
Known contracts and their state. If you only know parameter types and don't need to run contract's views, you can use dummyContractState to construct the state.
rcSelf :: Maybe ContractAddress
Address returned by the SELF instruction, will be auto-generated if Nothing
rcDelegate :: Maybe KeyHash
Contract's delegate
rcVotingPowers :: VotingPowers
Voting powers

runCodeParameters Source #

Arguments

:: Contract cp st	Contract to run
-> Value st	Contract storage
-> EntrypointCallT cp epArg	Entrypoint call specification
-> Value epArg	Entrypoint argument
-> RunCodeParameters cp epArg st

Construct RunCodeParameters with some reasonable defaults.

Prepare untyped storage and parameter with resolveRunCodeBigMaps.

Use mkEntrypointCall or mkDefEntrypointCall to construct the entrypoint call specification.

resolveRunCodeBigMaps :: SingI t => BigMapFinder -> Value -> Either TcError (Value t) Source #

Given an untyped value, possibly containing big_map ids, typecheck it, resolving ids to the corresponding big_maps.

BigMapFinder can be constructed using mkBigMapFinder.

mkBigMapFinder :: ExecutorM BigMapFinder Source #

Construct BigMapFinder using the current executor context.

data CommonRunOptions Source #

Constructors

CommonRunOptions
Fields croNow :: Maybe Timestamp croLevel :: Natural croMinBlockTime :: Natural croMaxSteps :: RemainingSteps croDBPath :: FilePath croTCOpts :: TypeCheckOptions croVerbose :: Bool croDryRun :: Bool

Instances

Instances details

Default CommonRunOptions Source #
Instance details Defined in Morley.Michelson.Runtime Methods def :: CommonRunOptions #

data ContractSpecification a Source #

Constructors

ContractSpecAddressOrAlias ContractAddressOrAlias
ContractSpecOrigination a

Instances

Instances details

Foldable ContractSpecification Source #
Instance details Defined in Morley.Michelson.Runtime Methods fold :: Monoid m => ContractSpecification m -> m # foldMap :: Monoid m => (a -> m) -> ContractSpecification a -> m # foldMap' :: Monoid m => (a -> m) -> ContractSpecification a -> m # foldr :: (a -> b -> b) -> b -> ContractSpecification a -> b # foldr' :: (a -> b -> b) -> b -> ContractSpecification a -> b # foldl :: (b -> a -> b) -> b -> ContractSpecification a -> b # foldl' :: (b -> a -> b) -> b -> ContractSpecification a -> b # foldr1 :: (a -> a -> a) -> ContractSpecification a -> a # foldl1 :: (a -> a -> a) -> ContractSpecification a -> a # toList :: ContractSpecification a -> [a] # null :: ContractSpecification a -> Bool # length :: ContractSpecification a -> Int # elem :: Eq a => a -> ContractSpecification a -> Bool # maximum :: Ord a => ContractSpecification a -> a # minimum :: Ord a => ContractSpecification a -> a # sum :: Num a => ContractSpecification a -> a # product :: Num a => ContractSpecification a -> a #
Traversable ContractSpecification Source #
Instance details Defined in Morley.Michelson.Runtime Methods traverse :: Applicative f => (a -> f b) -> ContractSpecification a -> f (ContractSpecification b) # sequenceA :: Applicative f => ContractSpecification (f a) -> f (ContractSpecification a) # mapM :: Monad m => (a -> m b) -> ContractSpecification a -> m (ContractSpecification b) # sequence :: Monad m => ContractSpecification (m a) -> m (ContractSpecification a) #
Functor ContractSpecification Source #
Instance details Defined in Morley.Michelson.Runtime Methods fmap :: (a -> b) -> ContractSpecification a -> ContractSpecification b # (<$) :: a -> ContractSpecification b -> ContractSpecification a #

data ContractSimpleOriginationData a Source #

Constructors

ContractSimpleOriginationData
Fields csodContract :: a csodStorage :: Value csodBalance :: Mutez

Instances

Instances details

Foldable ContractSimpleOriginationData Source #
Instance details Defined in Morley.Michelson.Runtime Methods fold :: Monoid m => ContractSimpleOriginationData m -> m # foldMap :: Monoid m => (a -> m) -> ContractSimpleOriginationData a -> m # foldMap' :: Monoid m => (a -> m) -> ContractSimpleOriginationData a -> m # foldr :: (a -> b -> b) -> b -> ContractSimpleOriginationData a -> b # foldr' :: (a -> b -> b) -> b -> ContractSimpleOriginationData a -> b # foldl :: (b -> a -> b) -> b -> ContractSimpleOriginationData a -> b # foldl' :: (b -> a -> b) -> b -> ContractSimpleOriginationData a -> b # foldr1 :: (a -> a -> a) -> ContractSimpleOriginationData a -> a # foldl1 :: (a -> a -> a) -> ContractSimpleOriginationData a -> a # toList :: ContractSimpleOriginationData a -> [a] # null :: ContractSimpleOriginationData a -> Bool # length :: ContractSimpleOriginationData a -> Int # elem :: Eq a => a -> ContractSimpleOriginationData a -> Bool # maximum :: Ord a => ContractSimpleOriginationData a -> a # minimum :: Ord a => ContractSimpleOriginationData a -> a # sum :: Num a => ContractSimpleOriginationData a -> a # product :: Num a => ContractSimpleOriginationData a -> a #
Traversable ContractSimpleOriginationData Source #
Instance details Defined in Morley.Michelson.Runtime Methods traverse :: Applicative f => (a -> f b) -> ContractSimpleOriginationData a -> f (ContractSimpleOriginationData b) # sequenceA :: Applicative f => ContractSimpleOriginationData (f a) -> f (ContractSimpleOriginationData a) # mapM :: Monad m => (a -> m b) -> ContractSimpleOriginationData a -> m (ContractSimpleOriginationData b) # sequence :: Monad m => ContractSimpleOriginationData (m a) -> m (ContractSimpleOriginationData a) #
Functor ContractSimpleOriginationData Source #
Instance details Defined in Morley.Michelson.Runtime Methods fmap :: (a -> b) -> ContractSimpleOriginationData a -> ContractSimpleOriginationData b # (<$) :: a -> ContractSimpleOriginationData b -> ContractSimpleOriginationData a #

Other helpers

parseContract :: MichelsonSource -> Text -> Either ParserException (Contract' ParsedOp) Source #

Parse a contract from Text.

parseExpandContract :: MichelsonSource -> Text -> Either ParserException Contract Source #

Parse a contract from Text and expand macros.

readAndParseContract :: Maybe FilePath -> IO (Contract' ParsedOp) Source #

Read and parse a contract from give path or stdin (if the argument is Nothing). The contract is not expanded.

prepareContract :: Maybe FilePath -> IO Contract Source #

Read a contract using readAndParseContract, expand and flatten. The contract is not type checked.

Re-exports

data ContractState Source #

State of a contract with code.

Constructors

forall cp st.(ParameterScope cp, StorageScope st) => ContractState
Fields csBalance :: Mutez Amount of mutez owned by this contract. csContract :: Contract cp st Contract itself. csStorage :: Value st Storage value associated with this contract. csDelegate :: Maybe KeyHash Delegate associated with this contract.

Instances

Instances details

FromJSON ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser ContractState # parseJSONList :: Value -> Parser [ContractState] #
ToJSON ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: ContractState -> Value # toEncoding :: ContractState -> Encoding # toJSONList :: [ContractState] -> Value # toEncodingList :: [ContractState] -> Encoding #
Show ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> ContractState -> ShowS # show :: ContractState -> String # showList :: [ContractState] -> ShowS #
Eq ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: ContractState -> ContractState -> Bool # (/=) :: ContractState -> ContractState -> Bool #
Buildable ContractState Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods build :: ContractState -> Doc buildList :: [ContractState] -> Doc

data VotingPowers Source #

Distribution of voting power among the contracts.

Voting power reflects the ability of bakers to accept, deny or pass new proposals for protocol updates. I.e. each baker has its vote weight.

This datatype definition may change in future, so its internals are not exported.

Instances

Instances details

FromJSON VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods parseJSON :: Value -> Parser VotingPowers # parseJSONList :: Value -> Parser [VotingPowers] #
ToJSON VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods toJSON :: VotingPowers -> Value # toEncoding :: VotingPowers -> Encoding # toJSONList :: [VotingPowers] -> Value # toEncodingList :: [VotingPowers] -> Encoding #
Show VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods showsPrec :: Int -> VotingPowers -> ShowS # show :: VotingPowers -> String # showList :: [VotingPowers] -> ShowS #
Eq VotingPowers Source #
Instance details Defined in Morley.Michelson.Runtime.GState Methods (==) :: VotingPowers -> VotingPowers -> Bool # (/=) :: VotingPowers -> VotingPowers -> Bool #

mkVotingPowers :: [(KeyHash, Natural)] -> VotingPowers Source #

Create voting power distribution.

If some key is encountered multiple times, voting power will be summed up.

mkVotingPowersFromMap :: Map KeyHash Natural -> VotingPowers Source #

Create voting power distribution from map.

data TxData Source #

Data associated with a particular transaction.

Constructors

TxData
Fields tdSenderAddress :: L1Address tdParameter :: TxParam tdEntrypoint :: EpName tdAmount :: Mutez

Instances

Instances details

Show TxData Source #
Instance details Defined in Morley.Michelson.Runtime.TxData Methods showsPrec :: Int -> TxData -> ShowS # show :: TxData -> String # showList :: [TxData] -> ShowS #

data TxParam where Source #

A parameter associated with a particular transaction.

Constructors

TxTypedParam :: forall t. ParameterScope t => Value t -> TxParam
TxUntypedParam :: Value -> TxParam

Instances

Instances details

Show TxParam Source #
Instance details Defined in Morley.Michelson.Runtime.TxData Methods showsPrec :: Int -> TxParam -> ShowS # show :: TxParam -> String # showList :: [TxParam] -> ShowS #
Buildable TxParam Source #
Instance details Defined in Morley.Michelson.Runtime.TxData Methods build :: TxParam -> Doc buildList :: [TxParam] -> Doc

For testing

data ExecutorOp Source #

Operations executed by interpreter. In our model one Michelson's operation (operation type in Michelson) corresponds to 0 or 1 interpreter operation.

Note: Address is not part of TxData, because TxData is supposed to be provided by the user, while Address can be computed by our code.

Constructors

OriginateOp OriginationOperation	Originate a contract.
TransferOp TransferOperation	Transfer tokens to the address.
SetDelegateOp SetDelegateOperation	Set the delegate of a contract.
EmitOp EmitOperation	Emit contract event.

Instances

Instances details

Show ExecutorOp Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> ExecutorOp -> ShowS # show :: ExecutorOp -> String # showList :: [ExecutorOp] -> ShowS #
Buildable ExecutorOp Source #
Instance details Defined in Morley.Michelson.Runtime Methods build :: ExecutorOp -> Doc buildList :: [ExecutorOp] -> Doc

data ExecutorRes Source #

Result of a single execution of interpreter.

Constructors

ExecutorRes

Fields

_erGState :: GState
New GState.
_erUpdates :: [GStateUpdate]
Updates applied to GState.
_erInterpretResults :: [(Address, SomeInterpretResult)]
During execution a contract can print logs and in the end it returns a pair. All logs and returned values are kept until all called contracts are executed. In the end they are printed.
_erRemainingSteps :: RemainingSteps
Now much gas all remaining executions can consume.

Instances

Instances details

Show ExecutorRes Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> ExecutorRes -> ShowS # show :: ExecutorRes -> String # showList :: [ExecutorRes] -> ShowS #

erGState :: Lens' ExecutorRes GState Source #

erUpdates :: Lens' ExecutorRes [GStateUpdate] Source #

erInterpretResults :: Lens' ExecutorRes [(Address, SomeInterpretResult)] Source #

erRemainingSteps :: Lens' ExecutorRes RemainingSteps Source #

data ExecutorError' a Source #

ExecutorErrorPrim, enriched by the list of operations that succeeded before the error.

Constructors

ExecutorError
Fields eeCallStack :: [ExecutorOp] eeError :: ExecutorErrorPrim a

Instances

Instances details

Foldable ExecutorError' Source #
Instance details Defined in Morley.Michelson.Runtime Methods fold :: Monoid m => ExecutorError' m -> m # foldMap :: Monoid m => (a -> m) -> ExecutorError' a -> m # foldMap' :: Monoid m => (a -> m) -> ExecutorError' a -> m # foldr :: (a -> b -> b) -> b -> ExecutorError' a -> b # foldr' :: (a -> b -> b) -> b -> ExecutorError' a -> b # foldl :: (b -> a -> b) -> b -> ExecutorError' a -> b # foldl' :: (b -> a -> b) -> b -> ExecutorError' a -> b # foldr1 :: (a -> a -> a) -> ExecutorError' a -> a # foldl1 :: (a -> a -> a) -> ExecutorError' a -> a # toList :: ExecutorError' a -> [a] # null :: ExecutorError' a -> Bool # length :: ExecutorError' a -> Int # elem :: Eq a => a -> ExecutorError' a -> Bool # maximum :: Ord a => ExecutorError' a -> a # minimum :: Ord a => ExecutorError' a -> a # sum :: Num a => ExecutorError' a -> a # product :: Num a => ExecutorError' a -> a #
Traversable ExecutorError' Source #
Instance details Defined in Morley.Michelson.Runtime Methods traverse :: Applicative f => (a -> f b) -> ExecutorError' a -> f (ExecutorError' b) # sequenceA :: Applicative f => ExecutorError' (f a) -> f (ExecutorError' a) # mapM :: Monad m => (a -> m b) -> ExecutorError' a -> m (ExecutorError' b) # sequence :: Monad m => ExecutorError' (m a) -> m (ExecutorError' a) #
Functor ExecutorError' Source #
Instance details Defined in Morley.Michelson.Runtime Methods fmap :: (a -> b) -> ExecutorError' a -> ExecutorError' b # (<$) :: a -> ExecutorError' b -> ExecutorError' a #
(Typeable a, Show a, Buildable a) => Exception (ExecutorError' a) Source #
Instance details Defined in Morley.Michelson.Runtime Methods toException :: ExecutorError' a -> SomeException # fromException :: SomeException -> Maybe (ExecutorError' a) # displayException :: ExecutorError' a -> String #
Show a => Show (ExecutorError' a) Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> ExecutorError' a -> ShowS # show :: ExecutorError' a -> String # showList :: [ExecutorError' a] -> ShowS #
Buildable a => Buildable (ExecutorError' a) Source #
Instance details Defined in Morley.Michelson.Runtime Methods build :: ExecutorError' a -> Doc buildList :: [ExecutorError' a] -> Doc

data ExecutorErrorPrim a Source #

Errors that can happen during contract interpreting. Type parameter a determines how contracts will be represented in these errors, e.g. Address.

Constructors

EEUnknownContract a	The interpreted contract hasn't been originated.
EEInterpreterFailed a (InterpretError Void)	Interpretation of Michelson contract failed.
EEViewLookupError a ViewLookupError	Error looking up view while trying to call it.
EEViewArgTcError a TcError	Error type-checking untyped view argument.
EEUnknownAddressAlias SomeAlias	The given alias isn't associated with any address OR is associated with an address of an unexpected kind (e.g. we expected an implicit address and found a contract address, or vice-versa).
EEUnknownL1AddressAlias Text	The given alias is not associated with any address.
EEAmbiguousAlias Text ImplicitAddress ContractAddress	The given alias is ambiguous, i.e. it is associated with both an implicit address and a contract address.
EEUnknownSender a	Sender address is unknown.
EEUnknownManager a	Manager address is unknown.
EENotEnoughFunds a Mutez	Sender doesn't have enough funds.
EEEmptyImplicitContract a	Sender is an implicit address with the balance of 0. We mimic `octez-client` in calling it "Empty implicit contract".
EEZeroTransaction a	Sending 0tz towards an address.
EEFailedToApplyUpdates GStateUpdateError	Failed to apply updates to GState.
EEIllTypedParameter a TcError	Contract parameter is ill-typed.
EEDeprecatedType TcError	Found deprecated types.
EEUnexpectedParameterType a (MismatchError T)	Contract parameter is well-typed, but its type does not match the entrypoint's type.
EEUnknownEntrypoint EpName	Specified entrypoint to run is not found.
EETransactionFromContract a Mutez	A transaction from an originated contract was attempted as a global operation.
EEWrongParameterType a	Type of parameter in transfer to an implicit account is not Unit.
EEOperationReplay ExecutorOp	An attempt to perform the operation duplicated with `DUP` instruction.
EEGlobalOperationSourceNotImplicit Address	Attempted to initiate global operation from a non-implicit address.
EEGlobalEmitOp	Trying to run emit operation as a global operation, which should be impossible.

Instances

Instances details

Foldable ExecutorErrorPrim Source #
Instance details Defined in Morley.Michelson.Runtime Methods fold :: Monoid m => ExecutorErrorPrim m -> m # foldMap :: Monoid m => (a -> m) -> ExecutorErrorPrim a -> m # foldMap' :: Monoid m => (a -> m) -> ExecutorErrorPrim a -> m # foldr :: (a -> b -> b) -> b -> ExecutorErrorPrim a -> b # foldr' :: (a -> b -> b) -> b -> ExecutorErrorPrim a -> b # foldl :: (b -> a -> b) -> b -> ExecutorErrorPrim a -> b # foldl' :: (b -> a -> b) -> b -> ExecutorErrorPrim a -> b # foldr1 :: (a -> a -> a) -> ExecutorErrorPrim a -> a # foldl1 :: (a -> a -> a) -> ExecutorErrorPrim a -> a # toList :: ExecutorErrorPrim a -> [a] # null :: ExecutorErrorPrim a -> Bool # length :: ExecutorErrorPrim a -> Int # elem :: Eq a => a -> ExecutorErrorPrim a -> Bool # maximum :: Ord a => ExecutorErrorPrim a -> a # minimum :: Ord a => ExecutorErrorPrim a -> a # sum :: Num a => ExecutorErrorPrim a -> a # product :: Num a => ExecutorErrorPrim a -> a #
Traversable ExecutorErrorPrim Source #
Instance details Defined in Morley.Michelson.Runtime Methods traverse :: Applicative f => (a -> f b) -> ExecutorErrorPrim a -> f (ExecutorErrorPrim b) # sequenceA :: Applicative f => ExecutorErrorPrim (f a) -> f (ExecutorErrorPrim a) # mapM :: Monad m => (a -> m b) -> ExecutorErrorPrim a -> m (ExecutorErrorPrim b) # sequence :: Monad m => ExecutorErrorPrim (m a) -> m (ExecutorErrorPrim a) #
Functor ExecutorErrorPrim Source #
Instance details Defined in Morley.Michelson.Runtime Methods fmap :: (a -> b) -> ExecutorErrorPrim a -> ExecutorErrorPrim b # (<$) :: a -> ExecutorErrorPrim b -> ExecutorErrorPrim a #
(Typeable a, Show a, Buildable a) => Exception (ExecutorErrorPrim a) Source #	To reduce friction between `ExecutorError'` and `ExecutorErrorPrim`, this instance will try to run `fromException` for both.
Instance details Defined in Morley.Michelson.Runtime Methods toException :: ExecutorErrorPrim a -> SomeException # fromException :: SomeException -> Maybe (ExecutorErrorPrim a) # displayException :: ExecutorErrorPrim a -> String #
Show a => Show (ExecutorErrorPrim a) Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> ExecutorErrorPrim a -> ShowS # show :: ExecutorErrorPrim a -> String # showList :: [ExecutorErrorPrim a] -> ShowS #
Buildable a => Buildable (ExecutorErrorPrim a) Source #
Instance details Defined in Morley.Michelson.Runtime Methods build :: ExecutorErrorPrim a -> Doc buildList :: [ExecutorErrorPrim a] -> Doc

type ExecutorError = ExecutorError' Address Source #

type ExecutorM = ReaderT ExecutorEnv (StateT ExecutorState (Except ExecutorError)) Source #

A monad in which contract executor runs.

runExecutorM :: Timestamp -> Natural -> Natural -> RemainingSteps -> TypeCheckOptions -> GState -> ExecutorM a -> Either ExecutorError (ExecutorRes, a) Source #

Run some executor action, returning its result and final executor state in ExecutorRes.

The action has access to the hash of currently executed global operation, in order to construct addresses of originated contracts. It is expected that the action uses #isGlobalOp :! True to specify this hash. Otherwise it is initialized with error.

runExecutorMWithDB :: CommonRunOptions -> ExecutorM a -> IO (ExecutorRes, a) Source #

Run some executor action, reading state from the DB on disk.

If croDryRun is False, the final state is written back to the disk.

If the executor fails with ExecutorError it will be thrown as an exception.

executeGlobalOperations :: [ExecutorOp] -> ExecutorM [EmitOperation] Source #

Execute a list of global operations, returning a list of generated events.

executeGlobalOrigination :: OriginationOperation -> ExecutorM ContractAddress Source #

Execute a global origination operation.

executeOrigination :: ("isGlobalOp" :! Bool) -> OriginationOperation -> ExecutorM ContractAddress Source #

Execute an origination operation.

executeTransfer :: ("isGlobalOp" :! Bool) -> TransferOperation -> ExecutorM [ExecutorOp] Source #

Execute a transfer operation.

Note: we're handling both XTZ and ticket transfers here to avoid code duplication. We assume that if an implicit account sends tickets via TxTypedParam, it should be interpreted as transfer_ticket manager operation, and not a regular transfer.

Note that this only works for TxTypedParam, as for ticket transfers between implicit accounts we can't know the exact type of the ticket to transfer if the value is untyped.

data ExecutorState Source #

Constructors

ExecutorState
Fields _esGState :: GState _esRemainingSteps :: RemainingSteps _esSourceAddress :: Maybe L1Address _esLog :: ExecutorLog _esOperationHash :: ~OperationHash _esPrevCounters :: HashSet GlobalCounter

Instances

Instances details

Generic ExecutorState Source #
Instance details Defined in Morley.Michelson.Runtime Associated Types type Rep ExecutorState :: Type -> Type # Methods from :: ExecutorState -> Rep ExecutorState x # to :: Rep ExecutorState x -> ExecutorState #
Show ExecutorState Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> ExecutorState -> ShowS # show :: ExecutorState -> String # showList :: [ExecutorState] -> ShowS #
type Rep ExecutorState Source #
Instance details Defined in Morley.Michelson.Runtime type Rep ExecutorState = D1 ('MetaData "ExecutorState" "Morley.Michelson.Runtime" "morley-1.20.0-inplace" 'False) (C1 ('MetaCons "ExecutorState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_esGState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GState) :: (S1 ('MetaSel ('Just "_esRemainingSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemainingSteps) :: S1 ('MetaSel ('Just "_esSourceAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe L1Address)))) :: (S1 ('MetaSel ('Just "_esLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutorLog) :: (S1 ('MetaSel ('Just "_esOperationHash") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 OperationHash) :*: S1 ('MetaSel ('Just "_esPrevCounters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashSet GlobalCounter))))))

esGState :: Lens' ExecutorState GState Source #

esRemainingSteps :: Lens' ExecutorState RemainingSteps Source #

esSourceAddress :: Lens' ExecutorState (Maybe L1Address) Source #

esLog :: Lens' ExecutorState ExecutorLog Source #

esOperationHash :: Lens' ExecutorState OperationHash Source #

esPrevCounters :: Lens' ExecutorState (HashSet GlobalCounter) Source #

data ExecutorLog Source #

Constructors

ExecutorLog
Fields _elUpdates :: [GStateUpdate] _elInterpreterResults :: [(Address, SomeInterpretResult)]

Instances

Instances details

Monoid ExecutorLog Source #
Instance details Defined in Morley.Michelson.Runtime Methods mempty :: ExecutorLog # mappend :: ExecutorLog -> ExecutorLog -> ExecutorLog # mconcat :: [ExecutorLog] -> ExecutorLog #
Semigroup ExecutorLog Source #
Instance details Defined in Morley.Michelson.Runtime Methods (<>) :: ExecutorLog -> ExecutorLog -> ExecutorLog # sconcat :: NonEmpty ExecutorLog -> ExecutorLog # stimes :: Integral b => b -> ExecutorLog -> ExecutorLog #
Generic ExecutorLog Source #
Instance details Defined in Morley.Michelson.Runtime Associated Types type Rep ExecutorLog :: Type -> Type # Methods from :: ExecutorLog -> Rep ExecutorLog x # to :: Rep ExecutorLog x -> ExecutorLog #
Show ExecutorLog Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> ExecutorLog -> ShowS # show :: ExecutorLog -> String # showList :: [ExecutorLog] -> ShowS #
type Rep ExecutorLog Source #
Instance details Defined in Morley.Michelson.Runtime type Rep ExecutorLog = D1 ('MetaData "ExecutorLog" "Morley.Michelson.Runtime" "morley-1.20.0-inplace" 'False) (C1 ('MetaCons "ExecutorLog" 'PrefixI 'True) (S1 ('MetaSel ('Just "_elUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GStateUpdate]) :*: S1 ('MetaSel ('Just "_elInterpreterResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Address, SomeInterpretResult)])))

data SomeInterpretResult Source #

Constructors

forall st. SomeInterpretResult
Fields unSomeInterpretResult :: InterpretResult st

Instances

Instances details

Show SomeInterpretResult Source #
Instance details Defined in Morley.Michelson.Runtime Methods showsPrec :: Int -> SomeInterpretResult -> ShowS # show :: SomeInterpretResult -> String # showList :: [SomeInterpretResult] -> ShowS #

elInterpreterResults :: Lens' ExecutorLog [(Address, SomeInterpretResult)] Source #

elUpdates :: Lens' ExecutorLog [GStateUpdate] Source #