package octez-protocol-alpha-libs

  1. Overview
  2. Docs
package octez-protocol-alpha-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Tezos_baking_alpha.Baking_stateSource

Sourcetype consensus_key = {
  1. alias : string option;
  2. public_key : Tezos_base.TzPervasives.Signature.public_key;
  3. public_key_hash : Tezos_base.TzPervasives.Signature.public_key_hash;
  4. secret_key_uri : Tezos_client_base.Client_keys.sk_uri;
}
Sourceval consensus_key_encoding : consensus_key Tezos_base.TzPervasives.Data_encoding.t
Sourceval pp_consensus_key : Format.formatter -> consensus_key -> unit
Sourcetype consensus_key_and_delegate = consensus_key * Tezos_base.TzPervasives.Signature.Public_key_hash.t
Sourceval consensus_key_and_delegate_encoding : consensus_key_and_delegate Tezos_base.TzPervasives.Data_encoding.t
Sourceval pp_consensus_key_and_delegate : Format.formatter -> consensus_key_and_delegate -> unit
Sourcetype validation_mode =
  1. | Node
  2. | Local of Abstract_context_index.t
Sourcetype prequorum = {
  1. level : int32;
  2. round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
  3. block_payload_hash : Tezos_protocol_alpha.Protocol.Block_payload_hash.t;
  4. preattestations : Tezos_protocol_alpha.Protocol.Alpha_context.Kind.preattestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list;
}
Sourcetype block_info = {
  1. hash : Tezos_base.TzPervasives.Block_hash.t;
  2. shell : Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.shell_header;
  3. payload_hash : Tezos_protocol_alpha.Protocol.Block_payload_hash.t;
  4. payload_round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
  5. round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
  6. prequorum : prequorum option;
  7. quorum : Tezos_protocol_alpha.Protocol.Alpha_context.Kind.attestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list;
  8. dal_attestations : Tezos_protocol_alpha.Protocol.Alpha_context.Kind.dal_attestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list;
  9. payload : Operation_pool.payload;
}
Sourcetype cache = {
  1. known_timestamps : Tezos_protocol_alpha.Protocol.Alpha_context.Timestamp.time Baking_cache.Timestamp_of_round_cache.t;
  2. round_timestamps : (Tezos_protocol_alpha.Protocol.Alpha_context.Timestamp.time * Tezos_protocol_alpha.Protocol.Alpha_context.Round.t * consensus_key_and_delegate) Baking_cache.Round_timestamp_interval_cache.t;
}
Sourcetype global_state = {
  1. cctxt : Tezos_client_alpha.Protocol_client_context.full;
  2. chain_id : Tezos_base.TzPervasives.Chain_id.t;
  3. config : Baking_configuration.t;
  4. constants : Tezos_protocol_alpha.Protocol.Alpha_context.Constants.t;
  5. round_durations : Tezos_protocol_alpha.Protocol.Alpha_context.Round.round_durations;
  6. operation_worker : Operation_worker.t;
  7. validation_mode : validation_mode;
  8. delegates : consensus_key list;
  9. cache : cache;
  10. dal_node_rpc_ctxt : Tezos_rpc.Context.generic option;
}
Sourceval block_info_encoding : block_info Tezos_base.TzPervasives.Data_encoding.t
Sourceval round_of_shell_header : Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.shell_header -> Tezos_protocol_alpha.Protocol.Alpha_context.Round.t Tezos_base.TzPervasives.tzresult
Sourcemodule SlotMap : Tezos_base.TzPervasives.Map.S with type key = Tezos_protocol_alpha.Protocol.Alpha_context.Slot.t
Sourcetype delegate_slot = {
  1. consensus_key_and_delegate : consensus_key_and_delegate;
  2. first_slot : Tezos_protocol_alpha.Protocol.Alpha_context.Slot.t;
  3. attesting_power : int;
}

A delegate slot consists of the delegate's consensus key, its public key hash, its first slot, and its attesting power at some level.

Sourcemodule Delegate_slots : sig ... end
Sourcetype delegate_slots = Delegate_slots.t
Sourcetype proposal = {
  1. block : block_info;
  2. predecessor : block_info;
}
Sourceval proposal_encoding : proposal Tezos_base.TzPervasives.Data_encoding.t
Sourceval is_first_block_in_protocol : proposal -> bool

Identify the first block of the protocol, ie. the block that activates the current protocol.

This block should be baked by the baker of the previous protocol (that's why this same block is also referred to as the last block of the previous protocol). It is always considered final and therefore is not attested.

Sourcetype locked_round = {
  1. payload_hash : Tezos_protocol_alpha.Protocol.Block_payload_hash.t;
  2. round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
}
Sourceval locked_round_encoding : locked_round Tezos_base.TzPervasives.Data_encoding.t
Sourcetype attestable_payload = {
  1. proposal : proposal;
  2. prequorum : prequorum;
}
Sourceval attestable_payload_encoding : attestable_payload Tezos_base.TzPervasives.Data_encoding.t
Sourcetype elected_block = {
  1. proposal : proposal;
  2. attestation_qc : Tezos_protocol_alpha.Protocol.Alpha_context.Kind.attestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list;
}
Sourcetype level_state = {
  1. current_level : int32;
  2. latest_proposal : proposal;
  3. is_latest_proposal_applied : bool;
  4. locked_round : locked_round option;
  5. attestable_payload : attestable_payload option;
  6. elected_block : elected_block option;
  7. delegate_slots : delegate_slots;
  8. next_level_delegate_slots : delegate_slots;
  9. next_level_proposed_round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t option;
}
Sourcetype phase =
  1. | Idle
  2. | Awaiting_preattestations
  3. | Awaiting_attestations
  4. | Awaiting_application
Sourceval phase_encoding : phase Tezos_base.TzPervasives.Data_encoding.t
Sourcetype round_state = {
  1. current_round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
  2. current_phase : phase;
  3. delayed_quorum : Tezos_protocol_alpha.Protocol.Alpha_context.Kind.attestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list option;
}
Sourcetype state = {
  1. global_state : global_state;
  2. level_state : level_state;
  3. round_state : round_state;
}
Sourcetype t = state
Sourceval update_current_phase : t -> phase -> t
Sourceval round_proposer : state -> level:[ `Current | `Next ] -> Tezos_protocol_alpha.Protocol.Alpha_context.Round.t -> delegate_slot option

Returns, among our *own* delegates, the delegate (and its attesting slot) that has a proposer slot at the given round and the current or next level, if any.

Sourcetype timeout_kind =
  1. | End_of_round of {
    1. ending_round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
    }
  2. | Time_to_bake_next_level of {
    1. at_round : Tezos_protocol_alpha.Protocol.Alpha_context.Round.t;
    }
Sourceval timeout_kind_encoding : timeout_kind Tezos_base.TzPervasives.Data_encoding.t
Sourcetype event =
  1. | New_valid_proposal of proposal
  2. | New_head_proposal of proposal
  3. | Prequorum_reached of Operation_worker.candidate * Tezos_protocol_alpha.Protocol.Alpha_context.Kind.preattestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list
  4. | Quorum_reached of Operation_worker.candidate * Tezos_protocol_alpha.Protocol.Alpha_context.Kind.attestation Tezos_protocol_alpha.Protocol.Alpha_context.operation list
  5. | Timeout of timeout_kind
Sourceval event_encoding : event Tezos_base.TzPervasives.Data_encoding.t
Sourcetype state_data = {
  1. level_data : int32;
  2. locked_round_data : locked_round option;
  3. attestable_payload_data : attestable_payload option;
}
Sourceval state_data_encoding : state_data Tezos_base.TzPervasives.Data_encoding.t
Sourceval record_state : t -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval may_record_new_state : previous_state:t -> new_state:t -> unit Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval may_load_attestable_data : t -> t Tezos_base.TzPervasives.tzresult Lwt.t
  • parameter block

    default to `Head 0

Sourceval create_cache : unit -> cache
Sourceval pp_validation_mode : Format.formatter -> validation_mode -> unit
Sourceval pp_global_state : Format.formatter -> global_state -> unit
Sourceval pp_option : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a option -> unit
Sourceval pp_block_info : Format.formatter -> block_info -> unit
Sourceval pp_proposal : Format.formatter -> proposal -> unit
Sourceval pp_locked_round : Format.formatter -> locked_round -> unit
Sourceval pp_attestable_payload : Format.formatter -> attestable_payload -> unit
Sourceval pp_elected_block : Format.formatter -> elected_block -> unit
Sourceval pp_delegate_slot : Format.formatter -> delegate_slot -> unit
Sourceval pp_delegate_slots : Format.formatter -> delegate_slots -> unit
Sourceval pp_level_state : Format.formatter -> level_state -> unit
Sourceval pp_phase : Format.formatter -> phase -> unit
Sourceval pp_round_state : Format.formatter -> round_state -> unit
Sourceval pp : Format.formatter -> t -> unit
Sourceval pp_timeout_kind : Format.formatter -> timeout_kind -> unit
Sourceval pp_event : Format.formatter -> event -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct