Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Protocol.PBFT

Contents

Forging
Classes
CannotForge
Type instances
Exported for tracing errors

Synopsis

data PBft c
data PBftCanBeLeader c = PBftCanBeLeader {
- pbftCanBeLeaderCoreNodeId ∷ !CoreNodeId
- pbftCanBeLeaderSignKey ∷ !(SignKeyDSIGN (PBftDSIGN c))
- pbftCanBeLeaderDlgCert ∷ !(PBftDelegationCert c)
}
data PBftFields c toSign = PBftFields {
- pbftIssuer ∷ VerKeyDSIGN (PBftDSIGN c)
- pbftGenKey ∷ VerKeyDSIGN (PBftDSIGN c)
- pbftSignature ∷ SignedDSIGN (PBftDSIGN c) toSign
}
data PBftIsLeader c = PBftIsLeader {
- pbftIsLeaderSignKey ∷ !(SignKeyDSIGN (PBftDSIGN c))
- pbftIsLeaderDlgCert ∷ !(PBftDelegationCert c)
}
newtype PBftLedgerView c = PBftLedgerView {
- pbftDelegates ∷ Bimap (PBftVerKeyHash c) (PBftVerKeyHash c)
}
data PBftParams = PBftParams {
- pbftSecurityParam ∷ !SecurityParam
- pbftNumNodes ∷ !NumCoreNodes
- pbftSignatureThreshold ∷ !PBftSignatureThreshold
}
data PBftSelectView = PBftSelectView {
- pbftSelectViewBlockNo ∷ BlockNo
- pbftSelectViewIsEBB ∷ IsEBB
}
newtype PBftSignatureThreshold = PBftSignatureThreshold {
- getPBftSignatureThreshold ∷ Double
}
mkPBftSelectView ∷ GetHeader blk ⇒ Header blk → PBftSelectView
pbftWindowExceedsThreshold ∷ PBftCrypto c ⇒ PBftWindowParams → PBftState c → PBftVerKeyHash c → Either Word64 ()
pbftWindowSize ∷ SecurityParam → WindowSize
forgePBftFields ∷ (PBftCrypto c, Signable (PBftDSIGN c) toSign) ⇒ (VerKeyDSIGN (PBftDSIGN c) → ContextDSIGN (PBftDSIGN c)) → IsLeader (PBft c) → toSign → PBftFields c toSign
class (Typeable c, DSIGNAlgorithm (PBftDSIGN c), Condense (SigDSIGN (PBftDSIGN c)), Show (PBftVerKeyHash c), Ord (PBftVerKeyHash c), Eq (PBftVerKeyHash c), Show (PBftVerKeyHash c), NoThunks (PBftVerKeyHash c), NoThunks (PBftDelegationCert c), Serialise (PBftVerKeyHash c)) ⇒ PBftCrypto c where
- type PBftDSIGN c
- type PBftDelegationCert c = (d ∷ Type) | d → c
- type PBftVerKeyHash c = (d ∷ Type) | d → c
- dlgCertGenVerKey ∷ PBftDelegationCert c → VerKeyDSIGN (PBftDSIGN c)
- dlgCertDlgVerKey ∷ PBftDelegationCert c → VerKeyDSIGN (PBftDSIGN c)
- hashVerKey ∷ VerKeyDSIGN (PBftDSIGN c) → PBftVerKeyHash c
data PBftMockCrypto
newtype PBftMockVerKeyHash = PBftMockVerKeyHash {
- getPBftMockVerKeyHash ∷ VerKeyDSIGN MockDSIGN
}
data PBftValidateView c
- = Signable (PBftDSIGN c) signed ⇒ PBftValidateRegular (PBftFields c signed) signed (ContextDSIGN (PBftDSIGN c))
- | PBftValidateBoundary
pbftValidateBoundary ∷ hdr → PBftValidateView c
pbftValidateRegular ∷ (SignedHeader hdr, Signable (PBftDSIGN c) (Signed hdr)) ⇒ ContextDSIGN (PBftDSIGN c) → (hdr → PBftFields c (Signed hdr)) → hdr → PBftValidateView c
data PBftCannotForge c
- = PBftCannotForgeInvalidDelegation !(PBftVerKeyHash c)
- | PBftCannotForgeThresholdExceeded !Word64
pbftCheckCanForge ∷ PBftCrypto c ⇒ ConsensusConfig (PBft c) → PBftCanBeLeader c → SlotNo → Ticked (PBftState c) → Either (PBftCannotForge c) ()
data family ConsensusConfig p
data family Ticked (st ∷ k) ∷ k
data PBftValidationErr c
- = PBftInvalidSignature !Text
- | PBftNotGenesisDelegate !(PBftVerKeyHash c) !(PBftLedgerView c)
- | PBftExceededSignThreshold !(PBftVerKeyHash c) !Word64
- | PBftInvalidSlot

Documentation

data PBft c Source #

Permissive BFT

As defined in https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/byronChainSpec/latest/download-by-type/doc-pdf/blockchain-spec

Instances

Instances details

Generic (ConsensusConfig (PBft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (ConsensusConfig (PBft c))
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))

Methods

from ∷ ConsensusConfig (PBft c) → Rep (ConsensusConfig (PBft c)) x #

to ∷ Rep (ConsensusConfig (PBft c)) x → ConsensusConfig (PBft c) #

NoThunks (ConsensusConfig (PBft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (PBft c)) → String Source #

PBftCrypto c ⇒ ConsensusProtocol (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type ChainDepState (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type ChainDepState (PBft c) = PBftState c
type IsLeader (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type IsLeader (PBft c) = PBftIsLeader c
type CanBeLeader (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type CanBeLeader (PBft c) = PBftCanBeLeader c
type SelectView (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type SelectView (PBft c) = PBftSelectView
type LedgerView (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type LedgerView (PBft c) = PBftLedgerView c
type ValidationErr (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type ValidationErr (PBft c) = PBftValidationErr c
type ValidateView (PBft c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type ValidateView (PBft c) = PBftValidateView c

Methods

checkIsLeader ∷ ConsensusConfig (PBft c) → CanBeLeader (PBft c) → SlotNo → Ticked (ChainDepState (PBft c)) → Maybe (IsLeader (PBft c)) Source #

tickChainDepState ∷ ConsensusConfig (PBft c) → LedgerView (PBft c) → SlotNo → ChainDepState (PBft c) → Ticked (ChainDepState (PBft c)) Source #

updateChainDepState ∷ ConsensusConfig (PBft c) → ValidateView (PBft c) → SlotNo → Ticked (ChainDepState (PBft c)) → Except (ValidationErr (PBft c)) (ChainDepState (PBft c)) Source #

reupdateChainDepState ∷ ConsensusConfig (PBft c) → ValidateView (PBft c) → SlotNo → Ticked (ChainDepState (PBft c)) → ChainDepState (PBft c) Source #

protocolSecurityParam ∷ ConsensusConfig (PBft c) → SecurityParam Source #

type Rep (ConsensusConfig (PBft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))

type CanBeLeader (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type CanBeLeader (PBft c) = PBftCanBeLeader c

type ChainDepState (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type ChainDepState (PBft c) = PBftState c

newtype ConsensusConfig (PBft c) Source #

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

newtype ConsensusConfig (PBft c) = PBftConfig {

pbftParams ∷ PBftParams

}

type IsLeader (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type IsLeader (PBft c) = PBftIsLeader c

type LedgerView (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type LedgerView (PBft c) = PBftLedgerView c

type SelectView (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type SelectView (PBft c) = PBftSelectView

type ValidateView (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type ValidateView (PBft c) = PBftValidateView c

type ValidationErr (PBft c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type ValidationErr (PBft c) = PBftValidationErr c

data PBftCanBeLeader c Source #

If we are a core node (i.e. a block producing node) we know which core node we are, and we have the operational key pair and delegation certificate.

Constructors

PBftCanBeLeader
Fields pbftCanBeLeaderCoreNodeId ∷ !CoreNodeId pbftCanBeLeaderSignKey ∷ !(SignKeyDSIGN (PBftDSIGN c)) pbftCanBeLeaderDlgCert ∷ !(PBftDelegationCert c)

Instances

Instances details

Generic (PBftCanBeLeader c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (PBftCanBeLeader c)

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftCanBeLeader c) = D1 ('MetaData "PBftCanBeLeader" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftCanBeLeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftCanBeLeaderCoreNodeId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CoreNodeId) :*: (S1 ('MetaSel ('Just "pbftCanBeLeaderSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (PBftDSIGN c))) :*: S1 ('MetaSel ('Just "pbftCanBeLeaderDlgCert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PBftDelegationCert c)))))

Methods

from ∷ PBftCanBeLeader c → Rep (PBftCanBeLeader c) x #

to ∷ Rep (PBftCanBeLeader c) x → PBftCanBeLeader c #

PBftCrypto c ⇒ NoThunks (PBftCanBeLeader c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftCanBeLeader c → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftCanBeLeader c → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PBftCanBeLeader c) → String Source #

type Rep (PBftCanBeLeader c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftCanBeLeader c) = D1 ('MetaData "PBftCanBeLeader" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftCanBeLeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftCanBeLeaderCoreNodeId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CoreNodeId) :*: (S1 ('MetaSel ('Just "pbftCanBeLeaderSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (PBftDSIGN c))) :*: S1 ('MetaSel ('Just "pbftCanBeLeaderDlgCert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PBftDelegationCert c)))))

data PBftFields c toSign Source #

Constructors

PBftFields
Fields pbftIssuer ∷ VerKeyDSIGN (PBftDSIGN c) The actual issuer of a block pbftGenKey ∷ VerKeyDSIGN (PBftDSIGN c) The stakeholder on whose behalf the block is being issued pbftSignature ∷ SignedDSIGN (PBftDSIGN c) toSign

Instances

Instances details

Generic (PBftFields c toSign) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (PBftFields c toSign)

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftFields c toSign) = D1 ('MetaData "PBftFields" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftIssuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyDSIGN (PBftDSIGN c))) :*: (S1 ('MetaSel ('Just "pbftGenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyDSIGN (PBftDSIGN c))) :*: S1 ('MetaSel ('Just "pbftSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SignedDSIGN (PBftDSIGN c) toSign)))))

Methods

from ∷ PBftFields c toSign → Rep (PBftFields c toSign) x #

to ∷ Rep (PBftFields c toSign) x → PBftFields c toSign #

PBftCrypto c ⇒ Show (PBftFields c toSign) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftFields c toSign → ShowS #

show ∷ PBftFields c toSign → String #

showList ∷ [PBftFields c toSign] → ShowS #

PBftCrypto c ⇒ Eq (PBftFields c toSign) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

(==) ∷ PBftFields c toSign → PBftFields c toSign → Bool #

(/=) ∷ PBftFields c toSign → PBftFields c toSign → Bool #

(PBftCrypto c, Typeable toSign) ⇒ NoThunks (PBftFields c toSign) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftFields c toSign → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftFields c toSign → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PBftFields c toSign) → String Source #

PBftCrypto c ⇒ Condense (PBftFields c toSign) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

condense ∷ PBftFields c toSign → String Source #

type Rep (PBftFields c toSign) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftFields c toSign) = D1 ('MetaData "PBftFields" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftIssuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyDSIGN (PBftDSIGN c))) :*: (S1 ('MetaSel ('Just "pbftGenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyDSIGN (PBftDSIGN c))) :*: S1 ('MetaSel ('Just "pbftSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SignedDSIGN (PBftDSIGN c) toSign)))))

data PBftIsLeader c Source #

Information required to produce a block.

Constructors

PBftIsLeader
Fields pbftIsLeaderSignKey ∷ !(SignKeyDSIGN (PBftDSIGN c)) pbftIsLeaderDlgCert ∷ !(PBftDelegationCert c)

Instances

Instances details

Generic (PBftIsLeader c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (PBftIsLeader c)

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftIsLeader c) = D1 ('MetaData "PBftIsLeader" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftIsLeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftIsLeaderSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (PBftDSIGN c))) :*: S1 ('MetaSel ('Just "pbftIsLeaderDlgCert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PBftDelegationCert c))))

Methods

from ∷ PBftIsLeader c → Rep (PBftIsLeader c) x #

to ∷ Rep (PBftIsLeader c) x → PBftIsLeader c #

PBftCrypto c ⇒ NoThunks (PBftIsLeader c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftIsLeader c → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftIsLeader c → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PBftIsLeader c) → String Source #

type Rep (PBftIsLeader c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftIsLeader c) = D1 ('MetaData "PBftIsLeader" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftIsLeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftIsLeaderSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (PBftDSIGN c))) :*: S1 ('MetaSel ('Just "pbftIsLeaderDlgCert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PBftDelegationCert c))))

newtype PBftLedgerView c Source #

Constructors

PBftLedgerView
Fields pbftDelegates ∷ Bimap (PBftVerKeyHash c) (PBftVerKeyHash c) ProtocolParameters: map from genesis to delegate keys.

Instances

Instances details

Generic (PBftLedgerView c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (PBftLedgerView c)

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftLedgerView c) = D1 ('MetaData "PBftLedgerView" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftLedgerView" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftDelegates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bimap (PBftVerKeyHash c) (PBftVerKeyHash c)))))

Methods

from ∷ PBftLedgerView c → Rep (PBftLedgerView c) x #

to ∷ Rep (PBftLedgerView c) x → PBftLedgerView c #

Show (PBftVerKeyHash c) ⇒ Show (PBftLedgerView c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftLedgerView c → ShowS #

show ∷ PBftLedgerView c → String #

showList ∷ [PBftLedgerView c] → ShowS #

Eq (PBftVerKeyHash c) ⇒ Eq (PBftLedgerView c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

(==) ∷ PBftLedgerView c → PBftLedgerView c → Bool #

(/=) ∷ PBftLedgerView c → PBftLedgerView c → Bool #

PBftCrypto c ⇒ NoThunks (PBftLedgerView c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftLedgerView c → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftLedgerView c → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PBftLedgerView c) → String Source #

(Serialise (PBftVerKeyHash c), Ord (PBftVerKeyHash c)) ⇒ Serialise (PBftLedgerView c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

encode ∷ PBftLedgerView c → Encoding Source #

decode ∷ Decoder s (PBftLedgerView c) Source #

encodeList ∷ [PBftLedgerView c] → Encoding Source #

decodeList ∷ Decoder s [PBftLedgerView c] Source #

type Rep (PBftLedgerView c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftLedgerView c) = D1 ('MetaData "PBftLedgerView" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftLedgerView" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftDelegates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bimap (PBftVerKeyHash c) (PBftVerKeyHash c)))))

data PBftParams Source #

Protocol parameters

Constructors

PBftParams

Fields

pbftSecurityParam ∷ !SecurityParam
Security parameter
Although the protocol proper does not have such a security parameter, we insist on it.
pbftNumNodes ∷ !NumCoreNodes
Number of core nodes
pbftSignatureThreshold ∷ !PBftSignatureThreshold
Signature threshold
This bounds the proportion of the latest pbftSecurityParam-many blocks which is allowed to be signed by any single key. The protocol proper is parameterized over the size of this window of recent blocks, but this implementation follows the specification by fixing that parameter to the ambient security parameter k.

Instances

Instances details

Generic PBftParams Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep PBftParams

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep PBftParams = D1 ('MetaData "PBftParams" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "pbftNumNodes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NumCoreNodes) :*: S1 ('MetaSel ('Just "pbftSignatureThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PBftSignatureThreshold))))

Methods

from ∷ PBftParams → Rep PBftParams x #

to ∷ Rep PBftParams x → PBftParams #

Show PBftParams Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftParams → ShowS #

show ∷ PBftParams → String #

showList ∷ [PBftParams] → ShowS #

NoThunks PBftParams Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftParams → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftParams → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PBftParams → String Source #

type Rep PBftParams Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep PBftParams = D1 ('MetaData "PBftParams" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "pbftNumNodes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NumCoreNodes) :*: S1 ('MetaSel ('Just "pbftSignatureThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PBftSignatureThreshold))))

data PBftSelectView Source #

Part of the header required for chain selection

EBBs share a block number with regular blocks, and so for chain selection we need to know if a block is an EBB or not (because a chain ending on an EBB with a particular block number is longer than a chain on a regular block with that same block number).

Constructors

PBftSelectView
Fields pbftSelectViewBlockNo ∷ BlockNo pbftSelectViewIsEBB ∷ IsEBB

Instances

Instances details

Generic PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep PBftSelectView

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep PBftSelectView = D1 ('MetaData "PBftSelectView" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftSelectView" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftSelectViewBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockNo) :*: S1 ('MetaSel ('Just "pbftSelectViewIsEBB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IsEBB)))

Methods

from ∷ PBftSelectView → Rep PBftSelectView x #

to ∷ Rep PBftSelectView x → PBftSelectView #

Show PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftSelectView → ShowS #

show ∷ PBftSelectView → String #

showList ∷ [PBftSelectView] → ShowS #

Eq PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

(==) ∷ PBftSelectView → PBftSelectView → Bool #

(/=) ∷ PBftSelectView → PBftSelectView → Bool #

Ord PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

compare ∷ PBftSelectView → PBftSelectView → Ordering #

(<) ∷ PBftSelectView → PBftSelectView → Bool #

(<=) ∷ PBftSelectView → PBftSelectView → Bool #

(>) ∷ PBftSelectView → PBftSelectView → Bool #

(>=) ∷ PBftSelectView → PBftSelectView → Bool #

max ∷ PBftSelectView → PBftSelectView → PBftSelectView #

min ∷ PBftSelectView → PBftSelectView → PBftSelectView #

NoThunks PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftSelectView → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftSelectView → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PBftSelectView → String Source #

ChainOrder PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type ChainOrderConfig PBftSelectView
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type ChainOrderConfig PBftSelectView = ChainOrderConfig (SimpleChainOrder PBftSelectView)

Methods

preferCandidate ∷ ChainOrderConfig PBftSelectView → PBftSelectView → PBftSelectView → Bool Source #

type Rep PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep PBftSelectView = D1 ('MetaData "PBftSelectView" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftSelectView" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftSelectViewBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockNo) :*: S1 ('MetaSel ('Just "pbftSelectViewIsEBB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IsEBB)))

type ChainOrderConfig PBftSelectView Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type ChainOrderConfig PBftSelectView = ChainOrderConfig (SimpleChainOrder PBftSelectView)

newtype PBftSignatureThreshold Source #

Signature threshold. This represents the proportion of blocks in a pbftSignatureWindow-sized window which may be signed by any single key.

Constructors

PBftSignatureThreshold
Fields getPBftSignatureThreshold ∷ Double

Instances

Instances details

Generic PBftSignatureThreshold Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type Rep PBftSignatureThreshold = D1 ('MetaData "PBftSignatureThreshold" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftSignatureThreshold" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftSignatureThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

Methods

from ∷ PBftSignatureThreshold → Rep PBftSignatureThreshold x #

to ∷ Rep PBftSignatureThreshold x → PBftSignatureThreshold #

Show PBftSignatureThreshold Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftSignatureThreshold → ShowS #

show ∷ PBftSignatureThreshold → String #

showList ∷ [PBftSignatureThreshold] → ShowS #

Eq PBftSignatureThreshold Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

(==) ∷ PBftSignatureThreshold → PBftSignatureThreshold → Bool #

(/=) ∷ PBftSignatureThreshold → PBftSignatureThreshold → Bool #

NoThunks PBftSignatureThreshold Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftSignatureThreshold → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftSignatureThreshold → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PBftSignatureThreshold → String Source #

type Rep PBftSignatureThreshold Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep PBftSignatureThreshold = D1 ('MetaData "PBftSignatureThreshold" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftSignatureThreshold" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftSignatureThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

mkPBftSelectView ∷ GetHeader blk ⇒ Header blk → PBftSelectView Source #

pbftWindowExceedsThreshold ∷ PBftCrypto c ⇒ PBftWindowParams → PBftState c → PBftVerKeyHash c → Either Word64 () Source #

Does the number of blocks signed by this key exceed the threshold?

Returns Just the number of blocks signed if exceeded.

pbftWindowSize ∷ SecurityParam → WindowSize Source #

Window size used by PBFT

We set the window size to be equal to k.

Forging

forgePBftFields Source #

Arguments

∷ (PBftCrypto c, Signable (PBftDSIGN c) toSign)
⇒ (VerKeyDSIGN (PBftDSIGN c) → ContextDSIGN (PBftDSIGN c))	Construct DSIGN context given `pbftGenKey`
→ IsLeader (PBft c)
→ toSign
→ PBftFields c toSign

Classes

class (Typeable c, DSIGNAlgorithm (PBftDSIGN c), Condense (SigDSIGN (PBftDSIGN c)), Show (PBftVerKeyHash c), Ord (PBftVerKeyHash c), Eq (PBftVerKeyHash c), Show (PBftVerKeyHash c), NoThunks (PBftVerKeyHash c), NoThunks (PBftDelegationCert c), Serialise (PBftVerKeyHash c)) ⇒ PBftCrypto c where Source #

Crypto primitives required by BFT

Cardano stores a map of stakeholder IDs rather than the verification key directly. We make this family injective for convenience - whilst it's _possible_ that there could be non-injective instances, the chances of there being more than the two instances here are basically non-existent.

Associated Types

type PBftDSIGN c Source #

type PBftDelegationCert c = (d ∷ Type) | d → c Source #

type PBftVerKeyHash c = (d ∷ Type) | d → c Source #

Methods

dlgCertGenVerKey ∷ PBftDelegationCert c → VerKeyDSIGN (PBftDSIGN c) Source #

dlgCertDlgVerKey ∷ PBftDelegationCert c → VerKeyDSIGN (PBftDSIGN c) Source #

hashVerKey ∷ VerKeyDSIGN (PBftDSIGN c) → PBftVerKeyHash c Source #

Instances

Instances details

PBftCrypto PBftMockCrypto Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Associated Types

type PBftDSIGN PBftMockCrypto
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto type PBftDSIGN PBftMockCrypto = MockDSIGN
type PBftDelegationCert PBftMockCrypto
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto type PBftDelegationCert PBftMockCrypto = (VerKeyDSIGN MockDSIGN, VerKeyDSIGN MockDSIGN)
type PBftVerKeyHash PBftMockCrypto
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto type PBftVerKeyHash PBftMockCrypto = PBftMockVerKeyHash

data PBftMockCrypto Source #

Instances

Instances details

PBftCrypto PBftMockCrypto Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Associated Types

type PBftDSIGN PBftMockCrypto
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto type PBftDSIGN PBftMockCrypto = MockDSIGN
type PBftDelegationCert PBftMockCrypto
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto type PBftDelegationCert PBftMockCrypto = (VerKeyDSIGN MockDSIGN, VerKeyDSIGN MockDSIGN)
type PBftVerKeyHash PBftMockCrypto
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto type PBftVerKeyHash PBftMockCrypto = PBftMockVerKeyHash

type PBftDSIGN PBftMockCrypto Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

type PBftDSIGN PBftMockCrypto = MockDSIGN

type PBftDelegationCert PBftMockCrypto Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

type PBftDelegationCert PBftMockCrypto = (VerKeyDSIGN MockDSIGN, VerKeyDSIGN MockDSIGN)

type PBftVerKeyHash PBftMockCrypto Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

type PBftVerKeyHash PBftMockCrypto = PBftMockVerKeyHash

newtype PBftMockVerKeyHash Source #

We don't hash and just use the underlying Word64.

Constructors

PBftMockVerKeyHash
Fields getPBftMockVerKeyHash ∷ VerKeyDSIGN MockDSIGN

Instances

Instances details

Generic PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Associated Types

type Rep PBftMockVerKeyHash

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

type Rep PBftMockVerKeyHash = D1 ('MetaData "PBftMockVerKeyHash" "Ouroboros.Consensus.Protocol.PBFT.Crypto" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftMockVerKeyHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftMockVerKeyHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyDSIGN MockDSIGN))))

Methods

from ∷ PBftMockVerKeyHash → Rep PBftMockVerKeyHash x #

to ∷ Rep PBftMockVerKeyHash x → PBftMockVerKeyHash #

Show PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Methods

showsPrec ∷ Int → PBftMockVerKeyHash → ShowS #

show ∷ PBftMockVerKeyHash → String #

showList ∷ [PBftMockVerKeyHash] → ShowS #

Eq PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Methods

(==) ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Bool #

(/=) ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Bool #

Ord PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Methods

compare ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Ordering #

(<) ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Bool #

(<=) ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Bool #

(>) ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Bool #

(>=) ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → Bool #

max ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → PBftMockVerKeyHash #

min ∷ PBftMockVerKeyHash → PBftMockVerKeyHash → PBftMockVerKeyHash #

NoThunks PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Methods

noThunks ∷ Context → PBftMockVerKeyHash → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftMockVerKeyHash → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PBftMockVerKeyHash → String Source #

Serialise PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

Methods

encode ∷ PBftMockVerKeyHash → Encoding Source #

decode ∷ Decoder s PBftMockVerKeyHash Source #

encodeList ∷ [PBftMockVerKeyHash] → Encoding Source #

decodeList ∷ Decoder s [PBftMockVerKeyHash] Source #

type Rep PBftMockVerKeyHash Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT.Crypto

type Rep PBftMockVerKeyHash = D1 ('MetaData "PBftMockVerKeyHash" "Ouroboros.Consensus.Protocol.PBFT.Crypto" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftMockVerKeyHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftMockVerKeyHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyDSIGN MockDSIGN))))

data PBftValidateView c Source #

Part of the header that we validate

Constructors

Signable (PBftDSIGN c) signed ⇒ PBftValidateRegular (PBftFields c signed) signed (ContextDSIGN (PBftDSIGN c))

Regular block

Regular blocks are signed, and so we need to validate them. We also need to know the slot number of the block

PBftValidateBoundary

Boundary block (EBB)

EBBs are not signed and they do not affect the consensus state.

pbftValidateBoundary ∷ hdr → PBftValidateView c Source #

Convenience constructor for PBftValidateView for boundary blocks

pbftValidateRegular ∷ (SignedHeader hdr, Signable (PBftDSIGN c) (Signed hdr)) ⇒ ContextDSIGN (PBftDSIGN c) → (hdr → PBftFields c (Signed hdr)) → hdr → PBftValidateView c Source #

Convenience constructor for PBftValidateView for regular blocks

CannotForge

data PBftCannotForge c Source #

Expresses that, whilst we believe ourselves to be a leader for this slot, we are nonetheless unable to forge a block.

Constructors

PBftCannotForgeInvalidDelegation !(PBftVerKeyHash c)	We cannot forge a block because we are not the current delegate of the genesis key we have a delegation certificate from.
PBftCannotForgeThresholdExceeded !Word64	We cannot lead because delegates of the genesis key we have a delegation from have already forged the maximum number of blocks in this signing window.

Instances

Instances details

Generic (PBftCannotForge c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (PBftCannotForge c)

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftCannotForge c) = D1 ('MetaData "PBftCannotForge" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftCannotForgeInvalidDelegation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PBftVerKeyHash c))) :+: C1 ('MetaCons "PBftCannotForgeThresholdExceeded" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)))

Methods

from ∷ PBftCannotForge c → Rep (PBftCannotForge c) x #

to ∷ Rep (PBftCannotForge c) x → PBftCannotForge c #

PBftCrypto c ⇒ Show (PBftCannotForge c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftCannotForge c → ShowS #

show ∷ PBftCannotForge c → String #

showList ∷ [PBftCannotForge c] → ShowS #

PBftCrypto c ⇒ NoThunks (PBftCannotForge c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftCannotForge c → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PBftCannotForge c → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PBftCannotForge c) → String Source #

type Rep (PBftCannotForge c) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (PBftCannotForge c) = D1 ('MetaData "PBftCannotForge" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "PBftCannotForgeInvalidDelegation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PBftVerKeyHash c))) :+: C1 ('MetaCons "PBftCannotForgeThresholdExceeded" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)))

pbftCheckCanForge ∷ PBftCrypto c ⇒ ConsensusConfig (PBft c) → PBftCanBeLeader c → SlotNo → Ticked (PBftState c) → Either (PBftCannotForge c) () Source #

Type instances

data family ConsensusConfig p Source #

Static configuration required to run the consensus protocol

Every method in the ConsensusProtocol class takes the consensus configuration as a parameter, so having this as a data family rather than a type family resolves most ambiguity.

Defined out of the class so that protocols can define this type without having to define the entire protocol at the same time (or indeed in the same module).

Instances

Instances details

Generic (ConsensusConfig (HardForkProtocol xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Associated Types

type Rep (ConsensusConfig (HardForkProtocol xs))

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

type Rep (ConsensusConfig (HardForkProtocol xs)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.HardFork.Combinator.Basics" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "HardForkConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardForkConsensusConfigK") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "hardForkConsensusConfigShape") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Shape xs)) :*: S1 ('MetaSel ('Just "hardForkConsensusConfigPerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerEraConsensusConfig xs)))))

Methods

from ∷ ConsensusConfig (HardForkProtocol xs) → Rep (ConsensusConfig (HardForkProtocol xs)) x #

to ∷ Rep (ConsensusConfig (HardForkProtocol xs)) x → ConsensusConfig (HardForkProtocol xs) #

Generic (ConsensusConfig (Bft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

Associated Types

type Rep (ConsensusConfig (Bft c))

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

type Rep (ConsensusConfig (Bft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.BFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "BftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "bftParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BftParams) :*: (S1 ('MetaSel ('Just "bftSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (BftDSIGN c))) :*: S1 ('MetaSel ('Just "bftVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map NodeId (VerKeyDSIGN (BftDSIGN c)))))))

Methods

from ∷ ConsensusConfig (Bft c) → Rep (ConsensusConfig (Bft c)) x #

to ∷ Rep (ConsensusConfig (Bft c)) x → ConsensusConfig (Bft c) #

Generic (ConsensusConfig (ModChainSel p s)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

Associated Types

type Rep (ConsensusConfig (ModChainSel p s))

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

type Rep (ConsensusConfig (ModChainSel p s)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))

Methods

from ∷ ConsensusConfig (ModChainSel p s) → Rep (ConsensusConfig (ModChainSel p s)) x #

to ∷ Rep (ConsensusConfig (ModChainSel p s)) x → ConsensusConfig (ModChainSel p s) #

Generic (ConsensusConfig (PBft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep (ConsensusConfig (PBft c))
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))

Methods

from ∷ ConsensusConfig (PBft c) → Rep (ConsensusConfig (PBft c)) x #

to ∷ Rep (ConsensusConfig (PBft c)) x → ConsensusConfig (PBft c) #

CanHardFork xs ⇒ NoThunks (ConsensusConfig (HardForkProtocol xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

noThunks ∷ Context → ConsensusConfig (HardForkProtocol xs) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (HardForkProtocol xs) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (HardForkProtocol xs)) → String Source #

BftCrypto c ⇒ NoThunks (ConsensusConfig (Bft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

Methods

noThunks ∷ Context → ConsensusConfig (Bft c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (Bft c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (Bft c)) → String Source #

ConsensusProtocol p ⇒ NoThunks (ConsensusConfig (ModChainSel p s)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

Methods

noThunks ∷ Context → ConsensusConfig (ModChainSel p s) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (ModChainSel p s) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (ModChainSel p s)) → String Source #

NoThunks (ConsensusConfig (PBft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (PBft c)) → String Source #

type Rep (ConsensusConfig (HardForkProtocol xs)) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

type Rep (ConsensusConfig (HardForkProtocol xs)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.HardFork.Combinator.Basics" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "HardForkConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardForkConsensusConfigK") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "hardForkConsensusConfigShape") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Shape xs)) :*: S1 ('MetaSel ('Just "hardForkConsensusConfigPerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerEraConsensusConfig xs)))))

type Rep (ConsensusConfig (Bft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

type Rep (ConsensusConfig (Bft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.BFT" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "BftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "bftParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BftParams) :*: (S1 ('MetaSel ('Just "bftSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (BftDSIGN c))) :*: S1 ('MetaSel ('Just "bftVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map NodeId (VerKeyDSIGN (BftDSIGN c)))))))

type Rep (ConsensusConfig (ModChainSel p s)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

type Rep (ConsensusConfig (ModChainSel p s)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))

type Rep (ConsensusConfig (PBft c)) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.26.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))

data ConsensusConfig (HardForkProtocol xs) Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

data ConsensusConfig (HardForkProtocol xs) = HardForkConsensusConfig {

hardForkConsensusConfigK ∷ !SecurityParam
hardForkConsensusConfigShape ∷ !(Shape xs)
hardForkConsensusConfigPerEra ∷ !(PerEraConsensusConfig xs)

}

data ConsensusConfig (Bft c) Source #

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

data ConsensusConfig (Bft c) = BftConfig {

bftParams ∷ !BftParams
bftSignKey ∷ !(SignKeyDSIGN (BftDSIGN c))
bftVerKeys ∷ !(Map NodeId (VerKeyDSIGN (BftDSIGN c)))

}

newtype ConsensusConfig (PBft c) Source #

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

newtype ConsensusConfig (PBft c) = PBftConfig {

pbftParams ∷ PBftParams

}

newtype ConsensusConfig (ModChainSel p s) Source #

Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

newtype ConsensusConfig (ModChainSel p s) = McsConsensusConfig {

mcsConfigP ∷ ConsensusConfig p

}

data family Ticked (st ∷ k) ∷ k Source #

" Ticked " piece of state, either LedgerState or ChainDepState

Ticking refers to the passage of time (the ticking of the clock). When a piece of state is marked as ticked, it means that time-related changes have been applied to the state. There are exactly two methods in the interface that do that: tickChainDepState and applyChainTickLedgerResult.

Also note that a successful forecast forecastFor (ledgerViewForecastAt cfg st) slot must equal protocolLedgerView cfg (applyChainTick cfg slot st). Thus a LedgerView can only be projected from a Ticked state, but cannot itself be ticked.

Some examples of time related changes:

Scheduled delegations might have been applied in Byron
New leader schedule computed for Shelley
Transition from Byron to Shelley activated in the hard fork combinator.
Nonces switched out at the start of a new epoch.

Instances

Instances details

Show (Ticked ()) Source #
Instance details Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → Ticked () → ShowS # show ∷ Ticked () → String # showList ∷ [Ticked ()] → ShowS #
CanHardFork xs ⇒ GetTip (Ticked (LedgerState (HardForkBlock xs))) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods getTip ∷ ∀ (mk ∷ MapKind). Ticked (LedgerState (HardForkBlock xs)) mk → Point (Ticked (LedgerState (HardForkBlock xs))) Source #
Bridge m a ⇒ GetTip (Ticked (LedgerState (DualBlock m a))) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods getTip ∷ ∀ (mk ∷ MapKind). Ticked (LedgerState (DualBlock m a)) mk → Point (Ticked (LedgerState (DualBlock m a))) Source #
IsLedger (LedgerState blk) ⇒ GetTip (Ticked (ExtLedgerState blk)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Extended Methods getTip ∷ ∀ (mk ∷ MapKind). Ticked (ExtLedgerState blk) mk → Point (Ticked (ExtLedgerState blk)) Source #
(CanHardFork xs, HasCanonicalTxIn xs, HasHardForkTxOut xs) ⇒ HasLedgerTables (Ticked (LedgerState (HardForkBlock xs))) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (HardForkBlock xs)) mk → LedgerTables (Ticked (LedgerState (HardForkBlock xs))) mk Source # withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (HardForkBlock xs)) any → LedgerTables (Ticked (LedgerState (HardForkBlock xs))) mk → Ticked (LedgerState (HardForkBlock xs)) mk Source #
(Bridge m a, NoThunks (TxOut (LedgerState m)), NoThunks (TxIn (LedgerState m)), Show (TxOut (LedgerState m)), Show (TxIn (LedgerState m)), Eq (TxOut (LedgerState m)), Ord (TxIn (LedgerState m)), MemPack (TxIn (LedgerState m))) ⇒ HasLedgerTables (Ticked (LedgerState (DualBlock m a))) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (DualBlock m a)) mk → LedgerTables (Ticked (LedgerState (DualBlock m a))) mk Source # withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (DualBlock m a)) any → LedgerTables (Ticked (LedgerState (DualBlock m a))) mk → Ticked (LedgerState (DualBlock m a)) mk Source #
(HasLedgerTables (Ticked (LedgerState blk)), NoThunks (TxOut (LedgerState blk)), NoThunks (TxIn (LedgerState blk)), Show (TxOut (LedgerState blk)), Show (TxIn (LedgerState blk)), Eq (TxOut (LedgerState blk)), Ord (TxIn (LedgerState blk)), MemPack (TxIn (LedgerState blk))) ⇒ HasLedgerTables (Ticked (ExtLedgerState blk)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Extended Methods projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (ExtLedgerState blk) mk → LedgerTables (Ticked (ExtLedgerState blk)) mk Source # withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (ExtLedgerState blk) any → LedgerTables (Ticked (ExtLedgerState blk)) mk → Ticked (ExtLedgerState blk) mk Source #
LedgerTablesAreTrivial (Ticked (LedgerState blk)) ⇒ LedgerTablesAreTrivial (Ticked (ExtLedgerState blk)) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Extended Methods convertMapKind ∷ ∀ (mk ∷ MapKind) (mk' ∷ MapKind). Ticked (ExtLedgerState blk) mk → Ticked (ExtLedgerState blk) mk' Source #
NoThunks (Ticked (LedgerState (DualBlock m a)) mk) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods noThunks ∷ Context → Ticked (LedgerState (DualBlock m a)) mk → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Ticked (LedgerState (DualBlock m a)) mk → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Ticked (LedgerState (DualBlock m a)) mk) → String Source #
Show (Ticked (f a)) ⇒ Show (((Ticked ∷ Type → Type) :.: f) a) Source #
Instance details Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → ((Ticked ∷ Type → Type) :.: f) a → ShowS # show ∷ ((Ticked ∷ Type → Type) :.: f) a → String # showList ∷ [((Ticked ∷ Type → Type) :.: f) a] → ShowS #
NoThunks (Ticked (f a)) ⇒ NoThunks (((Ticked ∷ Type → Type) :.: f) a) Source #
Instance details Defined in Ouroboros.Consensus.Ticked Methods noThunks ∷ Context → ((Ticked ∷ Type → Type) :.: f) a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ((Ticked ∷ Type → Type) :.: f) a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (((Ticked ∷ Type → Type) :.: f) a) → String Source #
data Ticked () Source #
Instance details Defined in Ouroboros.Consensus.Ticked data Ticked () = TickedTrivial
data Ticked (HardForkChainDepState xs ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol data Ticked (HardForkChainDepState xs ∷ Type) = TickedHardForkChainDepState { tickedHardForkChainDepStatePerEra ∷ HardForkState ((Ticked ∷ Type → Type) :.: WrapChainDepState) xs tickedHardForkChainDepStateEpochInfo ∷ EpochInfo (Except PastHorizonException) }
data Ticked (HeaderState blk ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.HeaderValidation data Ticked (HeaderState blk ∷ Type) = TickedHeaderState { untickedHeaderStateTip ∷ WithOrigin (AnnTip blk) tickedHeaderStateChainDep ∷ Ticked (ChainDepState (BlockProtocol blk)) }
data Ticked (PBftState c ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT data Ticked (PBftState c ∷ Type) = TickedPBftState { getPBftLedgerView ∷ LedgerView (PBft c) getTickedPBftState ∷ PBftState c }
newtype Ticked (WrapChainDepState blk ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.TypeFamilyWrappers newtype Ticked (WrapChainDepState blk ∷ Type) = WrapTickedChainDepState { unwrapTickedChainDepState ∷ Ticked (ChainDepState (BlockProtocol blk)) }
type HeaderHash (Ticked l ∷ k) Source #
Instance details Defined in Ouroboros.Consensus.Ticked type HeaderHash (Ticked l ∷ k) = HeaderHash l
type TxIn (Ticked l) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Tables.Basics type TxIn (Ticked l) = TxIn l
type TxOut (Ticked l) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Tables.Basics type TxOut (Ticked l) = TxOut l
data Ticked (LedgerState (HardForkBlock xs) ∷ MapKind → Type) (mk ∷ MapKind) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger data Ticked (LedgerState (HardForkBlock xs) ∷ MapKind → Type) (mk ∷ MapKind) = TickedHardForkLedgerState { tickedHardForkLedgerStateTransition ∷ !TransitionInfo tickedHardForkLedgerStatePerEra ∷ !(HardForkState (FlipTickedLedgerState mk) xs) }
data Ticked (LedgerState (DualBlock m a) ∷ MapKind → Type) (mk ∷ MapKind) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual data Ticked (LedgerState (DualBlock m a) ∷ MapKind → Type) (mk ∷ MapKind) = TickedDualLedgerState { tickedDualLedgerStateMain ∷ Ticked (LedgerState m) mk tickedDualLedgerStateAux ∷ Ticked (LedgerState a) ValuesMK tickedDualLedgerStateBridge ∷ BridgeLedger m a tickedDualLedgerStateAuxOrig ∷ LedgerState a ValuesMK }
data Ticked (ExtLedgerState blk ∷ MapKind → Type) (mk ∷ MapKind) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Extended data Ticked (ExtLedgerState blk ∷ MapKind → Type) (mk ∷ MapKind) = TickedExtLedgerState { tickedLedgerState ∷ Ticked (LedgerState blk) mk ledgerView ∷ LedgerView (BlockProtocol blk) tickedHeaderState ∷ Ticked (HeaderState blk) }

Exported for tracing errors

data PBftValidationErr c Source #

NOTE: this type is stored in the state, so it must be in normal form to avoid space leaks.

Constructors

PBftInvalidSignature !Text
PBftNotGenesisDelegate !(PBftVerKeyHash c) !(PBftLedgerView c)
PBftExceededSignThreshold !(PBftVerKeyHash c) !Word64	We record how many slots this key signed
PBftInvalidSlot