package tezos-protocol-012-Psithaca
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ad9e08819871c75ba6f4530b125f7d157799398e4d77a1e6bfea9d91ff37ff55
sha512=c5dc4d40cc09bc6980fbbdb5c2e105bf4252cf9cfcb2b49660b0ebe4dc789f6709ec3b3bf2f87d81580d3eed9521eeb1c960f24d9b14eb0285aaba1f84d10a9b
doc/tezos-protocol-012-Psithaca.raw/Tezos_raw_protocol_012_Psithaca/Storage/Contract/Balance/index.html
Module Contract.BalanceSource
The tez possessed by a contract and that can be used. A contract may also possess tez in frozen deposits. Empty balances (of zero tez) are only allowed for originated contracts, not for implicit ones.
include Storage_sigs.Non_iterable_indexed_data_storage
with type key = Contract_repr.t
with type value = Tez_repr.t
with type t := Raw_context.t
An abstract type for keys
The type of values
Tells if a given key is already bound to a storage bucket
val get :
context ->
key ->
value Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
Tezos_protocol_environment_012_Psithaca.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.
val find :
context ->
key ->
value option Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
Tezos_protocol_environment_012_Psithaca.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.
val update :
context ->
key ->
value ->
Raw_context.t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
Tezos_protocol_environment_012_Psithaca.Lwt.tUpdates the content of a bucket ; returns A Storage_Error
Missing_key if the value does not exists.
val init :
context ->
key ->
value ->
Raw_context.t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
Tezos_protocol_environment_012_Psithaca.Lwt.tAllocates a storage bucket at the given key and initializes it ; returns a Storage_errorExisting_key if the bucket exists.
val add :
context ->
key ->
value ->
Raw_context.t Tezos_protocol_environment_012_Psithaca.Lwt.tAllocates a storage bucket at the given key and initializes it with a value ; just updates it if the bucket exists.
val add_or_remove :
context ->
key ->
value option ->
Raw_context.t Tezos_protocol_environment_012_Psithaca.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.
val remove_existing :
context ->
key ->
Raw_context.t Tezos_protocol_environment_012_Psithaca.Error_monad.tzresult
Tezos_protocol_environment_012_Psithaca.Lwt.tDelete a storage bucket and its contents ; returns a Storage_errorMissing_key if the bucket does not exists.
Removes a storage bucket and its contents ; does nothing if the bucket does not exists.
Empties all the keys and associated data.
Lists all the keys.
Lists all the keys and associated data.
val fold :
context ->
order:[ `Sorted | `Undefined ] ->
init:'a ->
f:(key -> value -> 'a -> 'a Tezos_protocol_environment_012_Psithaca.Lwt.t) ->
'a Tezos_protocol_environment_012_Psithaca.Lwt.tIterates over all the keys and associated data.
val fold_keys :
context ->
order:[ `Sorted | `Undefined ] ->
init:'a ->
f:(key -> 'a -> 'a Tezos_protocol_environment_012_Psithaca.Lwt.t) ->
'a Tezos_protocol_environment_012_Psithaca.Lwt.tIterate over all the keys.