package octez-shell-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez shell libraries

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

octez-19.0.tar.gz

sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4

sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-shell-libs.shell-services/Tezos_shell_services/History_mode/index.html

Module `Tezos_shell_services.History_mode`Source

History modes for the chain history storage

History modes allow a node to require less disk storage. Indeed, depending on the chosen history mode, some parts of the complete chain history can be deleted as they are not required anymore. Three history modes are provided:

Full mode (default mode): The node stores the minimal data since the genesis required to reconstruct (or 'replay') the complete chain's ledger state.

Rolling mode: This is the lightest mode as it only maintains a minimal rolling fragment of the chain data so the node can still validate new blocks and synchronize with the head.

Archive: This is the heaviest mode as it keeps the whole chain data to be able to query any information stored on the chain since the genesis. It is particularly suitable for indexers or block explorers.

Sourcetype additional_cycles = {

offset : int;

}

The type for defining the number of additional cycles to preserve.

Sourcetype t =

| Archive
| Full of additional_cycles option
| Rolling of additional_cycles option

The type for defining an history mode.

Sourceval default_additional_cycles : additional_cycles

The default value for the number of additional cycles to preserve.

Sourceval default_full : t

The default full history mode value. Based on default_additional_cycles.

Sourceval default_rolling : t

The default rolling history mode value. Based on default_additional_cycles.

Sourceval default : t

The default history mode value.

Sourceval encoding : t Tezos_base.TzPervasives.Data_encoding.t

Sourceval equal : t -> t -> bool

Returns true if the modes and the number of additional cycles are equal.

Sourceval mode_equality : t -> t -> bool

Returns true if the modes are equal. The number of additional cycles are not checked.

Sourceval pp : Format.formatter -> t -> unit

Sourceval pp_short : Format.formatter -> t -> unit

Sourceval tag : t Tezos_base.TzPervasives.Tag.def

Sourcemodule Legacy : sig ... end

The module for handling legacy history modes. It is only used for legacy support, see Tezos_store.Legacy and Tezos_store.Snapshots.

Sourceval convert : Legacy.t -> t

convert legacy returns the history mode of a given legacy history mode, using the default offset values.