Snapshots (octez-evm-node-libs.Evm_node_lib

type compression =

| No
(*
Produce uncompressed archive. Takes more space.
*)
| On_the_fly
(*
Compress archive on the fly. The rollup node will use less disk space to produce the snapshot but will lock the rollup node (if running) for a longer time.
*)
| After
(*
Compress archive after snapshot creation. Uses more disk space temporarily than On_the_fly but does not lock the rollup node for very long.
*)

Compression strategy for snapshot archives.

module Header : sig ... end

val export : 
  ?snapshot_file:string ->
  compression:compression ->
  data_dir:string ->
  unit ->
  string Tezos_base.TzPervasives.tzresult Lwt.t

export ?snapshot_file ~compression ~data_dir () creates a tar gzipped archive with name snapshot_file (or a generated name in the current directory) containing a snapshot of the data of the rollup node with data directory data_dir. The path of the snapshot archive is returned.

val import_from : 
  force:bool ->
  ?history_mode:Evm_node_config.Configuration.history_mode ->
  data_dir:string ->
  snapshot_file:string ->
  unit ->
  Evm_node_config.Configuration.history_mode option
    Tezos_base.TzPervasives.tzresult
    Lwt.t

import_from ~force ~data_dir ~snapshot_file imports the snapshot from file snapshot_file (but also takes care of downloading the file if snapshot_file is an url) at path snapshot_file into the data directory data_dir. Import will fail if data_dir is already populated unless force is set to true.

val info : 
  snapshot_file:string ->
  (Header.t * [ `Compressed | `Uncompressed ]) Tezos_base.TzPervasives.tzresult
    Lwt.t

info ~snapshot_file returns information that can be used to inspect the snapshot file.

val interpolate_snapshot_provider : 
  ?rollup_address:Octez_smart_rollup.Address.t ->
  ?network:Evm_node_config.Configuration.supported_network ->
  Evm_node_config.Configuration.history_mode ->
  string ->
  string Tezos_base.TzPervasives.tzresult