package tezos-protocol-013-PtJakart

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

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.

init 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.

find 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.

get 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.

update ctxt tx_rollup new_state replaces the stored state of tx_rollup with new_state.

assert_exist ctxt tx_rollup fails with Tx_rollup_does_not_exist when tx_rollup is not a valid transaction rollup address.

OCaml

Innovation. Community. Security.