package tezos-protocol-alpha
Install
    
    dune-project
 Dependency
Authors
Maintainers
Sources
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
    
    
  sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f
    
    
  doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Storage/Contract/Frozen_deposits/index.html
Module Contract.Frozen_depositsSource
The part of a delegate balance that can't be used. The total balance is frozen_deposits.current_amount + balance. It also stores the initial frozen balance in frozen_deposits.initial_amount. We have current_amount <= initial_amount and current_amount < initial_amount iff the delegate was slashed.
include Storage_sigs.Non_iterable_indexed_data_storage
  with type key = Contract_repr.t
  with type value = deposits
  with type t := Raw_context.t
An abstract type for keys
Tells if a given key is already bound to a storage bucket
val get : 
  context ->
  key ->
  value Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.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_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.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_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.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_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.tAllocates a storage bucket at the given key and initializes it ; returns a Storage_errorExisting_key if the bucket exists.
Allocates 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_alpha.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_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.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_alpha.Lwt.t) ->
  'a Tezos_protocol_environment_alpha.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_alpha.Lwt.t) ->
  'a Tezos_protocol_environment_alpha.Lwt.tIterate over all the keys.
Returns true iff context is empty.