package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Tezos_alpha_test_helpersSource

Sourcemodule Account : sig ... end
Sourcemodule Account_helpers : sig ... end

Account_helpers defines a type abstracting the information of an account in the protocol. This includes its pkh, delegate, any funds, staking parameters, etc...

Sourcemodule Adaptive_issuance_helpers : sig ... end
Sourcemodule Assert : sig ... end
Sourcemodule Big_map_helpers : sig ... end
Sourcemodule Block : sig ... end
Sourcemodule Consensus_helpers : sig ... end
Sourcemodule Constants_helpers : sig ... end
Sourcemodule Context : sig ... end
Sourcemodule Contract_helpers : sig ... end
Sourcemodule Cpmm_logic : sig ... end
Sourcemodule Cpmm_repr : sig ... end
Sourcemodule Dal_helpers : sig ... end
Sourcemodule Dummy_zk_rollup : sig ... end

Dummy ZK Rollup for testing the ZKRU integration in the protocol. The library Plompiler is used to build the circuits (in a module V as verifier) and the corresponding functions to produce the inputs for the circuits (in a module P as prover).

Sourcemodule Expr : sig ... end
Sourcemodule Expr_common : sig ... end
Sourcemodule Incremental : sig ... end

This module provides a set of abstractions to reason about the so-called “liquidity baking” feature1.

Sourcemodule Liquidity_baking_machine : sig ... end

This module provides the means to test extensively the Liquidity Baking (LB) feature. We recall that this feature is built upon three smart contracts: (1) a CPMM contract initially based on Dexter 2, and (2) two tokens contracts. Our objective is to run “scenarios” consisting in interleaved, realistic calls to these contracts, and to assert these scenarios do not yield any undesirable behaviors.

Sourcemodule Log_helpers : sig ... end
Sourcemodule Lqt_fa12_repr : sig ... end
Sourcemodule Lwt_result_wrap_syntax : sig ... end

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.

Sourcemodule Merkle_list_helper : sig ... end
Sourcemodule Nonce : sig ... end
Sourcemodule Op : sig ... end
Sourcemodule Operation_generator : sig ... end

These generators aims at generating operations which are not necessary correct. The goal is to tests functions such as Operation.compare with as much as possible parameters that play a role in operation weight computation.

Sourcemodule Result_wrap_syntax : sig ... end

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

Sourcemodule Rewards : sig ... end

The tables are precomputed using this the following formulas:

Sourcemodule Sapling_helpers : sig ... end
Sourcemodule Sc_rollup_helpers : sig ... end
Sourcemodule Scenario : sig ... end

This module centralises all modules related to Scenario writing and execution. Most scenario tests would use most if not all of them, so they only need to open Scenario.

Sourcemodule Scenario_bake : sig ... end
Sourcemodule Scenario_base : sig ... end

This module gathers the basic operations used in test scenarios. This includes starting a scenario, baking, checking and manipulating the state, and various wait functions

Sourcemodule Scenario_begin : sig ... end
Sourcemodule Scenario_constants : sig ... end
Sourcemodule Scenario_dsl : sig ... end
Sourcemodule Scenario_op : sig ... end

This module gathers many protocol operations in the form of scenarios. This includes (but is not limited to) transfers and such (stake, unstake...), as well as various ways to forge double signings.

Sourcemodule Script_big_map : sig ... end
Sourcemodule Script_map : sig ... end
Sourcemodule Script_set : sig ... end
Sourcemodule Slashing_helpers : sig ... end

Helpers related to denunciations and slashing.

Sourcemodule State : sig ... end
Sourcemodule State_account : sig ... end

State_account is dedicated to operations in State.t that would modify an account_state. This includes any operation like transfer, stake, unstake, set_delegate_parameters, anything related to slashing or rewards, etc...

Sourcemodule State_ai_flags : sig ... end

This module handles the logic of flags for AI/AS in the State

Sourcemodule Test_global_constants : sig ... end
Sourcemodule Testable : sig ... end
Sourcemodule Tez_helpers : sig ... end
Sourcemodule Tez_staking_helpers : sig ... end

Tez_staking_helpers defines different kinds of tez Modules that manipulate them in different ways. They involve more complicated operations, as they are related to staking, thus are represented as partial amounts, and are related to pseudotokens.

Sourcemodule Ticket_helpers : sig ... end
Sourcemodule Transfers : sig ... end
Sourcemodule Zk_rollup_l2_helpers : sig ... end
OCaml

Innovation. Community. Security.