From ed04fc3d0134c769b2e41ab54df334f276c430bd Mon Sep 17 00:00:00 2001
From: Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>
Date: Tue, 25 Jul 2017 13:59:15 +0200
Subject: [PATCH] Michelson: add the .mli of the typechecker

---
 src/proto/alpha/script_ir_translator.mli | 108 +++++++++++++++++++++++
 1 file changed, 108 insertions(+)
 create mode 100644 src/proto/alpha/script_ir_translator.mli

diff --git a/src/proto/alpha/script_ir_translator.mli b/src/proto/alpha/script_ir_translator.mli
new file mode 100644
index 000000000..8efc03c6f
--- /dev/null
+++ b/src/proto/alpha/script_ir_translator.mli
@@ -0,0 +1,108 @@
+(**************************************************************************)
+(*                                                                        *)
+(*    Copyright (c) 2014 - 2016.                                          *)
+(*    Dynamic Ledger Solutions, Inc. <contact@tezos.com>                  *)
+(*                                                                        *)
+(*    All rights reserved. No warranty, explicit or implicit, provided.   *)
+(*                                                                        *)
+(**************************************************************************)
+
+open Tezos_context
+
+type ('ta, 'tb) eq = Eq : 'same * 'same -> ('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 Script_typed_ir.stack_ty -> ex_stack_ty
+type ex_script = Ex_script : ('a, 'b, 'c) Script_typed_ir.script -> ex_script
+
+(* ---- Error definitions ---------------------------------------------------*)
+
+(* Auxiliary types for error documentation *)
+type namespace = Type_namespace | Constant_namespace | Instr_namespace
+type kind =  Int_kind | String_kind | Prim_kind | Seq_kind
+type type_map = (int * (Script.expr list * Script.expr list)) list
+
+(* Structure errors *)
+type error += Invalid_arity of Script.location * string * int * int
+type error += Invalid_namespace of Script.location * string * namespace * namespace
+type error += Invalid_primitive of Script.location * string list * string
+type error += Invalid_case of Script.location * string
+type error += Invalid_kind of Script.location * kind list * kind
+
+(* Instruction typing errors *)
+type error += Fail_not_in_tail_position of Script.location
+type error += Undefined_binop : Script.location * string * _ Script_typed_ir.ty * _ Script_typed_ir.ty -> error
+type error += Undefined_unop : Script.location * string * _ Script_typed_ir.ty -> error
+type error += Bad_return : Script.location * _ Script_typed_ir.stack_ty * _ Script_typed_ir.ty -> error
+type error += Bad_stack : Script.location * string * int * _ Script_typed_ir.stack_ty -> error
+type error += Unmatched_branches : Script.location * _ Script_typed_ir.stack_ty * _ Script_typed_ir.stack_ty -> error
+type error += Transfer_in_lambda of Script.location
+type error += Bad_stack_length
+type error += Bad_stack_item of int
+
+(* Value typing errors *)
+type error += Invalid_constant : Script.location * Script.expr * _ Script_typed_ir.ty -> error
+type error += Invalid_contract of Script.location * Contract.t
+type error += Comparable_type_expected : Script.location * _ Script_typed_ir.ty -> error
+type error += Inconsistent_types : _ Script_typed_ir.ty * _ Script_typed_ir.ty -> error
+
+(* Toplevel errors *)
+type error += Ill_typed_data : string option * Script.expr * _ Script_typed_ir.ty -> error
+type error += Ill_formed_type of string option * Script.expr
+type error += Ill_typed_contract : Script.expr * _ Script_typed_ir.ty * _ Script_typed_ir.ty * _ Script_typed_ir.ty * type_map -> error
+
+(* ---- Sets and Maps -------------------------------------------------------*)
+
+val empty_set : 'a Script_typed_ir.comparable_ty -> 'a Script_typed_ir.set
+val set_fold :
+  ('elt -> 'acc -> 'acc) ->
+  'elt Script_typed_ir.set -> 'acc -> 'acc
+val set_update : 'a -> bool -> 'a Script_typed_ir.set -> 'a Script_typed_ir.set
+val set_mem : 'elt -> 'elt Script_typed_ir.set -> bool
+
+val empty_map : 'a Script_typed_ir.comparable_ty -> ('a, 'b) Script_typed_ir.map
+val map_fold :
+  ('key -> 'value -> 'acc -> 'acc) ->
+  ('key, 'value) Script_typed_ir.map -> 'acc -> 'acc
+val map_update :
+  'a -> 'b option -> ('a, 'b) Script_typed_ir.map -> ('a, 'b) Script_typed_ir.map
+val map_mem : 'key -> ('key, 'value) Script_typed_ir.map -> bool
+val map_get : 'key -> ('key, 'value) Script_typed_ir.map -> 'value option
+val map_key_ty : ('a, 'b) Script_typed_ir.map -> 'a Script_typed_ir.comparable_ty
+
+val ty_eq :
+  'ta Script_typed_ir.ty -> 'tb Script_typed_ir.ty ->
+  ('ta Script_typed_ir.ty, 'tb Script_typed_ir.ty) eq tzresult
+
+val parse_data :
+  ?type_logger: (int * (Script.expr list * Script.expr list) -> unit) ->
+  context -> 'a Script_typed_ir.ty -> Script.expr -> 'a tzresult Lwt.t
+val unparse_data :
+  'a Script_typed_ir.ty -> 'a -> Script.expr
+
+val parse_ty :
+  Script.expr -> ex_ty tzresult
+val unparse_ty :
+  'a Script_typed_ir.ty -> Script.expr
+
+val parse_lambda :
+  context ->
+  ?storage_type:'storage Script_typed_ir.ty ->
+  ?type_logger: (int * (Script.expr list * Script.expr list) -> unit) ->
+  'arg Script_typed_ir.ty -> 'ret Script_typed_ir.ty -> Script.expr ->
+  ('arg, 'ret) Script_typed_ir.lambda tzresult Lwt.t
+
+val type_map_enc : type_map Data_encoding.encoding
+val ex_ty_enc : ex_ty Data_encoding.encoding
+
+val typecheck_code :
+  context -> Script.code -> type_map tzresult Lwt.t
+
+val typecheck_data :
+  ?type_logger: (int * (Script.expr list * Script.expr list) -> unit) ->
+  context -> Script.expr * Script.expr -> unit tzresult Lwt.t
+
+val parse_script :
+  ?type_logger: (int * (Script.expr list * Script.expr list) -> unit) ->
+  context -> Script.storage -> Script.code -> ex_script tzresult Lwt.t