Safe Haskell	None
Language	Haskell2010

Cardano.Chain.Update.Proposal

Contents

Proposal
Proposal Constructors
Proposal Accessors
Proposal Formatting
ProposalBody
ProposalBody Binary Serialization

Synopsis

data AProposal a = AProposal {
- aBody ∷ !(Annotated ProposalBody a)
- issuer ∷ !VerificationKey
- signature ∷ !(Signature ProposalBody)
- annotation ∷ !a
}
type Proposal = AProposal ()
type UpId = Hash Proposal
unsafeProposal ∷ ProposalBody → VerificationKey → Signature ProposalBody → Proposal
signProposal ∷ ProtocolMagicId → ProposalBody → SafeSigner → Proposal
signatureForProposal ∷ ProtocolMagicId → ProposalBody → SafeSigner → Signature ProposalBody
body ∷ AProposal a → ProposalBody
recoverUpId ∷ AProposal ByteString → UpId
formatMaybeProposal ∷ Maybe Proposal → Builder
data ProposalBody = ProposalBody {
- protocolVersion ∷ !ProtocolVersion
- protocolParametersUpdate ∷ !ProtocolParametersUpdate
- softwareVersion ∷ !SoftwareVersion
- metadata ∷ !(Map SystemTag InstallerHash)
}
recoverProposalSignedBytes ∷ Annotated ProposalBody ByteString → Annotated ProposalBody ByteString

Proposal

data AProposal a Source #

Proposal for software update

Constructors

AProposal
Fields aBody ∷ !(Annotated ProposalBody a) issuer ∷ !VerificationKey Who proposed this UP. signature ∷ !(Signature ProposalBody) annotation ∷ !a

Instances

Instances details

FromCBOR Proposal Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

fromCBOR ∷ Decoder s Proposal Source #

label ∷ Proxy Proposal → Text Source #

ToCBOR Proposal Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

toCBOR ∷ Proposal → Encoding Source #

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

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

DecCBOR Proposal Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

decCBOR ∷ Decoder s Proposal Source #

dropCBOR ∷ Proxy Proposal → Decoder s () Source #

label ∷ Proxy Proposal → Text Source #

EncCBOR Proposal Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

encCBOR ∷ Proposal → Encoding Source #

Functor AProposal Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

fmap ∷ (a → b) → AProposal a → AProposal b #

(<$) ∷ a → AProposal b → AProposal a #

ToJSON a ⇒ ToJSON (AProposal a) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

toJSON ∷ AProposal a → Value Source #

toEncoding ∷ AProposal a → Encoding Source #

toJSONList ∷ [AProposal a] → Value Source #

toEncodingList ∷ [AProposal a] → Encoding Source #

omitField ∷ AProposal a → Bool Source #

FromCBOR (AProposal ByteSpan) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

fromCBOR ∷ Decoder s (AProposal ByteSpan) Source #

label ∷ Proxy (AProposal ByteSpan) → Text Source #

Decoded (AProposal ByteString) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Associated Types

type BaseType (AProposal ByteString)
Instance details Defined in Cardano.Chain.Update.Proposal type BaseType (AProposal ByteString) = Proposal

Methods

recoverBytes ∷ AProposal ByteString → ByteString Source #

DecCBOR (AProposal ByteSpan) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

decCBOR ∷ Decoder s (AProposal ByteSpan) Source #

dropCBOR ∷ Proxy (AProposal ByteSpan) → Decoder s () Source #

label ∷ Proxy (AProposal ByteSpan) → Text Source #

NFData a ⇒ NFData (AProposal a) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

rnf ∷ AProposal a → () #

Buildable (AProposal ()) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

build ∷ AProposal () → Builder Source #

Generic (AProposal a) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Associated Types

type Rep (AProposal a)

Instance details

Defined in Cardano.Chain.Update.Proposal

type Rep (AProposal a) = D1 ('MetaData "AProposal" "Cardano.Chain.Update.Proposal" "cardano-ledger-byron-1.3.0.1-inplace" 'False) (C1 ('MetaCons "AProposal" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aBody") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Annotated ProposalBody a)) :*: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VerificationKey)) :*: (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Signature ProposalBody)) :*: S1 ('MetaSel ('Just "annotation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a))))

Methods

from ∷ AProposal a → Rep (AProposal a) x #

to ∷ Rep (AProposal a) x → AProposal a #

Show a ⇒ Show (AProposal a) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

showsPrec ∷ Int → AProposal a → ShowS #

show ∷ AProposal a → String #

showList ∷ [AProposal a] → ShowS #

Eq a ⇒ Eq (AProposal a) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

Methods

(==) ∷ AProposal a → AProposal a → Bool #

(/=) ∷ AProposal a → AProposal a → Bool #

Buildable (Proposal, [Vote]) Source #

Instance details

Defined in Cardano.Chain.Update.Vote

Methods

build ∷ (Proposal, [Vote]) → Builder Source #

type BaseType (AProposal ByteString) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

type BaseType (AProposal ByteString) = Proposal

type Rep (AProposal a) Source #

Instance details

Defined in Cardano.Chain.Update.Proposal

type Rep (AProposal a) = D1 ('MetaData "AProposal" "Cardano.Chain.Update.Proposal" "cardano-ledger-byron-1.3.0.1-inplace" 'False) (C1 ('MetaCons "AProposal" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aBody") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Annotated ProposalBody a)) :*: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VerificationKey)) :*: (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Signature ProposalBody)) :*: S1 ('MetaSel ('Just "annotation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a))))

type Proposal = AProposal () Source #

type UpId = Hash Proposal Source #

ID of software update proposal

Proposal Constructors

unsafeProposal ∷ ProposalBody → VerificationKey → Signature ProposalBody → Proposal Source #

Create an update Proposal using the provided signature.

signProposal ∷ ProtocolMagicId → ProposalBody → SafeSigner → Proposal Source #

Create an update Proposal, signing it with the provided safe signer.

signatureForProposal ∷ ProtocolMagicId → ProposalBody → SafeSigner → Signature ProposalBody Source #

Proposal Accessors

body ∷ AProposal a → ProposalBody Source #

recoverUpId ∷ AProposal ByteString → UpId Source #

Proposal Formatting

formatMaybeProposal ∷ Maybe Proposal → Builder Source #

ProposalBody

data ProposalBody Source #

Constructors

ProposalBody
Fields protocolVersion ∷ !ProtocolVersion protocolParametersUpdate ∷ !ProtocolParametersUpdate softwareVersion ∷ !SoftwareVersion metadata ∷ !(Map SystemTag InstallerHash) InstallerHash for each system which this update affects