Module Tezos_dal_node_lib.Cli

module Term : sig ... end

Command-line options

This module declares the main commands of the DAL node. For each command, a set of options is recognized. The function commands can be used to register a function when the user invokes the command.

type experimental_features = unit
type options = {
  1. data_dir : string option;
    (*

    Directory containing files related to the DAL node.

    *)
  2. config_file : string option;
    (*

    Configuration file of the DAL node.

    *)
  3. rpc_addr : Tezos_base.TzPervasives.P2p_point.Id.t option;
    (*

    The endpoint on which the DAL node can be contacted for RPCs.

    *)
  4. expected_pow : float option;
    (*

    The expected proof of work for the P2P identity.

    *)
  5. listen_addr : Tezos_base.TzPervasives.P2p_point.Id.t option;
    (*

    The TCP address and port bound by the DAL node.

    *)
  6. public_addr : Tezos_base.TzPervasives.P2p_point.Id.t option;
    (*

    The endpoint on which the DAL node can be contacted by other DAL nodes.

    *)
  7. endpoint : Uri.t option;
    (*

    The endpoint on which to contact the L1 node.

    *)
  8. slots_backup_uris : Uri.t list;
    (*

    (Optional) URIs to use as backup sources for slot data retrieval, in case the slot is missing locally and reconstruction from shards is not possible. Supported URI schemes include http, https, and file.

    *)
  9. trust_slots_backup_uris : bool;
    (*

    Whether to trust the data downlaoded from the provided slots backup URIs.

    *)
  10. profile : Profile_manager.unresolved_profile option;
    (*

    Profiles of the DAL node used for tracking shards.

    *)
  11. metrics_addr : Tezos_base.TzPervasives.P2p_point.Id.t option;
    (*

    Metrics server endpoint.

    *)
  12. peers : string list;
    (*

    DAL nodes to connect to.

    *)
  13. history_mode : Configuration_file.history_mode option;
  14. service_name : string option;
    (*

    Name of the service provided by this node.

    *)
  15. service_namespace : string option;
    (*

    Namespace for the service.

    *)
  16. experimental_features : experimental_features;
    (*

    Experimental features.

    *)
  17. fetch_trusted_setup : bool option;
    (*

    Should the trusted setup be installed if required and invalid? In case of None at init it is considered as yes.

    *)
  18. disable_shard_validation : bool;
    (*

    Should the crypto shard verification against commitment hashes be bypassed.

    *)
  19. verbose : bool;
    (*

    Emit events related to connections. Default value is false.

    *)
  20. ignore_l1_config_peers : bool;
    (*

    Ignore the boot(strap) peers provided by L1.

    *)
  21. disable_amplification : bool;
    (*

    Disable amplification. Default value is false.

    *)
  22. ignore_topics : Tezos_crypto.Signature.public_key_hash list;
    (*

    Do not distribute shards of these pkhs.

    *)
}
type t =
  1. | Run
  2. | Config_init
  3. | Config_update
  4. | Debug_print_store_schemas

Subcommands that can be used by the DAL node. In the future this type could be generalized if a command recgonizes a different set of options.

val cli_options_to_options : string option -> string option -> Tezos_base.TzPervasives.P2p_point.Id.t option -> float option -> Tezos_base.TzPervasives.P2p_point.Id.t option -> Tezos_base.TzPervasives.P2p_point.Id.t option -> Uri.t option -> Uri.t list -> bool -> Tezos_base.TzPervasives.P2p_point.Id.t option -> Tezos_crypto.Signature.public_key_hash list -> int Tezos_base.TzPervasives.trace -> int Tezos_base.TzPervasives.trace option -> bool -> string Tezos_base.TzPervasives.trace -> Configuration_file.history_mode option -> string option -> string option -> bool option -> bool -> bool -> bool -> bool -> Tezos_crypto.Signature.public_key_hash list -> (options, bool * string) Stdlib.result
val run : t -> options -> unit Tezos_base.TzPervasives.tzresult Lwt.t
val commands : unit Cmdliner.Cmd.t

Subcommands of the DAL node