Module `Tezos_raw_protocol_012_Psithaca.Script_ir_translator`Source

Michelson Existential Witness types

Sourcetype ('ta, 'tb) eq =

| Eq : ('same, 'same) eq

Sourcetype ex_comparable_ty =

| Ex_comparable_ty : 'a Script_typed_ir.comparable_ty -> ex_comparable_ty

Sourcetype ex_ty =

| Ex_ty : 'a Script_typed_ir.ty -> ex_ty

Sourcetype ex_stack_ty =

| Ex_stack_ty : ('a, 's) Script_typed_ir.stack_ty -> ex_stack_ty

Sourcetype ex_script =

| Ex_script : ('a, 'b) Script_typed_ir.script -> ex_script

Sourcetype toplevel = {

code_field : Alpha_context.Script.node;
arg_type : Alpha_context.Script.node;
storage_type : Alpha_context.Script.node;
views : Script_typed_ir.view Script_typed_ir.SMap.t;
root_name : Script_ir_annot.field_annot option;

}

Sourcetype ('arg, 'storage) code = {

code : (('arg, 'storage) Script_typed_ir.pair, (Script_typed_ir.operation Script_typed_ir.boxed_list, 'storage) Script_typed_ir.pair) Script_typed_ir.lambda;
arg_type : 'arg Script_typed_ir.ty;
storage_type : 'storage Script_typed_ir.ty;
views : Script_typed_ir.view Script_typed_ir.SMap.t;
root_name : Script_ir_annot.field_annot option;
code_size : Cache_memory_helpers.sint;
(*
This is an over-approximation of the value size in memory, in bytes, of the contract's static part, that is its source code. This includes the code of the contract as well as the code of the views. The storage size is not taken into account by this field as it has a dynamic size.
*)

}

Sourcetype ex_code =

| Ex_code : ('a, 'c) code -> ex_code

Sourcetype 'storage ex_view =

| Ex_view : ('input * 'storage, 'output) Script_typed_ir.lambda -> 'storage ex_view

Sourcetype ('a, 's, 'b, 'u) cinstr = {

apply : 'r 'f. ('a, 's) Script_typed_ir.kinfo -> ('b, 'u, 'r, 'f) Script_typed_ir.kinstr -> ('a, 's, 'r, 'f) Script_typed_ir.kinstr;

}

Sourcetype ('a, 's, 'b, 'u) descr = {

loc : Alpha_context.Script.location;
bef : ('a, 's) Script_typed_ir.stack_ty;
aft : ('b, 'u) Script_typed_ir.stack_ty;
instr : ('a, 's, 'b, 'u) cinstr;

}

Sourcetype tc_context =

| Lambda : tc_context
| Dip : ('a, 's) Script_typed_ir.stack_ty * tc_context -> tc_context
| 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;
} -> tc_context

Sourcetype ('a, 's) judgement =

| Typed : ('a, 's, 'b, 'u) descr -> ('a, 's) judgement
| Failed : {
1. descr : 'b 'u. ('b, 'u) Script_typed_ir.stack_ty -> ('a, 's, 'b, 'u) descr;
} -> ('a, 's) judgement

Source

val close_descr : 
  ('a, 'b, 'c, 'd) descr ->
  ('a, 'b, 'c, 'd) Script_typed_ir.kdescr

Sourcetype unparsing_mode =

| Optimized
| Readable
| Optimized_legacy

Flag that drives unparsing of typed values to nodes.

Optimized_legacy must be kept backward-compatible in order to compute valid hashes (of big map keys).
Optimized may be used as long as the result can be read by parse_data.
Readable produces with string values instead of bytes when feasible.

Sourcetype merge_type_error_flag =

| Default_merge_type_error
| Fast_merge_type_error

Source

type type_logger =
  Alpha_context.Script.location ->
  (Alpha_context.Script.expr * Alpha_context.Script.annot) list ->
  (Alpha_context.Script.expr * Alpha_context.Script.annot) list ->
  unit

High-level Michelson Data Types

Source

val empty_big_map : 
  'a Script_typed_ir.comparable_ty ->
  'b Script_typed_ir.ty ->
  ('a, 'b) Script_typed_ir.big_map

Create an empty big_map

Source

val big_map_mem : 
  Alpha_context.context ->
  'key ->
  ('key, 'value) Script_typed_ir.big_map ->
  (bool * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val big_map_get : 
  Alpha_context.context ->
  'key ->
  ('key, 'value) Script_typed_ir.big_map ->
  ('value option * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val big_map_update : 
  Alpha_context.context ->
  'key ->
  'value option ->
  ('key, 'value) Script_typed_ir.big_map ->
  (('key, 'value) Script_typed_ir.big_map * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Update a big map. See big_map_get_and_update for details.

Source

val big_map_get_and_update : 
  Alpha_context.context ->
  'key ->
  'value option ->
  ('key, 'value) Script_typed_ir.big_map ->
  (('value option * ('key, 'value) Script_typed_ir.big_map)
   * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Update a big map, returning the old value of the given key and the new map.

This does not modify the underlying storage, only the diff table.

Source

val ty_eq : 
  Alpha_context.context ->
  Alpha_context.Script.location ->
  'ta Script_typed_ir.ty ->
  'tb Script_typed_ir.ty ->
  (('ta Script_typed_ir.ty, 'tb Script_typed_ir.ty) eq * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val merge_types : 
  legacy:bool ->
  merge_type_error_flag:merge_type_error_flag ->
  Alpha_context.Script.location ->
  'a Script_typed_ir.ty ->
  'b Script_typed_ir.ty ->
  (('a Script_typed_ir.ty, 'b Script_typed_ir.ty) eq * 'a Script_typed_ir.ty,
    Tezos_protocol_environment_012_Psithaca.Error_monad.error
      Tezos_protocol_environment_012_Psithaca.Error_monad.trace)
    Gas_monad.t

Source

val parse_comparable_data : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  'a Script_typed_ir.comparable_ty ->
  Alpha_context.Script.node ->
  ('a * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Parsing and Typechecking Michelson

Source

val parse_data : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  legacy:bool ->
  allow_forged:bool ->
  'a Script_typed_ir.ty ->
  Alpha_context.Script.node ->
  ('a * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val unparse_data : 
  Alpha_context.context ->
  unparsing_mode ->
  'a Script_typed_ir.ty ->
  'a ->
  (Alpha_context.Script.node * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val unparse_comparable_data : 
  loc:'loc ->
  Alpha_context.context ->
  unparsing_mode ->
  'a Script_typed_ir.comparable_ty ->
  'a ->
  ('loc Alpha_context.Script.michelson_node * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val unparse_code : 
  Alpha_context.context ->
  unparsing_mode ->
  Alpha_context.Script.node ->
  (Alpha_context.Script.node * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_instr : 
  ?type_logger:type_logger ->
  tc_context ->
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.node ->
  ('a, 's) Script_typed_ir.stack_ty ->
  (('a, 's) judgement * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_big_map_value_ty : 
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

parse_ty specialized for the right-hand side part of a big map type, i.e. the `value` in `big_map key value`.

Source

val parse_packable_ty : 
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val parse_parameter_ty : 
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val parse_comparable_ty : 
  Alpha_context.context ->
  Alpha_context.Script.node ->
  (ex_comparable_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val parse_view_input_ty : 
  Alpha_context.context ->
  stack_depth:int ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val parse_view_output_ty : 
  Alpha_context.context ->
  stack_depth:int ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val parse_view_returning : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  legacy:bool ->
  'storage Script_typed_ir.ty ->
  Script_typed_ir.view ->
  ('storage ex_view * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val typecheck_views : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  legacy:bool ->
  'storage Script_typed_ir.ty ->
  Script_typed_ir.view Script_typed_ir.SMap.t ->
  Alpha_context.context
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_any_ty : 
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

parse_ty allowing big_map values, operations, contract and tickets.

Source

val parse_ty : 
  Alpha_context.context ->
  legacy:bool ->
  allow_lazy_storage:bool ->
  allow_operation:bool ->
  allow_contract:bool ->
  allow_ticket:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

We expose parse_ty for convenience to external tools. Please use specialized versions such as parse_packable_ty, parse_parameter_ty, parse_comparable_ty, or parse_big_map_value_ty if possible.

Source

val unparse_ty : 
  loc:'loc ->
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  ('loc Alpha_context.Script.michelson_node * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val unparse_comparable_ty : 
  loc:'loc ->
  Alpha_context.context ->
  'a Script_typed_ir.comparable_ty ->
  ('loc Alpha_context.Script.michelson_node * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val ty_of_comparable_ty : 
  'a Script_typed_ir.comparable_ty ->
  'a Script_typed_ir.ty

Source

val parse_toplevel : 
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.expr ->
  (toplevel * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val add_field_annot : 
  Script_ir_annot.field_annot option ->
  Script_ir_annot.var_annot option ->
  ('loc, 'prim) Tezos_protocol_environment_012_Psithaca.Micheline.node ->
  ('loc, 'prim) Tezos_protocol_environment_012_Psithaca.Micheline.node

Source

val typecheck_code : 
  legacy:bool ->
  show_types:bool ->
  Alpha_context.context ->
  Alpha_context.Script.expr ->
  (Script_tc_errors.type_map * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

High-level function to typecheck a Michelson script. This function is not used for validating operations but only for the typecheck_code RPC.

If show_types is set to true, details of the typechecking are returned in the type_map, otherwise the returned type_map is empty.

Sourceval serialize_ty_for_error : 'a Script_typed_ir.ty -> Alpha_context.Script.expr

Source

val parse_code : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  legacy:bool ->
  code:Alpha_context.Script.lazy_expr ->
  (ex_code * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_storage : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  legacy:bool ->
  allow_forged:bool ->
  'storage Script_typed_ir.ty ->
  storage:Alpha_context.Script.lazy_expr ->
  ('storage * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_script : 
  ?type_logger:type_logger ->
  Alpha_context.context ->
  legacy:bool ->
  allow_forged_in_storage:bool ->
  Alpha_context.Script.t ->
  (ex_script * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Combines parse_code and parse_storage

Source

val unparse_script : 
  Alpha_context.context ->
  unparsing_mode ->
  ('a, 'b) Script_typed_ir.script ->
  (Alpha_context.Script.t * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_contract : 
  legacy:bool ->
  Alpha_context.context ->
  Alpha_context.Script.location ->
  'a Script_typed_ir.ty ->
  Alpha_context.Contract.t ->
  entrypoint:string ->
  (Alpha_context.context * 'a Script_typed_ir.typed_contract)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val parse_contract_for_script : 
  Alpha_context.context ->
  Alpha_context.Script.location ->
  'a Script_typed_ir.ty ->
  Alpha_context.Contract.t ->
  entrypoint:string ->
  (Alpha_context.context * 'a Script_typed_ir.typed_contract option)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val find_entrypoint : 
  't Script_typed_ir.ty ->
  root_name:Script_ir_annot.field_annot option ->
  string ->
  ((Alpha_context.Script.node -> Alpha_context.Script.node) * ex_ty)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

module Entrypoints_map : 
  Tezos_protocol_environment_012_Psithaca.Map.S with type key = string

Source

val list_entrypoints : 
  't Script_typed_ir.ty ->
  Alpha_context.context ->
  root_name:Script_ir_annot.field_annot option ->
  (Michelson_v1_primitives.prim list list
   * (Michelson_v1_primitives.prim list
      * Alpha_context.Script.unlocated_michelson_node)
       Entrypoints_map.t)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Source

val pack_data : 
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  'a ->
  (bytes * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val hash_comparable_data : 
  Alpha_context.context ->
  'a Script_typed_ir.comparable_ty ->
  'a ->
  (Script_expr_hash.t * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Source

val hash_data : 
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  'a ->
  (Script_expr_hash.t * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Sourcetype lazy_storage_ids

Sourceval no_lazy_storage_id : lazy_storage_ids

Source

val collect_lazy_storage : 
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  'a ->
  (lazy_storage_ids * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Traverse the given type, producing a lazy_storage_ids for use with extract_lazy_storage_diff.

Sourceval list_of_big_map_ids : lazy_storage_ids -> Alpha_context.Big_map.Id.t list

Source

val extract_lazy_storage_diff : 
  Alpha_context.context ->
  unparsing_mode ->
  temporary:bool ->
  to_duplicate:lazy_storage_ids ->
  to_update:lazy_storage_ids ->
  'a Script_typed_ir.ty ->
  'a ->
  ('a * Alpha_context.Lazy_storage.diffs option * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
    Tezos_protocol_environment_012_Psithaca.Lwt.t

Produce a lazy storage diff, containing in-memory writes to lazy data structures such as big_maps yet to be committed.

The resulting diff can be committed to the underlying storage (context) using Lazy_storage_diff.apply.

parameter to_duplicate
Lazy data structure reference produced via collect_lazy_storage that can not be reused. Typically collected via traversing the parameters to a smart contract.

parameter to_update
Lazy data structure reference produced via collect_lazy_storage that can be reused. Typically collected via traversing the previous storage of a smart contract.

Source

val get_single_sapling_state : 
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  'a ->
  (Alpha_context.Sapling.Id.t option * Alpha_context.context)
    Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult

Sourceval script_size : ex_script -> int * Gas_limit_repr.cost

script_size script returns an overapproximation of the size of the in-memory representation of script as well as the cost associated to computing that overapproximation.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-012-Psithaca.raw/Tezos_raw_protocol_012_Psithaca/Script_ir_translator/index.html

Module `Tezos_raw_protocol_012_Psithaca.Script_ir_translator`Source

Michelson Existential Witness types

package tezos-protocol-012-Psithaca

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-012-Psithaca.raw/Tezos_raw_protocol_012_Psithaca/Script_ir_translator/index.html

Module Tezos_raw_protocol_012_Psithaca.Script_ir_translatorSource

Michelson Existential Witness types

Module `Tezos_raw_protocol_012_Psithaca.Script_ir_translator`Source