160 lines
4.1 KiB
OCaml
160 lines
4.1 KiB
OCaml
(**************************************************************************)
|
|
(* *)
|
|
(* Copyright (c) 2014 - 2018. *)
|
|
(* Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
|
|
(* *)
|
|
(* All rights reserved. No warranty, explicit or implicit, provided. *)
|
|
(* *)
|
|
(**************************************************************************)
|
|
|
|
open Store_sigs
|
|
|
|
type t
|
|
type global_store = t
|
|
|
|
(** [init ~mapsize path] returns an initialized store at [path] of
|
|
maximum capacity [mapsize] bytes. *)
|
|
val init: ?mapsize:int64 -> string -> t tzresult Lwt.t
|
|
val close : t -> unit
|
|
|
|
|
|
(** {2 Chain store} **********************************************************)
|
|
|
|
module Chain : sig
|
|
|
|
val list: global_store -> Chain_id.t list Lwt.t
|
|
val destroy: global_store -> Chain_id.t -> unit Lwt.t
|
|
|
|
type store
|
|
val get: global_store -> Chain_id.t -> store
|
|
|
|
module Genesis_hash : SINGLE_STORE
|
|
with type t := store
|
|
and type value := Block_hash.t
|
|
|
|
module Genesis_time : SINGLE_STORE
|
|
with type t := store
|
|
and type value := Time.t
|
|
|
|
module Genesis_protocol : SINGLE_STORE
|
|
with type t := store
|
|
and type value := Protocol_hash.t
|
|
|
|
module Genesis_test_protocol : SINGLE_STORE
|
|
with type t := store
|
|
and type value := Protocol_hash.t
|
|
|
|
module Expiration : SINGLE_STORE
|
|
with type t := store
|
|
and type value := Time.t
|
|
|
|
module Allow_forked_chain : SET_STORE
|
|
with type t := t
|
|
and type elt := Chain_id.t
|
|
|
|
end
|
|
|
|
|
|
(** {2 Mutable chain data} *******************************************************)
|
|
|
|
module Chain_data : sig
|
|
|
|
type store
|
|
val get: Chain.store -> store
|
|
|
|
module Current_head : SINGLE_STORE
|
|
with type t := store
|
|
and type value := Block_hash.t
|
|
|
|
module Known_heads : BUFFERED_SET_STORE
|
|
with type t := store
|
|
and type elt := Block_hash.t
|
|
and module Set := Block_hash.Set
|
|
|
|
module In_main_branch : SINGLE_STORE
|
|
with type t = store * Block_hash.t
|
|
and type value := Block_hash.t (* successor *)
|
|
|
|
end
|
|
|
|
|
|
(** {2 Block header store} **************************************************)
|
|
|
|
module Block : sig
|
|
|
|
type store
|
|
val get: Chain.store -> store
|
|
|
|
type contents = {
|
|
header: Block_header.t ;
|
|
message: string option ;
|
|
max_operations_ttl: int ;
|
|
context: Context_hash.t ;
|
|
metadata: MBytes.t ;
|
|
}
|
|
|
|
module Contents : SINGLE_STORE
|
|
with type t = store * Block_hash.t
|
|
and type value := contents
|
|
|
|
module Operation_hashes : MAP_STORE
|
|
with type t = store * Block_hash.t
|
|
and type key = int
|
|
and type value = Operation_hash.t list
|
|
|
|
module Operation_path : MAP_STORE
|
|
with type t = store * Block_hash.t
|
|
and type key = int
|
|
and type value = Operation_list_list_hash.path
|
|
|
|
module Operations : MAP_STORE
|
|
with type t = store * Block_hash.t
|
|
and type key = int
|
|
and type value = Operation.t list
|
|
|
|
module Operations_metadata : MAP_STORE
|
|
with type t = store * Block_hash.t
|
|
and type key = int
|
|
and type value = MBytes.t list
|
|
|
|
type invalid_block = {
|
|
level: int32 ;
|
|
errors: Error_monad.error list ;
|
|
}
|
|
|
|
module Invalid_block : MAP_STORE
|
|
with type t = store
|
|
and type key = Block_hash.t
|
|
and type value = invalid_block
|
|
|
|
(**
|
|
Block predecessors under
|
|
[/blocks/<block_id>/predecessors/<distance>/<block_id>].
|
|
Used to compute block predecessors in [lib_node_shell/state.ml].
|
|
*)
|
|
module Predecessors : MAP_STORE
|
|
with type t = store * Block_hash.t
|
|
and type key = int
|
|
and type value = Block_hash.t
|
|
|
|
end
|
|
|
|
|
|
(** {2 Protocol store} ******************************************************)
|
|
|
|
module Protocol : sig
|
|
|
|
type store
|
|
val get: global_store -> store
|
|
|
|
module Contents : MAP_STORE
|
|
with type t := store
|
|
and type key := Protocol_hash.t
|
|
and type value := Protocol.t
|
|
|
|
module RawContents : SINGLE_STORE
|
|
with type t = store * Protocol_hash.t
|
|
and type value := MBytes.t
|
|
|
|
end
|