package tezos-protocol-013-PtJakart
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ad9e08819871c75ba6f4530b125f7d157799398e4d77a1e6bfea9d91ff37ff55
sha512=c5dc4d40cc09bc6980fbbdb5c2e105bf4252cf9cfcb2b49660b0ebe4dc789f6709ec3b3bf2f87d81580d3eed9521eeb1c960f24d9b14eb0285aaba1f84d10a9b
doc/tezos-protocol-013-PtJakart.raw/Tezos_raw_protocol_013_PtJakart/Script_interpreter/index.html
Module Tezos_raw_protocol_013_PtJakart.Script_interpreterSource
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_013_PtJakart.Error_monad.error += | Overflow of Alpha_context.Script.location * Script_typed_ir.execution_trace option
type Tezos_protocol_environment_013_PtJakart.Error_monad.error += | Runtime_contract_error of Alpha_context.Contract.t
type Tezos_protocol_environment_013_PtJakart.Error_monad.error += | Bad_contract_parameter of Alpha_context.Contract.t
type execution_result = {script : Script_ir_translator.ex_script;code_size : int;storage : Alpha_context.Script.expr;lazy_storage_diff : Alpha_context.Lazy_storage.diffs option;operations : Script_typed_ir.packed_internal_operation list;ticket_diffs : Tezos_protocol_environment_013_PtJakart.Z.t Ticket_token_map.t;
}type step_constants = Script_typed_ir.step_constants = {source : Alpha_context.Contract.t;payer : Alpha_context.Contract.t;self : Alpha_context.Contract.t;amount : Alpha_context.Tez.t;balance : Alpha_context.Tez.t;chain_id : Tezos_protocol_environment_013_PtJakart.Chain_id.t;now : Alpha_context.Script_timestamp.t;level : Alpha_context.Script_int.n Alpha_context.Script_int.num;
}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_013_PtJakart.Error_monad.tzresult
Tezos_protocol_environment_013_PtJakart.Lwt.tval 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:Alpha_context.Entrypoint.t ->
parameter:Alpha_context.Script.expr ->
internal:bool ->
(execution_result * Alpha_context.context)
Tezos_protocol_environment_013_PtJakart.Error_monad.tzresult
Tezos_protocol_environment_013_PtJakart.Lwt.texecute ?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 execute_with_typed_parameter :
?logger:Script_typed_ir.logger ->
Alpha_context.context ->
cached_script:Script_ir_translator.ex_script option ->
Script_ir_translator.unparsing_mode ->
step_constants ->
script:Alpha_context.Script.t ->
entrypoint:Alpha_context.Entrypoint.t ->
parameter_ty:('a, _) Script_typed_ir.ty ->
location:Alpha_context.Script.location ->
parameter:'a ->
internal:bool ->
(execution_result * Alpha_context.context)
Tezos_protocol_environment_013_PtJakart.Error_monad.tzresult
Tezos_protocol_environment_013_PtJakart.Lwt.texecute_with_typed_parameter ?logger ctxt ~cached_script mode step_constant ~script ~entrypoint loc ~parameter_ty ~parameter ~internal interprets the script's entrypoint for a given (typed) parameter.
See execute for more details about the function's arguments.
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_013_PtJakart.Error_monad.tzresult
Tezos_protocol_environment_013_PtJakart.Lwt.tkstep 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.