106 lines
3.2 KiB
OCaml
106 lines
3.2 KiB
OCaml
(**************************************************************************)
|
|
(* *)
|
|
(* Copyright (c) 2014 - 2017. *)
|
|
(* Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
|
|
(* *)
|
|
(* All rights reserved. No warranty, explicit or implicit, provided. *)
|
|
(* *)
|
|
(**************************************************************************)
|
|
|
|
(** Tezos - Versioned, block indexed (key x value) store *)
|
|
|
|
(** A block-indexed (key x value) store directory. *)
|
|
type index
|
|
|
|
(** A (key x value) store for a given block. *)
|
|
type t
|
|
type context = t
|
|
|
|
type commit
|
|
|
|
val dummy_commit: commit
|
|
val commit_encoding: commit Data_encoding.t
|
|
|
|
(** Open or initialize a versioned store at a given path. *)
|
|
val init:
|
|
?patch_context:(context -> context Lwt.t) ->
|
|
root:string ->
|
|
index Lwt.t
|
|
|
|
val commit_genesis:
|
|
index ->
|
|
net_id:Net_id.t ->
|
|
time:Time.t ->
|
|
protocol:Protocol_hash.t ->
|
|
commit Lwt.t
|
|
|
|
val commit_test_network_genesis:
|
|
index -> Block_hash.t -> Time.t -> context ->
|
|
(Net_id.t * Block_hash.t * commit) tzresult Lwt.t
|
|
|
|
(** {2 Generic interface} ****************************************************)
|
|
|
|
type key = string list
|
|
type value = MBytes.t
|
|
|
|
val mem: context -> key -> bool Lwt.t
|
|
val dir_mem: context -> key -> bool Lwt.t
|
|
val get: context -> key -> value option Lwt.t
|
|
val set: context -> key -> value -> t Lwt.t
|
|
val del: context -> key -> t Lwt.t
|
|
val remove_rec: context -> key -> t Lwt.t
|
|
|
|
val fold:
|
|
context -> key -> init:'a ->
|
|
f:([ `Key of key | `Dir of key ] -> 'a -> 'a Lwt.t) ->
|
|
'a Lwt.t
|
|
|
|
val keys: context -> key -> key list Lwt.t
|
|
val fold_keys:
|
|
context -> key -> init:'a -> f:(key -> 'a -> 'a Lwt.t) -> 'a Lwt.t
|
|
|
|
(** {2 Accessing and Updating Versions} **************************************)
|
|
|
|
val exists: index -> commit -> bool Lwt.t
|
|
val checkout: index -> commit -> context option Lwt.t
|
|
val checkout_exn: index -> commit -> context Lwt.t
|
|
val commit:
|
|
time:Time.t ->
|
|
message:string ->
|
|
context ->
|
|
commit Lwt.t
|
|
val set_head: index -> Net_id.t -> commit -> unit Lwt.t
|
|
val set_master: index -> commit -> unit Lwt.t
|
|
|
|
(** {2 Predefined Fields} ****************************************************)
|
|
|
|
val get_protocol: context -> Protocol_hash.t Lwt.t
|
|
val set_protocol: context -> Protocol_hash.t -> context Lwt.t
|
|
|
|
type test_network =
|
|
| Not_running
|
|
| Forking of {
|
|
protocol: Protocol_hash.t ;
|
|
expiration: Time.t ;
|
|
}
|
|
| Running of {
|
|
net_id: Net_id.t ;
|
|
genesis: Block_hash.t ;
|
|
protocol: Protocol_hash.t ;
|
|
expiration: Time.t ;
|
|
}
|
|
|
|
val pp_test_network : Format.formatter -> test_network -> unit
|
|
|
|
val test_network_encoding: test_network Data_encoding.t
|
|
|
|
val get_test_network: context -> test_network Lwt.t
|
|
val set_test_network: context -> test_network -> context Lwt.t
|
|
val del_test_network: context -> context Lwt.t
|
|
|
|
val reset_test_network: context -> Block_hash.t -> Time.t -> context Lwt.t
|
|
|
|
val fork_test_network:
|
|
context -> protocol:Protocol_hash.t -> expiration:Time.t -> context Lwt.t
|
|
val clear_test_network: index -> Net_id.t -> unit Lwt.t
|