tezos-alpha-test-helpers 12.3

type t = {

hash : Tezos_crypto.Block_hash.t;
header : Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.t;
operations : Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed list;
context : Tezos_protocol_environment.Context.t;
(*
Resulting context
*)

}

type block = t

val rpc_ctxt : t Tezos_protocol_alpha.Protocol.Environment.RPC_context.simple

type baker_policy =

| By_round of int
| By_account of Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash
| Excluding of Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash list

Policies to select the next baker:

By_round r selects the baker at round r
By_account pkh selects the first slot for baker pkh
Excluding pkhs selects the first baker that doesn't belong to pkhs

type baking_mode =

| Application
| Baking

The default baking functions below is to use (blocks) Application mode. Setting baking_mode allows to switch to Full_construction mode.

val get_next_baker : 
  ?policy:baker_policy ->
  t ->
  (Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash
   * int
   * Tezos_base.Time.Protocol.t,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

Returns (account, round, timestamp) of the next baker given a policy, defaults to By_round 0.

val get_round : 
  block ->
  (Tezos_protocol_alpha.Protocol.Alpha_context.Round.t,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result

module Forge : sig ... end

val check_constants_consistency : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Constants.parametric ->
  (unit, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

val genesis : 
  ?commitments:Tezos_protocol_alpha.Protocol.Alpha_context.Commitment.t list ->
  ?consensus_threshold:int ->
  ?min_proposal_quorum:int32 ->
  ?bootstrap_contracts:
    Tezos_protocol_alpha.Protocol.Alpha_context.Parameters.bootstrap_contract
      list ->
  ?level:int32 ->
  ?cost_per_byte:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?liquidity_baking_subsidy:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?endorsing_reward_per_slot:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?baking_reward_bonus_per_slot:
    Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?baking_reward_fixed_portion:
    Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?origination_size:int ->
  ?blocks_per_cycle:int32 ->
  ?tx_rollup_enable:bool ->
  (Account.t * Tezos_protocol_alpha.Protocol.Alpha_context.Tez.tez) list ->
  (block, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

genesis <opts> accounts : generates an initial block with the given constants <opts> and initializes accounts with their associated amounts.

val genesis_with_parameters : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Parameters.t ->
  (block, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

val alpha_context : 
  ?commitments:Tezos_protocol_alpha.Protocol.Alpha_context.Commitment.t list ->
  ?min_proposal_quorum:int32 ->
  (Account.t * Tezos_protocol_alpha.Protocol.Alpha_context.Tez.tez) list ->
  (Tezos_protocol_alpha.Protocol.Alpha_context.t,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

alpha_context <opts> accounts : instantiates an alpha_context with the given constants <opts> and initializes accounts with their associated amounts.

val get_application_vstate : 
  t ->
  Tezos_protocol_alpha.Protocol.operation list ->
  (Tezos_protocol_alpha.Protocol.validation_state,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

get_application_vstate pred operations constructs a protocol validation environment for operations in application mode on top of the given block with the given operations. It's a shortcut for begin_application

val get_construction_vstate : 
  ?policy:baker_policy ->
  ?timestamp:Tezos_protocol_alpha.Protocol.Alpha_context.Timestamp.time ->
  ?protocol_data:Tezos_protocol_alpha.Protocol.block_header_data option ->
  block ->
  (Tezos_protocol_alpha.Protocol.validation_state,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

get_construction_vstate ?policy ?timestamp ?protocol_data pred constructs a protocol validation environment for operations in construction mode on top of the given block. The mode is full(baking)/partial(mempool) if protocol_data given/absent. It's a shortcut for begin_construction

val apply : 
  Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header ->
  ?operations:Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed list ->
  t ->
  (t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

applies a signed header and its operations to a block and obtains a new block

val bake : 
  ?baking_mode:baking_mode ->
  ?payload_round:Tezos_protocol_alpha.Protocol.Alpha_context.Round.t option ->
  ?locked_round:Tezos_protocol_alpha.Protocol.Alpha_context.Round.t option ->
  ?policy:baker_policy ->
  ?timestamp:Tezos_protocol_alpha.Protocol.Alpha_context.Timestamp.time ->
  ?operation:Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed ->
  ?operations:Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed list ->
  ?liquidity_baking_escape_vote:bool ->
  t ->
  (t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

bake b returns a block b' which has as predecessor block b. Optional parameter policy allows to pick the next baker in several ways. This function bundles together forge_header, sign_header and apply. These functions should be used instead of bake to craft unusual blocks for testing together with setters for properties of the headers. For examples see seed.ml or double_baking.ml

val bake_n : 
  ?baking_mode:baking_mode ->
  ?policy:baker_policy ->
  ?liquidity_baking_escape_vote:bool ->
  int ->
  t ->
  (block, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Bakes n blocks.

val bake_n_with_all_balance_updates : 
  ?baking_mode:baking_mode ->
  ?policy:baker_policy ->
  ?liquidity_baking_escape_vote:bool ->
  int ->
  t ->
  (block * Tezos_protocol_alpha.Protocol.Alpha_context.Receipt.balance_updates,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

Version of bake_n that returns a list of all balance updates included in the metadata of baked blocks. *

val bake_n_with_origination_results : 
  ?baking_mode:baking_mode ->
  ?policy:baker_policy ->
  int ->
  t ->
  (block
   * Tezos_protocol_alpha.Protocol.Alpha_context.Kind.origination
       Tezos_protocol_alpha.Protocol.Apply_results.successful_manager_operation_result
       list,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

Version of bake_n that returns a list of all origination results in the metadata of baked blocks. *

val bake_n_with_liquidity_baking_escape_ema : 
  ?baking_mode:baking_mode ->
  ?policy:baker_policy ->
  ?liquidity_baking_escape_vote:bool ->
  int ->
  t ->
  (block
   * Tezos_protocol_alpha.Protocol.Alpha_context.Liquidity_baking.escape_ema,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

Version of bake_n that returns the liquidity baking escape EMA after n blocks. *

val current_cycle : 
  t ->
  (Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

val bake_until_cycle_end : 
  ?policy:baker_policy ->
  t ->
  (t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Given a block b at level l bakes enough blocks to complete a cycle, that is blocks_per_cycle - (l % blocks_per_cycle).

val bake_until_n_cycle_end : 
  ?policy:baker_policy ->
  int ->
  t ->
  (t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Bakes enough blocks to end n cycles.

val bake_until_cycle : 
  ?policy:baker_policy ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t ->
  t ->
  (t, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t

Bakes enough blocks to reach the cycle.

val prepare_initial_context_params : 
  ?consensus_threshold:int ->
  ?min_proposal_quorum:int32 ->
  ?level:int32 ->
  ?cost_per_byte:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?liquidity_baking_subsidy:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?endorsing_reward_per_slot:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?baking_reward_bonus_per_slot:
    Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?baking_reward_fixed_portion:
    Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?origination_size:int ->
  ?blocks_per_cycle:int32 ->
  ?tx_rollup_enable:bool ->
  (Account.t * Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t) list ->
  (Tezos_protocol_alpha.Protocol.Alpha_context.Constants.parametric
   * Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.shell_header
   * Tezos_crypto.Block_hash.t,
    Tezos_error_monad.TzCore.error list)
    Stdlib.result
    Lwt.t

Common util function to create parameters for initial_context function

package tezos-alpha-test-helpers