package tezos-protocol-alpha

You can search for identifiers within the package.

in-package search v0.2.0

tezos-protocol-alpha.embedded-protocol
- Tezos_embedded_protocol_alpha
  - Registerer
    
    Registered
    
    Mempool
    
    Source
tezos-protocol-alpha.parameters
- Tezos_protocol_alpha_parameters
  - Default_parameters
tezos-protocol-alpha.protocol
- Tezos_protocol_alpha
  - Protocol
tezos-protocol-alpha.protocol.environment
- Tezos_protocol_environment_alpha
  - Array
    
    Floatarray
  - Base58
  - Bits
  - Blake2B
    
    Make
    
    Map
    
    Name
    
    Register
    
    Set
    
    Make_minimal
    
    Name
    
    Name
    
    PrefixedName
    
    Register
  - Block_hash
    
    Map
    
    Set
  - Block_header
  - Bls
    
    Primitive
    
    Fr
    
    G1
    
    Scalar
    
    G2
    
    Scalar
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Bounded
    
    BOUNDS
    
    Int16
    
    B
    
    Int31
    
    B
    
    Int32
    
    B
    
    Int64
    
    B
    
    Int8
    
    B
    
    Non_negative_int32
    
    S
    
    Uint16
    
    B
    
    Uint8
    
    B
  - Bytes
  - CamlinternalFormatBasics
  - Chain_id
    
    Map
    
    Set
  - Char
  - Compare
    
    Bool
    
    Bytes
    
    COMPARABLE
    
    Char
    
    Int
    
    Int32
    
    Int64
    
    List
    
    P
    
    List_length_with
    
    List_lengths
    
    Make
    
    P
    
    Option
    
    P
    
    Q
    
    Result
    
    Error
    
    Ok
    
    S
    
    String
    
    Uint32
    
    Uint64
    
    Z
  - Context
    
    CACHE
    
    Cache
    
    Kind
    
    PROOF_ENCODING
    
    Proof
    
    Internal_for_tests
    
    Stream
    
    Proof_encoding
    
    V1
    
    Tree2
    
    Tree32
    
    V2
    
    Tree2
    
    Tree32
    
    TREE
    
    Tree
    
    VIEW
  - Context_binary
    
    Tree
  - Context_hash
    
    Map
    
    Set
    
    Version
  - Dal
    
    Commitment
    
    Commitment_proof
  - Data_encoding
    
    Binary
    
    Bounded
    
    Compact
    
    Custom
    
    S
    
    Fixed
    
    Json
    
    Variable
    
    With_JSON_discriminant
    
    With_field_name_duplicate_checks
  - Ed25519
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Either
  - Equality_witness
  - Error_monad
    
    Lwt_option_syntax
    
    Lwt_result_syntax
    
    Lwt_syntax
    
    Option_syntax
    
    Result_syntax
  - FallbackArray
  - Fitness
  - Format
  - Hex
  - Int32
  - Int64
  - Lift
    
    Mempool
    
    P
    
    Mempool
  - List
  - Logging
  - Lwt
  - Map
    
    Make
    
    Ord
    
    S
  - Micheline
  - Name
  - Operation
  - Operation_hash
    
    Map
    
    Set
  - Operation_list_hash
    
    Map
    
    Set
  - Operation_list_list_hash
    
    Map
    
    Set
  - Option
  - P256
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Pervasives
  - Plonk
  - Protocol_hash
    
    Map
    
    Set
  - Q
  - RPC_answer
  - RPC_arg
  - RPC_context
    
    simple
  - RPC_directory
  - RPC_path
  - RPC_query
  - RPC_service
  - Raw_hashes
  - Result
  - S
    
    AGGREGATE_SIGNATURE
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
    
    B58_DATA
    
    CURVE
    
    Scalar
    
    ENCODER
    
    FIELD
    
    HASH
    
    Map
    
    Set
    
    HASHABLE
    
    INDEXES
    
    Map
    
    Set
    
    INDEXES_MAP
    
    INDEXES_SET
    
    MERKLE_TREE
    
    Map
    
    Set
    
    MINIMAL_HASH
    
    PRIME_FIELD
    
    RAW_DATA
    
    SIGNATURE
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
    
    SIGNATURE_PUBLIC_KEY
    
    SIGNATURE_PUBLIC_KEY_HASH
    
    Map
    
    Set
    
    SPLIT_SIGNATURE
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
    
    T
  - Sapling
    
    CV
    
    Ciphertext
    
    Commitment
    
    Hash
    
    Nullifier
    
    UTXO
    
    Legacy
    
    Verification
  - Secp256k1
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Seq
  - Set
    
    Make
    
    Ord
    
    S
  - Signature
    
    Public_key
    
    Public_key_hash
    
    Map
    
    Set
  - Skip_list
    
    MONAD
    
    Make
    
    Arg
    
    Lwt
    
    MONADIC
    
    Make_monadic
    
    M
    
    S
    
    Lwt
    
    MONADIC
    
    Make_monadic
    
    M
  - Smart_rollup
    
    Address
    
    Map
    
    Set
    
    Commitment_hash
    
    Map
    
    Set
    
    Inbox_hash
    
    Map
    
    Set
    
    Merkelized_payload_hashes_hash
    
    Map
    
    Set
    
    State_hash
    
    Map
    
    Set
  - String
  - Time
  - Timelock
  - TzEndian
  - Updater
    
    PROTOCOL
    
    Mempool
  - Vdf
  - Wasm_2_0_0
    
    Make
    
    Tree
  - Z
  - proto_rpc_context
  - proto_rpc_context_of_directory
tezos-protocol-alpha.protocol.lifted
- Tezos_protocol_alpha_lifted
  - Lifted_protocol
    
    Mempool
tezos-protocol-alpha.protocol.raw
- Tezos_raw_protocol_alpha

Legend:
Library
Module
Module type
Parameter
Class
Class type

Storage from this submodule must only be accessed through the module `Contract`.

module Global_counter : 
  Simple_single_data_storage with type value = Manager_counter_repr.t

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

The domain of alive contracts

val list : 
  Raw_context.t ->
  Contract_repr.t list Tezos_protocol_environment_alpha.Lwt.t

type local_context

see Raw_context_intf.T.local_context

val with_local_context : 
  Raw_context.t ->
  Contract_repr.t ->
  (local_context ->
    (local_context * 'a) Tezos_protocol_environment_alpha.Error_monad.tzresult
      Tezos_protocol_environment_alpha.Lwt.t) ->
  (Raw_context.t * 'a) Tezos_protocol_environment_alpha.Error_monad.tzresult
    Tezos_protocol_environment_alpha.Lwt.t

see Raw_context_intf.T.with_local_context

module Spendable_balance : 
  Storage_sigs.Indexed_data_storage_with_local_context
    with type key = Contract_repr.t
     and type value = Tez_repr.t
     and type t := Raw_context.t
     and type local_context := local_context

The tez possessed by a contract and that can be used. A contract may also possess tez in frozen deposits. Empty balances (of zero tez) are only allowed for originated contracts, not for implicit ones.

module Missed_attestations : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = missed_attestations_info
     and type t := Raw_context.t

If the value is not set, the delegate didn't miss any attesting opportunity. If it is set, this value is a record of type missed_attestations_info, where:

module Manager : 
  Storage_sigs.Indexed_data_storage_with_local_context
    with type key = Contract_repr.t
     and type value = Manager_repr.t
     and type t := Raw_context.t
     and type local_context := local_context

The manager of a contract

module Consensus_key : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Tezos_protocol_environment_alpha.Signature.Public_key.t
     and type t := Raw_context.t

The active consensus key of a delegate

module Pending_consensus_keys_up_to_Nairobi : 
  Storage_sigs.Indexed_data_storage
    with type key = Cycle_repr.t
     and type value = Tezos_protocol_environment_alpha.Signature.Public_key.t
     and type t := Raw_context.t * Contract_repr.t

The pending consensus key of a delegate

module Delegate : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value =
           Tezos_protocol_environment_alpha.Signature.Public_key_hash.t
     and type t := Raw_context.t

The delegate of a contract, if any.

module Staking_parameters : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Staking_parameters_repr.t
     and type t := Raw_context.t

module Delegated : 
  Storage_sigs.Data_set_storage
    with type elt = Contract_repr.t
     and type t = Raw_context.t * Contract_repr.t

All contracts (implicit and originated) that are delegated, if any

module Frozen_deposits_up_to_Nairobi : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Deposits_repr.t
     and type t := Raw_context.t

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.

module Unstaked_frozen_deposits : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Unstaked_frozen_deposits_repr.t
     and type t := Raw_context.t

Tez that were part of frozen deposits (either own_frozen or staked_frozen in Staking_balance) but have been requested to be unstaked by a staker. They won't be part of the stake for future distributions. For cycles current_cycle - preserved_cycles - max_slashing_period + 1 to current_cycle they are still slashable. For cycle current_cycle - preserved_cycles - max_slashing_period they are not slashable anymore and hence any other older cycles must be squashed into this one at cycle end.

module Unstake_requests : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Unstake_request.t
     and type t := Raw_context.t

The contract's unstake requests that haven't been finalized yet.

module Frozen_deposits_pseudotokens : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Staking_pseudotoken_repr.t
     and type t := Raw_context.t

The sum of all pseudotokens owned by stakers corresponding to shares of the staked_frozen in Staking_balance.

module Staking_pseudotokens : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Staking_pseudotoken_repr.t
     and type t := Raw_context.t

Share of the contract's delegate frozen deposits the contract owns.

module Frozen_deposits_limit : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Tez_repr.t
     and type t := Raw_context.t

If there is a value, the frozen balance for the contract won't exceed it (starting in preserved_cycles + 1).

module Inactive_delegate : 
  Storage_sigs.Data_set_storage
    with type elt = Contract_repr.t
     and type t = Raw_context.t

module Delegate_last_cycle_before_deactivation : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Cycle_repr.t
     and type t := Raw_context.t

The last cycle where the delegate is considered active; that is, at the next cycle it will be considered inactive.

module Counter : 
  Storage_sigs.Indexed_data_storage_with_local_context
    with type key = Contract_repr.t
     and type value = Manager_counter_repr.t
     and type t := Raw_context.t
     and type local_context := local_context

module Code : 
  Storage_sigs.Non_iterable_indexed_carbonated_data_storage
    with type key = Contract_repr.t
     and type value = Script_repr.lazy_expr
     and type t := Raw_context.t

module Storage : 
  Storage_sigs.Non_iterable_indexed_carbonated_data_storage
    with type key = Contract_repr.t
     and type value = Script_repr.lazy_expr
     and type t := Raw_context.t

module Used_storage_space : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Tezos_protocol_environment_alpha.Z.t
     and type t := Raw_context.t

Current storage space in bytes. Includes code, global storage and big map elements.

module Paid_storage_space : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Tezos_protocol_environment_alpha.Z.t
     and type t := Raw_context.t

Maximal space available without needing to burn new fees.

module Slashed_deposits : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Slashed_deposits_history.t
     and type t := Raw_context.t

History of slashed deposits: an associative list of cycles to slashed percentages.

module Frozen_bonds : 
  Storage_sigs.Non_iterable_indexed_carbonated_data_storage
    with type key = Bond_id_repr.t
     and type value = Tez_repr.t
     and type t := Raw_context.t * Contract_repr.t

Associates a contract and a bond_id with a bond, i.e. an amount of tez that is frozen.

val fold_bond_ids : 
  (Raw_context.t * Contract_repr.t) ->
  order:[ `Sorted | `Undefined ] ->
  init:'a ->
  f:(Bond_id_repr.t -> 'a -> 'a Tezos_protocol_environment_alpha.Lwt.t) ->
  'a Tezos_protocol_environment_alpha.Lwt.t

module Total_frozen_bonds : 
  Storage_sigs.Indexed_data_storage
    with type key = Contract_repr.t
     and type value = Tez_repr.t
     and type t := Raw_context.t

Associates a contract with the total of all its frozen bonds.

module Total_supply : 
  Storage_sigs.Single_data_storage
    with type value = Tez_repr.t
     and type t := Raw_context.t

Stores the amount of tokens currently present on chain