package tezos-protocol-alpha

You can search for identifiers within the package.

in-package search v0.2.0

Tezos protocol alpha package

Install

Dune Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

octez-19.1.tar.gz

sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e

sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Cache_repr/index.html

Module `Tezos_raw_protocol_alpha.Cache_repr`Source

Frequently used data should be kept in memory and persisted along a chain of blocks. The caching mechanism allows the economic protocol to declare such data and to rely on a Least Recently Used strategy to keep the cache size under a fixed limit.

Take a look at Environment_cache and Environment_context for additional implementation details about the protocol cache.

The protocol has two main kinds of interaction with the cache:

1. It is responsible for setting up the cache with appropriate parameter values and callbacks. It must also compute cache nonces to give the shell enough information to properly synchronize the in-memory cache with the block contexts and protocol upgrades. A typical place where this happens is Apply. This aspect must be implemented using Cache.Admin.

2. It can exploit the cache to retrieve, to insert, and to update cached values from the in-memory cache. The basic idea is to avoid recomputing values from scratch at each block when they are frequently used. Script_cache is an example of such usage. This aspect must be implemented using Cache.Interface.

Sourcetype size = int

Size for subcaches and values of the cache.

Sourcetype index = int

Index type to index caches.

Sourcetype cache_nonce

Type used to identifies the block that introduced new cache entries

Sourcemodule Admin : sig ... end

The following module acts on the whole cache, not on a specific sub-cache, unlike Interface. It is used to administrate the protocol cache, e.g., to maintain the cache in a consistent state with respect to the chain. This module is typically used by low-level layers of the protocol and by the shell.

Sourcetype namespace = private string

A client uses a unique namespace (represented as a string without '@') to avoid collision with the keys of other clients.

Sourceval create_namespace : string -> namespace

create_namespace str creates a valid namespace from str

raises Invalid_argument
if str contains '@'

Sourcetype identifier = string

A key is fully determined by a namespace and an identifier.

Sourcemodule type CLIENT = sig ... end

To use the cache, a client must implement the CLIENT interface.

Sourcemodule type INTERFACE = sig ... end

An INTERFACE to the subcache where keys live in a given namespace.

Source

val register_exn : 
  (module CLIENT with type cached_value = 'a) ->
  (module INTERFACE
  with type cached_value = 'a)

register_exn client produces an Interface specific to a given client. This function can fail if client does not respect the invariant declared in the documentation of CLIENT.