package tezos-protocol-alpha

You can search for identifiers within the package.

in-package search v0.2.0

tezos-protocol-alpha

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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:

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_limit : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Tez_repr.t option Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Source

val set_frozen_deposits_limit : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Tez_repr.t option ->
  Raw_context.t Tezos_protocol_environment_alpha.Lwt.t

Source

val frozen_deposits : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Storage.deposits 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 staking_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Tez_repr.t Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Source

val full_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Tez_repr.t Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Returns the full 'balance' of the implicit contract associated to a given key, i.e. the sum of the spendable balance (given by balance or Contract_storage.get_balance) and of the frozen balance. The frozen balance is composed of all frozen bonds associated to the contract (given by Contract_storage.get_frozen_bonds) and of the frozen deposits (given by frozen_deposits).

Only use this function for RPCs: this is expensive.

Source

val delegated_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_alpha.Signature.Public_key_hash.t ->
  Tez_repr.t Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

Only use this function for RPCs: this is expensive.

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

package tezos-protocol-alpha

Module Tezos_raw_protocol_alpha.Delegate_storageSource

Module `Tezos_raw_protocol_alpha.Delegate_storage`Source