package tezos-protocol-012-Psithaca

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This is the Michelson interpreter.

This module offers a way to execute either a Michelson script or a Michelson instruction.

Implementation details are documented in the .ml file.

type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Reject of Alpha_context.Script.location * Alpha_context.Script.expr * Script_typed_ir.execution_trace option
type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Overflow of Alpha_context.Script.location * Script_typed_ir.execution_trace option
type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Runtime_contract_error of Alpha_context.Contract.t
type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Bad_contract_parameter of Alpha_context.Contract.t
type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Cannot_serialize_failure
type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Cannot_serialize_storage
type Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error +=
  1. | Michelson_too_many_recursive_calls
type execution_result = {
  1. ctxt : Alpha_context.context;
  2. storage : Alpha_context.Script.expr;
  3. lazy_storage_diff : Alpha_context.Lazy_storage.diffs option;
  4. operations : Alpha_context.packed_internal_operation list;
}
val step : Script_typed_ir.logger option -> Alpha_context.context -> Script_typed_ir.step_constants -> ('a, 's, 'r, 'f) Script_typed_ir.kdescr -> 'a -> 's -> ('r * 'f * Alpha_context.context, Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.trace) result Lwt.t
val execute : ?logger:Script_typed_ir.logger -> Alpha_context.t -> cached_script:Script_ir_translator.ex_script option -> Script_ir_translator.unparsing_mode -> step_constants -> script:Alpha_context.Script.t -> entrypoint:string -> parameter:Alpha_context.Script.expr -> internal:bool -> (execution_result * (Script_ir_translator.ex_script * int), Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.trace) result Lwt.t

execute ?logger ctxt ~cached_script mode step_constant ~script ~entrypoint ~parameter ~internal interprets the script's entrypoint for a given parameter.

This will update the local storage of the contract step_constants.self. Other pieces of contextual information (source, payer, amount, and chaind_id) are also passed in step_constant.

internal is true if and only if the execution happens within an internal operation.

mode is the unparsing mode, as declared by Script_ir_translator.

cached_script is the cached elaboration of script, that is the well typed abstract syntax tree produced by the type elaboration of script during a previous execution and stored in the in-memory cache.

val kstep : Script_typed_ir.logger option -> Alpha_context.context -> step_constants -> ('a, 's, 'r, 'f) Script_typed_ir.kinstr -> 'a -> 's -> ('r * 'f * Alpha_context.context, Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.error Tezos_protocol_environment_012_Psithaca__Environment.Error_monad.trace) result Lwt.t

kstep logger ctxt step_constants kinstr accu stack interprets the script represented by kinstr under the context ctxt. This will turn a stack whose topmost element is accu and remaining elements stack into a new accumulator and a new stack. This function also returns an updated context. If logger is given, kstep calls back its functions at specific points of the execution. The execution is parameterized by some step_constants.

Internal interpretation loop ============================

The following types and the following functions are exposed in the interface to allow the inference of a gas model in snoop.

Strictly speaking, they should not be considered as part of the interface since they expose implementation details that may change in the future.

module Internals : sig ... end