Docs/RPC: fix doc generation
The current doc generator does not handles path were multiple method are registred. The fix remove the intermediate (compilation) tree.
This commit is contained in:
Grégoire Henry
Benjamin Canou
parent
eb78c2ae8c
commit
89cbe0f8fa
@ -4,20 +4,24 @@
|
|||||||
((name rpc_doc)
|
((name rpc_doc)
|
||||||
(libraries
|
(libraries
|
||||||
(tezos-base
|
(tezos-base
|
||||||
tezos-rpc-http
|
tezos-stdlib-unix
|
||||||
tezos-client-base
|
tezos-shell
|
||||||
tezos-client-commands
|
tezos-protocol-updater
|
||||||
tezos-client-base-unix))
|
tezos-embedded-protocol-alpha
|
||||||
|
re))
|
||||||
(flags (:standard -w -9+27-30-32-40@8
|
(flags (:standard -w -9+27-30-32-40@8
|
||||||
-safe-string
|
-safe-string
|
||||||
-open Tezos_base__TzPervasives
|
-open Tezos_base__TzPervasives
|
||||||
-open Tezos_rpc_http
|
-open Tezos_stdlib_unix
|
||||||
-open Tezos_client_base
|
-open Tezos_shell
|
||||||
-open Tezos_client_commands
|
-open Tezos_protocol_updater
|
||||||
-open Tezos_client_base_unix
|
|
||||||
-linkall))
|
-linkall))
|
||||||
))
|
))
|
||||||
|
|
||||||
|
(alias
|
||||||
|
((name buildtest)
|
||||||
|
(deps (rpc_doc.exe))))
|
||||||
|
|
||||||
(alias
|
(alias
|
||||||
((name runtest_indent)
|
((name runtest_indent)
|
||||||
(deps ((glob_files *.ml{,i})))
|
(deps ((glob_files *.ml{,i})))
|
||||||
|
|||||||
@ -7,518 +7,414 @@
|
|||||||
(* *)
|
(* *)
|
||||||
(**************************************************************************)
|
(**************************************************************************)
|
||||||
|
|
||||||
type service_repr =
|
let protocols = [
|
||||||
{ path : string list ;
|
"Alpha", "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK" ;
|
||||||
meth : Resto.meth ;
|
]
|
||||||
description : string ;
|
|
||||||
query : Resto.Description.query_item list ;
|
|
||||||
input : Json_schema.schema option ;
|
|
||||||
output : Json_schema.schema option ;
|
|
||||||
example : string option ;
|
|
||||||
error : Json_schema.schema option
|
|
||||||
}
|
|
||||||
|
|
||||||
type service_tree =
|
module Rst = struct
|
||||||
| Root of service_tree list
|
|
||||||
| Node of service_repr * service_tree list
|
|
||||||
| SymbNode of string list * service_tree list
|
|
||||||
|
|
||||||
let make_descr = function
|
let pp_title ~char ppf title =
|
||||||
| None | Some "" -> "No description"
|
|
||||||
| Some s -> s
|
|
||||||
|
|
||||||
(** Inspect a JSON schema: if it doesn't contain any field (e.g. { }),
|
|
||||||
return None *)
|
|
||||||
let normalize_json_schema = function
|
|
||||||
| None -> None
|
|
||||||
| Some schema ->
|
|
||||||
let open Json_schema in
|
|
||||||
let elt = root schema in
|
|
||||||
match elt.kind with
|
|
||||||
| Object specs when
|
|
||||||
specs = object_specs ||
|
|
||||||
specs = { object_specs with additional_properties = None } ->
|
|
||||||
None
|
|
||||||
| _ -> Some schema
|
|
||||||
|
|
||||||
let repr_of_service path
|
|
||||||
RPC_description.{ description ; error ;
|
|
||||||
meth ; input ; output ;
|
|
||||||
query ; _ } : service_repr =
|
|
||||||
|
|
||||||
{ path ; meth ; query ;
|
|
||||||
description = make_descr description ;
|
|
||||||
input = normalize_json_schema input ;
|
|
||||||
output = normalize_json_schema (Some output) ;
|
|
||||||
example = None ; error = Some error }
|
|
||||||
|
|
||||||
open Format
|
|
||||||
|
|
||||||
let pp_print_service fmt
|
|
||||||
{ path ; meth }
|
|
||||||
=
|
|
||||||
fprintf fmt "%s %s" (Resto.string_of_meth meth) (String.concat "/" path)
|
|
||||||
|
|
||||||
let rec pp_print_service_tree fmt = function
|
|
||||||
| Root l ->
|
|
||||||
fprintf fmt "@[<v 2>/";
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" pp_print_service_tree tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
| Node (repr, l) ->
|
|
||||||
fprintf fmt "@[<v 2>%a" pp_print_service repr;
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" pp_print_service_tree tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
| SymbNode (sl, l) ->
|
|
||||||
fprintf fmt "@[<v 2>%s" (String.concat "/" sl);
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" pp_print_service_tree tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
|
|
||||||
let make_tree cctxt path =
|
|
||||||
let open RPC_description in
|
|
||||||
describe cctxt ~recurse:true path >>=? fun dir ->
|
|
||||||
let rec loop path : _ directory -> service_tree list = function
|
|
||||||
| Dynamic descr ->
|
|
||||||
[ Node ({ path ; meth=`POST ; query = [] ;
|
|
||||||
description=make_descr descr ;
|
|
||||||
input = None ; output = None ;
|
|
||||||
example = None ; error = None }, []) ]
|
|
||||||
|
|
||||||
| Empty -> []
|
|
||||||
|
|
||||||
| Static { services ; subdirs = None } ->
|
|
||||||
let l = RPC_service.MethMap.bindings services in
|
|
||||||
let l = List.map snd l in
|
|
||||||
List.map
|
|
||||||
(fun service -> Node (repr_of_service path service, []))
|
|
||||||
l
|
|
||||||
|
|
||||||
| Static { services ; subdirs = Some (Suffixes subdirs) } ->
|
|
||||||
let subdirs = Resto.StringMap.bindings subdirs in
|
|
||||||
|
|
||||||
let l = List.map (fun (name, subdir) ->
|
|
||||||
loop (path @ [ name ]) subdir
|
|
||||||
) subdirs |> List.concat
|
|
||||||
in
|
|
||||||
|
|
||||||
let services = RPC_service.MethMap.bindings services in
|
|
||||||
let services = List.map snd services in
|
|
||||||
|
|
||||||
begin
|
|
||||||
match services with
|
|
||||||
| [] -> [ SymbNode (path, l) ]
|
|
||||||
| service::[] -> [ Node (repr_of_service path service, l) ]
|
|
||||||
| _ -> assert false (* ? *)
|
|
||||||
end
|
|
||||||
|
|
||||||
| Static { services ; subdirs = Some (Arg (arg, solo)) } ->
|
|
||||||
let name = Printf.sprintf "<%s>" arg.RPC_arg.name in
|
|
||||||
|
|
||||||
let services = RPC_service.MethMap.bindings services in
|
|
||||||
let services = List.map snd services in
|
|
||||||
|
|
||||||
let l = loop (path @ [ name ]) solo in
|
|
||||||
|
|
||||||
begin
|
|
||||||
match services with
|
|
||||||
| [] -> [ SymbNode (path, l) ]
|
|
||||||
| service::[] -> [ Node (repr_of_service path service, l) ]
|
|
||||||
| _ -> assert false (* ? *)
|
|
||||||
end
|
|
||||||
in
|
|
||||||
return (Root (loop path dir))
|
|
||||||
|
|
||||||
let rec pp_print_hierarchy fmt =
|
|
||||||
let open Format in
|
|
||||||
function
|
|
||||||
| Root l ->
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" pp_print_hierarchy tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
|
|
||||||
| SymbNode (path, l)
|
|
||||||
| Node ( { path } , l) ->
|
|
||||||
if List.length path = 0 then begin
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" pp_print_hierarchy tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
end
|
|
||||||
else
|
|
||||||
begin
|
|
||||||
let name = "/" ^ List.hd (List.rev path) in
|
|
||||||
let offset = max 4 (String.length name / 2) in
|
|
||||||
|
|
||||||
if List.length l = 0 then
|
|
||||||
pp_open_vbox fmt 0
|
|
||||||
else
|
|
||||||
pp_open_vbox fmt offset;
|
|
||||||
|
|
||||||
fprintf fmt "%s" name;
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" pp_print_hierarchy tree)
|
|
||||||
l;
|
|
||||||
pp_close_box fmt ()
|
|
||||||
end
|
|
||||||
|
|
||||||
(**************** RST PRINTING ****************)
|
|
||||||
|
|
||||||
let pp_print_rst_title ~char ppf title =
|
|
||||||
let sub = String.map (fun _ -> char) title in
|
let sub = String.map (fun _ -> char) title in
|
||||||
Format.fprintf ppf "@[<v 0>%s@ %s@ @ @]" title sub
|
Format.fprintf ppf "@[<v 0>%s@ %s@ @ @]" title sub
|
||||||
|
|
||||||
let pp_print_rst_h1 = pp_print_rst_title ~char:'#'
|
let pp_h1 = pp_title ~char:'#'
|
||||||
let pp_print_rst_h2 = pp_print_rst_title ~char:'*'
|
let pp_h2 = pp_title ~char:'*'
|
||||||
let pp_print_rst_h3 = pp_print_rst_title ~char:'='
|
let pp_h3 = pp_title ~char:'='
|
||||||
let pp_print_rst_h4 = pp_print_rst_title ~char:'`'
|
let pp_h4 = pp_title ~char:'`'
|
||||||
|
|
||||||
let pp_print_rst_raw_html fmt str =
|
let pp_raw_html ppf str =
|
||||||
(* let ic = open_in file in *)
|
Format.fprintf ppf "@[<v>.. raw:: html@ @ %s@ @ @]"
|
||||||
fprintf fmt "@[<v 2>.. raw:: html@ @ %s@ @ @]" str
|
(Re.Str.global_replace (Re.Str.regexp "\n") "\n " str)
|
||||||
|
|
||||||
let label_table = Hashtbl.create 17
|
let pp_html ppf f =
|
||||||
|
Format.fprintf ppf
|
||||||
|
"@[<v 2>.. raw:: html@ @ %a@]@\n@\n"
|
||||||
|
(fun ppf () -> f ppf) ()
|
||||||
|
|
||||||
let make_counter () =
|
let pp_ref ppf name = Format.fprintf ppf ".. _%s :@\n@\n" name
|
||||||
let i = ref 1 in
|
|
||||||
fun () -> incr i; !i
|
|
||||||
|
|
||||||
let count = make_counter ()
|
end
|
||||||
|
|
||||||
let rst_label_of_path path =
|
let pp_name ppf = function
|
||||||
let label = Printf.sprintf "ref%d" (count ()) in
|
| [] | [""] -> Format.pp_print_string ppf "/"
|
||||||
Hashtbl.add label_table path label;
|
| prefix -> Format.pp_print_string ppf (String.concat "/" prefix)
|
||||||
"<" ^ label ^ "_>"
|
|
||||||
|
|
||||||
let ref_of_path path =
|
let ref_of_service (prefix, meth) =
|
||||||
Hashtbl.find label_table path
|
Format.asprintf "%s_%s"
|
||||||
|
(Resto.string_of_meth meth)
|
||||||
|
(Re.Str.global_replace
|
||||||
|
(Re.Str.regexp "<\\([^>]*\\)>")
|
||||||
|
"\\1"
|
||||||
|
(String.concat "--" prefix))
|
||||||
|
|
||||||
let rec pp_print_rst_hierarchy fmt ~title node =
|
module Index = struct
|
||||||
fprintf fmt "%a@ " pp_print_rst_h2 title;
|
|
||||||
let rst_name =
|
|
||||||
String.lowercase_ascii title
|
|
||||||
|> String.map (function ' ' -> '-' | x -> x)
|
|
||||||
in
|
|
||||||
let rst_name =
|
|
||||||
let rec loop str =
|
|
||||||
let open Stringext in
|
|
||||||
if find_from str ~pattern:"--" <> None then
|
|
||||||
loop (replace_all_assoc str [("--","-")])
|
|
||||||
else
|
|
||||||
str
|
|
||||||
in loop rst_name
|
|
||||||
in
|
|
||||||
|
|
||||||
fprintf fmt "%a@." pp_print_rst_raw_html
|
let rec pp prefix ppf dir =
|
||||||
(sprintf "<style>#%s * { margin-bottom:0px }\
|
let open Resto.Description in
|
||||||
#%s > *:last-child { margin-bottom:15px }\
|
match dir with
|
||||||
#%s > h2 { margin-bottom:15px}</style>" rst_name rst_name rst_name);
|
| Empty -> Format.fprintf ppf "Empty"
|
||||||
|
| Static { services ; subdirs = None } ->
|
||||||
|
pp_services prefix ppf services
|
||||||
|
| Static { services ; subdirs = Some (Suffixes map) } ->
|
||||||
|
Format.fprintf ppf "@[<v 2>%a@ @ %a@]"
|
||||||
|
(pp_services prefix) services
|
||||||
|
(Format.pp_print_list
|
||||||
|
~pp_sep:(fun ppf () -> Format.fprintf ppf "@ @ ")
|
||||||
|
(pp_suffixes prefix))
|
||||||
|
(Resto.StringMap.bindings map)
|
||||||
|
| Static { services ; subdirs = Some (Arg (arg, dir)) } ->
|
||||||
|
let name = Format.asprintf "<%s>" arg.name in
|
||||||
|
Format.fprintf ppf "@[<v 2>%a@ @ %a@]"
|
||||||
|
(pp_services prefix) services
|
||||||
|
(pp_suffixes prefix) (name, dir)
|
||||||
|
| Dynamic _ ->
|
||||||
|
Format.fprintf ppf "* %a (<dyn>)" pp_name prefix
|
||||||
|
|
||||||
let rec loop fmt tree =
|
and pp_suffixes prefix ppf (name, dir) =
|
||||||
match tree with
|
pp (prefix @ [name]) ppf dir
|
||||||
| Root l ->
|
|
||||||
(* fprintf fmt "@[<v 4>/"; *)
|
|
||||||
fprintf fmt "@[<v 0>";
|
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" loop tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
| Node ( { path }, l) ->
|
|
||||||
let name = "/" ^ String.concat "/" path in
|
|
||||||
fprintf fmt "@[<v 4>";
|
|
||||||
fprintf fmt "`%s %s`_" name (rst_label_of_path path);
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
|
|
||||||
List.iter
|
and pp_services prefix ppf services =
|
||||||
(fun tree ->
|
match (Resto.MethMap.bindings services) with
|
||||||
fprintf fmt "@ ";
|
| [] ->
|
||||||
fprintf fmt "%a" loop tree
|
Format.fprintf ppf "* %a" pp_name prefix
|
||||||
) l;
|
| _ :: _ as services ->
|
||||||
fprintf fmt "@]"
|
Format.fprintf ppf "* %a (@[<h>%a@])"
|
||||||
| SymbNode (path, l) ->
|
pp_name prefix
|
||||||
if List.length path > 0 then begin
|
(Format.pp_print_list
|
||||||
let name = "\\/" ^ String.concat "/" path in
|
~pp_sep:Format.pp_print_space
|
||||||
|
(pp_service_method prefix)) services
|
||||||
|
|
||||||
fprintf fmt "@[<v 2>%s" name;
|
and pp_service_method prefix ppf (meth, _service) =
|
||||||
(* fprintf fmt "%s" name; *)
|
Format.fprintf ppf "`%s <%s_>`_"
|
||||||
|
(Resto.string_of_meth meth)
|
||||||
|
(ref_of_service (prefix, meth))
|
||||||
|
|
||||||
fprintf fmt "@ ";
|
end
|
||||||
|
|
||||||
List.iter
|
module Description = struct
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" loop tree
|
|
||||||
) l;
|
|
||||||
fprintf fmt "@]"
|
|
||||||
|
|
||||||
end else
|
module Query = struct
|
||||||
List.iter
|
|
||||||
(fun tree ->
|
|
||||||
fprintf fmt "@ ";
|
|
||||||
fprintf fmt "%a" loop tree
|
|
||||||
) l
|
|
||||||
in
|
|
||||||
loop fmt node
|
|
||||||
|
|
||||||
let pp_print_query_arg fmt =
|
let pp_arg fmt =
|
||||||
let open RPC_arg in
|
let open RPC_arg in
|
||||||
function { name ; _ } ->
|
function { name ; _ } ->
|
||||||
fprintf fmt "<%s>" name
|
Format.fprintf fmt "<%s>" name
|
||||||
|
|
||||||
let pp_print_query_html_arg fmt =
|
let pp_title_item ppf =
|
||||||
let open RPC_arg in
|
|
||||||
function { name ; _ } ->
|
|
||||||
fprintf fmt "<%s>" name
|
|
||||||
|
|
||||||
let pp_print_query_title fmt =
|
|
||||||
let open RPC_description in
|
let open RPC_description in
|
||||||
function {name ; kind ; _ } ->
|
function {name ; kind ; _ } ->
|
||||||
match kind with
|
match kind with
|
||||||
| Single arg -> fprintf fmt "%s=%a" name pp_print_query_arg arg
|
| Single arg | Optional arg ->
|
||||||
| Optional arg -> fprintf fmt "[%s=%a]" name pp_print_query_arg arg
|
Format.fprintf ppf "[%s=%a]" name pp_arg arg
|
||||||
| Flag -> fprintf fmt "%s" name
|
| Flag ->
|
||||||
| Multi arg -> fprintf fmt "(%s=%a)\\*" name pp_print_query_arg arg
|
Format.fprintf ppf "[%s]" name
|
||||||
|
| Multi arg ->
|
||||||
|
Format.fprintf ppf "(%s=%a)\\*" name pp_arg arg
|
||||||
|
|
||||||
let pp_print_query_item_descr fmt =
|
let pp_title ppf query =
|
||||||
|
Format.fprintf ppf "%s%a"
|
||||||
|
(if query = [] then "" else "?")
|
||||||
|
(Format.pp_print_list
|
||||||
|
~pp_sep:(fun ppf () -> Format.fprintf ppf "&")
|
||||||
|
pp_title_item) query
|
||||||
|
|
||||||
|
let pp_html_arg fmt =
|
||||||
|
let open RPC_arg in
|
||||||
|
function { name ; _ } ->
|
||||||
|
Format.fprintf fmt "<%s>" name
|
||||||
|
|
||||||
|
let pp_item ppf =
|
||||||
let open RPC_description in
|
let open RPC_description in
|
||||||
function { name ; description ; kind } ->
|
function { name ; description ; kind } ->
|
||||||
begin match kind with
|
begin match kind with
|
||||||
| Single arg -> fprintf fmt "%s : %a" name pp_print_query_html_arg arg
|
| Single arg
|
||||||
| Optional arg -> fprintf fmt "[%s : %a] - Optional" name pp_print_query_html_arg arg
|
| Optional arg
|
||||||
| Flag -> fprintf fmt "%s - Flag" name
|
| Multi arg ->
|
||||||
| Multi arg -> fprintf fmt "(%s : %a)\\* - Can be given multiple times" name
|
Format.fprintf ppf
|
||||||
pp_print_query_html_arg arg
|
"<span class=\"query\">%s = %a</span>"
|
||||||
end;
|
name pp_html_arg arg
|
||||||
|
| Flag ->
|
||||||
|
Format.fprintf ppf
|
||||||
|
"<span class=\"query\">%s</span>"
|
||||||
|
name
|
||||||
|
end ;
|
||||||
begin match description with
|
begin match description with
|
||||||
| None -> ()
|
| None -> ()
|
||||||
| Some descr -> fprintf fmt " : %s" descr
|
| Some descr -> Format.fprintf ppf " : %s" descr
|
||||||
end
|
end
|
||||||
|
|
||||||
let pp_print_html_tab_button fmt ?(default=false) ~shortlabel ~content path =
|
let pp ppf query =
|
||||||
let target_ref = ref_of_path path in
|
match query with
|
||||||
fprintf fmt "<button class=\"tablinks%s\" onclick=\"showTab(this, '%s', '%s')\">%s</button>@ "
|
| [] -> ()
|
||||||
|
| _ :: _ as query ->
|
||||||
|
Format.fprintf ppf
|
||||||
|
"</p> <p>Optional query arguments :<ul><li>%a</li></ul>"
|
||||||
|
(Format.pp_print_list
|
||||||
|
~pp_sep:(fun ppf () -> Format.fprintf ppf "</li><li>")
|
||||||
|
pp_item)
|
||||||
|
query
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
module Tabs = struct
|
||||||
|
|
||||||
|
let pp_tab_div ppf f =
|
||||||
|
Format.fprintf ppf
|
||||||
|
"@[<v 2><div class=\"tab\">%a</div>@]"
|
||||||
|
(fun ppf () -> f ppf) ()
|
||||||
|
|
||||||
|
let pp_tabcontent_div ~id ~class_ ppf f =
|
||||||
|
Format.fprintf ppf
|
||||||
|
"@[<v 2><div id=\"%s\" class=\"%s tabcontent\">@ \
|
||||||
|
%a@ \
|
||||||
|
@]</div>@ "
|
||||||
|
id class_ (fun ppf () -> f ppf) ()
|
||||||
|
|
||||||
|
let pp_button ppf ?(default=false) ~shortlabel ~content target_ref =
|
||||||
|
Format.fprintf ppf
|
||||||
|
"<button class=\"tablinks%s\" onclick=\"showTab(this, '%s', '%s')\">%s</button>@ "
|
||||||
(if default then " defaultOpen" else "")
|
(if default then " defaultOpen" else "")
|
||||||
(target_ref ^ shortlabel)
|
(target_ref ^ shortlabel)
|
||||||
target_ref
|
target_ref
|
||||||
content
|
content
|
||||||
|
|
||||||
let pp_print_html_tab_content fmt ~tag ~shortlabel ~pp_content ~content path =
|
let pp_content ppf ~tag ~shortlabel target_ref pp_content content =
|
||||||
let target_ref = ref_of_path path in
|
pp_tabcontent_div
|
||||||
fprintf fmt "@[<v 2><div id=\"%s\" class=\"%s tabcontent\" style=\"max-height:200px; overflow:auto\" >@ "
|
~id:(target_ref ^ shortlabel) ~class_:target_ref ppf
|
||||||
(target_ref ^ shortlabel) target_ref;
|
begin fun ppf ->
|
||||||
fprintf fmt "<%s>@ %a</%s>@ " tag pp_content content tag;
|
Format.fprintf ppf "<%s>@ %a</%s>" tag pp_content content tag
|
||||||
fprintf fmt "</div>@]"
|
end
|
||||||
|
|
||||||
let pp_print_html_tabs fmt { path ; description ; input ; output ; query ; _ (* example ; error *) } =
|
let pp_description ppf (service : _ RPC_description.service) =
|
||||||
fprintf fmt "@[<v 2>.. raw:: html@ @ ";
|
let open RPC_description in
|
||||||
fprintf fmt "@[<v 2><div class=\"tab\">@ ";
|
(* TODO collect and display arg description (in path and in query) *)
|
||||||
|
Format.fprintf ppf "%s%a"
|
||||||
|
(Option.unopt ~default:"" service.description)
|
||||||
|
Query.pp service.query
|
||||||
|
|
||||||
fprintf fmt "%a" (pp_print_html_tab_button ~default:true ~shortlabel:"descr" ~content:"Description") path;
|
let pp ppf prefix service =
|
||||||
(match input with
|
let open RPC_description in
|
||||||
| Some _ ->
|
let target_ref = ref_of_service (prefix, service.meth) in
|
||||||
fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"input" ~content:"Input format") path;
|
Rst.pp_html ppf begin fun ppf ->
|
||||||
| None -> ());
|
pp_tab_div ppf begin fun ppf ->
|
||||||
(match output with
|
pp_button ppf
|
||||||
| Some _ ->
|
~default:true ~shortlabel:"descr" ~content:"Description"
|
||||||
fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"output" ~content:"Output format") path;
|
target_ref ;
|
||||||
| None -> ());
|
Option.iter service.input ~f: begin fun __ ->
|
||||||
(* (match example with
|
pp_button ppf
|
||||||
* | Some _ ->
|
~default:false ~shortlabel:"input" ~content:"Input format"
|
||||||
* fprintf fmt "%a" (pp_print_html_tab_button ~default:false ~shortlabel:"example" ~content:"Example") path;
|
target_ref
|
||||||
* | None -> ()); *)
|
end ;
|
||||||
fprintf fmt "</div>@]@ ";
|
pp_button ppf
|
||||||
|
~default:false ~shortlabel:"output" ~content:"Output format"
|
||||||
|
target_ref ;
|
||||||
|
end ;
|
||||||
|
pp_content ppf
|
||||||
|
~tag:"p" ~shortlabel:"descr" target_ref
|
||||||
|
pp_description service ;
|
||||||
|
Option.iter service.input ~f: begin fun schema ->
|
||||||
|
pp_content ppf
|
||||||
|
~tag:"pre" ~shortlabel:"input" target_ref
|
||||||
|
Json_schema.pp schema ;
|
||||||
|
end ;
|
||||||
|
pp_content ppf
|
||||||
|
~tag:"pre" ~shortlabel:"output" target_ref
|
||||||
|
Json_schema.pp service.output ;
|
||||||
|
end
|
||||||
|
|
||||||
let query_item_list =
|
end
|
||||||
if query <> [] then
|
|
||||||
asprintf "</p> <p>Optional query arguments :<ul><li>%a</li></ul>"
|
|
||||||
(pp_print_list
|
|
||||||
~pp_sep:(fun fmt () -> fprintf fmt "</li><li>")
|
|
||||||
pp_print_query_item_descr) query
|
|
||||||
else ""
|
|
||||||
in
|
|
||||||
fprintf fmt "%a@ " (pp_print_html_tab_content ~tag:"p" ~shortlabel:"descr"
|
|
||||||
~pp_content:pp_print_string ~content:(description^query_item_list)) path;
|
|
||||||
(match input with
|
|
||||||
| Some x -> fprintf fmt "%a@ " (pp_print_html_tab_content ~tag:"pre" ~shortlabel:"input"
|
|
||||||
~pp_content:Json_schema.pp ~content:x) path;
|
|
||||||
| None -> ());
|
|
||||||
(match output with
|
|
||||||
| Some x -> fprintf fmt "%a@ " (pp_print_html_tab_content ~tag:"pre" ~shortlabel:"output"
|
|
||||||
~pp_content:Json_schema.pp ~content:x) path;
|
|
||||||
| None -> ());
|
|
||||||
(* (match example with
|
|
||||||
* | Some x -> fprintf fmt "%a@ " (pp_print_html_tab_content ~tag:"pre" ~shortlabel:"example"
|
|
||||||
* ~pp_content:pp_print_string ~content:x) path;
|
|
||||||
* | None -> ()); *)
|
|
||||||
|
|
||||||
fprintf fmt "@]"
|
let rec pp prefix ppf dir =
|
||||||
|
let open Resto.Description in
|
||||||
|
match dir with
|
||||||
|
| Empty -> ()
|
||||||
|
| Static { services ; subdirs = None } ->
|
||||||
|
pp_services prefix ppf services
|
||||||
|
| Static { services ; subdirs = Some (Suffixes map) } ->
|
||||||
|
pp_services prefix ppf services ;
|
||||||
|
Format.pp_print_list (pp_suffixes prefix)
|
||||||
|
ppf (Resto.StringMap.bindings map)
|
||||||
|
| Static { services ; subdirs = Some (Arg (arg, dir)) } ->
|
||||||
|
let name = Format.asprintf "<%s>" arg.name in
|
||||||
|
pp_services prefix ppf services ;
|
||||||
|
pp_suffixes prefix ppf (name, dir)
|
||||||
|
| Dynamic _ -> ()
|
||||||
|
|
||||||
let pp_print_rst_full_service fmt ({ path ; meth ; query } as repr) =
|
and pp_suffixes prefix ppf (name, dir) =
|
||||||
fprintf fmt ".. _%s :@\n@\n**%s %s%s%a**@\n@\n"
|
pp (prefix @ [name]) ppf dir
|
||||||
(ref_of_path path)
|
|
||||||
|
and pp_services prefix ppf services =
|
||||||
|
List.iter
|
||||||
|
(pp_service prefix ppf)
|
||||||
|
(Resto.MethMap.bindings services)
|
||||||
|
|
||||||
|
and pp_service prefix ppf (meth, service) =
|
||||||
|
Rst.pp_ref ppf (ref_of_service (prefix, meth)) ;
|
||||||
|
Format.fprintf ppf "**%s %a%a**@\n@\n"
|
||||||
(Resto.string_of_meth meth)
|
(Resto.string_of_meth meth)
|
||||||
("/" ^ String.concat "/" path)
|
pp_name prefix
|
||||||
(if query = [] then "" else "?")
|
Query.pp_title service.query ;
|
||||||
(pp_print_list ~pp_sep:(fun fmt () -> fprintf fmt "&") pp_print_query_title) query;
|
Tabs.pp ppf prefix service
|
||||||
fprintf fmt "%a" pp_print_html_tabs repr
|
|
||||||
|
|
||||||
let rec pp_print_rst_service_tree fmt node =
|
end
|
||||||
let open Format in
|
|
||||||
match node with
|
|
||||||
| Root l -> (pp_print_list ~pp_sep:pp_print_cut pp_print_rst_service_tree) fmt l
|
|
||||||
| SymbNode (_, l) -> (pp_print_list ~pp_sep:pp_print_cut pp_print_rst_service_tree) fmt l
|
|
||||||
| Node ( repr , l) ->
|
|
||||||
(* Generates services details and ref for links *)
|
|
||||||
fprintf fmt "%a@\n@\n" pp_print_rst_full_service repr;
|
|
||||||
fprintf fmt "%a" (pp_print_list ~pp_sep:pp_print_newline pp_print_rst_service_tree) l
|
|
||||||
|
|
||||||
let style =
|
let style = {css|
|
||||||
"<style>\
|
<style>
|
||||||
.tab {\
|
.tab {
|
||||||
overflow: hidden;\
|
overflow: hidden;
|
||||||
border: 1px solid #ccc;\
|
border: 1px solid #ccc;
|
||||||
background-color: #f1f1f1;\
|
background-color: #f1f1f1;
|
||||||
}\
|
}
|
||||||
.tab button {\
|
.tab button {
|
||||||
background-color: inherit;\
|
background-color: inherit;
|
||||||
float: left;\
|
float: left;
|
||||||
border: none;\
|
border: none;
|
||||||
outline: none;\
|
outline: none;
|
||||||
cursor: pointer;\
|
cursor: pointer;
|
||||||
padding: 5px 10px;\
|
padding: 5px 10px;
|
||||||
}\
|
}
|
||||||
.tab button:hover {\
|
.tab button:hover {
|
||||||
background-color: #ddd;\
|
background-color: #ddd;
|
||||||
}\
|
}
|
||||||
.tab button.active {\
|
.tab button.active {
|
||||||
background-color: #ccc;\
|
background-color: #ccc;
|
||||||
}\
|
}
|
||||||
.tabcontent {\
|
.tabcontent {
|
||||||
display: none;\
|
display: none;
|
||||||
padding: 6px 12px;\
|
padding: 6px 12px;
|
||||||
border: 1px solid #ccc;\
|
border: 1px solid #ccc;
|
||||||
border-top: none;\
|
border-top: none;
|
||||||
margin-bottom: 20px;\
|
max-height: 40ex;
|
||||||
}\
|
margin-bottom: 7ex;
|
||||||
pre {\
|
overflow: auto;
|
||||||
font-size: 12px\
|
}
|
||||||
}</style>"
|
.tabcontent p {
|
||||||
|
margin-bottom: 12px;
|
||||||
|
}
|
||||||
|
pre {
|
||||||
|
font-size: 12px
|
||||||
|
}
|
||||||
|
.rst-content .section ul p {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
span.query {
|
||||||
|
font-family: monospace;
|
||||||
|
white-space: pre;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|css}
|
||||||
|
|
||||||
let script =
|
let script = {script|
|
||||||
"<script>\
|
<script>
|
||||||
function showTab(elt, tab, ref) {\
|
function showTab(elt, tab, ref) {
|
||||||
var i, tabcontent, tablinks;\
|
var i, tabcontent, tablinks;
|
||||||
\
|
tabcontent = document.getElementsByClassName(ref);
|
||||||
tabcontent = document.getElementsByClassName(ref);\
|
for (i = 0; i < tabcontent.length; i++) {
|
||||||
for (i = 0; i < tabcontent.length; i++) {\
|
tabcontent[i].style.display = 'none';
|
||||||
tabcontent[i].style.display = 'none';\
|
}
|
||||||
}\
|
|
||||||
\
|
|
||||||
tablinks = elt.parentNode.children;\
|
|
||||||
for (i = 0; i < tablinks.length; i++) {\
|
|
||||||
tablinks[i].className = tablinks[i].className.replace(' active', '');\
|
|
||||||
}\
|
|
||||||
\
|
|
||||||
document.getElementById(tab).style.display = 'block';\
|
|
||||||
elt.className += ' active';\
|
|
||||||
}\
|
|
||||||
\
|
|
||||||
document.addEventListener('DOMContentLoaded', function(){\
|
|
||||||
var a = document.getElementsByClassName('defaultOpen');\
|
|
||||||
for (i = 0; i < a.length; i++) { a[i].click() }\
|
|
||||||
})\
|
|
||||||
</script>"
|
|
||||||
|
|
||||||
let ppf = Format.std_formatter
|
tablinks = elt.parentNode.children;
|
||||||
let err_ppf = Format.err_formatter
|
for (i = 0; i < tablinks.length; i++) {
|
||||||
|
tablinks[i].className = tablinks[i].className.replace(' active', '');
|
||||||
|
}
|
||||||
|
|
||||||
let run ?(rpc_port=18731) () =
|
document.getElementById(tab).style.display = 'block';
|
||||||
(* Client context *)
|
elt.className += ' active';
|
||||||
let rpc_config = { RPC_client.default_config with port=rpc_port } in
|
}
|
||||||
let open Client_config in
|
|
||||||
let {block; _} = default_cli_args in
|
|
||||||
let (cctxt : #Tezos_client_base.Client_context.full) =
|
|
||||||
new Client_context_unix.unix_full
|
|
||||||
~block ~confirmations:None ~base_dir: "/" ~rpc_config
|
|
||||||
in
|
|
||||||
|
|
||||||
let print_header () =
|
document.addEventListener('DOMContentLoaded', function() {
|
||||||
|
var a = document.getElementsByClassName('defaultOpen');
|
||||||
|
for (i = 0; i < a.length; i++) { a[i].click() }
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|script}
|
||||||
|
|
||||||
|
|
||||||
|
let pp_document ppf descriptions =
|
||||||
(* Style : hack *)
|
(* Style : hack *)
|
||||||
fprintf ppf "%a@." pp_print_rst_raw_html style;
|
Format.fprintf ppf "%a@." Rst.pp_raw_html style ;
|
||||||
(* Script : hack *)
|
(* Script : hack *)
|
||||||
fprintf ppf "%a@." pp_print_rst_raw_html script;
|
Format.fprintf ppf "%a@." Rst.pp_raw_html script ;
|
||||||
(* Page title *)
|
(* Page title *)
|
||||||
fprintf ppf "%a" pp_print_rst_h1 "RPC API";
|
Format.fprintf ppf "%a" Rst.pp_h1 "RPC API" ;
|
||||||
(* include/copy usage.rst from input *)
|
(* include/copy usage.rst from input *)
|
||||||
let rec loop () =
|
let rec loop () =
|
||||||
let s = read_line () in
|
let s = read_line () in
|
||||||
fprintf ppf "%s@\n" s;
|
Format.fprintf ppf "%s@\n" s ;
|
||||||
loop ()
|
loop () in
|
||||||
in begin try loop () with End_of_file -> () end
|
begin try loop () with End_of_file -> () end ;
|
||||||
in
|
Format.fprintf ppf "@\n" ;
|
||||||
(make_tree cctxt [] >>= function
|
(* Index *)
|
||||||
| Ok service_tree ->
|
Format.pp_set_margin ppf 10000 ;
|
||||||
(* Print header!! *)
|
Format.pp_set_max_indent ppf 9000 ;
|
||||||
fprintf ppf "@\n";
|
List.iter
|
||||||
print_header ();
|
(fun (name, prefix, rpc_dir) ->
|
||||||
fprintf ppf "@\n";
|
Rst.pp_h2 ppf (Format.asprintf "%s RPCs - Index" name) ;
|
||||||
|
Format.fprintf ppf "%a@\n@\n" (Index.pp prefix) rpc_dir)
|
||||||
|
descriptions ;
|
||||||
|
(* Full description *)
|
||||||
|
Format.pp_set_margin ppf 80 ;
|
||||||
|
Format.pp_set_max_indent ppf 76 ;
|
||||||
|
List.iter
|
||||||
|
(fun (name, prefix, rpc_dir) ->
|
||||||
|
Rst.pp_h2 ppf (Format.asprintf "%s RPCs - Full description" name) ;
|
||||||
|
Format.fprintf ppf "%a@\n@\n" (Description.pp prefix) rpc_dir)
|
||||||
|
descriptions
|
||||||
|
|
||||||
(* Shell RPCs tree *)
|
let genesis : State.Chain.genesis = {
|
||||||
fprintf ppf "%a@." (pp_print_rst_hierarchy ~title:"Client RPCs - Index") service_tree;
|
time =
|
||||||
fprintf ppf "%a" pp_print_rst_h2 "Client RPCs - Full description";
|
Time.of_notation_exn "2018-04-17T11:46:23Z" ;
|
||||||
fprintf ppf "%a@." pp_print_rst_service_tree service_tree;
|
block =
|
||||||
Lwt.return 0
|
Block_hash.of_b58check_exn
|
||||||
|
"BLockGenesisGenesisGenesisGenesisGenesisa52f8bUWPcg" ;
|
||||||
|
protocol =
|
||||||
|
Protocol_hash.of_b58check_exn
|
||||||
|
"ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" ;
|
||||||
|
}
|
||||||
|
|
||||||
| Error _ ->
|
let main dir =
|
||||||
Format.eprintf "[RPC Doc Generation] Client : Couldn't reach node\n";
|
let (/) = Filename.concat in
|
||||||
Lwt.return 1) >>= function
|
let node_config : Node.config = {
|
||||||
| 0 ->
|
genesis ;
|
||||||
(* Alpha Protocol RPCs *)
|
patch_context = None ;
|
||||||
let path_proto_alpha = String.split '/' "/blocks/head/proto" in
|
store_root = dir / "store" ;
|
||||||
begin
|
context_root = dir / "context" ;
|
||||||
make_tree cctxt path_proto_alpha >>= function
|
p2p = None ;
|
||||||
| Ok service_tree ->
|
test_chain_max_tll = None ;
|
||||||
(* Proto alpha RPCs tree *)
|
} in
|
||||||
fprintf ppf "%a@." (pp_print_rst_hierarchy ~title:"Protocol Alpha RPCs - Index") service_tree;
|
Node.create
|
||||||
fprintf ppf "%a" pp_print_rst_h2 "Protocol Alpha RPCs - Full description";
|
node_config
|
||||||
fprintf ppf "%a@." pp_print_rst_service_tree service_tree;
|
Node.default_peer_validator_limits
|
||||||
|
Node.default_block_validator_limits
|
||||||
Lwt.return 0
|
Node.default_prevalidator_limits
|
||||||
|
Node.default_chain_validator_limits >>=? fun node ->
|
||||||
| Error _ ->
|
let shell_dir = Node.build_rpc_directory node in
|
||||||
Format.fprintf err_ppf "[RPC Doc Generation] Proto alpha : Couldn't reach node\n";
|
let protocol_dirs =
|
||||||
Lwt.return 1
|
List.map
|
||||||
end
|
(fun (name, hash) ->
|
||||||
| _ -> Lwt.return 1
|
let hash = Protocol_hash.of_b58check_exn hash in
|
||||||
|
let (module Proto) = Registered_protocol.get_exn hash in
|
||||||
|
"Protocol " ^ name,
|
||||||
|
[".." ; "<block_id>"] ,
|
||||||
|
RPC_directory.map (fun () -> assert false) @@
|
||||||
|
Block_directory.build_raw_rpc_directory (module Proto) (module Proto))
|
||||||
|
protocols in
|
||||||
|
let dirs = ("Shell", [""], shell_dir) :: protocol_dirs in
|
||||||
|
Lwt_list.map_p
|
||||||
|
(fun (name, path, dir) ->
|
||||||
|
RPC_directory.describe_directory ~recurse:true ~arg:() dir >>= fun dir ->
|
||||||
|
Lwt.return (name, path, dir))
|
||||||
|
dirs >>= fun descriptions ->
|
||||||
|
let ppf = Format.std_formatter in
|
||||||
|
pp_document ppf descriptions ;
|
||||||
|
return ()
|
||||||
|
|
||||||
let () =
|
let () =
|
||||||
Pervasives.exit
|
Lwt_main.run begin
|
||||||
(Lwt_main.run
|
Lwt_utils_unix.with_tempdir "tezos_rpcdoc_" main >>= function
|
||||||
begin try
|
| Ok _ ->
|
||||||
if Array.length Sys.argv > 1 then
|
Lwt.return_unit
|
||||||
let rpc_port = int_of_string Sys.argv.(1) in
|
| Error err ->
|
||||||
run ~rpc_port ()
|
Format.eprintf "%a@." pp_print_error err ;
|
||||||
else
|
Pervasives.exit 1
|
||||||
run ()
|
end
|
||||||
with _ ->
|
|
||||||
run ()
|
|
||||||
end)
|
|
||||||
|
|||||||
@ -13,44 +13,7 @@ set -o pipefail
|
|||||||
#**************************************************************************#
|
#**************************************************************************#
|
||||||
|
|
||||||
docgen_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && echo "$(pwd -P)")"
|
docgen_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && echo "$(pwd -P)")"
|
||||||
|
|
||||||
rpc_doc="../_build/default/docs/doc_gen/rpcs/rpc_doc.exe"
|
rpc_doc="../_build/default/docs/doc_gen/rpcs/rpc_doc.exe"
|
||||||
|
|
||||||
tezos_sandboxed_node="${1:-$docgen_dir/../../../src/bin_node/tezos-sandboxed-node.sh}"
|
|
||||||
tezos_init_sandboxed_client="${3:-$docgen_dir/../../../src/bin_client/tezos-init-sandboxed-client.sh}"
|
|
||||||
|
|
||||||
local_node="${2:-$docgen_dir/../../../_build/default/src/bin_node/main.exe}"
|
|
||||||
local_client="${2:-$docgen_dir/../../../_build/default/src/bin_client/main_client.exe}"
|
|
||||||
|
|
||||||
sandbox_file="/tmp/sandbox.json"
|
|
||||||
usage="$docgen_dir/usage.rst"
|
usage="$docgen_dir/usage.rst"
|
||||||
|
|
||||||
source $tezos_sandboxed_node
|
$rpc_doc < $usage | sed -e 's|/chains/main/blocks/head/|.../<block_id>/|g'
|
||||||
source $tezos_init_sandboxed_client
|
|
||||||
|
|
||||||
start_node() {
|
|
||||||
local id=${1:-1}
|
|
||||||
start_sandboxed_node $id
|
|
||||||
init_sandboxed_client $id
|
|
||||||
wait_for_the_node_to_be_ready
|
|
||||||
add_sandboxed_bootstrap_identities
|
|
||||||
client_instances+=("$client")
|
|
||||||
export "client$id=$client"
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup() {
|
|
||||||
set -e
|
|
||||||
cleanup_nodes
|
|
||||||
cleanup_clients
|
|
||||||
}
|
|
||||||
trap cleanup EXIT INT
|
|
||||||
|
|
||||||
# Default to 7 to avoid potentially running nodes
|
|
||||||
# TODO : get first available port
|
|
||||||
start_node 7 >&2
|
|
||||||
|
|
||||||
activate_alpha >&2
|
|
||||||
|
|
||||||
sleep 2
|
|
||||||
|
|
||||||
$rpc_doc $rpc < $usage | sed -e 's|/chains/main/blocks/head/|.../<block_id>/|g'
|
|
||||||
|
|||||||
@ -109,46 +109,10 @@ let default_log = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
let default_shell = {
|
let default_shell = {
|
||||||
block_validator_limits = {
|
block_validator_limits = Node.default_block_validator_limits ;
|
||||||
protocol_timeout = 120. ;
|
prevalidator_limits = Node.default_prevalidator_limits ;
|
||||||
worker_limits = {
|
peer_validator_limits = Node.default_peer_validator_limits ;
|
||||||
backlog_size = 1000 ;
|
chain_validator_limits = Node.default_chain_validator_limits ;
|
||||||
backlog_level = Logging.Debug ;
|
|
||||||
zombie_lifetime = 3600. ;
|
|
||||||
zombie_memory = 1800. ;
|
|
||||||
}
|
|
||||||
} ;
|
|
||||||
prevalidator_limits = {
|
|
||||||
operation_timeout = 10. ;
|
|
||||||
max_refused_operations = 1000 ;
|
|
||||||
worker_limits = {
|
|
||||||
backlog_size = 1000 ;
|
|
||||||
backlog_level = Logging.Info ;
|
|
||||||
zombie_lifetime = 600. ;
|
|
||||||
zombie_memory = 120. ;
|
|
||||||
}
|
|
||||||
} ;
|
|
||||||
peer_validator_limits = {
|
|
||||||
block_header_timeout = 60. ;
|
|
||||||
block_operations_timeout = 60. ;
|
|
||||||
protocol_timeout = 120. ;
|
|
||||||
new_head_request_timeout = 90. ;
|
|
||||||
worker_limits = {
|
|
||||||
backlog_size = 1000 ;
|
|
||||||
backlog_level = Logging.Info ;
|
|
||||||
zombie_lifetime = 600. ;
|
|
||||||
zombie_memory = 120. ;
|
|
||||||
}
|
|
||||||
} ;
|
|
||||||
chain_validator_limits = {
|
|
||||||
bootstrap_threshold = 4 ;
|
|
||||||
worker_limits = {
|
|
||||||
backlog_size = 1000 ;
|
|
||||||
backlog_level = Logging.Info ;
|
|
||||||
zombie_lifetime = 600. ;
|
|
||||||
zombie_memory = 120. ;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let default_config = {
|
let default_config = {
|
||||||
|
|||||||
@ -60,6 +60,9 @@ let get hash =
|
|||||||
try Some (get_exn hash)
|
try Some (get_exn hash)
|
||||||
with Not_found -> None
|
with Not_found -> None
|
||||||
|
|
||||||
|
let list () =
|
||||||
|
VersionTable.fold (fun _ p acc -> p :: acc) versions []
|
||||||
|
|
||||||
let list_embedded () =
|
let list_embedded () =
|
||||||
VersionTable.fold (fun k _ acc -> k :: acc) sources []
|
VersionTable.fold (fun k _ acc -> k :: acc) sources []
|
||||||
|
|
||||||
|
|||||||
@ -22,6 +22,8 @@ type t = (module T)
|
|||||||
|
|
||||||
val mem: Protocol_hash.t -> bool
|
val mem: Protocol_hash.t -> bool
|
||||||
|
|
||||||
|
val list: unit -> t list
|
||||||
|
|
||||||
val get: Protocol_hash.t -> t option
|
val get: Protocol_hash.t -> t option
|
||||||
val get_exn: Protocol_hash.t -> t
|
val get_exn: Protocol_hash.t -> t
|
||||||
|
|
||||||
|
|||||||
@ -27,7 +27,7 @@ let rec read_partial_context context path depth =
|
|||||||
end >>= fun l ->
|
end >>= fun l ->
|
||||||
Lwt.return (Block_services.Dir (List.rev l))
|
Lwt.return (Block_services.Dir (List.rev l))
|
||||||
|
|
||||||
let rpc_directory
|
let build_raw_rpc_directory
|
||||||
(module Proto : Block_services.PROTO)
|
(module Proto : Block_services.PROTO)
|
||||||
(module Next_proto : Registered_protocol.T) =
|
(module Next_proto : Registered_protocol.T) =
|
||||||
|
|
||||||
@ -336,7 +336,7 @@ let get_directory block =
|
|||||||
let next_protocol = get_protocol next_protocol_hash in
|
let next_protocol = get_protocol next_protocol_hash in
|
||||||
State.Block.predecessor block >>= function
|
State.Block.predecessor block >>= function
|
||||||
| None ->
|
| None ->
|
||||||
Lwt.return (rpc_directory
|
Lwt.return (build_raw_rpc_directory
|
||||||
(module Block_services.Fake_protocol)
|
(module Block_services.Fake_protocol)
|
||||||
next_protocol)
|
next_protocol)
|
||||||
| Some pred ->
|
| Some pred ->
|
||||||
@ -345,7 +345,7 @@ let get_directory block =
|
|||||||
State.Block.get_rpc_directory block >>= function
|
State.Block.get_rpc_directory block >>= function
|
||||||
| Some dir -> Lwt.return dir
|
| Some dir -> Lwt.return dir
|
||||||
| None ->
|
| None ->
|
||||||
let dir = rpc_directory (module Proto) next_protocol in
|
let dir = build_raw_rpc_directory (module Proto) next_protocol in
|
||||||
State.Block.set_rpc_directory block dir >>= fun () ->
|
State.Block.set_rpc_directory block dir >>= fun () ->
|
||||||
Lwt.return dir
|
Lwt.return dir
|
||||||
|
|
||||||
|
|||||||
@ -9,6 +9,11 @@
|
|||||||
|
|
||||||
val get_block: State.Chain.t -> Block_services.block -> State.Block.t Lwt.t
|
val get_block: State.Chain.t -> Block_services.block -> State.Block.t Lwt.t
|
||||||
|
|
||||||
|
val build_raw_rpc_directory:
|
||||||
|
(module Block_services.PROTO) ->
|
||||||
|
(module Registered_protocol.T) ->
|
||||||
|
State.Block.t RPC_directory.directory
|
||||||
|
|
||||||
val build_rpc_directory:
|
val build_rpc_directory:
|
||||||
State.Chain.t ->
|
State.Chain.t ->
|
||||||
Block_services.block ->
|
Block_services.block ->
|
||||||
|
|||||||
@ -93,6 +93,47 @@ and chain_validator_limits = Chain_validator.limits = {
|
|||||||
worker_limits : Worker_types.limits ;
|
worker_limits : Worker_types.limits ;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let default_block_validator_limits = {
|
||||||
|
protocol_timeout = 120. ;
|
||||||
|
worker_limits = {
|
||||||
|
backlog_size = 1000 ;
|
||||||
|
backlog_level = Logging.Debug ;
|
||||||
|
zombie_lifetime = 3600. ;
|
||||||
|
zombie_memory = 1800. ;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let default_prevalidator_limits = {
|
||||||
|
operation_timeout = 10. ;
|
||||||
|
max_refused_operations = 1000 ;
|
||||||
|
worker_limits = {
|
||||||
|
backlog_size = 1000 ;
|
||||||
|
backlog_level = Logging.Info ;
|
||||||
|
zombie_lifetime = 600. ;
|
||||||
|
zombie_memory = 120. ;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let default_peer_validator_limits = {
|
||||||
|
block_header_timeout = 60. ;
|
||||||
|
block_operations_timeout = 60. ;
|
||||||
|
protocol_timeout = 120. ;
|
||||||
|
new_head_request_timeout = 90. ;
|
||||||
|
worker_limits = {
|
||||||
|
backlog_size = 1000 ;
|
||||||
|
backlog_level = Logging.Info ;
|
||||||
|
zombie_lifetime = 600. ;
|
||||||
|
zombie_memory = 120. ;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let default_chain_validator_limits = {
|
||||||
|
bootstrap_threshold = 4 ;
|
||||||
|
worker_limits = {
|
||||||
|
backlog_size = 1000 ;
|
||||||
|
backlog_level = Logging.Info ;
|
||||||
|
zombie_lifetime = 600. ;
|
||||||
|
zombie_memory = 120. ;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let create { genesis ; store_root ; context_root ;
|
let create { genesis ; store_root ; context_root ;
|
||||||
patch_context ; p2p = p2p_params ;
|
patch_context ; p2p = p2p_params ;
|
||||||
test_chain_max_tll = max_child_ttl }
|
test_chain_max_tll = max_child_ttl }
|
||||||
|
|||||||
@ -39,6 +39,11 @@ and chain_validator_limits = {
|
|||||||
worker_limits : Worker_types.limits ;
|
worker_limits : Worker_types.limits ;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
val default_peer_validator_limits: peer_validator_limits
|
||||||
|
val default_prevalidator_limits: prevalidator_limits
|
||||||
|
val default_block_validator_limits: block_validator_limits
|
||||||
|
val default_chain_validator_limits: chain_validator_limits
|
||||||
|
|
||||||
val create:
|
val create:
|
||||||
config ->
|
config ->
|
||||||
peer_validator_limits ->
|
peer_validator_limits ->
|
||||||
|
|||||||
@ -177,6 +177,11 @@ module Make (Encoding : ENCODING) : sig
|
|||||||
('prefix, 'prefix, 'error) Service.description_service ->
|
('prefix, 'prefix, 'error) Service.description_service ->
|
||||||
'prefix directory
|
'prefix directory
|
||||||
|
|
||||||
|
val describe_directory:
|
||||||
|
recurse:bool ->
|
||||||
|
?arg:'a ->
|
||||||
|
'a directory -> Encoding.schema Resto.Description.directory Lwt.t
|
||||||
|
|
||||||
(**/**)
|
(**/**)
|
||||||
|
|
||||||
module Curry: sig
|
module Curry: sig
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user