Michelson.Interpret

Module, containing function to interpret Michelson instructions against given context and input stack.

Documentation

data ContractEnv

Environment for contract execution.

Constructors

ContractEnv

Fields

• ceNow :: Timestamp

  Timestamp returned by the NOW instruction.

• ceMaxSteps :: RemainingSteps

  Number of steps after which execution unconditionally terminates.

• ceBalance :: Mutez

  Current amount of mutez of the current contract.

• ceContracts :: TcOriginatedContracts

  Mapping from existing contracts' addresses to their executable representation.

• ceSelf :: Address

  Address of the interpreted contract.

• ceSource :: Address

  The contract that initiated the current transaction.

• ceSender :: Address

  The contract that initiated the current internal transaction.

• ceAmount :: Mutez

  Amount of the current transaction.

• ceChainId :: ChainId

  Identifier of the current chain.

data InterpreterState

Constructors

InterpreterState

Fields

• isMorleyLogs :: MorleyLogs
• isRemainingSteps :: RemainingSteps

Instances

Show InterpreterState

Defined in Michelson.Interpret

Methods

showsPrec :: Int -> InterpreterState -> ShowS

show :: InterpreterState -> String

showList :: [InterpreterState] -> ShowS

data MichelsonFailed where

Represents `[FAILED]` state of a Michelson program. Contains value that was on top of the stack when FAILWITH was called.

Constructors

MichelsonFailedWith :: (Typeable t, SingI t) => Value t -> MichelsonFailed

MichelsonArithError :: (Typeable n, Typeable m) => ArithError (CValue n) (CValue m) -> MichelsonFailed

MichelsonGasExhaustion :: MichelsonFailed

MichelsonFailedTestAssert :: Text -> MichelsonFailed

MichelsonAmbigousEpRef :: EpName -> EpAddress -> MichelsonFailed

Instances

Eq MichelsonFailed

Defined in Michelson.Interpret

Methods

(==) :: MichelsonFailed -> MichelsonFailed -> Bool

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

Show MichelsonFailed

Defined in Michelson.Interpret

Methods

showsPrec :: Int -> MichelsonFailed -> ShowS

show :: MichelsonFailed -> String

showList :: [MichelsonFailed] -> ShowS

Buildable MichelsonFailed

Defined in Michelson.Interpret

Methods

build :: MichelsonFailed -> Builder

newtype RemainingSteps

Constructors

RemainingSteps Word64

Instances

Eq RemainingSteps

Defined in Michelson.Interpret

Methods

(==) :: RemainingSteps -> RemainingSteps -> Bool

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

Num RemainingSteps

Defined in Michelson.Interpret

Methods

(+) :: RemainingSteps -> RemainingSteps -> RemainingSteps

(-) :: RemainingSteps -> RemainingSteps -> RemainingSteps

(*) :: RemainingSteps -> RemainingSteps -> RemainingSteps

negate :: RemainingSteps -> RemainingSteps

abs :: RemainingSteps -> RemainingSteps

signum :: RemainingSteps -> RemainingSteps

fromInteger :: Integer -> RemainingSteps

Ord RemainingSteps

Defined in Michelson.Interpret

Methods

compare :: RemainingSteps -> RemainingSteps -> Ordering

(<) :: RemainingSteps -> RemainingSteps -> Bool

(<=) :: RemainingSteps -> RemainingSteps -> Bool

(>) :: RemainingSteps -> RemainingSteps -> Bool

(>=) :: RemainingSteps -> RemainingSteps -> Bool

max :: RemainingSteps -> RemainingSteps -> RemainingSteps

min :: RemainingSteps -> RemainingSteps -> RemainingSteps

Show RemainingSteps

Defined in Michelson.Interpret

Methods

showsPrec :: Int -> RemainingSteps -> ShowS

show :: RemainingSteps -> String

showList :: [RemainingSteps] -> ShowS

Buildable RemainingSteps

Defined in Michelson.Interpret

Methods

build :: RemainingSteps -> Builder

data SomeItStack where

Constructors

SomeItStack :: ExtInstr inp -> Rec Value inp -> SomeItStack

type EvalOp a = ExceptT MichelsonFailed (ReaderT ContractEnv (State InterpreterState)) a

newtype MorleyLogs

Morley interpreter state

Constructors

MorleyLogs

Fields

• unMorleyLogs :: [Text]

Instances

Eq MorleyLogs

Defined in Michelson.Interpret

Methods

(==) :: MorleyLogs -> MorleyLogs -> Bool

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

Show MorleyLogs

Defined in Michelson.Interpret

Methods

showsPrec :: Int -> MorleyLogs -> ShowS

show :: MorleyLogs -> String

showList :: [MorleyLogs] -> ShowS

Default MorleyLogs

Defined in Michelson.Interpret

Methods

def :: MorleyLogs

Buildable MorleyLogs

Defined in Michelson.Interpret

Methods

build :: MorleyLogs -> Builder

noMorleyLogs :: MorleyLogs

interpret :: Contract cp st -> EntryPointCallT cp arg -> Value arg -> Value st -> ContractEnv -> ContractReturn st

interpretInstr :: ContractEnv -> Instr inp out -> Rec Value inp -> Either MichelsonFailed (Rec Value out)

Interpret an instruction in vacuum, putting no extra contraints on its execution.

Mostly for testing purposes.

type ContractReturn st = (Either MichelsonFailed ([Operation], Value st), InterpreterState)

handleContractReturn :: StorageScope st => ContractReturn st -> Either InterpretError InterpretResult

interpretUntyped :: Contract -> Value -> Value -> ContractEnv -> Either InterpretError InterpretResult

Interpret a contract without performing any side effects. This function uses untyped representation of contract, parameter and storage. Mostly used for testing.

data InterpretError

Constructors

RuntimeFailure (MichelsonFailed, MorleyLogs)

IllTypedContract TCError

IllTypedParam TCError

IllTypedStorage TCError

UnexpectedParamType TCTypeError

UnexpectedStorageType TCTypeError

Instances

Show InterpretError

Defined in Michelson.Interpret

Methods

showsPrec :: Int -> InterpretError -> ShowS

show :: InterpretError -> String

showList :: [InterpretError] -> ShowS

Generic InterpretError

Defined in Michelson.Interpret

Associated Types

type Rep InterpretError :: Type -> Type

Methods

from :: InterpretError -> Rep InterpretError x

to :: Rep InterpretError x -> InterpretError

Buildable InterpretError

Defined in Michelson.Interpret

Methods

build :: InterpretError -> Builder

type Rep InterpretError

Defined in Michelson.Interpret

type Rep InterpretError = D1 (MetaData "InterpretError" "Michelson.Interpret" "morley-0.6.0-IcSJJapq7QZIEQu7njyuVy" False) ((C1 (MetaCons "RuntimeFailure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 (MichelsonFailed, MorleyLogs))) :+: (C1 (MetaCons "IllTypedContract" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 TCError)) :+: C1 (MetaCons "IllTypedParam" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 TCError)))) :+: (C1 (MetaCons "IllTypedStorage" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 TCError)) :+: (C1 (MetaCons "UnexpectedParamType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 TCTypeError)) :+: C1 (MetaCons "UnexpectedStorageType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 TCTypeError)))))

data InterpretResult where

Constructors

InterpretResult

Fields

• :: StorageScope st
• => { iurOps :: [Operation]
•    , iurNewStorage :: Value st
•    , iurNewState :: InterpreterState
•    } -> InterpretResult

Instances

Show InterpretResult

Defined in Michelson.Interpret

Methods

showsPrec :: Int -> InterpretResult -> ShowS

show :: InterpretResult -> String

showList :: [InterpretResult] -> ShowS

runInstr :: Instr inp out -> Rec Value inp -> EvalOp (Rec Value out)

Function to change amount of remaining steps stored in State monad

runInstrNoGas :: forall a b. Instr a b -> Rec Value a -> EvalOp (Rec Value b)

runUnpack :: forall t. UnpackedValScope t => ByteString -> Either UnpackError (Value t)

Unpacks given raw data into a typed value.