ligo/lib_node_services/RPC.mli

(**************************************************************************)
(*                                                                        *)
(*    Copyright (c) 2014 - 2017.                                          *)
(*    Dynamic Ledger Solutions, Inc. <contact@tezos.com>                  *)
(*                                                                        *)
(*    All rights reserved. No warranty, explicit or implicit, provided.   *)
(*                                                                        *)
(**************************************************************************)

(** Typed RPC services: definition, binding and dispatch. *)

module Data : Resto.ENCODING with type 'a t = 'a Data_encoding.t
                              and type schema = Data_encoding.json_schema

include (module type of struct include Resto end)
module Service : (module type of struct include Resto.MakeService(Data) end)

(** Compatibility layer, to be removed ASAP. *)

val service:
  ?description: string ->
  input: 'input Data_encoding.t ->
  output: 'output Data_encoding.t ->
  ('prefix, 'params) Path.t ->
  ([ `POST ], 'prefix, 'params, unit, 'input, 'output, unit) Service.t

type directory_descr = Data_encoding.json_schema Description.directory

val forge_request :
  (_ , unit, 'params, unit, 'input, 'output, unit) Service.t ->
  'params -> 'input -> MethMap.key * string list * Data_encoding.json
First public release 2016-09-08 21:13:10 +04:00			`(**************************************************************************)`
			`(* *)`
Almost too late for copyright update. 2017-11-14 03:36:14 +04:00			`(* Copyright (c) 2014 - 2017. *)`
First public release 2016-09-08 21:13:10 +04:00			`(* Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)`
			`(* *)`
			`(* All rights reserved. No warranty, explicit or implicit, provided. *)`
			`(* *)`
			`(**************************************************************************)`

Extract the js_of_ocaml compatible part of utils. 2016-12-01 21:27:53 +04:00			`(** Typed RPC services: definition, binding and dispatch. *)`
First public release 2016-09-08 21:13:10 +04:00
Import new version of `vendors/ocplib-resto` The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible. 2017-11-27 09:13:12 +04:00			`module Data : Resto.ENCODING with type 'a t = 'a Data_encoding.t`
			`and type schema = Data_encoding.json_schema`
First public release 2016-09-08 21:13:10 +04:00
Import new version of `vendors/ocplib-resto` The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible. 2017-11-27 09:13:12 +04:00			`include (module type of struct include Resto end)`
Jbuilder: split `lib_node_net` - `lib_node_p2p_base`: Base datatypes for the P2P layers - `lib_node_services`: RPC service definitions (depends on `node_p2p_base`) - `lib_node_http`: RPC http server - `lib_node_p2p`: the P2P workers 2017-11-27 09:13:12 +04:00			`module Service : (module type of struct include Resto.MakeService(Data) end)`
First public release 2016-09-08 21:13:10 +04:00
Import new version of `vendors/ocplib-resto` The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible. 2017-11-27 09:13:12 +04:00			`(** Compatibility layer, to be removed ASAP. *)`
First public release 2016-09-08 21:13:10 +04:00
			`val service:`
RPC: add HTTP methods and Content-Type headers. 2016-12-11 19:34:58 +04:00			`?description: string ->`
			`input: 'input Data_encoding.t ->`
			`output: 'output Data_encoding.t ->`
Import new version of `vendors/ocplib-resto` The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible. 2017-11-27 09:13:12 +04:00			`('prefix, 'params) Path.t ->`
RPC: remove the deprecated type `RPC.service` 2017-12-07 20:43:21 +04:00			([ `POST ], 'prefix, 'params, unit, 'input, 'output, unit) Service.t
RPC: add HTTP methods and Content-Type headers. 2016-12-11 19:34:58 +04:00
Import new version of `vendors/ocplib-resto` The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible. 2017-11-27 09:13:12 +04:00			`type directory_descr = Data_encoding.json_schema Description.directory`
First public release 2016-09-08 21:13:10 +04:00
RPC: remove the deprecated type `RPC.service` 2017-12-07 20:43:21 +04:00			`val forge_request :`
			`(_ , unit, 'params, unit, 'input, 'output, unit) Service.t ->`
Import new version of `vendors/ocplib-resto` The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible. 2017-11-27 09:13:12 +04:00			`'params -> 'input -> MethMap.key * string list * Data_encoding.json`
First public release 2016-09-08 21:13:10 +04:00