370112f9b8
This patch is co-authored with: cagdas.bozman@ocamlpro.com With this patch the economic protocol is now compiled as as "functor-pack", parameterized over the environment. This will ease the protocol reusability outside of the tezos source tree (e.g. for a michelson Web IDE) and will allow proper unit testing of the economic protocol. This functorization allows to break the dependency of the 'tezos-protocol-compiler' on various '.mli' of the node, and hence we don't need anymore the unusual compilation schema: a.mli -> b.mli -> b.ml -> a.ml where 'A' is linked after 'B' but 'a.mli' should still be compiled before 'b.mli'. This will simplify a switch to 'ocp-build' or 'jbuiler'.
140 lines
3.4 KiB
OCaml
140 lines
3.4 KiB
OCaml
|
|
(** Tezos - Manipulation and creation of hashes *)
|
|
|
|
(** {2 Hash Types} ************************************************************)
|
|
|
|
(** The signature of an abstract hash type, as produced by functor
|
|
{!Make_SHA256}. The {!t} type is abstracted for separating the
|
|
various kinds of hashes in the system at typing time. Each type is
|
|
equipped with functions to use it as is of as keys in the database
|
|
or in memory sets and maps. *)
|
|
|
|
module type MINIMAL_HASH = sig
|
|
|
|
type t
|
|
|
|
val name: string
|
|
val title: string
|
|
|
|
val hash_bytes: MBytes.t list -> t
|
|
val hash_string: string list -> t
|
|
val size: int (* in bytes *)
|
|
val compare: t -> t -> int
|
|
val equal: t -> t -> bool
|
|
|
|
val to_hex: t -> string
|
|
val of_hex: string -> t option
|
|
val of_hex_exn: string -> t
|
|
|
|
val to_string: t -> string
|
|
val of_string: string -> t option
|
|
val of_string_exn: string -> t
|
|
|
|
val to_bytes: t -> MBytes.t
|
|
val of_bytes: MBytes.t -> t option
|
|
val of_bytes_exn: MBytes.t -> t
|
|
|
|
val read: MBytes.t -> int -> t
|
|
val write: MBytes.t -> int -> t -> unit
|
|
|
|
val to_path: t -> string list
|
|
val of_path: string list -> t option
|
|
val of_path_exn: string list -> t
|
|
|
|
val prefix_path: string -> string list
|
|
val path_length: int
|
|
|
|
end
|
|
|
|
module type HASH = sig
|
|
|
|
include MINIMAL_HASH
|
|
|
|
val of_b58check_exn: string -> t
|
|
val of_b58check_opt: string -> t option
|
|
val to_b58check: t -> string
|
|
val to_short_b58check: t -> string
|
|
val encoding: t Data_encoding.t
|
|
val pp: Format.formatter -> t -> unit
|
|
val pp_short: Format.formatter -> t -> unit
|
|
type Base58.data += Hash of t
|
|
val b58check_encoding: t Base58.encoding
|
|
|
|
module Set : sig
|
|
include Set.S with type elt = t
|
|
val encoding: t Data_encoding.t
|
|
end
|
|
|
|
module Map : sig
|
|
include Map.S with type key = t
|
|
val encoding: 'a Data_encoding.t -> 'a t Data_encoding.t
|
|
end
|
|
|
|
end
|
|
|
|
module type MERKLE_TREE = sig
|
|
type elt
|
|
include HASH
|
|
val compute: elt list -> t
|
|
val empty: t
|
|
type path =
|
|
| Left of path * t
|
|
| Right of t * path
|
|
| Op
|
|
val compute_path: elt list -> int -> path
|
|
val check_path: path -> elt -> t * int
|
|
val path_encoding: path Data_encoding.t
|
|
end
|
|
|
|
(** {2 Building Hashes} *******************************************************)
|
|
|
|
(** The parameters for creating a new Hash type using
|
|
{!Make_Blake2B}. Both {!name} and {!title} are only informative,
|
|
used in error messages and serializers. *)
|
|
|
|
module type Name = sig
|
|
val name : string
|
|
val title : string
|
|
val size : int option
|
|
end
|
|
|
|
module type PrefixedName = sig
|
|
include Name
|
|
val b58check_prefix : string
|
|
end
|
|
|
|
(** Builds a new Hash type using Sha256. *)
|
|
|
|
module Make_minimal_Blake2B (Name : Name) : MINIMAL_HASH
|
|
module Make_Blake2B
|
|
(Register : sig
|
|
val register_encoding:
|
|
prefix: string ->
|
|
length: int ->
|
|
to_raw: ('a -> string) ->
|
|
of_raw: (string -> 'a option) ->
|
|
wrap: ('a -> Base58.data) ->
|
|
'a Base58.encoding
|
|
end)
|
|
(Name : PrefixedName) : HASH
|
|
|
|
(** {2 Predefined Hashes } ****************************************************)
|
|
|
|
(** Blocks hashes / IDs. *)
|
|
module Block_hash : HASH
|
|
|
|
(** Operations hashes / IDs. *)
|
|
module Operation_hash : HASH
|
|
|
|
(** List of operations hashes / IDs. *)
|
|
module Operation_list_hash :
|
|
MERKLE_TREE with type elt = Operation_hash.t
|
|
|
|
module Operation_list_list_hash :
|
|
MERKLE_TREE with type elt = Operation_list_hash.t
|
|
|
|
(** Protocol versions / source hashes. *)
|
|
module Protocol_hash : HASH
|
|
|
|
module Net_id : HASH
|