Morley.Michelson.Runtime

Executor and typechecker of a contract in Morley language.

High level interface for end user

originateContract :: FilePath -> TypeCheckOptions -> ImplicitAddress -> Maybe ContractAlias -> Maybe KeyHash -> Mutez -> Value -> Contract -> ("verbose" :! Bool) -> IO ContractAddress

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

runContract :: Maybe Timestamp -> Maybe Natural -> Maybe Natural -> Word64 -> Mutez -> FilePath -> TypeCheckOptions -> Value -> Contract -> TxData -> ("verbose" :! Bool) -> ("dryRun" :! Bool) -> IO SomeStorage

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 :: Maybe Timestamp -> Maybe Natural -> Maybe Natural -> Word64 -> FilePath -> TypeCheckOptions -> AddressOrAlias kind -> TxData -> ("verbose" :! Bool) -> ("dryRun" :? Bool) -> IO ()

Send a transaction to given address with given parameters.

Other helpers

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

Parse a contract from Text.

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

Parse a contract from Text and expand macros.

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

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

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

Re-exports

data ContractState

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

FromJSON ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser ContractState

parseJSONList :: Value -> Parser [ContractState]

ToJSON ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: ContractState -> Value

toEncoding :: ContractState -> Encoding

toJSONList :: [ContractState] -> Value

toEncodingList :: [ContractState] -> Encoding

Show ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> ContractState -> ShowS

show :: ContractState -> String

showList :: [ContractState] -> ShowS

Buildable ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

build :: ContractState -> Builder

Eq ContractState

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: ContractState -> ContractState -> Bool

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

data VotingPowers

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

FromJSON VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser VotingPowers

parseJSONList :: Value -> Parser [VotingPowers]

ToJSON VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

toJSON :: VotingPowers -> Value

toEncoding :: VotingPowers -> Encoding

toJSONList :: [VotingPowers] -> Value

toEncodingList :: [VotingPowers] -> Encoding

Show VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

showsPrec :: Int -> VotingPowers -> ShowS

show :: VotingPowers -> String

showList :: [VotingPowers] -> ShowS

Eq VotingPowers

Defined in Morley.Michelson.Runtime.GState

Methods

(==) :: VotingPowers -> VotingPowers -> Bool

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

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

Create voting power distribution.

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

mkVotingPowersFromMap :: Map KeyHash Natural -> VotingPowers

Create voting power distribution from map.

data TxData

Data associated with a particular transaction.

Constructors

TxData

Fields

• tdSenderAddress :: L1Address
• tdParameter :: TxParam
• tdEntrypoint :: EpName
• tdAmount :: Mutez

Instances

Show TxData

Defined in Morley.Michelson.Runtime.TxData

Methods

showsPrec :: Int -> TxData -> ShowS

show :: TxData -> String

showList :: [TxData] -> ShowS

data TxParam where

A parameter associated with a particular transaction.

Constructors

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

TxUntypedParam :: Value -> TxParam

Instances

Show TxParam

Defined in Morley.Michelson.Runtime.TxData

Methods

showsPrec :: Int -> TxParam -> ShowS

show :: TxParam -> String

showList :: [TxParam] -> ShowS

For testing

data ExecutorOp

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

Show ExecutorOp

Defined in Morley.Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorOp -> ShowS

show :: ExecutorOp -> String

showList :: [ExecutorOp] -> ShowS

Buildable ExecutorOp

Defined in Morley.Michelson.Runtime

Methods

build :: ExecutorOp -> Builder

data ExecutorRes

Result of a single execution of interpreter.

Constructors

ExecutorRes

Fields

• _erGState :: GState

  New GState.

• _erUpdates :: [GStateUpdate]

  Updates applied to GState.

• _erInterpretResults :: [(Address, InterpretResult)]

  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

Show ExecutorRes

Defined in Morley.Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorRes -> ShowS

show :: ExecutorRes -> String

showList :: [ExecutorRes] -> ShowS

erGState :: Lens' ExecutorRes GState

erUpdates :: Lens' ExecutorRes [GStateUpdate]

erInterpretResults :: Lens' ExecutorRes [(Address, InterpretResult)]

erRemainingSteps :: Lens' ExecutorRes RemainingSteps

data ExecutorError' a

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

Interpretation of Michelson contract failed.

EEUnknownAddressAlias SomeAlias

Given alias doesn't refer to any 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 tezos-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.

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

Foldable ExecutorError'

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'

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'

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)

Defined in Morley.Michelson.Runtime

Methods

toException :: ExecutorError' a -> SomeException

fromException :: SomeException -> Maybe (ExecutorError' a)

displayException :: ExecutorError' a -> String

Show a => Show (ExecutorError' a)

Defined in Morley.Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorError' a -> ShowS

show :: ExecutorError' a -> String

showList :: [ExecutorError' a] -> ShowS

Buildable a => Buildable (ExecutorError' a)

Defined in Morley.Michelson.Runtime

Methods

build :: ExecutorError' a -> Builder

type ExecutorError = ExecutorError' Address

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

A monad in which contract executor runs.

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

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 :: Maybe Timestamp -> Maybe Natural -> Maybe Natural -> FilePath -> RemainingSteps -> ("verbose" :! Bool) -> ("dryRun" :? Bool) -> ExecutorM a -> IO (ExecutorRes, a)

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

Unless dryRun 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 :: TypeCheckOptions -> [ExecutorOp] -> ExecutorM [EmitOperation]

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

executeGlobalOrigination :: OriginationOperation -> ExecutorM ContractAddress

Execute a global origination operation.

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

Execute an origination operation.

executeTransfer

Arguments

:: ("isGlobalOp" :! Bool)

-> Maybe Mutez

Whether to override the destination's balance.

When it's a Just, the destination's balance will be set to the given amount and no tz will be debited from the sender's account. This is useful to emulate the behaviour of the Tezos RPC's /run_code endpoint.

-> TypeCheckOptions

-> TransferOperation

-> ExecutorM [ExecutorOp]

Execute a transfer operation.

data ExecutorState

Constructors

ExecutorState

Fields

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

Instances

Generic ExecutorState

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

Defined in Morley.Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorState -> ShowS

show :: ExecutorState -> String

showList :: [ExecutorState] -> ShowS

type Rep ExecutorState

Defined in Morley.Michelson.Runtime

type Rep ExecutorState = D1 ('MetaData "ExecutorState" "Morley.Michelson.Runtime" "morley-1.18.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

esRemainingSteps :: Lens' ExecutorState RemainingSteps

esSourceAddress :: Lens' ExecutorState (Maybe L1Address)

esLog :: Lens' ExecutorState ExecutorLog

esOperationHash :: Lens' ExecutorState OperationHash

esPrevCounters :: Lens' ExecutorState (HashSet GlobalCounter)

data ExecutorLog

Constructors

ExecutorLog

Fields

• _elUpdates :: [GStateUpdate]
• _elInterpreterResults :: [(Address, InterpretResult)]

Instances

Monoid ExecutorLog

Defined in Morley.Michelson.Runtime

Methods

mempty :: ExecutorLog

mappend :: ExecutorLog -> ExecutorLog -> ExecutorLog

mconcat :: [ExecutorLog] -> ExecutorLog

Semigroup ExecutorLog

Defined in Morley.Michelson.Runtime

Methods

(<>) :: ExecutorLog -> ExecutorLog -> ExecutorLog

sconcat :: NonEmpty ExecutorLog -> ExecutorLog

stimes :: Integral b => b -> ExecutorLog -> ExecutorLog

Generic ExecutorLog

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

Defined in Morley.Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorLog -> ShowS

show :: ExecutorLog -> String

showList :: [ExecutorLog] -> ShowS

type Rep ExecutorLog

Defined in Morley.Michelson.Runtime

type Rep ExecutorLog = D1 ('MetaData "ExecutorLog" "Morley.Michelson.Runtime" "morley-1.18.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, InterpretResult)])))

elInterpreterResults :: Lens' ExecutorLog [(Address, InterpretResult)]

elUpdates :: Lens' ExecutorLog [GStateUpdate]