package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

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

Module Tezos_rpc.ServiceSource

Sourcetype meth = [
  1. | `GET
  2. | `POST
  3. | `DELETE
  4. | `PUT
  5. | `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
Sourcetype (+'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 (+'meth, 'prefix, 'params, 'query, 'input, 'output) t = ('meth, 'prefix, 'params, 'query, 'input, 'output, error) raw constraint 'meth = [< meth ]
Sourcetype (+'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
Sourceval meth : ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw -> 'meth
Sourceval query : ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw -> 'query Resto.Query.t
Sourcetype _ input = _ Resto.MakeService(Tezos_rpc__.RPC_encoding).input =
  1. | No_input : unit input
  2. | Input : 'input Data_encoding.t -> 'input input
Sourceval input_encoding : ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw -> 'input input
Sourceval 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.

Sourceval prefix : ('prefix, 'inner_prefix) Resto.Path.t -> ('meth, 'inner_prefix, 'params, 'query, 'input, 'output, 'error) raw -> ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw
Sourceval subst0 : ([< Resto.meth ] as 'm, 'p, 'p, 'q, 'i, 'o, 'e) raw -> ('m, 'p2, 'p2, 'q, 'i, 'o, 'e) raw
Sourceval subst1 : ([< Resto.meth ] as 'm, 'p, 'p * 'a, 'q, 'i, 'o, 'e) raw -> ('m, 'p2, 'p2 * 'a, 'q, 'i, 'o, 'e) raw
Sourceval subst2 : ([< Resto.meth ] as 'm, 'p, ('p * 'a) * 'b, 'q, 'i, 'o, 'e) raw -> ('m, 'p2, ('p2 * 'a) * 'b, 'q, 'i, 'o, 'e) raw
Sourceval 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
Sourcetype ('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
Sourcetype 'input request = 'input Resto.MakeService(Tezos_rpc__.RPC_encoding).request = {
  1. meth : Resto.meth;
  2. uri : Uri.t;
  3. input : 'input input;
}
Sourceval forge_request : ('meth, unit, 'params, 'query, 'input, 'output, 'error) raw -> ?base:Uri.t -> 'params -> 'query -> 'input request
Sourceval forge_partial_request : ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) raw -> ?base:Uri.t -> 'params -> 'query -> 'input request
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval 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