Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.PerasCertDB.API

Contents

PerasCertSnapshot

Synopsis

data PerasCertDB (m ∷ Type → Type) blk = PerasCertDB {
- addCert ∷ WithArrivalTime (ValidatedPerasCert blk) → m AddPerasCertResult
- getWeightSnapshot ∷ STM m (WithFingerprint (PerasWeightSnapshot blk))
- getCertSnapshot ∷ STM m (PerasCertSnapshot blk)
- getLatestCertSeen ∷ STM m (Maybe (WithArrivalTime (ValidatedPerasCert blk)))
- garbageCollect ∷ SlotNo → m ()
- closeDB ∷ m ()
}
data AddPerasCertResult
- = AddedPerasCertToDB
- | PerasCertAlreadyInDB
data PerasCertSnapshot blk = PerasCertSnapshot {
- containsCert ∷ PerasRoundNo → Bool
- getCertsAfter ∷ PerasCertTicketNo → Map PerasCertTicketNo (WithArrivalTime (ValidatedPerasCert blk))
}
data PerasCertTicketNo
zeroPerasCertTicketNo ∷ PerasCertTicketNo

Documentation

data PerasCertDB (m ∷ Type → Type) blk Source #

Constructors

PerasCertDB

Fields

addCert ∷ WithArrivalTime (ValidatedPerasCert blk) → m AddPerasCertResult
Add a Peras certificate to the database. The result indicates whether the certificate was actually added, or if it was already present.
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.
getCertSnapshot ∷ STM m (PerasCertSnapshot blk)
getLatestCertSeen ∷ STM m (Maybe (WithArrivalTime (ValidatedPerasCert blk)))
Get the certificate with the highest round number that has been added to the db since it has been opened. This certificate is not affected by garbage collection, but it's forgotten when the db is closed.
FIXME(peras): having seen a certificate is a precondition to start voting in every round except for the first one (at origin). As a consequence, only caught-up nodes can actively participate in the Peras protocol for now.
garbageCollect ∷ SlotNo → m ()
Garbage-collect state older than the given slot number.
closeDB ∷ m ()

Instances

Instances details

NoThunks (PerasCertDB m blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods noThunks ∷ Context → PerasCertDB m blk → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PerasCertDB m blk → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PerasCertDB m blk) → String Source #

data AddPerasCertResult Source #

Constructors

AddedPerasCertToDB
PerasCertAlreadyInDB

Instances

Instances details

Show AddPerasCertResult Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods showsPrec ∷ Int → AddPerasCertResult → ShowS # show ∷ AddPerasCertResult → String # showList ∷ [AddPerasCertResult] → ShowS #
Eq AddPerasCertResult Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods (==) ∷ AddPerasCertResult → AddPerasCertResult → Bool # (/=) ∷ AddPerasCertResult → AddPerasCertResult → Bool #

`PerasCertSnapshot`

data PerasCertSnapshot blk Source #

Constructors

PerasCertSnapshot
Fields containsCert ∷ PerasRoundNo → Bool Do we have the certificate for this round? getCertsAfter ∷ PerasCertTicketNo → Map PerasCertTicketNo (WithArrivalTime (ValidatedPerasCert blk)) Get certificates after the given ticket number (excluded). The result is a map of ticket numbers to validated certificates.

data PerasCertTicketNo Source #

A sequence number, incremented every time we receive a new certificate.

Note that we will usually receive certificates monotonically by round number, so round numbers could almost fulfill the role of ticket numbers. However, in certain edge cases (while catching up, or during cooldowns), this might not be true, such as during syncing or during cooldown periods. Therefore, for robustness, we choose to maintain dedicated ticket numbers separately.

Instances

Instances details

Enum PerasCertTicketNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods succ ∷ PerasCertTicketNo → PerasCertTicketNo # pred ∷ PerasCertTicketNo → PerasCertTicketNo # toEnum ∷ Int → PerasCertTicketNo # fromEnum ∷ PerasCertTicketNo → Int # enumFrom ∷ PerasCertTicketNo → [PerasCertTicketNo] # enumFromThen ∷ PerasCertTicketNo → PerasCertTicketNo → [PerasCertTicketNo] # enumFromTo ∷ PerasCertTicketNo → PerasCertTicketNo → [PerasCertTicketNo] # enumFromThenTo ∷ PerasCertTicketNo → PerasCertTicketNo → PerasCertTicketNo → [PerasCertTicketNo] #
Show PerasCertTicketNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods showsPrec ∷ Int → PerasCertTicketNo → ShowS # show ∷ PerasCertTicketNo → String # showList ∷ [PerasCertTicketNo] → ShowS #
Eq PerasCertTicketNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods (==) ∷ PerasCertTicketNo → PerasCertTicketNo → Bool # (/=) ∷ PerasCertTicketNo → PerasCertTicketNo → Bool #
Ord PerasCertTicketNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods compare ∷ PerasCertTicketNo → PerasCertTicketNo → Ordering # (<) ∷ PerasCertTicketNo → PerasCertTicketNo → Bool # (<=) ∷ PerasCertTicketNo → PerasCertTicketNo → Bool # (>) ∷ PerasCertTicketNo → PerasCertTicketNo → Bool # (>=) ∷ PerasCertTicketNo → PerasCertTicketNo → Bool # max ∷ PerasCertTicketNo → PerasCertTicketNo → PerasCertTicketNo # min ∷ PerasCertTicketNo → PerasCertTicketNo → PerasCertTicketNo #
NoThunks PerasCertTicketNo Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasCertDB.API Methods noThunks ∷ Context → PerasCertTicketNo → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PerasCertTicketNo → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy PerasCertTicketNo → String Source #

zeroPerasCertTicketNo ∷ PerasCertTicketNo Source #