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_commitment_storage/index.html
Module Tezos_raw_protocol_alpha.Tx_rollup_commitment_storageSource
This module introduces various functions to manipulate the storage related to commitments for transaction rollups.
val check_message_result :
Raw_context.t ->
Tx_rollup_commitment_repr.Compact.t ->
[ `Hash of Tx_rollup_message_result_hash_repr.t
| `Result of Tx_rollup_message_result_repr.t ] ->
path:Tx_rollup_commitment_repr.Merkle.path ->
index:int ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresultval add_commitment :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
Tx_rollup_commitment_repr.Full.t ->
(Raw_context.t
* Tx_rollup_state_repr.t
* Tezos_protocol_environment_alpha.Signature.public_key_hash option)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tadd_commitment context tx_rollup contract commitment adds a commitment to a rollup. It returns the new context, the new state, and the committer of the previous commitment stored for this level if any.
In case this committer exists, then it means its bond needs to be slashed.
This function returns the errors
Level_already_has_commitmentiff there is already a valid commitment (i.e., not orphan) at this level.Invalid_committeriff an orphan commitment from the same committer already is in the storage.Missing_commitment_predecessoriff the predecessor does not match the already-stored predecessor commitment.Wrong_commitment_predecessor_leveliff there is no predecessor level, but a predecessor commitment is provided (or no predecessor commitment is provided but there is a precessor level)Wrong_batch_countiff the number of batches does not equal the length of the inbox.
val remove_bond :
Raw_context.t ->
Tx_rollup_repr.t ->
Tezos_protocol_environment_alpha.Signature.public_key_hash ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tremove_bond context state tx_rollup contract removes the bond for an implicit contract. This will fail if either the bond does not exist, or if the bond is currently in use.
val slash_bond :
Raw_context.t ->
Tx_rollup_repr.t ->
Tezos_protocol_environment_alpha.Signature.public_key_hash ->
(Raw_context.t * bool) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tslash_bond ctxt tx_rollup contract removes the bond counter for an implicit contract if it exists. Besides, it returns a boolean to determine if this counter was strictly superior to 0.
val find :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Tx_rollup_level_repr.t ->
(Raw_context.t * Tx_rollup_commitment_repr.Submitted_commitment.t option)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tfind context tx_rollup state level returns the commitment for a level, if any exists and is not orphan (that is, one of its ancestors has been rejected). If the rollup does not exist, the error Tx_rollup_does_not_exist is returned.
val get :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Tx_rollup_level_repr.t ->
(Raw_context.t * Tx_rollup_commitment_repr.Submitted_commitment.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tget context tx_rollup state level returns the commitment for a level, if any exists. If the rollup does not exist, the error Tx_rollup_does_not_exist is returned. If there is no commitment in the storage, or if a commitment exists but it is orphan (that is, one of its ancestors has been rejected), then Commitment_does_not_exist is returned.
val get_finalized :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Tx_rollup_level_repr.t ->
(Raw_context.t * Tx_rollup_commitment_repr.Submitted_commitment.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tget_finalized context tx_rollup level returns the commitment for a level, if any exists and is finalized. If the rollup does not exist, the error Tx_rollup_does_not_exist is returned. If the commitment is not finalized the error Tx_rollup_commitment_not_final is returned
val pending_bonded_commitments :
Raw_context.t ->
Tx_rollup_repr.t ->
Tezos_protocol_environment_alpha.Signature.public_key_hash ->
(Raw_context.t * int) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tpending_bonded_commitments ctxt tx_rollup contract returns the number of commitments that contract has made that are still in the storage.
val has_bond :
Raw_context.t ->
Tx_rollup_repr.t ->
Tezos_protocol_environment_alpha.Signature.public_key_hash ->
(Raw_context.t * bool) Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.thas_bond ctxt tx_rollup contract returns true if we have already collected a bond for contract for commitments on tx_rollup.
val finalize_commitment :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
(Raw_context.t * Tx_rollup_state_repr.t * Tx_rollup_level_repr.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tfinalize_commitment ctxt tx_rollup state marks the commitment of the oldest inbox as final, if the commitment exists and if it is old enough. Otherwise, this function returns the error No_commitment_to_finalize.
The number of pending_bonded_commitments is not updated, it is decremented when the commitment is removed (see remove_commitment). It is done to force the rollup operators to clean up the commitment storage.
The state of the rollup is adjusted accordingly, and the finalized level is returned. Besides, the inbox at said level is removed from the context. This function returns the new context, and the new state.
val remove_commitment :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
(Raw_context.t * Tx_rollup_state_repr.t * Tx_rollup_level_repr.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tremove_commitment ctxt tx_rollup state tries to remove the oldest finalized commitment from the layer-1 storage, if it exists, and if it is old enough. Otherwise, this functions returns the error No_commitment_to_remove.
The state of the rollup is adjusted accordingly.
val reject_commitment :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Tx_rollup_level_repr.t ->
(Raw_context.t * Tx_rollup_state_repr.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.treject_commitment context tx_rollup state level removes the commitment at level. It should only be called after a successful rejection operation. The state is updated to reflect the rejection, and returned.
val check_agreed_and_disputed_results :
Raw_context.t ->
Tx_rollup_repr.t ->
Tx_rollup_state_repr.t ->
Tx_rollup_commitment_repr.Submitted_commitment.t ->
agreed_result:Tx_rollup_message_result_repr.t ->
agreed_result_path:Tx_rollup_commitment_repr.Merkle.path ->
disputed_result:Tx_rollup_message_result_hash_repr.t ->
disputed_position:int ->
disputed_result_path:Tx_rollup_commitment_repr.Merkle.path ->
Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.t