package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file RPC_service.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

type meth = [`GET | `POST | `DELETE | `PUT | `PATCH]

let string_of_meth = Resto.string_of_meth

let meth_of_string = Resto.meth_of_string

let meth_encoding =
  let open Data_encoding in
  conv
    string_of_meth
    (fun m ->
      match meth_of_string m with
      | None -> Stdlib.failwith "Cannot parse methods"
      | Some s -> s)
    string

module MethMap = Resto.MethMap

type (+'m, 'pr, 'p, 'q, 'i, 'o, 'e) raw =
  ('m, 'pr, 'p, 'q, 'i, 'o, 'e) Resto.MakeService(RPC_encoding).t
  constraint 'meth = [< meth]

type error = Error_monad.error list

type (+'meth, 'prefix, 'params, 'query, 'input, 'output) t =
  ('meth, 'prefix, 'params, 'query, 'input, 'output, error) raw
  constraint 'meth = [< meth]

type (+'meth, 'prefix, 'params, 'query, 'input, 'output) service =
  ('meth, 'prefix, 'params, 'query, 'input, 'output, error) raw
  constraint 'meth = [< meth]

include (
  Resto.MakeService
    (RPC_encoding) :
      module type of struct
        include Resto.MakeService (RPC_encoding)
      end
      with type (+'m, 'pr, 'p, 'q, 'i, 'o, 'e) t :=
        ('m, 'pr, 'p, 'q, 'i, 'o, 'e) raw
       and type (+'m, 'pr, 'p, 'q, 'i, 'o, 'e) service :=
        ('m, 'pr, 'p, 'q, 'i, 'o, 'e) raw)

let error_path = ref None

type Error_monad.error += Unparsable_RPC_error of Data_encoding.json

type Error_monad.error += Empty_error_list

let () =
  let open Error_monad in
  register_error_kind
    `Branch
    ~id:"RPC.Unexpected_error_encoding"
    ~title:"RPC fails with an unparsable error message"
    ~description:
      "The RPC returned with an error code, and the associated body was not a \
       valid error trace. It is likely that the answer does not comes directly \
       from a compatible node."
    ~pp:(fun ppf msg ->
      Format.fprintf
        ppf
        "@[<v 2>The RPC returned with an error code, and the associated body \
         was not a valid error trace:@[%a@]@ It is likely that the answer does \
         not comes directly from a compatible node.@]@."
        Data_encoding.Json.pp
        msg)
    Data_encoding.(obj1 (req "unparsable message" json))
    (function Unparsable_RPC_error msg -> Some msg | _ -> None)
    (fun msg -> Unparsable_RPC_error msg)

let () =
  let open Error_monad in
  register_error_kind
    `Branch
    ~id:"RPC.Empty_error_list"
    ~title:"RPC returned an empty list of errors"
    ~description:"The RPC returned with an error code but no associated error."
    ~pp:(fun ppf () ->
      Format.fprintf
        ppf
        "@[<v 2>The RPC returned with an error code but no associated \
         error.@]@.")
    Data_encoding.empty
    (function Empty_error_list -> Some () | _ -> None)
    (fun () -> Empty_error_list)

let error_encoding =
  let open Data_encoding in
  delayed (fun () ->
      let {meth; uri; _} =
        match !error_path with None -> assert false | Some p -> p
      in
      def
        "error"
        ~description:
          (Printf.sprintf
             "The full list of errors is available with the global RPC `%s %s`"
             (string_of_meth meth)
             (Uri.path_and_query uri))
      @@ conv
           ~schema:Json_schema.any
           (fun errors -> `A (List.map Error_monad.json_of_error errors))
           (function
             | `A [] | `O [] -> [Empty_error_list]
             | json -> (
                 (* in BSON, which is used as an intermediate step when
                    serialising in binary, [`A _] and [`O _] are
                    indistinguishable. For this reason, we set [bson_relaxation]
                    when destructing the JSON. *)
                 match
                   Json.destruct
                     ~bson_relaxation:true
                     Error_monad.trace_encoding
                     json
                 with
                 | [] -> assert false (* see [`A [] | `O []] above *)
                 | trace -> trace
                 | exception Json.Cannot_destruct _ ->
                     [Unparsable_RPC_error json]))
           json)

let error_opt_encoding =
  let open Data_encoding in
  delayed (fun () ->
      let {meth; uri; _} =
        match !error_path with None -> assert false | Some p -> p
      in
      def
        "error_opt"
        ~description:
          (Printf.sprintf
             "An optional error-trace (None indicates no error). The full list \
              of errors is available with the global RPC `%s %s`"
             (string_of_meth meth)
             (Uri.path_and_query uri))
      @@ conv
           ~schema:Json_schema.any
           (function
             | None | Some [] -> `Null
             | Some (_ :: _ as errors) ->
                 `A (List.map Error_monad.json_of_error errors))
           (function
             | `Null | `A [] | `O [] -> None
             | json -> (
                 (* in BSON, which is used as an intermediate step when
                    serialising in binary, [`A _] and [`O _] are
                    indistinguishable. For this reason, we set [bson_relaxation]
                    when destructing the JSON. *)
                 match
                   Json.destruct
                     ~bson_relaxation:true
                     Error_monad.trace_encoding
                     json
                 with
                 | [] -> assert false (* see [`A [] | `O []] above *)
                 | trace -> Some trace
                 | exception Json.Cannot_destruct _ ->
                     Some [Unparsable_RPC_error json]))
           json)

let get_service = get_service ~error:error_encoding

let post_service = post_service ~error:error_encoding

let delete_service = delete_service ~error:error_encoding

let patch_service = patch_service ~error:error_encoding

let put_service = put_service ~error:error_encoding

let error_service =
  get_service
    ~description:"Schema for all the RPC errors from the shell"
    ~query:RPC_query.empty
    ~output:Data_encoding.json_schema
    RPC_path.(root / "errors")

let () = error_path := Some (forge_request error_service () ())

let description_service =
  description_service
    ~description:"RPCs documentation and input/output schema"
    error_encoding
    RPC_path.(root / "describe")
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct