package octez-protocol-alpha-libs

You can search for identifiers within the package.

in-package search v0.2.0

octez-protocol-alpha-libs.baking
- Tezos_baking_alpha
octez-protocol-alpha-libs.baking-commands
- Tezos_baking_alpha_commands
  - Baking_commands
octez-protocol-alpha-libs.baking-commands.registration
- Tezos_baking_alpha_commands_registration
  - Baking_commands_registration
octez-protocol-alpha-libs.baking.tenderbrute
- Tenderbrute_alpha
  - Tenderbrute
octez-protocol-alpha-libs.bakings.mockup-simulator
- Tezos_alpha_mockup_simulator
octez-protocol-alpha-libs.client
- Tezos_client_alpha
octez-protocol-alpha-libs.client.commands
- Tezos_client_alpha_commands
octez-protocol-alpha-libs.client.commands-registration
- Tezos_client_alpha_commands_registration
  - Alpha_commands_registration
octez-protocol-alpha-libs.client.sapling
- Tezos_client_sapling_alpha
octez-protocol-alpha-libs.dac
- Tezos_dac_alpha
  - Dac_plugin_registration
    
    Make
    
    Mapper
    
    Proto
    
    Mempool
octez-protocol-alpha-libs.dal
- Tezos_dal_alpha
  - Dal_plugin_registration
    
    Plugin
  - Dal_slot_frame_encoding
    
    Slot_version
    
    V0
    
    Internal
octez-protocol-alpha-libs.layer2-utils
- Tezos_layer2_utils_alpha
  - Layer1_services
octez-protocol-alpha-libs.plugin
- Tezos_protocol_plugin_alpha
  - Mempool
    
    Conflict_map
    
    Internal_for_tests
  - Metrics_plugin
  - Plugin
  - Plugin_errors
  - RPC
    
    Attestation_rights
    
    S
    
    Baking_rights
    
    S
    
    Big_map
    
    S
    
    Contract
    
    S
    
    Dal
    
    S
    
    Forge
    
    Manager
    
    S
    
    Parse
    
    S
    
    Registration
    
    S
    
    Sc_rollup
    
    S
    
    Scripts
    
    Normalize_stack
    
    S
    
    Traced_interpreter
    
    Unparsing_mode
    
    UNPARSING_MODE
    
    Unparse_types
    
    Staking
    
    S
    
    Validators
    
    S
  - Script_interpreter_logging
    
    Logger_base
  - View_helpers
octez-protocol-alpha-libs.plugin-registerer
- Tezos_protocol_plugin_alpha_registerer
  - Plugin_registerer
    
    Metrics
    
    RPC
    
    Validation
octez-protocol-alpha-libs.smart-rollup
- Tezos_smart_rollup_alpha
  - Context_helpers
    
    In_memory
    
    Tree
  - Game_helpers
    
    Wasm
  - Pvm_in_memory
    
    Arith
    
    Internal_for_tests
    
    S
    
    Internal_for_tests
    
    Wasm
    
    Internal_for_tests
octez-protocol-alpha-libs.smart-rollup-layer2
- Tezos_smart_rollup_layer2_alpha
  - Sc_rollup_proto_types
    
    Address
    
    Commitment
    
    Commitment_hash
    
    Constants
    
    Dal
    
    Page_index
    
    Slot_header
    
    Slot_history
    
    Slot_history_cache
    
    Slot_index
    
    Game
    
    Inbox
    
    Inbox_hash
    
    Kind
    
    Merkelized_payload_hashes_hash
    
    State_hash
  - Sc_rollup_services
    
    Block
    
    Helpers
    
    Encodings
    
    Query
octez-protocol-alpha-libs.test-helpers
- Tezos_alpha_test_helpers
  - Account
  - Adaptive_issuance_helpers
    
    CycleMap
    
    Frozen_tez
    
    Partial_tez
    
    Tez
    
    Unstaked_finalizable
    
    Unstaked_frozen
  - Assert
    
    Int32
    
    Int64
  - Big_map_helpers
  - Block
    
    Forge
  - Consensus_helpers
  - Context
    
    Contract
    
    Delegate
    
    Sc_rollup
    
    Vote
  - Contract_helpers
  - Cpmm_logic
    
    Simulate
    
    Simulate_raw
  - Cpmm_repr
    
    Parameter
    
    Storage
  - Dal_helpers
    
    Make
    
    P
  - Dummy_zk_rollup
    
    Bound
    
    Bounded
    
    Encoding
    
    VL
    
    P
    
    V
    
    Operator
    
    Internal_for_tests
    
    Params
    
    Types
    
    Encodings
    
    Bounded_e
    
    VL
    
    P
    
    Dummy
    
    V
    
    Bounded_u
    
    V
    
    E
    
    Bounded_e
    
    VL
  - Expr
  - Expr_common
  - Incremental
  - Liquidity_baking_generator
  - Liquidity_baking_machine
    
    ConcreteMachine
    
    SymbolicMachine
    
    ValidationMachine
    
    Concrete
    
    Symbolic
  - Lqt_fa12_repr
    
    Parameter
    
    Storage
  - Lwt_result_wrap_syntax
  - Merkle_list_helper
    
    Hash
    
    Map
    
    Set
    
    ML
    
    Internal_for_tests
  - Nonce
  - Op
  - Operation_generator
    
    Gen_hash
    
    H
  - Result_wrap_syntax
  - Rewards
  - Sapling_helpers
    
    Alpha_context_helpers
    
    Common
    
    Interpreter_helpers
  - Sc_rollup_helpers
    
    Arith_pvm_eval
    
    Internal_for_tests
    
    Make_PVM_eval
    
    Internal_for_tests
    
    PVM
    
    Internal_for_tests
    
    Make_in_memory_context
    
    Context
    
    Tree
    
    Tree
    
    Node_inbox
    
    PVM_eval
    
    Internal_for_tests
    
    Payloads_histories
    
    Protocol_inbox
    
    Protocol_inbox_with_ctxt
    
    Wasm_pvm_eval
    
    Internal_for_tests
    
    Wrong_arith_pvm
    
    Internal_for_tests
    
    Wrong_in_memory_context
    
    Tree
  - Script_big_map
  - Script_map
  - Script_set
  - Test_global_constants
    
    Generators
  - Test_tez
  - Testable
  - Ticket_helpers
  - Transfers
  - Zk_rollup_l2_helpers

Legend:
Library
Module
Module type
Parameter
Class
Class type

type mempool = Tezos_client_alpha.Mockup.M.Block_services.Mempool.t

val monitor_validated_blocks : 
  unit ->
  (Tezos_base.TzPervasives.Chain_id.t
   * Tezos_base.TzPervasives.Block_hash.t
   * Tezos_base.TzPervasives.Block_header.t
   * Tezos_base.TzPervasives.Operation.t list list)
    Tezos_rpc.Answer.stream

The baker relies on this stream to be notified of new valid blocks.

val monitor_heads : 
  unit ->
  (Tezos_base.TzPervasives.Block_hash.t
   * Tezos_base.TzPervasives.Block_header.t)
    Tezos_rpc.Answer.stream

The baker relies on this stream to be notified of new heads.

val protocols : 
  Block_services.block ->
  Block_services.protocols Tezos_base.TzPervasives.tzresult Lwt.t

Returns current and next protocol for a block.

val raw_header : 
  Block_services.block ->
  bytes Tezos_base.TzPervasives.tzresult Lwt.t

raw_header returns the byte encoded block header of the block associated to the given block specification.

val header : 
  Block_services.block ->
  Tezos_client_alpha.Mockup.M.Block_services.block_header
    Tezos_base.TzPervasives.tzresult
    Lwt.t

header returns the block header of the block associated to the given block specification.

val resulting_context_hash : 
  Block_services.block ->
  Tezos_base.TzPervasives.Context_hash.t Tezos_base.TzPervasives.tzresult Lwt.t

resulting_context_hash returns the context resulting hash of the given block.

val operations : 
  Block_services.block ->
  Tezos_client_alpha.Mockup.M.Block_services.operation list list
    Tezos_base.TzPervasives.tzresult
    Lwt.t

operations returns all operations included in the block.

val inject_block : 
  Tezos_base.TzPervasives.Block_hash.t ->
  Tezos_base.TzPervasives.Block_header.t ->
  Tezos_base.TzPervasives.Operation.t Tezos_base.TzPervasives.trace
    Tezos_base.TzPervasives.trace ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

inject_block_callback is called when an RPC is performed on Tezos_shell_services.Injection_services.S.block, after checking that the block header can be deserialized.

val inject_operation : 
  Tezos_base.TzPervasives.Operation.t ->
  Tezos_base.TzPervasives.Operation_hash.t Tezos_base.TzPervasives.tzresult
    Lwt.t

inject_operation is used by the baker (or the client) to inject operations, including attestations.

val pending_operations : unit -> mempool Lwt.t

pending_operations returns the current contents of the mempool. It is used by the baker to fetch operations to potentially include in the block being baked. These operations might include attestations. If there aren't enough attestations, the baker waits on monitor_operations.

val monitor_operations : 
  version:Block_services.version ->
  validated:bool ->
  branch_delayed:bool ->
  branch_refused:bool ->
  refused:bool ->
  (Block_services.version
   * ((Tezos_base.TzPervasives.Operation_hash.t
       * Tezos_client_alpha.Mockup.M.Protocol.operation)
      * Tezos_base.TzPervasives.error Tezos_base.TzPervasives.trace option)
       list)
    Tezos_rpc.Answer.stream

Return a stream of list of operations. Used by the baker to wait on attestations. Invariant: the stream becomes empty when the node changes head.

val list_blocks : 
  heads:Tezos_base.TzPervasives.Block_hash.t list ->
  length:int option ->
  min_date:Tezos_base.TzPervasives.Time.Protocol.t option ->
  Tezos_base.TzPervasives.Block_hash.t list list
    Tezos_base.TzPervasives.tzresult
    Lwt.t

Lists block hashes from the chain, up to the last checkpoint, sorted with decreasing fitness. Without arguments it returns the head of the chain. Optional arguments allow to return the list of predecessors of a given block or of a set of blocks.

val live_blocks : 
  Block_services.block ->
  Tezos_base.TzPervasives.Block_hash.Set.t Tezos_base.TzPervasives.tzresult
    Lwt.t

List the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.

val rpc_context_callback : 
  Block_services.block ->
  Tezos_protocol_environment.rpc_context Tezos_base.TzPervasives.tzresult Lwt.t

rpc_context_callback is used in the implementations of several RPCs (see local_services.ml). It should correspond to the rpc_context constructed from the context at the requested block.

val raw_protocol_data : 
  Block_services.block ->
  Tezos_base.TzPervasives.Bytes.t Tezos_base.TzPervasives.tzresult Lwt.t

Return raw protocol data as a block.

val broadcast_block : 
  ?dests:int list ->
  Tezos_base.TzPervasives.Block_hash.t ->
  Tezos_base.TzPervasives.Block_header.t ->
  Tezos_base.TzPervasives.Operation.t Tezos_base.TzPervasives.trace
    Tezos_base.TzPervasives.trace ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

Broadcast block manually to nodes dests (given by their number, starting from 0). If dests is not provided, broadcast to all nodes.

val broadcast_operation : 
  ?dests:int list ->
  Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

Broadcast operation manually to nodes dests (given by their number, starting from 0). If dests is not provided, broadcast to all nodes.

val monitor_bootstrapped : 
  unit ->
  (Tezos_base.TzPervasives.Block_hash.t
   * Tezos_base.TzPervasives.Time.Protocol.t)
    Tezos_rpc.Answer.stream

Simulate waiting for the node to be bootstrapped. Because the simulated node is already bootstrapped, returns the current head immediately.