Module `Tezos_rpc.Service`Source

Sourcetype meth = [

| `GET
| `POST
| `DELETE
| `PUT
| `PATCH

]

Sourceval string_of_meth : [< meth ] -> string

Sourceval meth_of_string : string -> [> meth ] option

Sourceval meth_encoding : meth Data_encoding.t

Sourcemodule MethMap = Resto.MethMap

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

Sourcetype error = Tezos_error_monad.Error_monad.error list

Source

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

Source

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

include module type of struct include Resto.MakeService(Tezos_rpc__.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

Source

val meth : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw ->
  'meth

Source

val query : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw ->
  'query Resto.Query.t

Sourcetype _ input = _ Resto.MakeService(Tezos_rpc__.RPC_encoding).input =

| No_input : unit input
| Input : 'input Data_encoding.t -> 'input input

Source

val input_encoding : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw ->
  'input input

Source

val output_encoding : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw ->
  'output Data_encoding.t

post_service, delete_service, put_service, and patch_service are similar to get_service but for the other HTTP methods.

Note that some of these functions take an additional input argument. This is only for the services with methods that expect additional parameters. It is used internally to encode/decode additional parameters passed in a dedicated payload rather than in the path/query parameters.

Source

val prefix : 
  ('prefix, 'inner_prefix) Resto.Path.t ->
  ('meth, 'inner_prefix, 'params, 'query, 'input, 'output, 'error) raw ->
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw

Source

val subst0 : 
  ([< Resto.meth ] as 'm, 'p, 'p, 'q, 'i, 'o, 'e) raw ->
  ('m, 'p2, 'p2, 'q, 'i, 'o, 'e) raw

Source

val subst1 : 
  ([< Resto.meth ] as 'm, 'p, 'p * 'a, 'q, 'i, 'o, 'e) raw ->
  ('m, 'p2, 'p2 * 'a, 'q, 'i, 'o, 'e) raw

Source

val subst2 : 
  ([< Resto.meth ] as 'm, 'p, ('p * 'a) * 'b, 'q, 'i, 'o, 'e) raw ->
  ('m, 'p2, ('p2 * 'a) * 'b, 'q, 'i, 'o, 'e) raw

Source

val subst3 : 
  ([< Resto.meth ] as 'm, 'p, (('p * 'a) * 'b) * 'c, 'q, 'i, 'o, 'e) raw ->
  ('m, 'p2, (('p2 * 'a) * 'b) * 'c, 'q, 'i, 'o, 'e) raw

Source

type ('prefix, 'params, 'error) description_service =
  ([ `GET ],
    'prefix,
    'params * string list,
    Resto.Description.request,
    unit,
    (Data_encoding.json_schema * Data_encoding.Binary_schema.t)
      Resto.Description.directory,
    'error)
    raw

Source

type 'input request =
  'input Resto.MakeService(Tezos_rpc__.RPC_encoding).request =
  {

meth : Resto.meth;
uri : Uri.t;
input : 'input input;

}

Source

val forge_request : 
  ('meth, unit, 'params, 'query, 'input, 'output, 'error) raw ->
  ?base:Uri.t ->
  'params ->
  'query ->
  'input request

Source

val forge_partial_request : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw ->
  ?base:Uri.t ->
  'params ->
  'query ->
  'input request

Sourcemodule Internal = Resto.MakeService(Tezos_rpc__.RPC_encoding).Internal

Source

val get_service : 
  ?description:string ->
  query:'query Resto.Query.t ->
  output:'output Data_encoding.t ->
  ('prefix, 'params) Resto.Path.t ->
  ([ `GET ], 'prefix, 'params, 'query, unit, 'output) service

Source

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

Source

val delete_service : 
  ?description:string ->
  query:'query Resto.Query.t ->
  output:'output Data_encoding.t ->
  ('prefix, 'params) Resto.Path.t ->
  ([ `DELETE ], 'prefix, 'params, 'query, unit, 'output) service

Source

val patch_service : 
  ?description:string ->
  query:'query Resto.Query.t ->
  input:'input Data_encoding.t ->
  output:'output Data_encoding.t ->
  ('prefix, 'params) Resto.Path.t ->
  ([ `PATCH ], 'prefix, 'params, 'query, 'input, 'output) service

Source

val put_service : 
  ?description:string ->
  query:'query Resto.Query.t ->
  input:'input Data_encoding.t ->
  output:'output Data_encoding.t ->
  ('prefix, 'params) Resto.Path.t ->
  ([ `PUT ], 'prefix, 'params, 'query, 'input, 'output) service

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-libs.rpc/Tezos_rpc/Service/index.html

Module `Tezos_rpc.Service`Source

package octez-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-libs.rpc/Tezos_rpc/Service/index.html

Module Tezos_rpc.ServiceSource

Module `Tezos_rpc.Service`Source