1. Overview
  2. Docs
package tezos-tx-rollup-013-PtJakart
Legend:
Library
Module
Module type
Parameter
Class
Class type
type mode =
  1. | Observer
    (*

    Only follows the chain and reconstructs L2 blocks

    *)
  2. | Accuser
    (*

    Follows the chain and rejects bad commitments

    *)
  3. | Batcher
    (*

    Accept transactions in its queue and batches them on the L1

    *)
  4. | Maintenance
    (*

    Follows the chain and injects commitments (and rejects bad ones)

    *)
  5. | Operator
    (*

    Equivalent to maintenance + batcher

    *)
  6. | Custom
    (*

    This mode allows to tweak which operations are injected by selecting the signers

    *)

Mode for the rollup node

type 'a purposed = {
  1. operator : 'a;
  2. submit_batch : 'a;
  3. finalize_commitment : 'a;
  4. remove_commitment : 'a;
  5. rejection : 'a;
  6. dispatch_withdrawals : 'a;
}
type caps = cost_caps purposed
type t = {
  1. data_dir : string;
  2. rollup_id : Tezos_protocol_013_PtJakart.Protocol.Alpha_context.Tx_rollup.t;
  3. origination_level : int32 option;
  4. rpc_addr : Tezos_base.P2p_point.Id.t;
  5. cors_origins : string list;
  6. cors_headers : string list;
  7. reconnection_delay : float;
  8. mode : mode;
  9. signers : signers;
  10. allow_deposit : bool;
  11. l2_blocks_cache_size : int;
  12. caps : caps;
  13. batch_burn_limit : Tezos_protocol_013_PtJakart.Protocol.Alpha_context.Tez.t option;
}

default_data_dir is the default value for data_dir.

val default_rpc_addr : Tezos_base.P2p_point.Id.t

default_rpc_addr is the default value for rpc_addr.

val default_reconnection_delay : float

default_reconnection_delay is the default value for reconnection-delay

val default_l2_blocks_cache_size : int

default_l2_blocks_cache_size is the default number of L2 blocks that are cached by the rollup node

val default_cost_caps : cost_caps

The default fees/burn caps

val default_caps : caps

The default fees/burn caps for operations of the injector

val modes : mode list
val string_of_mode : mode -> string
val mode_of_string : string -> mode Tezos_base.TzPervasives.tzresult

check_mode config ensures the signers correspond to the chosen mode and removes the extra ones.

val save : force:bool -> t -> string Tezos_base.TzPervasives.tzresult Lwt.t

save ~force configuration writes the configuration file and returns the filename. If force is true then configuration is overwritten when it exists.

val load : data_dir:string -> t Tezos_base.TzPervasives.tzresult Lwt.t

load ~data_dir loads a configuration stored in data_dir.

encoding encodes a configuration.