package tezos-protocol-alpha

  1. Overview
  2. Docs
package tezos-protocol-alpha
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module defines the typechecking context used during the translation from Michelson untyped nodes to typed nodes (Script_ir_translator). The context keeps track of the origin of the code (top-level from a contract, in a view, etc.), plus some information to allow or forbid instructions given the context (no `SELF` in a lambda for example).

type in_lambda = bool

Lambdas are a bit special when considering stateful instructions such as TRANSFER_TOKENS. For instance, a view containing a TRANSFER_TOKENS is not OK, because calling the view would transfer tokens from the view's owner. However, a view returning a lambda containing a TRANSFER_TOKENS could be considered OK, as the decision whether to execute it or not falls on the view's caller, whose tokens would be transfered. This type is used to keep track of whether we are inside a lambda: it is true when inside a lambda, and false otherwise.

type callsite =
  1. | Toplevel : {
    1. storage_type : 'sto Script_typed_ir.ty;
    2. param_type : 'param Script_typed_ir.ty;
    3. root_name : Script_ir_annot.field_annot option;
    } -> callsite
  2. | View : callsite
  3. | Data : callsite

The calling context when parsing Michelson code: either a top-level contract code, the code of a view, or code in data (when pushing a block of instructions for example).

type t = {
  1. callsite : callsite;
  2. in_lambda : in_lambda;
}
val init : callsite -> t
val toplevel : storage_type:'sto Script_typed_ir.ty -> param_type:'param Script_typed_ir.ty -> Script_ir_annot.field_annot option -> t
val view : t
val data : t

This value can be used outside the translation module as a simple context when testing code, for example.

val add_lambda : t -> t
val is_in_lambda : t -> bool
val check_not_in_view : Alpha_context.Script.location -> legacy:bool -> t -> Alpha_context.Script.prim -> (unit, Tezos_protocol_environment_alpha__Environment.Error_monad.error Tezos_protocol_environment_alpha__Environment.Error_monad.trace) Stdlib.result
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct