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

Functor AProposal Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods fmap :: (a -> b) -> AProposal a -> AProposal b Source # (<$) :: a -> AProposal b -> AProposal a Source #
ToCBOR Proposal Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods toCBOR :: Proposal -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Proposal -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Proposal ] -> Size Source #
FromCBOR Proposal Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods fromCBOR :: Decoder s Proposal Source # label :: Proxy Proposal -> Text Source #
Eq a => Eq ( AProposal a) Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods (==) :: AProposal a -> AProposal a -> Bool Source # (/=) :: AProposal a -> AProposal a -> Bool Source #
Show a => Show ( AProposal a) Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods showsPrec :: Int -> AProposal a -> ShowS Source # show :: AProposal a -> String Source # showList :: [ AProposal a] -> ShowS Source #
Generic ( AProposal a) Source #
Instance details Defined in Cardano.Chain.Update.Proposal Associated Types type Rep ( AProposal a) :: Type -> Type Source # Methods from :: AProposal a -> Rep ( AProposal a) x Source # to :: Rep ( AProposal a) x -> AProposal a Source #
NFData a => NFData ( AProposal a) Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods rnf :: AProposal a -> () Source #
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 #
Decoded ( AProposal ByteString ) Source #
Instance details Defined in Cardano.Chain.Update.Proposal Associated Types type BaseType ( AProposal ByteString ) Source # Methods recoverBytes :: AProposal ByteString -> ByteString 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 #
Buildable ( AProposal ()) Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods build :: AProposal () -> Builder Source #
Buildable ( Proposal , [ Vote ]) Source #
Instance details Defined in Cardano.Chain.Update.Vote Methods build :: ( Proposal , [ Vote ]) -> Builder Source #
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-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' 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 BaseType ( AProposal ByteString ) Source #
Instance details Defined in Cardano.Chain.Update.Proposal type BaseType ( AProposal ByteString ) = Proposal

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

Instances

Instances details

Eq ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods (==) :: ProposalBody -> ProposalBody -> Bool Source # (/=) :: ProposalBody -> ProposalBody -> Bool Source #
Show ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods showsPrec :: Int -> ProposalBody -> ShowS Source # show :: ProposalBody -> String Source # showList :: [ ProposalBody ] -> ShowS Source #
Generic ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Associated Types type Rep ProposalBody :: Type -> Type Source # Methods from :: ProposalBody -> Rep ProposalBody x Source # to :: Rep ProposalBody x -> ProposalBody Source #
NFData ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods rnf :: ProposalBody -> () Source #
ToJSON ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods toJSON :: ProposalBody -> Value Source # toEncoding :: ProposalBody -> Encoding Source # toJSONList :: [ ProposalBody ] -> Value Source # toEncodingList :: [ ProposalBody ] -> Encoding Source #
ToCBOR ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods toCBOR :: ProposalBody -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ProposalBody -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ProposalBody ] -> Size Source #
FromCBOR ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal Methods fromCBOR :: Decoder s ProposalBody Source # label :: Proxy ProposalBody -> Text Source #
type Rep ProposalBody Source #
Instance details Defined in Cardano.Chain.Update.Proposal type Rep ProposalBody = D1 (' MetaData "ProposalBody" "Cardano.Chain.Update.Proposal" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ProposalBody" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "protocolVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ProtocolVersion ) :: S1 (' MetaSel (' Just "protocolParametersUpdate") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ProtocolParametersUpdate )) :: ( S1 (' MetaSel (' Just "softwareVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 SoftwareVersion ) :*: S1 (' MetaSel (' Just "metadata") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map SystemTag InstallerHash )))))

ProposalBody Binary Serialization

recoverProposalSignedBytes :: Annotated ProposalBody ByteString -> Annotated ProposalBody ByteString Source #

Prepend byte corresponding to `encodeListLen 5`, which was used during signing