Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.PerasVoteDB.API

Contents

Invariants

Synopsis

data PerasVoteDB (m ∷ Type → Type) blk = PerasVoteDB {
- addVote ∷ WithArrivalTime (ValidatedPerasVote blk) → STM m (m (AddPerasVoteResult blk))
- getVoteIds ∷ STM m (Set (PerasVoteId blk))
- getVotesAfter ∷ PerasVoteTicketNo → STM m (Map PerasVoteTicketNo (WithArrivalTime (ValidatedPerasVote blk)))
- getForgedCertForRound ∷ PerasRoundNo → STM m (Maybe (ValidatedPerasCert blk))
- garbageCollect ∷ PerasRoundNo → STM m (m ())
}
data AddPerasVoteResult blk
data PerasVoteTicketNo
zeroPerasVoteTicketNo ∷ PerasVoteTicketNo
prop_addVoteThenGetVoteIds ∷ MonadSTM m ⇒ PerasVoteDB m blk → WithArrivalTime (ValidatedPerasVote blk) → m Bool
prop_getVotesAfterZero ∷ MonadSTM m ⇒ PerasVoteDB m blk → m Bool
prop_getVotesAfterMonotonic ∷ MonadSTM m ⇒ PerasVoteDB m blk → PerasVoteTicketNo → m Bool
prop_garbageCollectRemovesOldVotes ∷ MonadSTM m ⇒ PerasVoteDB m blk → PerasRoundNo → m Bool
prop_addVoteThenGetForgedCertForRound ∷ (MonadSTM m, StandardHash blk) ⇒ PerasVoteDB m blk → WithArrivalTime (ValidatedPerasVote blk) → m Bool

Documentation

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

Constructors

PerasVoteDB

Fields

addVote ∷ WithArrivalTime (ValidatedPerasVote blk) → STM m (m (AddPerasVoteResult blk))
Add a Peras vote to the database. The result indicates whether the vote was actually added, or if it was already present.
NOTE: the resulting computation over m is there solely for tracing purposes. Use the `join . atomically` pattern to consume its output.
getVoteIds ∷ STM m (Set (PerasVoteId blk))
Get the set of all vote IDs currently in the database.
getVotesAfter ∷ PerasVoteTicketNo → STM m (Map PerasVoteTicketNo (WithArrivalTime (ValidatedPerasVote blk)))
Get all votes with a ticket number strictly greater than the given one, in ascending order.
getForgedCertForRound ∷ PerasRoundNo → STM m (Maybe (ValidatedPerasCert blk))
Get the certificate if quorum was reached for the given round.
garbageCollect ∷ PerasRoundNo → STM m (m ())
Garbage-collect state strictly older than the given slot number.
NOTE: the resulting computation over m is there solely for tracing purposes. Use the `join . atomically` pattern to consume its output.

Instances

Instances details

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

data AddPerasVoteResult blk Source #

Constructors

PerasVoteAlreadyInDB
AddedPerasVoteButDidntGenerateNewCert
AddedPerasVoteAndGeneratedNewCert (ValidatedPerasCert blk)

Instances

Instances details

Generic (AddPerasVoteResult blk) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Associated Types

type Rep (AddPerasVoteResult blk)

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

type Rep (AddPerasVoteResult blk) = D1 ('MetaData "AddPerasVoteResult" "Ouroboros.Consensus.Storage.PerasVoteDB.API" "ouroboros-consensus-1.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVoteAlreadyInDB" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "AddedPerasVoteButDidntGenerateNewCert" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AddedPerasVoteAndGeneratedNewCert" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ValidatedPerasCert blk)))))

Methods

from ∷ AddPerasVoteResult blk → Rep (AddPerasVoteResult blk) x #

to ∷ Rep (AddPerasVoteResult blk) x → AddPerasVoteResult blk #

StandardHash blk ⇒ Show (AddPerasVoteResult blk) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Methods

showsPrec ∷ Int → AddPerasVoteResult blk → ShowS #

show ∷ AddPerasVoteResult blk → String #

showList ∷ [AddPerasVoteResult blk] → ShowS #

StandardHash blk ⇒ Eq (AddPerasVoteResult blk) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Methods

(==) ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Bool #

(/=) ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Bool #

StandardHash blk ⇒ Ord (AddPerasVoteResult blk) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Methods

compare ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Ordering #

(<) ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Bool #

(<=) ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Bool #

(>) ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Bool #

(>=) ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → Bool #

max ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → AddPerasVoteResult blk #

min ∷ AddPerasVoteResult blk → AddPerasVoteResult blk → AddPerasVoteResult blk #

StandardHash blk ⇒ NoThunks (AddPerasVoteResult blk) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Methods

noThunks ∷ Context → AddPerasVoteResult blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → AddPerasVoteResult blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (AddPerasVoteResult blk) → String Source #

type Rep (AddPerasVoteResult blk) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

type Rep (AddPerasVoteResult blk) = D1 ('MetaData "AddPerasVoteResult" "Ouroboros.Consensus.Storage.PerasVoteDB.API" "ouroboros-consensus-1.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVoteAlreadyInDB" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "AddedPerasVoteButDidntGenerateNewCert" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "AddedPerasVoteAndGeneratedNewCert" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ValidatedPerasCert blk)))))

data PerasVoteTicketNo Source #

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

Instances

Instances details

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

zeroPerasVoteTicketNo ∷ PerasVoteTicketNo Source #

Invariants

prop_addVoteThenGetVoteIds ∷ MonadSTM m ⇒ PerasVoteDB m blk → WithArrivalTime (ValidatedPerasVote blk) → m Bool Source #

After adding a vote, its ID should be present in getVoteIds.

prop_getVotesAfterZero ∷ MonadSTM m ⇒ PerasVoteDB m blk → m Bool Source #

getVotesAfter with ticket 0 should return all votes in the database.

prop_getVotesAfterMonotonic ∷ MonadSTM m ⇒ PerasVoteDB m blk → PerasVoteTicketNo → m Bool Source #

getVotesAfter returns strictly increasing ticket numbers.

prop_garbageCollectRemovesOldVotes ∷ MonadSTM m ⇒ PerasVoteDB m blk → PerasRoundNo → m Bool Source #

After garbage collection for round N, no votes for rounds <N should remain.

prop_addVoteThenGetForgedCertForRound ∷ (MonadSTM m, StandardHash blk) ⇒ PerasVoteDB m blk → WithArrivalTime (ValidatedPerasVote blk) → m Bool Source #

When adding a vote results in a certificate just being forged for a round, this certificate should also be retrievable via getForgedCertForRound.