Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.PerasVoteDB.API

Contents

Exceptions
Invariants

Synopsis

data PerasVoteDB (m ∷ Type → Type) blk = PerasVoteDB {
- addVote ∷ WithArrivalTime (ValidatedPerasVote blk) → STM m (m (AddPerasVoteResult blk))
- getVoteIds ∷ STM m (Set PerasVoteId)
- getVotesAfter ∷ PerasVoteTicketNo → STM m (Map PerasVoteTicketNo (WithArrivalTime (ValidatedPerasVote blk)))
- getForgedCertForRound ∷ PerasRoundNo → STM m (Maybe (ValidatedPerasCert blk))
- garbageCollect ∷ SlotNo → STM m (m ())
}
data AddPerasVoteResult blk
data PerasVoteTicketNo
zeroPerasVoteTicketNo ∷ PerasVoteTicketNo
newtype ExistingPerasRoundWinner blk = ExistingPerasRoundWinner (Point blk, VoteWeight)
newtype BlockedPerasRoundWinner blk = BlockedPerasRoundWinner (Point blk, VoteWeight)
data PerasVoteDbError blk where
- MultipleWinnersInRound ∷ ∀ blk. PerasRoundNo → ExistingPerasRoundWinner blk → BlockedPerasRoundWinner blk → PerasVoteDbError blk
- ForgingCertError ∷ ∀ blk. PerasError blk → PerasVoteDbError blk
- EpochContextNotFoundForRound ∷ ∀ blk. PerasEpochContextNotFoundForRound → PerasVoteDbError blk
prop_addVoteThenGetVoteIds ∷ (MonadSTM m, IsPerasVote (PerasVote blk) blk) ⇒ PerasVoteDB m blk → WithArrivalTime (ValidatedPerasVote blk) → m Bool
prop_getVotesAfterZero ∷ (MonadSTM m, IsPerasVote (PerasVote blk) blk) ⇒ PerasVoteDB m blk → m Bool
prop_getVotesAfterMonotonic ∷ MonadSTM m ⇒ PerasVoteDB m blk → PerasVoteTicketNo → m Bool
prop_garbageCollectRemovesOldVotes ∷ (MonadSTM m, IsPerasVote (PerasVote blk) blk) ⇒ PerasVoteDB m blk → SlotNo → m Bool
prop_addVoteThenGetForgedCertForRound ∷ (MonadSTM m, Eq (PerasCert blk), IsPerasVote (PerasVote blk) 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)
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 ∷ SlotNo → STM m (m ())
Garbage-collect votes whose target slot is strictly smaller 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

Eq (PerasCert 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 #

Ord (PerasCert 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 #

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-4.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 #

Show (PerasCert 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 #

NoThunks (PerasCert 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-4.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

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 #

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] #

Generic PerasVoteTicketNo Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Associated Types

type Rep PerasVoteTicketNo
Instance details Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API type Rep PerasVoteTicketNo = D1 ('MetaData "PerasVoteTicketNo" "Ouroboros.Consensus.Storage.PerasVoteDB.API" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PerasVoteTicketNo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from ∷ PerasVoteTicketNo → Rep PerasVoteTicketNo x #

to ∷ Rep PerasVoteTicketNo x → PerasVoteTicketNo #

Show PerasVoteTicketNo Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

Methods

showsPrec ∷ Int → PerasVoteTicketNo → ShowS #

show ∷ PerasVoteTicketNo → String #

showList ∷ [PerasVoteTicketNo] → ShowS #

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 #

type Rep PerasVoteTicketNo Source #

Instance details

Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API

type Rep PerasVoteTicketNo = D1 ('MetaData "PerasVoteTicketNo" "Ouroboros.Consensus.Storage.PerasVoteDB.API" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PerasVoteTicketNo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

zeroPerasVoteTicketNo ∷ PerasVoteTicketNo Source #

Exceptions

newtype ExistingPerasRoundWinner blk Source #

Constructors

ExistingPerasRoundWinner (Point blk, VoteWeight)

Instances

Instances details

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

newtype BlockedPerasRoundWinner blk Source #

Constructors

BlockedPerasRoundWinner (Point blk, VoteWeight)

Instances

Instances details

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

data PerasVoteDbError blk where Source #

Constructors

MultipleWinnersInRound ∷ ∀ blk. PerasRoundNo → ExistingPerasRoundWinner blk → BlockedPerasRoundWinner blk → PerasVoteDbError blk	Attempted to add a vote that would lead to multiple winners for the same round
ForgingCertError ∷ ∀ blk. PerasError blk → PerasVoteDbError blk	An error occurred while forging a certificate
EpochContextNotFoundForRound ∷ ∀ blk. PerasEpochContextNotFoundForRound → PerasVoteDbError blk	The epoch context for the round of the vote could not be found

Instances

Instances details

(StandardHash blk, Show (PerasError blk), Typeable blk) ⇒ Exception (PerasVoteDbError blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API Methods toException ∷ PerasVoteDbError blk → SomeException # fromException ∷ SomeException → Maybe (PerasVoteDbError blk) # displayException ∷ PerasVoteDbError blk → String # backtraceDesired ∷ PerasVoteDbError blk → Bool #
(StandardHash blk, Show (PerasError blk)) ⇒ Show (PerasVoteDbError blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.PerasVoteDB.API Methods showsPrec ∷ Int → PerasVoteDbError blk → ShowS # show ∷ PerasVoteDbError blk → String # showList ∷ [PerasVoteDbError blk] → ShowS #

Invariants

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

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

prop_getVotesAfterZero ∷ (MonadSTM m, IsPerasVote (PerasVote blk) blk) ⇒ 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, IsPerasVote (PerasVote blk) blk) ⇒ PerasVoteDB m blk → SlotNo → m Bool Source #

After garbage collection for slot S, no votes with target slot < S should remain.

prop_addVoteThenGetForgedCertForRound ∷ (MonadSTM m, Eq (PerasCert blk), IsPerasVote (PerasVote blk) 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.