tezos-protocol-011-PtHangz2 20.1 (latest)

type ('ta, 'tb) eq =

| Eq : ('same, 'same) eq

type ex_comparable_ty =

| Ex_comparable_ty : 'a Script_typed_ir.comparable_ty -> ex_comparable_ty

type ex_ty =

| Ex_ty : 'a Script_typed_ir.ty -> ex_ty

type ex_stack_ty =

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

type ex_script =

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

type 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_typed_ir.field_annot option;

}

type ('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_typed_ir.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.
*)

}

type ex_code =

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

type 'storage ex_view =

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

type ('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;

}

type ('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;

}

type 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_typed_ir.field_annot option;
4. legacy_create_contract_literal : bool;
} -> tc_context

type ('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

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

type unparsing_mode =

| Optimized
| Readable
| Optimized_legacy

type merge_type_error_flag =

| Default_merge_type_error
| Fast_merge_type_error

module Gas_monad : sig ... end

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

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

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

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

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

Update a big map. See big_map_get_and_update for details.

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.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.

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_011_PtHangz2.Error_monad.tzresult

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)
    Gas_monad.t

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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

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

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

val parse_big_map_value_ty : 
  Alpha_context.context ->
  legacy:bool ->
  Alpha_context.Script.node ->
  (ex_ty * Alpha_context.context)
    Tezos_protocol_environment_011_PtHangz2.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`.

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

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

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

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_011_PtHangz2.Error_monad.tzresult

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_011_PtHangz2.Error_monad.tzresult

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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

parse_ty allowing big_map values, operations, contract and tickets.

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_011_PtHangz2.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.

val unparse_ty : 
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  (Alpha_context.Script.node * Alpha_context.context)
    Tezos_protocol_environment_011_PtHangz2.Error_monad.tzresult

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

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

val add_field_annot : 
  Script_typed_ir.field_annot option ->
  Script_typed_ir.var_annot option ->
  Alpha_context.Script.node ->
  Alpha_context.Script.node

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

val serialize_ty_for_error : 
  Alpha_context.context ->
  'a Script_typed_ir.ty ->
  (Alpha_context.Script.expr * Alpha_context.context)
    Tezos_protocol_environment_011_PtHangz2.Error_monad.tzresult

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

Combines parse_code and parse_storage

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

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.Lwt.t

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

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

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

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

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

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

type lazy_storage_ids

val no_lazy_storage_id : lazy_storage_ids

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

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

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

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_011_PtHangz2.Error_monad.tzresult
    Tezos_protocol_environment_011_PtHangz2.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.

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_011_PtHangz2.Error_monad.tzresult

val 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.

package tezos-protocol-011-PtHangz2