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
    
    Rollups_map
    
    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
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    VL
    
    P
    
    V
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    Operator
    
    Internal_for_tests
    
    Params
    
    Types
    
    Encodings
    
    Bounded_e
    
    VL
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    P
    
    Dummy
    
    V
    
    Bounded_u
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
    
    V
    
    E
    
    Bounded_e
    
    VL
    
    L
    
    Anemoi
    
    Bool
    
    Internal
    
    Bytes
    
    Ecc
    
    Encodings
    
    Enum
    
    N
    
    Input
    
    Limb
    
    N
    
    Limbs
    
    N
    
    Mod_arith
    
    Num
    
    Poseidon
  - 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
    
    Proof
    
    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

Extends the Lwt_result_syntax with additional utilities for wrapping results produced by the protocol, i.e. Environment.Error_monad.tzresult, to tzresult Lwt.t values used in the tests.

The added utilities are binding operators. They use the same symbols as the ones from Lwt_result_syntax with an added @ character. This character symbolizes the ewrapping of the internal error monad type in a shell error.

include module type of Tezos_base.TzPervasives.Lwt_result_syntax

include module type of Tezos_error_monad.TzLwtreslib.Monad.Lwt_result_syntax

val return : 'a -> ('a, 'e) Stdlib.result Lwt.t

val return_unit : (unit, 'e) Stdlib.result Lwt.t

val return_none : ('a option, 'e) Stdlib.result Lwt.t

val return_some : 'a -> ('a option, 'e) Stdlib.result Lwt.t

val return_nil : ('a list, 'e) Stdlib.result Lwt.t

val return_true : (bool, 'e) Stdlib.result Lwt.t

val return_false : (bool, 'e) Stdlib.result Lwt.t

val fail : 'e -> ('a, 'e) Stdlib.result Lwt.t

val let* : 
  ('a, 'e) Stdlib.result Lwt.t ->
  ('a -> ('b, 'e) Stdlib.result Lwt.t) ->
  ('b, 'e) Stdlib.result Lwt.t

val let+ : 
  ('a, 'e) Stdlib.result Lwt.t ->
  ('a -> 'b) ->
  ('b, 'e) Stdlib.result Lwt.t

val lwt_map_error : 
  ('e -> 'f) ->
  ('a, 'e) Stdlib.result Lwt.t ->
  ('a, 'f) Stdlib.result Lwt.t

val let*! : 'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t

val let*? : 
  ('a, 'e) Stdlib.result ->
  ('a -> ('b, 'e) Stdlib.result Lwt.t) ->
  ('b, 'e) Stdlib.result Lwt.t

val join : 
  (unit, 'e) Stdlib.result Lwt.t list ->
  (unit, 'e list) Stdlib.result Lwt.t

val all : 
  ('a, 'e) Stdlib.result Lwt.t list ->
  ('a list, 'e list) Stdlib.result Lwt.t

val both : 
  ('a, 'e) Stdlib.result Lwt.t ->
  ('b, 'e) Stdlib.result Lwt.t ->
  ('a * 'b, 'e list) Stdlib.result Lwt.t

val tzfail : 
  'error ->
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t

val and* : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t ->
  ('b, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t ->
  ('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t

val and+ : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t ->
  ('b, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t ->
  ('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t

val tzjoin : 
  (unit, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t list ->
  (unit, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t

val tzall : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t list ->
  ('a list, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t

val tzboth : 
  ('a, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t ->
  ('b, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t ->
  ('a * 'b, 'error Tezos_base.TzPervasives.TzTrace.trace) Stdlib.result Lwt.t

val wrap : 
  'a Tezos_protocol_alpha.Environment.Error_monad.tzresult Lwt.t ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

wrap res maps the result type contained in res to a tzresult value.

val let@ : 
  'a Tezos_protocol_alpha.Environment.Error_monad.tzresult ->
  ('a Tezos_base.TzPervasives.tzresult -> 'b) ->
  'b

let@ x = m in f x is equivalent to let x = Environment.wrap_tzresult m in f x

val let*@ : 
  'a Tezos_protocol_alpha.Environment.Error_monad.tzresult Lwt.t ->
  ('a -> 'b Tezos_base.TzPervasives.tzresult Lwt.t) ->
  'b Tezos_base.TzPervasives.tzresult Lwt.t

let*@ x = m in f x is equivalent to let* x = wrap m in f x.

Mnemonic: @ "wraps" a protocol error in a shell error.

val let*?@ : 
  'a Tezos_protocol_alpha.Environment.Error_monad.tzresult ->
  ('a -> 'b Tezos_base.TzPervasives.tzresult Lwt.t) ->
  'b Tezos_base.TzPervasives.tzresult Lwt.t

let*?@ x = m in f x is equivalent to let*? x = Environment.wrap_tzresult m in f x.

Mnemonic: @ "wraps" a protocol error in a shell error.

val let*!@ : 
  'a Tezos_protocol_alpha.Environment.Error_monad.tzresult Lwt.t ->
  ('a Tezos_base.TzPervasives.tzresult -> 'b Lwt.t) ->
  'b Lwt.t

let*!@ x = m in f x is equivalent to let*! x = wrap m in f x.

Mnemonic: @ "wraps" a protocol error in a shell error.

val let+@ : 
  'a Tezos_protocol_alpha.Environment.Error_monad.tzresult Lwt.t ->
  ('a -> 'b) ->
  'b Tezos_base.TzPervasives.tzresult Lwt.t

let+@ x = m in f x is equivalent to let+ x = wrap m in f x.

Mnemonic: @ "wraps" a protocol error in a shell error.