package tezos-protocol-017-PtNairob

  1. Overview
  2. Docs
package tezos-protocol-017-PtNairob
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

The type of a reveal hash.

type supported_hashes =
  1. | Blake2B

The hashing schemes supported by the reveal hash.

A Map module for storing reveal-hash-indexed values.

val size : scheme:supported_hashes -> int

size ~scheme returns the size of reveal hashes using the scheme specified in input.

val zero : scheme:supported_hashes -> t

zero ~scheme returns the reveal hash corresponding to the zero hash for the scheme specified in input.

Formatting function for reveal-hashes.

val equal : t -> t -> bool

equal hash1 hash2 checks if the two reveal-hashes hash1 and hash2 are equal. This function must preserve the equality of individual supported hashing schemes. If hash1 and hash2 are hashes obtained from the same supported hashing scheme, then the equal function from that hashing scheme is used to determine whether they are equivalent. Otherwise, they are different.

val compare : t -> t -> int

compare hash1 hash2 compares the values of the reveal hashes hash1 and hash2. This function must preserve the ordering of individual supported hashing scheme. If hash1 and hash2 are reveal-hashes obtained from the same hashing scheme, then compare hash1 hash2 should return the same result of the compare function exposed by the hash module corresponding to their hashing scheme.

The encoding of reveal hashes.

val hash_string : scheme:supported_hashes -> ?key:string -> string list -> t

hash_string ~scheme ?key strings hashes strings using the supported hashing scheme given in input.

val hash_bytes : scheme:supported_hashes -> ?key:bytes -> bytes list -> t

hash_bytes ~scheme ?key strings hashes bytes using the supported hashing scheme given in input.

val scheme_of_hash : t -> supported_hashes

scheme_of_hash hash returns the supported hashing scheme that was used to obtain hash.

val of_hex : string -> t option
val to_hex : t -> string
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct