Scenario (octez-protocol-alpha-libs.Tezos_alpha_test

include module type of struct include Scenario_base end

type t = Block.t * State.t

Usual threaded state for the tests. Contains the current block and the known State.t

type t_incr = Incremental.t * State.t

Threaded state when constructing a block step by step in incremental mode. The operation metadata list is built as operations are getting applied.

val log : 
  ?level:Tezt_core.Cli.Logs.level ->
  ?color:Tezt_core.Log.Color.t ->
  ('a, Stdlib.Format.formatter, unit, ('b, 'b) Scenario_dsl.scenarios)
    Stdlib.format4 ->
  'a

val set_baker : ?min_round:int -> string -> (t, t) Scenario_dsl.scenarios

Sets the de facto baker for all future blocks

val exclude_bakers : string list -> (t, t) Scenario_dsl.scenarios

Exclude a list of delegates from baking

val set_payload_round : int option -> (t, t) Scenario_dsl.scenarios

val set_baked_round : 
  ?payload_round:int ->
  int ->
  (t, t) Scenario_dsl.scenarios

val unset_baking_policy : (t, t) Scenario_dsl.scenarios

Unsets the baking policy, it returns to default (By_round 0)

val snapshot_balances : 
  Tezos_base.TzPervasives.String.Map.key ->
  Tezos_base.TzPervasives.String.Map.key list ->
  (t, t) Scenario_dsl.scenarios

Creates a snapshot of the current balances for the given account names. Can be used to check that balances at point A and B in the execution of a test are the same (either nothing happened, or a succession of actions resulted in getting the same values as before

val check_snapshot_balances : 
  ?f:
    (name:Tezos_base.TzPervasives.String.Map.key ->
      old_balance:State_account.balance ->
      new_balance:State_account.balance ->
      (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  Tezos_base.TzPervasives.String.Map.key ->
  (t, t) Scenario_dsl.scenarios

Check balances against a previously defined snapshot

val save_current_rate : (t, t) Scenario_dsl.scenarios

Save the current issuance rate for future use

val check_rate_evolution : 
  (Q.t -> Q.t -> bool) ->
  (t, t) Scenario_dsl.scenarios

Check that f saved_rate current_rate is true. f is typically a comparison function

val check_failure_aux : 
  ?loc:string ->
  expected_error:
    ('a ->
      Tezos_base.TzPervasives.tztrace ->
      (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  ('a -> 'b Tezos_base.TzPervasives.tzresult Lwt.t) ->
  'a ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

val check_fail_and_rollback : 
  ?loc:string ->
  expected_error:
    ('a ->
      Tezos_base.TzPervasives.tztrace ->
      (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  ('a, 'b) Scenario_dsl.single_scenario ->
  'a ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

val assert_failure : 
  ?loc:string ->
  expected_error:
    ('a ->
      Tezos_base.TzPervasives.tztrace ->
      (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  ('a, 'b) Scenario_dsl.scenarios ->
  ('a, 'a) Scenario_dsl.scenarios

Useful function to test expected failures: runs the given branch until it fails, then rollbacks to before execution. Fails if the given branch Succeeds

val assert_success : 
  ?loc:string ->
  ('a, 'b) Scenario_dsl.scenarios ->
  ('a, 'a) Scenario_dsl.scenarios

Check a scenario does not fail, and rolls back to before the assert

val assert_failure_in_check_snapshot_balances : 
  loc:string ->
  ?f:
    (name:Tezos_base.TzPervasives.String.Map.key ->
      old_balance:State_account.balance ->
      new_balance:State_account.balance ->
      (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  Tezos_base.TzPervasives.String.Map.key ->
  (t, t) Scenario_dsl.scenarios

val loop : 
  int ->
  ('a, 'a) Scenario_dsl.scenarios ->
  ('a, 'a) Scenario_dsl.scenarios

Loop

val loop_action : 
  int ->
  ('a -> 'a Tezos_base.TzPervasives.tzresult Lwt.t) ->
  ('a, 'a) Scenario_dsl.scenarios

val check_balance_field : 
  ?loc:string ->
  Tezos_base.TzPervasives.String.Map.key ->
  [< `Bonds
  | `Liquid
  | `Pseudotokens
  | `Staked
  | `Total
  | `Unstaked_finalizable
  | `Unstaked_frozen_total ] ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  (t, t) Scenario_dsl.scenarios

Check a specific balance field for a specific account is equal to a specific amount

val assert_failure_in_check_balance_field : 
  loc:string ->
  Tezos_base.TzPervasives.String.Map.key ->
  [< `Bonds
  | `Liquid
  | `Pseudotokens
  | `Staked
  | `Total
  | `Unstaked_finalizable
  | `Unstaked_frozen_total ] ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  (t, t) Scenario_dsl.scenarios

val check_balance_fields : 
  ?loc:string ->
  Tezos_base.TzPervasives.String.Map.key ->
  liquid:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  staked:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?unstaked_frozen_total:Tezos_alpha_test_helpers.State_account.Tez.t ->
  ?unstaked_finalizable:Tezos_alpha_test_helpers.State_account.Tez.t ->
  unit ->
  (t, t) Scenario_dsl.scenarios

val with_metadata : 
  (Block.full_metadata -> ('a * State.t) -> 'b) ->
  ('a * State.t) ->
  'b

val exec_metadata : 
  (Block.full_metadata ->
    ('a * State.t) ->
    (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  ('a * State.t, 'a * State.t) Scenario_dsl.scenarios

include module type of struct include Scenario_op end

val normalize_parameters : 
  Adaptive_issuance_helpers.staking_parameters ->
  State.t ->
  Adaptive_issuance_helpers.staking_parameters

val set_delegate_params : 
  string ->
  Adaptive_issuance_helpers.staking_parameters ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Set delegate parameters for the given delegate

val add_account : 
  ?algo:Signature.algo ->
  Tezos_base.TzPervasives.String.Map.key ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Add a new account with the given name

val reveal : 
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Reveal operation

val transfer : 
  Tezos_base.TzPervasives.String.Map.key ->
  Tezos_base.TzPervasives.String.Map.key ->
  Tez_helpers.Ez_tez.tez_quantity ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Transfer from src to dst

val current_cycle : 
  Block.block ->
  Tezos_alpha_test_helpers.State_account.Cycle.cycle

val set_delegate : 
  Tezos_base.TzPervasives.String.Map.key ->
  Tezos_base.TzPervasives.String.t option ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Set delegate for src. If delegate_name_opt = None, then unset current delegate

val stake : 
  Tezos_base.TzPervasives.String.Map.key ->
  Tez_helpers.Ez_tez.tez_quantity ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Stake operation

val unstake : 
  Tezos_base.TzPervasives.String.Map.key ->
  Tez_helpers.Ez_tez.tez_quantity ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

unstake operation

val finalize_unstake : 
  Tezos_base.TzPervasives.String.Map.key ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

finalize unstake operation

val update_consensus_key_ : 
  ?proof_signer:string ->
  ?force_no_signer:bool ->
  ck_name:string ->
  string ->
  (Block.block * State.t) ->
  (State.t * Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list,
    Tezos_base.TzPervasives.tztrace)
    Stdlib.result
    Lwt.t

val update_consensus_key : 
  ?proof_signer:string ->
  ?force_no_signer:bool ->
  ck_name:string ->
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val update_companion_key_ : 
  ?proof_signer:string ->
  ?force_no_signer:bool ->
  ck_name:string ->
  string ->
  (Block.block * State.t) ->
  (State.t * Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list,
    Tezos_base.TzPervasives.tztrace)
    Stdlib.result
    Lwt.t

val update_companion_key : 
  ?proof_signer:string ->
  ?force_no_signer:bool ->
  ck_name:string ->
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val check_pending_slashings : 
  loc:string ->
  (Block.t * State.t) ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

val order_attestations : 
  correct_order:bool ->
  'a Tezos_raw_protocol_alpha__Alpha_context.operation ->
  'a Tezos_raw_protocol_alpha__Alpha_context.operation ->
  'a Tezos_raw_protocol_alpha__Alpha_context.operation
  * 'a Tezos_raw_protocol_alpha__Alpha_context.operation

Double attestation helpers

val op_double_attestation : 
  ?correct_order:bool ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Kind.attestation
    Tezos_protocol_alpha.Protocol.Alpha_context.Operation.t ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Kind.attestation
    Tezos_protocol_alpha.Protocol.Alpha_context.Operation.t ->
  Context.t ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed

val op_double_preattestation : 
  ?correct_order:bool ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Kind.preattestation
    Tezos_protocol_alpha.Protocol.Alpha_context.Operation.t ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Kind.preattestation
    Tezos_protocol_alpha.Protocol.Alpha_context.Operation.t ->
  Context.t ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed

val order_block_hashes : 
  correct_order:bool ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header
  * Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header

val op_double_baking : 
  ?correct_order:bool ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.block_header ->
  Context.t ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Operation.packed

val double_bake_op : 
  string list ->
  (Block.t * State.t) ->
  (Block.t * State.t, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

double_bake_op delegate_names (block, state) performs a double baking with the given delegate names. The first delegate in the list bakes the new main branch. All delegates (including the first) will bake two other blocks at the same level/different round.

val double_bake : 
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val double_bake_many : 
  string list ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val double_attest_op : 
  ?other_bakers:(string * string) ->
  op:
    (delegate:Tezos_alpha_test_helpers.Signature.Public_key_hash.t ->
      Block.t ->
      ('a Tezos_protocol_alpha.Protocol.Alpha_context.Kind.consensus
         Tezos_protocol_alpha.Protocol.Alpha_context.operation,
        Tezos_base.TzPervasives.tztrace)
        Stdlib.result
        Lwt.t) ->
  op_evidence:
    ('a Tezos_protocol_alpha.Protocol.Alpha_context.Kind.consensus
       Tezos_protocol_alpha.Protocol.Alpha_context.operation ->
      'a Tezos_protocol_alpha.Protocol.Alpha_context.Kind.consensus
        Tezos_protocol_alpha.Protocol.Alpha_context.operation ->
      Context.t ->
      Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation) ->
  kind:Tezos_protocol_alpha.Protocol.Misbehaviour_repr.kind ->
  string list ->
  (Block.t * State.t) ->
  (Block.t * State.t, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

double_attest_op ?other_bakers ~op ~op_evidence ~kind delegate_names (block, state) performs a double (pre)attestation with the given delegate names. Starting at block level `n`, it creates two 2-block branches and all delegates will (pre)attest the two blocks at level `n+2`. other_bakers can be used to force using specific bakers to avoid reusing forbidden ones

val double_attest_ : 
  ?other_bakers:(string * string) ->
  string list ->
  (Block.t * State.t) ->
  (Block.t * State.t, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

val double_attest_many : 
  ?other_bakers:(string * string) ->
  string list ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val double_attest : 
  ?other_bakers:(string * string) ->
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val double_preattest_ : 
  ?other_bakers:(string * string) ->
  string list ->
  (Block.t * State.t) ->
  (Block.t * State.t, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

val double_preattest_many : 
  ?other_bakers:(string * string) ->
  string list ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val double_preattest : 
  ?other_bakers:(string * string) ->
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val cycle_from_level : 
  int32 ->
  int32 ->
  Tezos_alpha_test_helpers.State_account.Cycle.cycle

val update_state_denunciation : 
  (Block.t * State.t) ->
  State.double_signing_state ->
  (State.t * bool, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

val make_denunciations_op : 
  ?single:bool ->
  ?rev:bool ->
  ?filter:(State.double_signing_state -> bool) ->
  (Block.t * State.t) ->
  (State.t * Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list,
    Tezos_base.TzPervasives.tztrace)
    Stdlib.result
    Lwt.t

make_denunciations_op ?single ?rev ?filter () denounces all double signers in the state. If single is set, only one denunciation is made. If rev is set, the denunciations are made in reverse order. If filter is set, only the double signers for which the filter returns true are denounced.

val make_denunciations : 
  ?single:bool ->
  ?rev:bool ->
  ?filter:(State.double_signing_state -> bool) ->
  unit ->
  (Block.t * State.t, Scenario_base.t) Scenario_dsl.scenarios

val add_account_with_funds : 
  ?algo:Signature.algo ->
  Tezos_base.TzPervasives.String.Map.key ->
  funder:Tezos_base.TzPervasives.String.Map.key ->
  Tez_helpers.Ez_tez.tez_quantity ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Create an account and give an initial balance funded by funder

val start_payload : (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val batch : 
  source:string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val add_batch_to_operations : 
  ?mode_after:State.operation_mode ->
  Scenario_base.t ->
  State.t Tezos_base.TzPervasives.tzresult Lwt.t

val end_batch : 
  ?bake_after:bool ->
  ?mode_after:State.operation_mode ->
  unit ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

include module type of struct include Scenario_dsl end

type ('input, 'output) scenarios = ('input, 'output) Scenario_dsl.scenarios =

| Action : ('input -> 'output Tezos_base.TzPervasives.tzresult Lwt.t) -> ('input, 'output) scenarios
| Empty : ('t, 't) scenarios
| Concat : (('a, 'b) scenarios * ('b, 'c) scenarios) -> ('a, 'c) scenarios
| Branch : (('a, 'b) scenarios * ('a, 'b) scenarios) -> ('a, 'b) scenarios
| Tag : string -> ('t, 't) scenarios
| Slow : ('t, 't) scenarios

A scenario is a succession of actions. We define a branching path as a way to create multiple tests from the same point. This allows easy compositionality of behaviors with minimal code sharing. The Tag allows to give meaningful identifiers to the branches. It is good practice to tag each case in a branch (it's not necessary, but since test names must be unique, at most one branch can remain unnamed, and even then it can create conflicting names.)

type ('input, 'output) single_scenario =
  ('input, 'output) Scenario_dsl.single_scenario =

| End_scenario : ('t, 't) single_scenario
| Cons : (('input -> 't Tezos_base.TzPervasives.tzresult Lwt.t) * ('t, 'output) single_scenario) -> ('input, 'output) single_scenario

Unfolded scenario type

val cat_ss : 
  'a 'b 'c. ('a, 'b) single_scenario ->
  ('b, 'c) single_scenario ->
  ('a, 'c) single_scenario

val combine : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list

val unfold_scenarios : 
  'input 'output. ('input, 'output) scenarios ->
  (('input, 'output) single_scenario * string list * bool) list

val run_scenario : 
  'input 'output. ('input, 'output) single_scenario ->
  'input ->
  'output Tezos_base.TzPervasives.tzresult Lwt.t

type test_closure = string * bool * (Tezt_tezos.Protocol.t -> unit Lwt.t)

val unfolded_to_test : 
  ((unit, unit) single_scenario * string list * bool) ->
  test_closure

val register_test : __FILE__:string -> tags:string list -> test_closure -> unit

val register_tests : 
  __FILE__:string ->
  tags:string list ->
  test_closure list ->
  unit

Useful aliases and operators

val noop : ('a, 'a) scenarios

val no_tag : ('a, 'a) scenarios

val concat : 
  'a 'b 'c. ('a, 'b) scenarios ->
  ('b, 'c) scenarios ->
  ('a, 'c) scenarios

val branch : 
  'a 'b. ('a, 'b) scenarios ->
  ('a, 'b) scenarios ->
  ('a, 'b) scenarios

val (-->) : ('a, 'b) scenarios -> ('b, 'c) scenarios -> ('a, 'c) scenarios

Continuation connector: execute a then b

val (|+) : ('a, 'b) scenarios -> ('a, 'b) scenarios -> ('a, 'b) scenarios

Branching connector: creates two tests with different execution paths

val list_map_branched : 
  'a list ->
  ('a -> ('b, 'b) scenarios) ->
  ('b, 'b) scenarios

Branching combinator: creates a test path for each element in the list.

val end_test : ('a, unit) scenarios

Ends the test. Dump the state, returns unit

val tests_of_scenarios : 
  (string * (unit, 't) scenarios) list ->
  test_closure list

Transforms scenarios into tests

val exec : 
  ('a -> 'b Tezos_base.TzPervasives.tzresult Lwt.t) ->
  ('a, 'b) scenarios

Arbitrary execution

val exec_state : 
  (('a * 'b) -> ('c, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  ('a * 'b, 'a * 'c) scenarios

Execute a function that does not modify the block, only the state

val exec_unit : 
  ('a -> (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t) ->
  ('a, 'a) scenarios

Execute a function that does not modify neither the block nor the state. Usually used for checks/asserts

val fold : ('a -> ('b, 'c) scenarios) -> 'a list -> ('b, 'c) scenarios

fold f l folds f over l, fails on empty list

val fold_tag : 
  ('a -> ('b, 'c) scenarios) ->
  (string * 'a) list ->
  ('b, 'c) scenarios

fold_tag f l folds f over l, l has a tag for each of its elements. Fails on empty list.

val fold_tag_f : 
  ('a -> ('b, 'c) scenarios) ->
  ('a -> string) ->
  'a list ->
  ('b, 'c) scenarios

fold_tag_f f tag l folds f over l, tag returns a tag for each element of l. Fails on empty list.

val unfold : ('a -> ('b, 'b) scenarios) -> 'a list -> ('b, 'b) scenarios

unfold f l maps f over l, and runs them in order

include module type of struct include Scenario_begin end

type Tezos_base.TzPervasives.error +=

| Inconsistent_number_of_bootstrap_accounts

Returns when the number of bootstrap accounts created by Context.init_n n is not equal to n

type starter_constants = Scenario_begin.starter_constants =

| Mainnet
| Sandbox
| Test

val start : 
  constants:starter_constants ->
  (unit, Scenario_constants.constants) Scenario_dsl.scenarios

val start_with : 
  constants:Scenario_constants.constants ->
  (unit, Scenario_constants.constants) Scenario_dsl.scenarios

val start_with_list : 
  constants:(string * Scenario_constants.constants) list ->
  (unit, Scenario_constants.constants) Scenario_dsl.scenarios

val init_constants : 
  ?default:starter_constants ->
  ?reward_per_block:int64 ->
  ?deactivate_dynamic:bool ->
  ?blocks_per_cycle:int32 ->
  ?delegate_parameters_activation_delay:int ->
  unit ->
  (unit, Scenario_constants.constants) Scenario_dsl.scenarios

Initializes the constants for testing, with well chosen default values. Recommended over start or start_with

val begin_test : 
  ?algo:Signature.algo ->
  ?burn_rewards:bool ->
  ?force_attest_all:bool ->
  ?force_preattest_all:bool ->
  ?check_finalized_every_block:
    (Block.full_metadata ->
      (Block.t * State.t) ->
      unit Tezos_base.TzPervasives.tzresult Lwt.t)
      list ->
  ?disable_default_checks:bool ->
  Tezos_base.TzPervasives.String.Map.key list ->
  (Scenario_constants.constants, Scenario_base.t) Scenario_dsl.scenarios

Initialize the test, given some initial parameters

include module type of struct include Scenario_constants end

type constants = Constants_helpers.t

module S = Tezos_alpha_test_helpers.Scenario_constants.S

val set : 
  ('a -> constants -> constants) ->
  'a ->
  (constants, constants) Scenario_dsl.scenarios

val set_opt : 
  ('a -> constants -> constants) ->
  'a option ->
  (constants, constants) Scenario_dsl.scenarios

val sets : 
  ('a -> constants -> constants) ->
  (string * 'a) list ->
  (constants, constants) Scenario_dsl.scenarios

val sets_f : 
  ('a -> constants -> constants) ->
  ('a -> string) ->
  'a list ->
  (constants, constants) Scenario_dsl.scenarios

val branch_flag : 
  (bool -> constants -> constants) ->
  (constants, constants) Scenario_dsl.scenarios

val branch_flags : 
  (bool -> constants -> constants) list ->
  (constants, constants) Scenario_dsl.scenarios

val sets_int : 
  (int -> constants -> constants) ->
  int list ->
  (constants, constants) Scenario_dsl.scenarios

include module type of struct include Scenario_bake end

val apply_end_cycle : 
  Tezos_alpha_test_helpers.State_account.Cycle.t ->
  Block.t ->
  Block.block ->
  State.t ->
  State.t Tezos_base.TzPervasives.tzresult Lwt.t

Applies when baking the last block of a cycle

val apply_new_cycle : 
  Tezos_alpha_test_helpers.State_account.Cycle.cycle ->
  State.t ->
  State.t

Applies when baking the first block of a cycle. Technically nothing special happens, but we need to update the unslashable unstakes since it's done lazily

val check_all_balances : 
  'a ->
  (Block.t * State.t) ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

After baking and applying rewards in state

val check_misc : 
  'a ->
  (Block.t * State.t) ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

Misc checks at block end

val check_issuance_rpc : 
  'a ->
  (Block.t * 'b) ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

val check_ai_launch_cycle_is_zero : 
  loc:string ->
  Block.t ->
  (unit, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

val apply_all_pending_operations_ : 
  Scenario_base.t_incr ->
  Scenario_base.t_incr Tezos_base.TzPervasives.tzresult Lwt.t

Apply all operations pending in the state. It is imperative that the list of pending operations in the state is empty before finalizing the block, either manually, or by calling this function.

val finalize_payload_ : 
  ?payload_round:int ->
  ?baker:string ->
  Scenario_base.t ->
  Scenario_base.t_incr Tezos_base.TzPervasives.tzresult Lwt.t

finalize the payload of the next block. Can start including preattestations.

val finalize_payload : 
  ?payload_round:int ->
  ?baker:string ->
  unit ->
  (Scenario_base.t, Scenario_base.t_incr) Scenario_dsl.scenarios

val finalize_block_ : 
  Scenario_base.t_incr ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

val finalize_block : 
  (Scenario_base.t_incr, Scenario_base.t) Scenario_dsl.scenarios

val bake : 
  ?baker:string ->
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

Bake a block, with the given baker and the given operations.

val repeat : 
  int ->
  ('a -> ('a, 'b) Stdlib.result Lwt.t) ->
  'a ->
  ('a, 'b) Stdlib.result Lwt.t

val bake_until_level : 
  target_level:int ->
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

val bake_until : 
  target_cycle:int ->
  [< `Cycle_end | `Cycle_end_but_one | `New_cycle ] ->
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

val bake_until_next_cycle : 
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

Bake until a cycle is reached, using bake instead of Block.bake

val bake_until_dawn_of_next_cycle : 
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

Bake all the remaining blocks of the current cycle

val bake_until_next_cycle_end_but_one : 
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

val next_block_ : 
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

Bake a single block

val next_block : (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val next_block_with_baker : 
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Bake a single block with a specific baker

val next_cycle_ : 
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

Bake until the end of a cycle

val next_cycle : (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Bake until the end of a cycle

val dawn_of_next_cycle : 
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val exec_op : 
  ((Block.t * 'a) ->
    (State.t
     * Tezos_protocol_alpha.Protocol.Alpha_context.packed_operation list,
      Tezos_base.TzPervasives.tztrace)
      Stdlib.result
      Lwt.t) ->
  (Block.t * 'a, Scenario_base.t) Scenario_dsl.scenarios

Executes an operation: f should return a new state and a list of operations, which are then applied

val wait_n_cycles : 
  int ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Waiting functions

val wait_n_blocks : 
  int ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val wait_cycle_f_es : 
  (Scenario_base.t ->
    Scenario_base.t ->
    bool Tezos_base.TzPervasives.tzresult Lwt.t) ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val wait_cycle_f : 
  (Scenario_base.t -> Scenario_base.t -> bool) ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Waits until condition init_t current_t is fulfilled. It is checked on the first block of every cycle. If it returns false, another cycle is baked, until it succeeds.

val wait_cycle_until : 
  [< `And of 'a * 'a
  | `delegate_parameters_activation
  | `right_before_delegate_parameters_activation ] as 'a ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

Wait until we are in a cycle satisfying the given condition. Fails if AI_activation is requested and AI is not set to be activated in the future.

val wait_delegate_parameters_activation : 
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

wait delegate_parameters_activation_delay cycles

val wait_n_cycles_f_es : 
  (Scenario_base.t -> int Tezos_base.TzPervasives.tzresult Lwt.t) ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val wait_n_cycles_f : 
  (Scenario_base.t -> int) ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

include module type of struct include Scenario_attestation end

val update_activity : string -> Block.block -> State.t -> State.t

type kind = Scenario_attestation.kind =

| Preattestation
| Attestation

val string_of_kind : kind -> string

--- Attestations ---

val check_attestation_metadata : 
  ?check_not_found:bool ->
  kind:kind ->
  Tezos_alpha_test_helpers.Signature.Public_key_hash.t ->
  Tezos_alpha_test_helpers.Signature.Public_key_hash.t ->
  Block.full_metadata ->
  Scenario_base.t ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

val check_attestation_aggregate_metadata : 
  ?check_not_found:bool ->
  kind:kind ->
  (Tezos_alpha_test_helpers.Signature.Public_key_hash.t * 'a) list ->
  Block.full_metadata ->
  Scenario_base.t ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

val check_attestation_rewards : 
  ?check_not_found:bool ->
  string ->
  Block.full_metadata ->
  Scenario_base.t ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

val check_missed_attestation_rewards : 
  string ->
  ?check_not_found:bool ->
  Block.full_metadata ->
  Scenario_base.t ->
  unit Tezos_base.TzPervasives.tzresult Lwt.t

val attest_with : 
  ?dal_content:Tezos_protocol_environment_alpha.Z.t ->
  string ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

val attest_aggreg_with : 
  string list ->
  (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

(tz4 only) Creates an aggregated attestation from the attestations of the given delegates. Fails if one of the delegates has no slot for the given block, or if one of the delegates' consensus key is not a tz4

val attest_with_all_ : 
  Scenario_base.t ->
  Scenario_base.t Tezos_base.TzPervasives.tzresult Lwt.t

val attest_with_all : (Scenario_base.t, Scenario_base.t) Scenario_dsl.scenarios

--- Preattestations ---

val make_fake_block : 
  ?payload_round:int ->
  Incremental.incremental ->
  (Block.t, Tezos_base.TzPervasives.tztrace) Stdlib.result Lwt.t

val preattest_with : 
  ?payload_round:int ->
  string ->
  (Scenario_base.t_incr, Scenario_base.t_incr) Scenario_dsl.scenarios

val preattest_aggreg_with : 
  ?payload_round:int ->
  string list ->
  (Scenario_base.t_incr, Scenario_base.t_incr) Scenario_dsl.scenarios

(tz4 only) Creates an aggregated preattestation from the preattestations of the given delegates. Fails if one of the delegates has no slot for the given block, or if one of the delegates' consensus key is not a tz4

val preattest_with_all_ : 
  ?payload_round:int ->
  Scenario_base.t_incr ->
  Scenario_base.t_incr Tezos_base.TzPervasives.tzresult Lwt.t