package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/octez-shell-libs.proxy/Tezos_proxy/Light/index.html
Module Tezos_proxy.LightSource
Code related to the light mode that is protocol-independent. See src/proto_*/lib_client/light.ml files for protocol-dependent code.
type sources_config = private {min_agreement : float;(*A float between 0 (exclusive) and 1 (inclusive), representing the minimum ratio of endpoints that must agree on data for said data to be accepted. 1 means "require all enpoints to agree" (the default).
*)uris : Uri.t list;(*The list of endpoint URIs used for Light mode consensus. This list must contain at least 2 endpoints (one for data retrieval, one for check).
*)
}See mk_sources_config smart constructor to build values.
type sources = private {min_agreement : float;(*A float between 0 (exclusive) and 1 (inclusive), representing the minimum ratio of endpoints that must agree on data for said data to be accepted. 1 means "require all enpoints to agree" (the default).
*)endpoints : (Uri.t * Tezos_rpc.Context.simple) list;(*The list of endpoint URIs used for Light mode consensus. This list must contain at least 2 endpoints (one for data retrieval, one for check).
*)
}See sources_config_to_sources to build values.
An example content of the --sources file
val destruct_sources_config :
Tezos_base.TzPervasives.Data_encoding.json ->
(sources_config, string) resultAd-hoc type safe JSON parsing function until json-data-encoding library provides a result-returning alternative.
sources_config_to_uris sources returns the Uris contained * in sources.
val sources_config_to_sources :
(Uri.t -> Tezos_rpc.Context.simple) ->
sources_config ->
sourcessources_config_to_sources f config transforms the value config (which was obtained by parsing the CLI) into a value used by core algorithms of the light mode.
val hash_of_block :
Tezos_shell_services.Block_services.block ->
Tezos_base.TzPervasives.Block_hash.t optionNone if the given block is symbolic, otherwise its concrete hash.