Module `Tezos_raw_protocol_alpha.Delegate_storage`Source

This module groups everything related to delegate registration. For the invariants maintained, see the submodule Contract.

It also groups "trivial" getters/setters related to delegates.

It is responsible for maintaining the following tables:

Storage.Delegates

Sourcetype Tezos_protocol_environment_alpha.Error_monad.error +=

| Unregistered_delegate of Tezos_protocol_environment_alpha.Signature.Public_key_hash.t

Sourcemodule Contract : sig ... end

This module ensures the following invariants:

Source

val registered : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  bool Tezos_protocol_environment_alpha.Lwt.t

Has a delegate been registered in the delegate table?

Source

val fold : 
  Raw_context.t ->
  order:[ `Sorted | `Undefined ] ->
  init:'a ->
  f:
    (Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
      'a ->
      'a Tezos_protocol_environment_alpha.Lwt.t) ->
  'a Tezos_protocol_environment_alpha.Lwt.t

Iterate on all registered delegates.

Source

val list : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t list
    Tezos_protocol_environment_alpha.Lwt.t

List all registered delegates.

Source

val frozen_deposits : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Deposits_repr.t Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Returns a delegate's frozen deposits, both the current amount and the initial freezed amount.

A delegate's frozen balance is only composed of frozen deposits; rewards and fees are not frozen, but simply credited at the right moment.

Source

val spendable_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.public_key_hash ->
  Tez_repr.tez Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Source

val is_forbidden_delegate : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  bool

is_forbidden_delegate ctxt delegate returns true if the given delegate is forbidden to bake or attest. This means that its current frozen deposit is equal to zero. Returns false otherwise.

Source

val forbid_delegate : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Raw_context.t Tezos_protocol_environment_alpha.Lwt.t

forbid_delegate ctxt delegate adds delegate to the set of forbidden delegates and stores the updated set, which prevents this delegate from baking or attesting.

Source

val load_forbidden_delegates : 
  Raw_context.t ->
  Raw_context.t Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

load_forbidden_delegates ctxt reads from the storage the saved set of forbidden delegates and sets the raw context's in-memory cached value.

Source

val reset_forbidden_delegates : 
  Raw_context.t ->
  Raw_context.t Tezos_protocol_environment_alpha.Lwt.t

reset_forbidden_delegates ctxt delegates overwrites the forbidden delegates set with an empty set in both storage and in-memory.

Source

val drain : 
  Raw_context.t ->
  delegate:Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  destination:Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  (Raw_context.t * bool * Tez_repr.t * Receipt_repr.balance_updates)
    Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Sourcemodule For_RPC : sig ... end

The functions in this module are considered too costly to be used in the protocol. They are meant to be used only to answer RPC calls.

package tezos-protocol-alpha

Module Tezos_raw_protocol_alpha.Delegate_storageSource

Module `Tezos_raw_protocol_alpha.Delegate_storage`Source