package tezos-protocol-alpha

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

This module defines identifiers for transaction only rollup (or tx rollup). It also specifies how to compute originated tx rollup's hash from origination nonce.

module Hash : sig ... end

A specialized Blake2B implementation for hashing tx_rollup identifiers with "tru1" as a base58 prefix

type t = private Hash.t
type tx_rollup = t
val (=) : t -> t -> bool
val (<>) : t -> t -> bool
val (<) : t -> t -> bool
val (<=) : t -> t -> bool
val (>=) : t -> t -> bool
val (>) : t -> t -> bool
val compare : t -> t -> int
val equal : t -> t -> bool
val max : t -> t -> t
val min : t -> t -> t
val to_b58check : t -> string
val of_b58check : string -> (t, Tezos_protocol_environment_alpha__Environment.Error_monad.error Tezos_protocol_environment_alpha__Environment.Error_monad.trace) Stdlib.result
val pp : Stdlib.Format.formatter -> t -> unit
val encoding : t Data_encoding.t
val originated_tx_rollup : Origination_nonce.t -> t

originated_tx_rollup nonce is the tx_rollup address originated from nonce. See Origination_nonce.t for more information.

val rpc_arg : t Tezos_protocol_environment_alpha__Environment.RPC_arg.t
module Index : Storage_description.INDEX with type t = t
type state

state is an empty type but will be changed in a future MR to represent the state of a tx_rollup.

val state_encoding : state Data_encoding.t
val empty_state : state

empty_state is the initial value at the origination of a tx_rollup. It contains no inboxes.

val pp_state : Stdlib.Format.formatter -> state -> unit
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