package tezos-protocol-alpha
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f
doc/tezos-protocol-alpha.raw/Tezos_raw_protocol_alpha/Ticket_storage/index.html
Module Tezos_raw_protocol_alpha.Ticket_storageSource
type Tezos_protocol_environment_alpha.Error_monad.error += | Negative_ticket_balance of {key : Ticket_hash_repr.t;balance : Tezos_protocol_environment_alpha.Z.t;
}| Used_storage_space_underflow
val get_balance :
Raw_context.t ->
Ticket_hash_repr.t ->
(Tezos_protocol_environment_alpha.Z.t option * Raw_context.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tget_balance ctxt key receives the ticket balance for the given key in the context ctxt. The key represents a ticket content and a ticket creator pair. In case there exists no value for the given key, None is returned.
val adjust_balance :
Raw_context.t ->
Ticket_hash_repr.t ->
delta:Tezos_protocol_environment_alpha.Z.t ->
(Tezos_protocol_environment_alpha.Z.t * Raw_context.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tadjust_balance ctxt key ~delta adjusts the balance of the given key (representing a ticket content, creator and owner pair) and delta. The value of delta can be positive as well as negative. If there is no pre-exising balance for the given ticket type and owner, it is assumed to be 0 and the new balance is delta. The function also returns the difference between the old and the new size of the storage. Note that the difference may be negative. For example, because when setting the balance to zero, an entry is removed.
The function fails with a Negative_ticket_balance error in case the resulting balance is negative.
val adjust_storage_space :
Raw_context.t ->
storage_diff:Tezos_protocol_environment_alpha.Z.t ->
(Tezos_protocol_environment_alpha.Z.t * Raw_context.t)
Tezos_protocol_environment_alpha.Error_monad.tzresult
Tezos_protocol_environment_alpha.Lwt.tadjust_storage_space ctxt ~storage_diff updates the used storage space for the ticket-table according to storage_diff. The additional positive amount of unpaid storage is returned. If no unpaid storage is consumed, this amount is 0.
Note that when storage space for the ticket table is released we may later use that space for free. For this reason, the amount returned may be less than the given (positive) storage_diff.