Fields

• forgeLabel ∷ Text

  Identifier used in the trace messages produced for this BlockForging record.

  Useful when the node is running with multiple sets of credentials.

• canBeLeader ∷ CanBeLeader (BlockProtocol blk)

  Proof that the node can be a leader

  NOTE: the other fields of this record may refer to this value (or a value derived from it) in their closure, which means one should not override this field independently from the others.

• updateForgeState ∷ TopLevelConfig blk → SlotNo → Ticked (ChainDepState (BlockProtocol blk)) → m (ForgeStateUpdateInfo blk)

  Update the forge state.

  When the node can be a leader, this will be called at the start of each slot, right before calling checkCanForge.

  When Updated is returned, we trace the ForgeStateInfo.

  When UpdateFailed is returned, we trace the ForgeStateUpdateError and don't call checkCanForge.

• checkCanForge ∷ TopLevelConfig blk → SlotNo → Ticked (ChainDepState (BlockProtocol blk)) → IsLeader (BlockProtocol blk) → ForgeStateInfo blk → Either (CannotForge blk) ()

  After checking that the node indeed is a leader (checkIsLeader returned Just) and successfully updating the forge state (updateForgeState did not return UpdateFailed), do another check to see whether we can actually forge a block.

  When CannotForge is returned, we don't call forgeBlock.

• forgeBlock ∷ TopLevelConfig blk → BlockNo → SlotNo → TickedLedgerState blk EmptyMK → [Validated (GenTx blk)] → IsLeader (BlockProtocol blk) → m blk

  Forge a block

  The function is passed the prefix of the mempool that will fit within a valid block; this is a set of transactions that is guaranteed to be consistent with the ledger state (also provided as an argument) and with each other (when applied in order). All of them should be included in the forged block, since the mempool ensures they can fit.

  NOTE: do not refer to the consensus or ledger config in the closure, because they might contain an EpochInfo Identity, which will be incorrect when used as part of the hard fork combinator. Use the given TopLevelConfig instead, as it is guaranteed to be correct even when used as part of the hard fork combinator.

  PRECONDITION: checkCanForge returned Right ().

• finalize ∷ m ()

  Clean up any unmanaged resources.

  Such resources may include KES keys that require explicit erasing ("secure forgetting"), and threads that connect to a KES agent. This method will be run once when the block forging thread terminates, whether cleanly or due to an exception.

Fields

• mkBlockForging ∷ m (BlockForging m blk)