package octez-protocol-alpha-libs
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Block/index.html
Module Tezos_alpha_test_helpers.BlockSource
type t = {hash : Tezos_base.TzPervasives.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
*)constants : Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.t;
}Policies to select the next baker:
By_round rselects the baker at roundrBy_account pkhselects the first slot for bakerpkhExcluding pkhsselects the first baker that doesn't belong topkhs
Note that bakers can have active consensus keys different from their regular delegate keys. For the By_account pkh policy, pkh refers to the baker's delegate key. However, for the Excluding pkhs policy, pkhs refer to the baker's active consensus key.
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
* Tezos_protocol_alpha.Protocol.Alpha_context.public_key_hash
* int
* Tezos_base.TzPervasives.Time.Protocol.t)
Tezos_base.TzPervasives.tzresult
Lwt.tReturns (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_base.TzPervasives.tzresultval check_constants_consistency :
Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.t ->
unit Tezos_base.TzPervasives.tzresult Lwt.tval 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 ->
?issuance_weights:
Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.issuance_weights ->
?origination_size:int ->
?blocks_per_cycle:int32 ->
?cycles_per_voting_period:int32 ->
?sc_rollup_enable:bool ->
?sc_rollup_arith_pvm_enable:bool ->
?sc_rollup_private_enable:bool ->
?dal_enable:bool ->
?zk_rollup_enable:bool ->
?hard_gas_limit_per_block:
Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral ->
?nonce_revelation_threshold:int32 ->
?dal:Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.dal ->
Tezos_protocol_alpha.Protocol.Alpha_context.Parameters.bootstrap_account list ->
block Tezos_base.TzPervasives.tzresult Lwt.tgenesis <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_base.TzPervasives.tzresult Lwt.tval alpha_context :
?commitments:Tezos_protocol_alpha.Protocol.Alpha_context.Commitment.t list ->
?min_proposal_quorum:int32 ->
Tezos_protocol_alpha.Protocol.Alpha_context.Parameters.bootstrap_account list ->
Tezos_protocol_alpha.Protocol.Alpha_context.t
Tezos_base.TzPervasives.tzresult
Lwt.talpha_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_protocol_alpha.Protocol.application_state)
Tezos_base.TzPervasives.tzresult
Lwt.tget_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_protocol_alpha.Protocol.application_state)
Tezos_base.TzPervasives.tzresult
Lwt.tget_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 ->
?allow_manager_failures:bool ->
t ->
t Tezos_base.TzPervasives.tzresult Lwt.tapplies a signed header and its operations to a block and obtains a new block
val bake :
?baking_mode:baking_mode ->
?allow_manager_failures:bool ->
?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_toggle_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
?check_size:bool ->
t ->
t Tezos_base.TzPervasives.tzresult Lwt.tbake b returns a block b' which has as predecessor block b. Optional parameter policy allows to pick the next baker in several ways. If check_size is true (the default case), then the function checks that the operations passed as arguments satisfy the size limit of Tezos operations, as defined in the protocol. 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. Setting allow_manager_failures (default=false), allows baking blocks with manager operation(s) that are valid but that could fail during their application. If this is not set, the block is correctly baked but the operations' application will fail silently. For examples see seed.ml or double_baking.ml
val bake_n :
?baking_mode:baking_mode ->
?policy:baker_policy ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
int ->
t ->
block Tezos_base.TzPervasives.tzresult Lwt.tBakes n blocks.
val bake_until_level :
?baking_mode:baking_mode ->
?policy:baker_policy ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
Tezos_protocol_alpha.Protocol.Alpha_context.Raw_level.t ->
t ->
block Tezos_base.TzPervasives.tzresult Lwt.tBakes until the given level is reached.
val bake_n_with_all_balance_updates :
?baking_mode:baking_mode ->
?policy:baker_policy ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
int ->
t ->
(block * Tezos_protocol_alpha.Protocol.Alpha_context.Receipt.balance_updates)
Tezos_base.TzPervasives.tzresult
Lwt.tVersion 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_base.TzPervasives.tzresult
Lwt.tVersion of bake_n that returns a list of all origination results in the metadata of baked blocks. *
val bake_n_with_liquidity_baking_toggle_ema :
?baking_mode:baking_mode ->
?policy:baker_policy ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.per_block_vote ->
int ->
t ->
(block
* Tezos_protocol_alpha.Protocol.Alpha_context.Per_block_votes.Liquidity_baking_toggle_EMA.t)
Tezos_base.TzPervasives.tzresult
Lwt.tVersion of bake_n that returns the liquidity baking toggle EMA after n blocks. *
val bake_n_with_metadata :
?locked_round:Tezos_protocol_alpha.Protocol.Alpha_context.Round.t option ->
?policy:baker_policy ->
?timestamp:Tezos_protocol_alpha.Protocol.Alpha_context.Timestamp.time ->
?payload_round:Tezos_protocol_alpha.Protocol.Alpha_context.Round.t option ->
?check_size:bool ->
?baking_mode:baking_mode ->
?allow_manager_failures:bool ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Per_block_votes_repr.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Per_block_votes_repr.per_block_vote ->
int ->
block ->
(block * Tezos_protocol_alpha.Protocol.block_header_metadata,
Tezos_base.TzPervasives.Error_monad.tztrace)
result
Lwt.tVariant of bake_n that returns the block metadata of the last baked block. n must be positive, otherwise a single block is baked. *
val bake_while :
?baking_mode:baking_mode ->
?policy:baker_policy ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Per_block_votes_repr.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Per_block_votes_repr.per_block_vote ->
?invariant:(block -> unit Tezos_base.TzPervasives.tzresult Lwt.t) ->
(block -> bool) ->
block ->
block Tezos_base.TzPervasives.tzresult Lwt.tBake blocks while a predicate over the block holds. The returned block is the last one for which the predicate holds; in case the predicate never holds, the input block is returned. When the optional invariant argument is provided, it is checked on the input block and on each baked block, including the returned one (the last one satisfy the predicate); it is however not checked on the next block (the first one to invalidate the predicate).
val bake_while_with_metadata :
?baking_mode:baking_mode ->
?policy:baker_policy ->
?liquidity_baking_toggle_vote:
Tezos_protocol_alpha.Protocol.Per_block_votes_repr.per_block_vote ->
?adaptive_issuance_vote:
Tezos_protocol_alpha.Protocol.Per_block_votes_repr.per_block_vote ->
?invariant:(block -> unit Tezos_base.TzPervasives.tzresult Lwt.t) ->
(block -> Tezos_protocol_alpha.Protocol.block_header_metadata -> bool) ->
block ->
block Tezos_base.TzPervasives.tzresult Lwt.tval bake_until_cycle_end :
?policy:baker_policy ->
t ->
t Tezos_base.TzPervasives.tzresult Lwt.tGiven 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_base.TzPervasives.tzresult Lwt.tBakes enough blocks to end n cycles.
val bake_until_cycle :
?policy:baker_policy ->
Tezos_protocol_alpha.Protocol.Alpha_context.Cycle.t ->
t ->
t Tezos_base.TzPervasives.tzresult Lwt.tBakes 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 ->
?issuance_weights:
Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.issuance_weights ->
?origination_size:int ->
?blocks_per_cycle:int32 ->
?cycles_per_voting_period:int32 ->
?sc_rollup_enable:bool ->
?sc_rollup_arith_pvm_enable:bool ->
?sc_rollup_private_enable:bool ->
?dal_enable:bool ->
?zk_rollup_enable:bool ->
?hard_gas_limit_per_block:
Tezos_protocol_alpha.Protocol.Alpha_context.Gas.Arith.integral ->
?nonce_revelation_threshold:int32 ->
?dal:Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.dal ->
unit ->
(Tezos_protocol_alpha.Protocol.Alpha_context.Constants.Parametric.t
* Tezos_protocol_alpha.Protocol.Alpha_context.Block_header.shell_header
* Tezos_base.TzPervasives.Block_hash.t,
Tezos_base.TzPervasives.tztrace)
result
Lwt.tCommon util function to create parameters for initial_context function