Fields

• addCert ∷ WithArrivalTime (ValidatedPerasCert blk) → STM m (m AddPerasCertResult)

  Add a Peras certificate to the database. The STM transaction adds the certificate to the in-memory index, and the resulting m action performs tracing and might perform side-effects in implementations with on-disk storage. The AddPerasCertResult indicates whether the certificate was actually added, or if it was already present.

  NOTE: Use the join . atomically pattern to run both the transaction and the side-effects in sequence.

• getCertIds ∷ STM m (Set PerasRoundNo)

  Get the set of all cert IDs currently in the database.

• getCertsAfter ∷ PerasCertTicketNo → STM m (Map PerasCertTicketNo (m (WithArrivalTime (ValidatedPerasCert blk))))

  Get all certs with a ticket number strictly greater than the given one, in ascending order. Unlike getVotesAfter in PerasVoteDB, the resulting map contains m actions to retrieve the certificates, instead of the certificates directly. This is to allow implementation with on-disk storage to retrieve certificates from disk.

• getWeightSnapshot ∷ STM m (WithFingerprint (PerasWeightSnapshot blk))

  Return the Peras weights in order compare the current selection against potential candidate chains, namely the weights for blocks not older than the current immutable tip. It might contain weights for even older blocks if they have not yet been garbage-collected.

  The Fingerprint is updated every time a new certificate is added, but it stays the same when certificates are garbage-collected.

• getLatestCertSeen ∷ STM m (Maybe (WithBoostedBlockStatus (WithArrivalTime (ValidatedPerasCert blk))))

  This field impacts voting directly because having seen a certificate is a precondition for voting in any round except for the very first one (at origin).

• garbageCollect ∷ SlotNo → STM m (m ())

  Garbage-collect certificates whose target slot is strictly smaller than the given slot number. The STM transaction clears the relevant state from the in-memory index, and the resulting m action performs tracing and might perform side-effects in implementations with on-disk storage.

  NOTE: Use the `join . atomically` pattern to consume its output.