Safe Haskell	None
Language	Haskell2010

Cardano.Chain.Update.Validation.Registration

Description

Validation rules for registering updates

This is an implementation of the rules defined in the Byron ledger specification

Synopsis

data Error
data Environment = Environment {
- protocolMagic ∷ !(Annotated ProtocolMagicId ByteString)
- currentSlot ∷ !SlotNumber
- adoptedProtocolVersion ∷ !ProtocolVersion
- adoptedProtocolParameters ∷ !ProtocolParameters
- appVersions ∷ !ApplicationVersions
- delegationMap ∷ !Map
}
data State = State {
- rsProtocolUpdateProposals ∷ !ProtocolUpdateProposals
- rsSoftwareUpdateProposals ∷ !SoftwareUpdateProposals
}
data ApplicationVersion = ApplicationVersion {
- avNumSoftwareVersion ∷ !NumSoftwareVersion
- avSlotNumber ∷ !SlotNumber
- avMetadata ∷ !Metadata
}
type ApplicationVersions = Map ApplicationName ApplicationVersion
type Metadata = Map SystemTag InstallerHash
data ProtocolUpdateProposal = ProtocolUpdateProposal {
- pupProtocolVersion ∷ !ProtocolVersion
- pupProtocolParameters ∷ !ProtocolParameters
}
type ProtocolUpdateProposals = Map UpId ProtocolUpdateProposal
data SoftwareUpdateProposal = SoftwareUpdateProposal {
- supSoftwareVersion ∷ !SoftwareVersion
- supSoftwareMetadata ∷ !Metadata
}
type SoftwareUpdateProposals = Map UpId SoftwareUpdateProposal
registerProposal ∷ MonadError Error m ⇒ Environment → State → AProposal ByteString → m State
data TooLarge n = TooLarge {
- tlActual ∷ n
- tlMaxBound ∷ n
}
newtype Adopted = Adopted ProtocolVersion

Documentation

data Error Source #

Error captures the ways in which registration could fail

Constructors

DuplicateProtocolVersion ProtocolVersion
DuplicateSoftwareVersion SoftwareVersion
InvalidProposer KeyHash
InvalidProtocolVersion ProtocolVersion Adopted
InvalidScriptVersion Word16 Word16
InvalidSignature
InvalidSoftwareVersion ApplicationVersions SoftwareVersion
MaxBlockSizeTooLarge (TooLarge Natural)
MaxTxSizeTooLarge (TooLarge Natural)
ProposalAttributesUnknown
ProposalTooLarge (TooLarge Natural)
SoftwareVersionError SoftwareVersionError
SystemTagError SystemTagError
NullUpdateProposal	The update proposal proposes neither a bump in the protocol or application versions.

Instances

Instances details

FromCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods fromCBOR ∷ Decoder s Error Source # label ∷ Proxy Error → Text Source #
ToCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods toCBOR ∷ Error → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Error → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Error] → Size Source #
DecCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods decCBOR ∷ Decoder s Error Source # dropCBOR ∷ Proxy Error → Decoder s () Source # label ∷ Proxy Error → Text Source #
EncCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods encCBOR ∷ Error → Encoding Source #
Show Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods showsPrec ∷ Int → Error → ShowS # show ∷ Error → String # showList ∷ [Error] → ShowS #
Eq Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods (==) ∷ Error → Error → Bool # (/=) ∷ Error → Error → Bool #

data Environment Source #

Constructors

Environment
Fields protocolMagic ∷ !(Annotated ProtocolMagicId ByteString) currentSlot ∷ !SlotNumber adoptedProtocolVersion ∷ !ProtocolVersion adoptedProtocolParameters ∷ !ProtocolParameters appVersions ∷ !ApplicationVersions delegationMap ∷ !Map

data State Source #

State keeps track of registered protocol and software update proposals

Constructors

State
Fields rsProtocolUpdateProposals ∷ !ProtocolUpdateProposals rsSoftwareUpdateProposals ∷ !SoftwareUpdateProposals

data ApplicationVersion Source #

Constructors

ApplicationVersion
Fields avNumSoftwareVersion ∷ !NumSoftwareVersion avSlotNumber ∷ !SlotNumber avMetadata ∷ !Metadata

Instances

Instances details

FromCBOR ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

fromCBOR ∷ Decoder s ApplicationVersion Source #

label ∷ Proxy ApplicationVersion → Text Source #

ToCBOR ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

toCBOR ∷ ApplicationVersion → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ApplicationVersion → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ApplicationVersion] → Size Source #

DecCBOR ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

decCBOR ∷ Decoder s ApplicationVersion Source #

dropCBOR ∷ Proxy ApplicationVersion → Decoder s () Source #

label ∷ Proxy ApplicationVersion → Text Source #

EncCBOR ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

encCBOR ∷ ApplicationVersion → Encoding Source #

NFData ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

rnf ∷ ApplicationVersion → () #

Generic ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Associated Types

type Rep ApplicationVersion

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

type Rep ApplicationVersion = D1 ('MetaData "ApplicationVersion" "Cardano.Chain.Update.Validation.Registration" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "ApplicationVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "avNumSoftwareVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NumSoftwareVersion) :*: (S1 ('MetaSel ('Just "avSlotNumber") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNumber) :*: S1 ('MetaSel ('Just "avMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Metadata))))

Methods

from ∷ ApplicationVersion → Rep ApplicationVersion x #

to ∷ Rep ApplicationVersion x → ApplicationVersion #

Show ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

showsPrec ∷ Int → ApplicationVersion → ShowS #

show ∷ ApplicationVersion → String #

showList ∷ [ApplicationVersion] → ShowS #

Eq ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

(==) ∷ ApplicationVersion → ApplicationVersion → Bool #

(/=) ∷ ApplicationVersion → ApplicationVersion → Bool #

NoThunks ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

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

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

showTypeOf ∷ Proxy ApplicationVersion → String Source #

type Rep ApplicationVersion Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

type Rep ApplicationVersion = D1 ('MetaData "ApplicationVersion" "Cardano.Chain.Update.Validation.Registration" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "ApplicationVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "avNumSoftwareVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NumSoftwareVersion) :*: (S1 ('MetaSel ('Just "avSlotNumber") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNumber) :*: S1 ('MetaSel ('Just "avMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Metadata))))

type ApplicationVersions = Map ApplicationName ApplicationVersion Source #

type Metadata = Map SystemTag InstallerHash Source #

data ProtocolUpdateProposal Source #

Constructors

ProtocolUpdateProposal
Fields pupProtocolVersion ∷ !ProtocolVersion pupProtocolParameters ∷ !ProtocolParameters

Instances

Instances details

FromCBOR ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

fromCBOR ∷ Decoder s ProtocolUpdateProposal Source #

label ∷ Proxy ProtocolUpdateProposal → Text Source #

ToCBOR ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

toCBOR ∷ ProtocolUpdateProposal → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ProtocolUpdateProposal → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ProtocolUpdateProposal] → Size Source #

DecCBOR ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

decCBOR ∷ Decoder s ProtocolUpdateProposal Source #

dropCBOR ∷ Proxy ProtocolUpdateProposal → Decoder s () Source #

label ∷ Proxy ProtocolUpdateProposal → Text Source #

EncCBOR ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

encCBOR ∷ ProtocolUpdateProposal → Encoding Source #

NFData ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

rnf ∷ ProtocolUpdateProposal → () #

Generic ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Associated Types

type Rep ProtocolUpdateProposal

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

type Rep ProtocolUpdateProposal = D1 ('MetaData "ProtocolUpdateProposal" "Cardano.Chain.Update.Validation.Registration" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "ProtocolUpdateProposal" 'PrefixI 'True) (S1 ('MetaSel ('Just "pupProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion) :*: S1 ('MetaSel ('Just "pupProtocolParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolParameters)))

Methods

from ∷ ProtocolUpdateProposal → Rep ProtocolUpdateProposal x #

to ∷ Rep ProtocolUpdateProposal x → ProtocolUpdateProposal #

Show ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

showsPrec ∷ Int → ProtocolUpdateProposal → ShowS #

show ∷ ProtocolUpdateProposal → String #

showList ∷ [ProtocolUpdateProposal] → ShowS #

Eq ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

(==) ∷ ProtocolUpdateProposal → ProtocolUpdateProposal → Bool #

(/=) ∷ ProtocolUpdateProposal → ProtocolUpdateProposal → Bool #

NoThunks ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

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

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

showTypeOf ∷ Proxy ProtocolUpdateProposal → String Source #

type Rep ProtocolUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

type Rep ProtocolUpdateProposal = D1 ('MetaData "ProtocolUpdateProposal" "Cardano.Chain.Update.Validation.Registration" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "ProtocolUpdateProposal" 'PrefixI 'True) (S1 ('MetaSel ('Just "pupProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion) :*: S1 ('MetaSel ('Just "pupProtocolParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolParameters)))

type ProtocolUpdateProposals = Map UpId ProtocolUpdateProposal Source #

data SoftwareUpdateProposal Source #

Constructors

SoftwareUpdateProposal
Fields supSoftwareVersion ∷ !SoftwareVersion supSoftwareMetadata ∷ !Metadata

Instances

Instances details

FromCBOR SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

fromCBOR ∷ Decoder s SoftwareUpdateProposal Source #

label ∷ Proxy SoftwareUpdateProposal → Text Source #

ToCBOR SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

toCBOR ∷ SoftwareUpdateProposal → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SoftwareUpdateProposal → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SoftwareUpdateProposal] → Size Source #

DecCBOR SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

decCBOR ∷ Decoder s SoftwareUpdateProposal Source #

dropCBOR ∷ Proxy SoftwareUpdateProposal → Decoder s () Source #

label ∷ Proxy SoftwareUpdateProposal → Text Source #

EncCBOR SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

encCBOR ∷ SoftwareUpdateProposal → Encoding Source #

NFData SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

rnf ∷ SoftwareUpdateProposal → () #

Generic SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Associated Types

type Rep SoftwareUpdateProposal

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

type Rep SoftwareUpdateProposal = D1 ('MetaData "SoftwareUpdateProposal" "Cardano.Chain.Update.Validation.Registration" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "SoftwareUpdateProposal" 'PrefixI 'True) (S1 ('MetaSel ('Just "supSoftwareVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SoftwareVersion) :*: S1 ('MetaSel ('Just "supSoftwareMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Metadata)))

Methods

from ∷ SoftwareUpdateProposal → Rep SoftwareUpdateProposal x #

to ∷ Rep SoftwareUpdateProposal x → SoftwareUpdateProposal #

Show SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

showsPrec ∷ Int → SoftwareUpdateProposal → ShowS #

show ∷ SoftwareUpdateProposal → String #

showList ∷ [SoftwareUpdateProposal] → ShowS #

Eq SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

(==) ∷ SoftwareUpdateProposal → SoftwareUpdateProposal → Bool #

(/=) ∷ SoftwareUpdateProposal → SoftwareUpdateProposal → Bool #

NoThunks SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

Methods

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

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

showTypeOf ∷ Proxy SoftwareUpdateProposal → String Source #

type Rep SoftwareUpdateProposal Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Registration

type Rep SoftwareUpdateProposal = D1 ('MetaData "SoftwareUpdateProposal" "Cardano.Chain.Update.Validation.Registration" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "SoftwareUpdateProposal" 'PrefixI 'True) (S1 ('MetaSel ('Just "supSoftwareVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SoftwareVersion) :*: S1 ('MetaSel ('Just "supSoftwareMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Metadata)))

type SoftwareUpdateProposals = Map UpId SoftwareUpdateProposal Source #

registerProposal ∷ MonadError Error m ⇒ Environment → State → AProposal ByteString → m State Source #

Register an update proposal after verifying its signature and validating its contents. This corresponds to the UPREG rules in the spec.

data TooLarge n Source #

Constructors

TooLarge
Fields tlActual ∷ n tlMaxBound ∷ n

Instances

Instances details

DecCBOR n ⇒ FromCBOR (TooLarge n) Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods fromCBOR ∷ Decoder s (TooLarge n) Source # label ∷ Proxy (TooLarge n) → Text Source #
(EncCBOR n, Typeable n) ⇒ ToCBOR (TooLarge n) Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods toCBOR ∷ TooLarge n → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (TooLarge n) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [TooLarge n] → Size Source #
DecCBOR n ⇒ DecCBOR (TooLarge n) Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods decCBOR ∷ Decoder s (TooLarge n) Source # dropCBOR ∷ Proxy (TooLarge n) → Decoder s () Source # label ∷ Proxy (TooLarge n) → Text Source #
EncCBOR n ⇒ EncCBOR (TooLarge n) Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods encCBOR ∷ TooLarge n → Encoding Source #
Show n ⇒ Show (TooLarge n) Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods showsPrec ∷ Int → TooLarge n → ShowS # show ∷ TooLarge n → String # showList ∷ [TooLarge n] → ShowS #
Eq n ⇒ Eq (TooLarge n) Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods (==) ∷ TooLarge n → TooLarge n → Bool # (/=) ∷ TooLarge n → TooLarge n → Bool #

newtype Adopted Source #

Constructors

Adopted ProtocolVersion

Instances

Instances details

FromCBOR Adopted Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods fromCBOR ∷ Decoder s Adopted Source # label ∷ Proxy Adopted → Text Source #
ToCBOR Adopted Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods toCBOR ∷ Adopted → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Adopted → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Adopted] → Size Source #
DecCBOR Adopted Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods decCBOR ∷ Decoder s Adopted Source # dropCBOR ∷ Proxy Adopted → Decoder s () Source # label ∷ Proxy Adopted → Text Source #
EncCBOR Adopted Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods encCBOR ∷ Adopted → Encoding Source #
Show Adopted Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods showsPrec ∷ Int → Adopted → ShowS # show ∷ Adopted → String # showList ∷ [Adopted] → ShowS #
Eq Adopted Source #
Instance details Defined in Cardano.Chain.Update.Validation.Registration Methods (==) ∷ Adopted → Adopted → Bool # (/=) ∷ Adopted → Adopted → Bool #