Module `Merkle_list.Make`Source

Parameters

module El : sig ... end

module H : Tezos_protocol_environment_alpha.S.HASH

Signature

Sourcetype t

The type of a Merkle list

Sourcetype h = H.t

The type of a hash

Sourcetype elt = El.t

The type of an element

Sourcetype path

A path, together with an element's position, is the proof of inclusion of an element in the Merkle list.

Sourceval dummy_path : path

A dummy path that can be used as a placeholder when no path is actually required.

Sourceval pp_path : Tezos_protocol_environment_alpha.Format.formatter -> path -> unit

Sourceval nil : t

The empty Merkle list

Sourceval empty : h

The empty hash

Sourceval root : t -> h

root t returns the root hash of a Merkle list.

Sourceval snoc : t -> elt -> t

snoc t el adds element el to a Merkle list t and returns the new list.

Sourceval snoc_tr : t -> elt -> t

Tail recursive variant of snoc.

Sourceval compute : elt list -> h

compute elems returns the root hash of the Merkle list constructed with elems.

Sourceval path_encoding : path Tezos_protocol_environment_alpha.Data_encoding.t

Encoding of a path.

Source

val bounded_path_encoding : 
  ?max_length:int ->
  unit ->
  path Tezos_protocol_environment_alpha.Data_encoding.t

Encoding of a path, with optional bound max_length.

Source

val compute_path : 
  t ->
  int ->
  path Tezos_protocol_environment_alpha.Error_monad.tzresult

compute_path t pos computes the path of the element in position pos.

Can fail with Merkle_list_invalid_position if pos is negative or if it is greater than the number of elements in the list.

Source

val check_path : 
  path ->
  int ->
  elt ->
  h ->
  bool Tezos_protocol_environment_alpha.Error_monad.tzresult

check_path path pos elt expected_root checks that an elt with path path at position pos has the expected_root.

Can fail with Merkle_list_invalid_position if pos is negative or if it is greater than the number of elements in the list.

Sourceval path_depth : path -> int

path_depth path returns the depth of the tree path is related to.

Sourceval elt_bytes : elt -> Tezos_protocol_environment_alpha.Bytes.t

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Merkle_list/Make/index.html

Module `Merkle_list.Make`Source

Parameters

Signature

package tezos-protocol-alpha

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Merkle_list/Make/index.html

Module Merkle_list.MakeSource

Parameters

Signature

Module `Merkle_list.Make`Source