package tezos-protocol-alpha
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7062cd57addd452852598a2214ade393130efa087b99068d53713bdf912b3680
sha512=08e4091144a03ce3c107fb91a66501bd8b65ca3278917c455a2eaac6df3e108ade63f6ab8340a4bb152d60f404326e464d0ec95d26cafe8e82f870465d24a5fc
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.