Module Mavbox.Mavryk_executable

This module wraps the type 'kind t around the notion of mavkit-executable: a path to a binary with mavkit-specific properties.

module Make_cli : sig ... end

Helper functions to construct exec-style command lines for "mavkit-*" applications.

module Unix_files_sink : sig ... end

Manipulate the "MAVRYK_EVENTS_CONFIG" environment variable.

type kind = [
  1. | `Node
  2. | `Baker
  3. | `Endorser
  4. | `Accuser
  5. | `Client
  6. | `Admin
  7. | `Smart_rollup_node
  8. | `Smart_rollup_installer
  9. | `Evm_node
]

The type kind is used to distinguish 'a t executables.

type t = private {
  1. kind : kind;
  2. binary : string option;
  3. unix_files_sink : Unix_files_sink.t option;
  4. environment : (string * string) list;
}

The wrapper of the mavkit-executable.

val make : ?binary:string -> ?unix_files_sink:Unix_files_sink.t -> ?environment:(string * string) list -> kind -> t

Create a "mavkit-node" executable.

val get : ?protocol_kind:Mavryk_protocol.Protocol_kind.t -> t -> string

The path to the executable.

val call : < env_config : Environment_configuration.t.. > -> t -> ?protocol_kind:Mavryk_protocol.Protocol_kind.t -> path:string -> string list -> unit Genspio.EDSL.t

Build a Genspio.EDSL.t script to run a mavryk command, the ~path argument is used as a toplevel path for the unix-files event-sink (event-logging-framework) and for other local logging files.

val cli_term : ?extra_doc:string -> ?prefix:string -> < manpager : Internal_pervasives.Manpage_builder.State.t.. > -> kind -> t Cmdliner.Term.t

Build a Cmdliner term which creates executables, the second argument is a prefix of option names (e.g. "mavryk" for the option "--mavryk-accuser-alpha-binary").

val kind_string : [< kind ] -> string

The name of the executable.