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 defines functions that emit the events used when the smart rollup node is running (see Daemon).

val starting_node : unit -> unit Lwt.t
val node_is_ready : rpc_addr:string -> rpc_port:int -> unit Lwt.t
val rollup_exists : addr:Octez_smart_rollup.Address.t -> kind:Octez_smart_rollup.Kind.t -> unit Lwt.t

rollup_exists addr kind emits the event that the smart rollup node is interacting with the rollup at address addr and of the given kind.

val shutdown_node : int -> unit Lwt.t

shutdown_node exit_status emits the event that the smart rollup node is stopping with exit status exit_status.

val starting_metrics_server : host:string -> port:int -> unit Lwt.t

starting_metrics_server ~metrics_addr ~metrics_port emits the event that the metrics server for the rollup node is starting.

val metrics_ended : string -> unit Lwt.t

metrics_ended error emits the event that the metrics server has ended with a failure.

val metrics_ended_dont_wait : string -> unit

metrics_ended error emits the event that the metrics server has ended with a failure. (Doesn't wait for event to be emited.

val kernel_debug : string -> unit Lwt.t

kernel_debug str emits the event that the kernel has logged str.

val simulation_kernel_debug : string -> unit Lwt.t

simulation_kernel_debug str emits the event that the kernel has logged str during a simulation.

val kernel_debug_dont_wait : string -> unit

kernel_debug str emits the event that the kernel has logged str. (Doesn't wait for event to be emitted)

val warn_dal_enabled_no_node : unit -> unit Lwt.t

warn_dal_enabled_no_node () emits a warning for when DAL is enabled in the protocol but the rollup node has no DAL node.

val waiting_first_block : Tezos_base.TzPervasives.Protocol_hash.t -> unit Lwt.t

Emit event that the node is waiting for the first block of its protocol.

Emit event that the node received the first block of its protocol.

val detected_protocol_migration : unit -> unit Lwt.t

Emit event that the node will shutdown because of protocol migration.

val acquiring_lock : unit -> unit Lwt.t

acquiring_lock () emits an event to indicate that the node is attempting to acquire a lock on the data directory.

val calling_gc : gc_level:int32 -> head_level:int32 -> unit Lwt.t

calling_gc ~gc_level ~head_level emits the event that the GC is started for level gc_level.

val starting_context_gc : Octez_smart_rollup.Smart_rollup_context_hash.t -> unit Lwt.t

starting_context_gc hash emits an event which indicates that a GC run was launched for hash.

val context_gc_already_launched : unit -> unit Lwt.t

context_gc_already_launched () emits an event which indicates that a GC launch was attempted but resulted in no action because a GC run is already in progress.

val ending_context_gc : (Ptime.span * Ptime.span) -> unit Lwt.t

ending_context_gc total_duration finalise_duration emits an event which indicates that a GC run has ended, providing its total duration and its finalisation duration.

val context_gc_failure : string -> unit Lwt.t

context_gc_failure err emits an event which indicates a GC failure.

val context_gc_launch_failure : string -> unit Lwt.t

context_gc_launch_failure err emits an event which indicates a GC launch error.

val gc_levels_storage_failure : unit -> unit Lwt.t

gc_levels_storage_failure () emits an event which indicates that GC level values (last_gc_level, first_available_level) could not be written to storage.

val convert_history_mode : Configuration.history_mode -> Configuration.history_mode -> unit Lwt.t

convert_history_mode old_history_mode new_history_mode emits an event for when the history mode of the rollup node is changed.

val gc_finished : gc_level:int32 -> head_level:int32 -> unit Lwt.t

gc_finished ~gc_level ~head_level emits the event that the GC is finished for level gc_level.

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