package tezos-protocol-alpha
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f
doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Tx_rollup_state_storage/index.html
Module Tezos_raw_protocol_alpha.Tx_rollup_state_storageSource
A collection of functions to manipulate the state of a transaction rollup.
Except if the contrary is explicitly stated, the functions of this module are carbonated.
val init :
Raw_context.t ->
Tx_rollup_repr.t ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tinit ctxt tx_rollup initializes the state of tx_rollup.
Returns the error Tx_rollup_already_exists iff this function has already been called for tx_rollup, which is definitely something that should not happen, because the protocol is expected to pick fresh addresses when it originates new transaction rollups (and does so by relying on the “origination nonce” derived from the hash of the operation responsible for the origination, using the same procedure as smart contracts).
Raising this error would therefore indicate a bug in the protocol.
val find :
Raw_context.t ->
Tx_rollup_repr.t ->
(Raw_context.t * Tx_rollup_state_repr.t option)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tfind ctxt tx_rollup returns the current state of tx_rollup. If tx_rollup is not the address of an existing transaction rollup, None is returned instead.
val get :
Raw_context.t ->
Tx_rollup_repr.t ->
(Raw_context.t * Tx_rollup_state_repr.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tget ctxt tx_rollup returns the current state of tx_rollup in the context.
Returns the Tx_rollup_does_not_exist error iff tx_rollup is not the address of an existing transaction rollup.
val update :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tupdate ctxt tx_rollup new_state replaces the stored state of tx_rollup with new_state.
val assert_exist :
Raw_context.t ->
Tx_rollup_repr.t ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tassert_exist ctxt tx_rollup fails with Tx_rollup_does_not_exist when tx_rollup is not a valid transaction rollup address.