Module `Tezos_raw_protocol_003_PsddFKi3.Delegate_storage`Source

Sourcetype balance =

| Contract of Contract_repr.t
| Rewards of Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t * Cycle_repr.t
| Fees of Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t * Cycle_repr.t
| Deposits of Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t * Cycle_repr.t

Places where tezzies can be found in the ledger's state.

Sourcetype balance_update =

| Debited of Tez_repr.t
| Credited of Tez_repr.t

A credit or debit of tezzies to a balance.

Sourcetype balance_updates = (balance * balance_update) list

A list of balance updates. Duplicates may happen.

Source

val balance_updates_encoding : 
  balance_updates Tezos_protocol_environment_003_PsddFKi3.Data_encoding.t

Sourceval cleanup_balance_updates : balance_updates -> balance_updates

Remove zero-valued balances from a list of updates.

Sourcetype frozen_balance = {

deposit : Tez_repr.t;
fees : Tez_repr.t;
rewards : Tez_repr.t;

}

Source

val is_delegatable : 
  Raw_context.t ->
  Contract_repr.t ->
  bool Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Is the contract eligible to delegation ?

Source

val init : 
  Raw_context.t ->
  Contract_repr.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Allow to register a delegate when creating an account.

Source

val remove : 
  Raw_context.t ->
  Contract_repr.t ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Cleanup delegation when deleting a contract.

Source

val get : 
  Raw_context.t ->
  Contract_repr.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t option
    Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Reading the current delegate of a contract.

Source

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

Source

val set : 
  Raw_context.t ->
  Contract_repr.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t option ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Updating the delegate of a contract.

When calling this function on an "implicit contract" this function fails, unless when the registered delegate is the contract manager. In the that case, the manager is now registered as a delegate. One cannot unregister a delegate for now. The associate contract is now 'undeletable'.

Source

val set_from_script : 
  Raw_context.t ->
  Contract_repr.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t option ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Same as set ignoring the delegatable flag.

Sourcetype Tezos_protocol_environment_003_PsddFKi3.Error_monad.error +=

| Non_delegatable_contract of Contract_repr.contract
| No_deletion of Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t
| Active_delegate
| Current_delegate
| Empty_delegate_account of Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t
| Balance_too_low_for_deposit of {
1. delegate : Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t;
2. deposit : Tez_repr.t;
3. balance : Tez_repr.t;
}

Source

val fold : 
  Raw_context.t ->
  init:'a ->
  f:
    (Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
      'a ->
      'a Tezos_protocol_environment_003_PsddFKi3.Lwt.t) ->
  'a Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Iterate on all registered delegates.

Source

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

List all registered delegates.

Source

val freeze_deposit : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Tez_repr.t ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Various functions to 'freeze' tokens. A frozen 'deposit' keeps its associated rolls. When frozen, 'fees' may trigger new rolls allocation. Rewards won't trigger new rolls allocation until unfrozen.

Source

val freeze_fees : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Tez_repr.t ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Source

val freeze_rewards : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Tez_repr.t ->
  Raw_context.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Source

val cycle_end : 
  Raw_context.t ->
  Cycle_repr.t ->
  Nonce_storage.unrevealed list ->
  (Raw_context.t
   * balance_updates
   * Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t list)
    Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Trigger the context maintenance at the end of cycle 'n', i.e.: unfreeze deposit/fees/rewards from 'n - preserved_cycle' ; punish the provided unrevealed seeds (tipically seed from cycle 'n - 1'). Returns a list of account with the amount that was unfrozen for each and the list of deactivated delegates.

Source

val punish : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Cycle_repr.t ->
  (Raw_context.t * frozen_balance)
    Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Burn all then frozen deposit/fees/rewards for a delegate at a given cycle. Returns the burned amounts.

Source

val has_frozen_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Cycle_repr.t ->
  bool Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Has the given key some frozen tokens in its implicit contract?

Source

val frozen_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Tez_repr.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Returns the amount of frozen deposit, fees and rewards associated to a given delegate.

Source

val frozen_balance_encoding : 
  frozen_balance Tezos_protocol_environment_003_PsddFKi3.Data_encoding.t

Source

val frozen_balance_by_cycle_encoding : 
  frozen_balance Cycle_repr.Map.t
    Tezos_protocol_environment_003_PsddFKi3.Data_encoding.t

Source

val frozen_balance_by_cycle : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  frozen_balance Cycle_repr.Map.t Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Returns the amount of frozen deposit, fees and rewards associated to a given delegate, indexed by the cycle by which at the end the balance will be unfrozen.

Source

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

Returns the full 'balance' of the implicit contract associated to a given key, i.e. the sum of the spendable balance and of the frozen balance.

Source

val staking_balance : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Tez_repr.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Source

val delegated_contracts : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Contract_hash.t list Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Returns the list of contract that delegated towards a given delegate

Source

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

Source

val deactivated : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  bool Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Source

val grace_period : 
  Raw_context.t ->
  Tezos_protocol_environment_003_PsddFKi3.Signature.Public_key_hash.t ->
  Cycle_repr.t Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
    Tezos_protocol_environment_003_PsddFKi3.Lwt.t

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-003-PsddFKi3.raw/Tezos_raw_protocol_003_PsddFKi3/Delegate_storage/index.html

Module `Tezos_raw_protocol_003_PsddFKi3.Delegate_storage`Source

package tezos-protocol-003-PsddFKi3

Install

Dune Dependency

Authors

Maintainers

Sources

doc/tezos-protocol-003-PsddFKi3.raw/Tezos_raw_protocol_003_PsddFKi3/Delegate_storage/index.html

Module Tezos_raw_protocol_003_PsddFKi3.Delegate_storageSource

Module `Tezos_raw_protocol_003_PsddFKi3.Delegate_storage`Source