package octez-protocol-020-PsParisC-libs

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

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.

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

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

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

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

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

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

bake 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

Variant of bake that returns the block metadata of the baked block. *

Bakes n blocks.

Bakes until the given level is reached.

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

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

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

Variant of bake_n that returns the block metadata of the last baked block. n must be positive, otherwise a single block is baked. *

Bake 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).

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

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

Bakes enough blocks to end n cycles.

Bakes enough blocks to reach the cycle.

Common util function to create parameters for initial_context function

autostaked_opt delegate metadata returns Some amount if amount tez have been staked for the given delegate. None otherwise.

same as autostaked_opt but fails in case autostaking didn't provoke a stake operation.