package octez-smart-rollup-node-lib

  1. Overview
  2. Docs
package octez-smart-rollup-node-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module is a helper to register your endpoints and build a resulting subdirectory eventually.

Parameters

module S : PARAM

Signature

val register0 : ([< Resto.meth ], 'prefix, 'prefix, 'query, 'input, 'output) Tezos_rpc.Service.t -> (S.subcontext -> 'query -> 'input -> 'output Tezos_base.TzPervasives.tzresult Lwt.t) -> unit

Register an endpoint with no parameters in the path.

val register1 : ([< Resto.meth ], 'prefix, 'prefix * 'param1, 'query, 'input, 'output) Tezos_rpc.Service.t -> (S.subcontext -> 'param1 -> 'query -> 'input -> 'output Tezos_base.TzPervasives.tzresult Lwt.t) -> unit

Register an endpoint with a single parameter in the path.

val gen_register0 : ([< Resto.meth ], 'prefix, 'prefix, 'query, 'input, 'output) Tezos_rpc.Service.t -> (S.subcontext -> 'query -> 'input -> 'output Tezos_rpc.Answer.t Lwt.t) -> unit

Register an endpoint that specifies how to process incoming queries and inputs; this function is intended for handling asynchronous contexts.

val build_sub_directory : S.context -> S.prefix Tezos_rpc.Directory.t

Build sub-directory with registered endpoints with respect to Node_context.

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