package tezos-protocol-018-Proxford
Game_timeout stores the block level at which the staker whose turn it is to move will (become vulnerable to) timeout. The staker pair should always be in lexical order to ensure that this value is not duplicated.
type t = Raw_context.t * Sc_rollup_repr.ttype context = ttype key = Sc_rollup_game_repr.Index.tAn abstract type for keys
type value = Sc_rollup_game_repr.timeoutThe type of values
val mem :
context ->
key ->
(Raw_context.t * bool)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tTells if a given key is already bound to a storage bucket. Consumes Gas_repr.read_bytes_cost Z.zero.
val get :
context ->
key ->
(Raw_context.t * value)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tRetrieve a value from the storage bucket at a given key ; returns Storage_errorMissing_key if the key is not set ; returns Storage_errorCorrupted_data if the deserialisation fails. Consumes Gas_repr.read_bytes_cost <size of the value>.
val find :
context ->
key ->
(Raw_context.t * value option)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tRetrieve a value from the storage bucket at a given key ; returns None if the value is not set ; returns Storage_error
Corrupted_data if the deserialisation fails. Consumes Gas_repr.read_bytes_cost <size of the value> if present or Gas_repr.read_bytes_cost Z.zero.
val update :
context ->
key ->
value ->
(Raw_context.t * int)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tUpdates the content of a bucket ; returns A Storage_Error
Missing_key if the value does not exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the new value>. Returns the difference from the old to the new size.
val init :
context ->
key ->
value ->
(Raw_context.t * int)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tAllocates a storage bucket at the given key and initializes it ; returns a Storage_errorExisting_key if the bucket exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the value>. Returns the size.
val add :
context ->
key ->
value ->
(Raw_context.t * int * bool)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tAllocates a storage bucket at the given key and initializes it with a value ; just updates it if the bucket exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the new value>. Returns the difference from the old (maybe 0) to the new size, and a boolean indicating if a value was already associated to this key.
val add_or_remove :
context ->
key ->
value option ->
(Raw_context.t * int * bool)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tWhen the value is Some v, allocates the data and initializes it with v ; just updates it if the bucket exists. When the value is None, delete the storage bucket when the value ; does nothing if the bucket does not exists. Consumes serialization cost. Consumes the same gas cost as either remove or init_set. Returns the difference from the old (maybe 0) to the new size, and a boolean indicating if a value was already associated to this key.
val remove_existing :
context ->
key ->
(Raw_context.t * int)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tDelete a storage bucket and its contents ; returns a Storage_errorMissing_key if the bucket does not exists. Consumes Gas_repr.write_bytes_cost Z.zero. Returns the freed size.
val remove :
context ->
key ->
(Raw_context.t * int * bool)
Tezos_protocol_environment_018_Proxford.Error_monad.tzresult
Tezos_protocol_environment_018_Proxford.Lwt.tRemoves a storage bucket and its contents ; does nothing if the bucket does not exists. Consumes Gas_repr.write_bytes_cost Z.zero. Returns the freed size, and a boolean indicating if a value was already associated to this key.
val keys_unaccounted :
context ->
key list Tezos_protocol_environment_018_Proxford.Lwt.tReturns the list of all storage bucket keys. Not carbonated (i.e. gas is not consumed); use with care.