Michelson.Runtime

Executor and typechecker of a contract in Morley language.

High level interface for end user

originateContract :: FilePath -> Address -> Maybe KeyHash -> Mutez -> Value -> Contract -> ("verbose" :! Bool) -> IO Address

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

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

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 -> Word64 -> FilePath -> Address -> TxData -> ("verbose" :! Bool) -> ("dryRun" :? Bool) -> IO ()

Send a transaction to given address with given parameters.

Other helpers

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

Parse a contract from Text.

parseExpandContract :: Maybe FilePath -> 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.

Instances

Show ContractState

Defined in Michelson.Runtime.GState

Methods

showsPrec :: Int -> ContractState -> ShowS

show :: ContractState -> String

showList :: [ContractState] -> ShowS

ToJSON ContractState

Defined in Michelson.Runtime.GState

Methods

toJSON :: ContractState -> Value

toEncoding :: ContractState -> Encoding

toJSONList :: [ContractState] -> Value

toEncodingList :: [ContractState] -> Encoding

FromJSON ContractState

Defined in Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser ContractState

parseJSONList :: Value -> Parser [ContractState]

Buildable ContractState

Defined in Michelson.Runtime.GState

Methods

build :: ContractState -> Builder

data AddressState

State of an arbitrary address.

Constructors

ASSimple Mutez

For contracts without code we store only its balance.

ASContract ContractState

For contracts with code we store more state represented by ContractState.

Instances

Show AddressState

Defined in Michelson.Runtime.GState

Methods

showsPrec :: Int -> AddressState -> ShowS

show :: AddressState -> String

showList :: [AddressState] -> ShowS

Generic AddressState

Defined in Michelson.Runtime.GState

Associated Types

type Rep AddressState :: Type -> Type

Methods

from :: AddressState -> Rep AddressState x

to :: Rep AddressState x -> AddressState

ToJSON AddressState

Defined in Michelson.Runtime.GState

Methods

toJSON :: AddressState -> Value

toEncoding :: AddressState -> Encoding

toJSONList :: [AddressState] -> Value

toEncodingList :: [AddressState] -> Encoding

FromJSON AddressState

Defined in Michelson.Runtime.GState

Methods

parseJSON :: Value -> Parser AddressState

parseJSONList :: Value -> Parser [AddressState]

Buildable AddressState

Defined in Michelson.Runtime.GState

Methods

build :: AddressState -> Builder

type Rep AddressState

Defined in Michelson.Runtime.GState

type Rep AddressState = D1 ('MetaData "AddressState" "Michelson.Runtime.GState" "morley-1.12.0-inplace" 'False) (C1 ('MetaCons "ASSimple" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Mutez)) :+: C1 ('MetaCons "ASContract" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContractState)))

data TxData

Data associated with a particular transaction.

Constructors

TxData

Fields

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

Instances

Show TxData

Defined in 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 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 Address TxData

Send a transaction to given address which is assumed to be the address of an originated contract.

Instances

Show ExecutorOp

Defined in Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorOp -> ShowS

show :: ExecutorOp -> String

showList :: [ExecutorOp] -> ShowS

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 Michelson.Runtime

Methods

showsPrec :: Int -> ExecutorRes -> ShowS

show :: ExecutorRes -> String

showList :: [ExecutorRes] -> ShowS

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.

EEAlreadyOriginated a ContractState

A contract is already originated.

EEUnknownSender a

Sender address is unknown.

EEUnknownManager a

Manager address is unknown.

EENotEnoughFunds a Mutez

Sender doesn't have enough funds.

EEZeroTransaction a

Sending 0tz towards an address.

EEFailedToApplyUpdates GStateUpdateError

Failed to apply updates to GState.

EEIllTypedParameter TCError

Contract parameter is ill-typed.

EEUnexpectedParameterType T 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.

Instances

Functor ExecutorError'

Defined in Michelson.Runtime

Methods

fmap :: (a -> b) -> ExecutorError' a -> ExecutorError' b

(<$) :: a -> ExecutorError' b -> ExecutorError' a

Show a => Show (ExecutorError' a)

Defined in Michelson.Runtime

Methods

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

show :: ExecutorError' a -> String

showList :: [ExecutorError' a] -> ShowS

(Typeable a, Show a, Buildable a) => Exception (ExecutorError' a)

Defined in Michelson.Runtime

Methods

toException :: ExecutorError' a -> SomeException

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

displayException :: ExecutorError' a -> String

Buildable a => Buildable (ExecutorError' a)

Defined in 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 -> 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 -> 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 :: [ExecutorOp] -> ExecutorM ()

Execute a list of global operations, discarding their results.

executeGlobalOrigination :: OriginationOperation -> ExecutorM Address

Execute a global origination operation.

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

Execute an origination operation.

executeTransfer :: ("isGlobalOp" :! Bool) -> Address -> TxData -> ExecutorM [ExecutorOp]

Execute a transfer operation.

To avoid warnings (can't generate lenses only for some fields)

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

erUpdates :: Lens' ExecutorRes [GStateUpdate]

erGState :: Lens' ExecutorRes GState

erRemainingSteps :: Lens' ExecutorRes RemainingSteps

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

elUpdates :: Lens' ExecutorLog [GStateUpdate]