morley-0.6.0: Developer tools for the Michelson Language

Safe HaskellNone
LanguageHaskell2010

Michelson.Runtime

Contents

Description

Executor and typechecker of a contract in Morley language.

Synopsis

High level interface for end user

originateContract :: FilePath -> OriginationOperation -> ("verbose" :! Bool) -> IO Address Source #

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

runContract :: Maybe Timestamp -> Word64 -> Mutez -> FilePath -> Value -> Contract -> TxData -> ("verbose" :! Bool) -> ("dryRun" :! Bool) -> IO () 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 :: Maybe Timestamp -> Word64 -> FilePath -> Address -> TxData -> ("verbose" :! Bool) -> ("dryRun" :? Bool) -> IO () Source #

Send a transaction to given address with given parameters.

Other helpers

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

ContractState 

Fields

data AddressState Source #

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 Source # 
Instance details

Defined in Michelson.Runtime.GState

Generic AddressState Source # 
Instance details

Defined in Michelson.Runtime.GState

Associated Types

type Rep AddressState :: Type -> Type #

ToJSON AddressState Source # 
Instance details

Defined in Michelson.Runtime.GState

FromJSON AddressState Source # 
Instance details

Defined in Michelson.Runtime.GState

Buildable AddressState Source # 
Instance details

Defined in Michelson.Runtime.GState

type Rep AddressState Source # 
Instance details

Defined in Michelson.Runtime.GState

type Rep AddressState = D1 (MetaData "AddressState" "Michelson.Runtime.GState" "morley-0.6.0-IcSJJapq7QZIEQu7njyuVy" 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 Source #

Data associated with a particular transaction.

Instances
Eq TxData Source # 
Instance details

Defined in Michelson.Runtime.TxData

Methods

(==) :: TxData -> TxData -> Bool #

(/=) :: TxData -> TxData -> Bool #

Show TxData Source # 
Instance details

Defined in Michelson.Runtime.TxData

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

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

Instances
Show ExecutorOp Source # 
Instance details

Defined in Michelson.Runtime

data ExecutorRes Source #

Result of a single execution of interpreter.

Constructors

ExecutorRes 

Fields

data ExecutorError' 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

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.

EEIllTypedContract !TCError

A contract is ill-typed.

EEIllTypedStorage !TCError

Contract storage is ill-typed.

EEIllTypedParameter !TCError

Contract parameter is ill-typed.

EEUnknownEntrypoint EpName

Specified entrypoint to run is not found.

executorPure :: Timestamp -> RemainingSteps -> GState -> [ExecutorOp] -> Either ExecutorError ExecutorRes Source #

Implementation of executor outside IO. It reads operations, executes them one by one and updates state accordingly. Each operation from the passed list is fully executed before the next one is considered.

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