Safe Haskell	None
Language	Haskell2010

Cardano.Chain.Delegation

Contents

Query
Update
Conversion/traversal
Certificate
Certificate Constructors
Certificate Accessor
Certificate Predicate

Synopsis

data APayload a = UnsafeAPayload {
- getPayload :: [ ACertificate a]
- getAnnotation :: a
}
type Payload = APayload ()
unsafePayload :: [ Certificate ] -> Payload
newtype Map = Map {
- unMap :: Bimap KeyHash KeyHash
}
memberR :: KeyHash -> Map -> Bool
notMemberR :: KeyHash -> Map -> Bool
pairMember :: ( KeyHash , KeyHash ) -> Map -> Bool
lookupR :: KeyHash -> Map -> Maybe KeyHash
insert :: KeyHash -> KeyHash -> Map -> Map
fromList :: [( KeyHash , KeyHash )] -> Map
keysSet :: Map -> Set KeyHash
type Certificate = ACertificate ()
data ACertificate a = UnsafeACertificate {
- aEpoch :: !( Annotated EpochNumber a)
- issuerVK :: ! VerificationKey
- delegateVK :: ! VerificationKey
- signature :: !( Signature EpochNumber )
- annotation :: !a
}
type CertificateId = Hash Certificate
signCertificate :: ProtocolMagicId -> VerificationKey -> EpochNumber -> SafeSigner -> Certificate
unsafeCertificate :: EpochNumber -> VerificationKey -> VerificationKey -> Signature EpochNumber -> Certificate
epoch :: ACertificate a -> EpochNumber
recoverCertificateId :: ACertificate ByteString -> CertificateId
isValid :: Annotated ProtocolMagicId ByteString -> ACertificate ByteString -> Bool

Documentation

data APayload a Source #

The delegation Payload contains a list of delegation Certificate s

Constructors

UnsafeAPayload
Fields getPayload :: [ ACertificate a] getAnnotation :: a

Instances

Instances details

Functor APayload Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods fmap :: (a -> b) -> APayload a -> APayload b Source # (<$) :: a -> APayload b -> APayload a Source #
ToCBOR Payload Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods toCBOR :: Payload -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Payload -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Payload ] -> Size Source #
FromCBOR Payload Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods fromCBOR :: Decoder s Payload Source # label :: Proxy Payload -> Text Source #
Eq a => Eq ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods (==) :: APayload a -> APayload a -> Bool Source # (/=) :: APayload a -> APayload a -> Bool Source #
Show a => Show ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods showsPrec :: Int -> APayload a -> ShowS Source # show :: APayload a -> String Source # showList :: [ APayload a] -> ShowS Source #
Generic ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Associated Types type Rep ( APayload a) :: Type -> Type Source # Methods from :: APayload a -> Rep ( APayload a) x Source # to :: Rep ( APayload a) x -> APayload a Source #
NFData a => NFData ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods rnf :: APayload a -> () Source #
ToJSON a => ToJSON ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods toJSON :: APayload a -> Value Source # toEncoding :: APayload a -> Encoding Source # toJSONList :: [ APayload a] -> Value Source # toEncodingList :: [ APayload a] -> Encoding Source #
Decoded ( APayload ByteString ) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Associated Types type BaseType ( APayload ByteString ) Source # Methods recoverBytes :: APayload ByteString -> ByteString Source #
FromCBOR ( APayload ByteSpan ) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods fromCBOR :: Decoder s ( APayload ByteSpan ) Source # label :: Proxy ( APayload ByteSpan ) -> Text Source #
Buildable ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload Methods build :: APayload a -> Builder Source #
type Rep ( APayload a) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload type Rep ( APayload a) = D1 (' MetaData "APayload" "Cardano.Chain.Delegation.Payload" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "UnsafeAPayload" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getPayload") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ ACertificate a]) :*: S1 (' MetaSel (' Just "getAnnotation") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 a)))
type BaseType ( APayload ByteString ) Source #
Instance details Defined in Cardano.Chain.Delegation.Payload type BaseType ( APayload ByteString ) = Payload

type Payload = APayload () Source #

unsafePayload :: [ Certificate ] -> Payload Source #

newtype Map Source #

Constructors

Map
Fields unMap :: Bimap KeyHash KeyHash

Instances

Instances details

Eq Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map Methods (==) :: Map -> Map -> Bool Source # (/=) :: Map -> Map -> Bool Source #
Show Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map Methods showsPrec :: Int -> Map -> ShowS Source # show :: Map -> String Source # showList :: [ Map ] -> ShowS Source #
Generic Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map Associated Types type Rep Map :: Type -> Type Source # Methods from :: Map -> Rep Map x Source # to :: Rep Map x -> Map Source #
NFData Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map Methods rnf :: Map -> () Source #
ToCBOR Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map Methods toCBOR :: Map -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Map -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Map ] -> Size Source #
FromCBOR Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map Methods fromCBOR :: Decoder s Map Source # label :: Proxy Map -> Text Source #
NoThunks Map Source #	A `Bimap` contains two regular `Map` s, which are spine strict; we therefore have to worry about the elements only
Instance details Defined in Cardano.Chain.Delegation.Map Methods noThunks :: Context -> Map -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Map -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Map -> String Source #
type Rep Map Source #
Instance details Defined in Cardano.Chain.Delegation.Map type Rep Map = D1 (' MetaData "Map" "Cardano.Chain.Delegation.Map" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' True ) ( C1 (' MetaCons "Map" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unMap") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Bimap KeyHash KeyHash ))))

Query

memberR :: KeyHash -> Map -> Bool Source #

notMemberR :: KeyHash -> Map -> Bool Source #

pairMember :: ( KeyHash , KeyHash ) -> Map -> Bool Source #

lookupR :: KeyHash -> Map -> Maybe KeyHash Source #

Update

insert :: KeyHash -> KeyHash -> Map -> Map Source #

Conversion/traversal

fromList :: [( KeyHash , KeyHash )] -> Map Source #

keysSet :: Map -> Set KeyHash Source #

Certificate

type Certificate = ACertificate () Source #

data ACertificate a Source #

Delegation certificate allowing the delegateVK to sign blocks on behalf of issuerVK

Each delegator can publish at most one Certificate per EpochNumber , and that EpochNumber must correspond to the current or next EpochNumber at the time of publishing

Constructors

UnsafeACertificate

Fields

aEpoch :: !( Annotated EpochNumber a)

The epoch from which the delegation is valid
issuerVK :: ! VerificationKey

The issuer of the certificate, who delegates their right to sign blocks
delegateVK :: ! VerificationKey

The delegate, who gains the right to sign blocks
signature :: !( Signature EpochNumber )

The signature that proves the certificate was issued by issuerVK
annotation :: !a

Instances

Instances details

Functor ACertificate Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods fmap :: (a -> b) -> ACertificate a -> ACertificate b Source # (<$) :: a -> ACertificate b -> ACertificate a Source #
ToCBOR Certificate Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods toCBOR :: Certificate -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Certificate -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Certificate ] -> Size Source #
FromCBOR Certificate Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods fromCBOR :: Decoder s Certificate Source # label :: Proxy Certificate -> Text Source #
Monad m => ToJSON m Certificate Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods toJSON :: Certificate -> m JSValue Source #
MonadError SchemaError m => FromJSON m Certificate Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods fromJSON :: JSValue -> m Certificate Source #
Eq a => Eq ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods (==) :: ACertificate a -> ACertificate a -> Bool Source # (/=) :: ACertificate a -> ACertificate a -> Bool Source #
Ord a => Ord ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods compare :: ACertificate a -> ACertificate a -> Ordering Source # (<) :: ACertificate a -> ACertificate a -> Bool Source # (<=) :: ACertificate a -> ACertificate a -> Bool Source # (>) :: ACertificate a -> ACertificate a -> Bool Source # (>=) :: ACertificate a -> ACertificate a -> Bool Source # max :: ACertificate a -> ACertificate a -> ACertificate a Source # min :: ACertificate a -> ACertificate a -> ACertificate a Source #
Show a => Show ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods showsPrec :: Int -> ACertificate a -> ShowS Source # show :: ACertificate a -> String Source # showList :: [ ACertificate a] -> ShowS Source #
Generic ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Associated Types type Rep ( ACertificate a) :: Type -> Type Source # Methods from :: ACertificate a -> Rep ( ACertificate a) x Source # to :: Rep ( ACertificate a) x -> ACertificate a Source #
NFData a => NFData ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods rnf :: ACertificate a -> () Source #
ToJSON a => ToJSON ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods toJSON :: ACertificate a -> Value Source # toEncoding :: ACertificate a -> Encoding Source # toJSONList :: [ ACertificate a] -> Value Source # toEncodingList :: [ ACertificate a] -> Encoding Source #
Decoded ( ACertificate ByteString ) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Associated Types type BaseType ( ACertificate ByteString ) Source # Methods recoverBytes :: ACertificate ByteString -> ByteString Source #
FromCBOR ( ACertificate ByteSpan ) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods fromCBOR :: Decoder s ( ACertificate ByteSpan ) Source # label :: Proxy ( ACertificate ByteSpan ) -> Text Source #
Buildable ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods build :: ACertificate a -> Builder Source #
NoThunks a => NoThunks ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate Methods noThunks :: Context -> ACertificate a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ACertificate a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ACertificate a) -> String Source #
type Rep ( ACertificate a) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate type Rep ( ACertificate a) = D1 (' MetaData "ACertificate" "Cardano.Chain.Delegation.Certificate" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "UnsafeACertificate" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "aEpoch") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Annotated EpochNumber a)) :: S1 (' MetaSel (' Just "issuerVK") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 VerificationKey )) :: ( S1 (' MetaSel (' Just "delegateVK") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 VerificationKey ) :: ( S1 (' MetaSel (' Just "signature") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Signature EpochNumber )) :: S1 (' MetaSel (' Just "annotation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a)))))
type BaseType ( ACertificate ByteString ) Source #
Instance details Defined in Cardano.Chain.Delegation.Certificate type BaseType ( ACertificate ByteString ) = Certificate

type CertificateId = Hash Certificate Source #

A delegation certificate identifier (the Hash of a Certificate ).

Certificate Constructors

signCertificate :: ProtocolMagicId -> VerificationKey -> EpochNumber -> SafeSigner -> Certificate Source #

Create a Certificate , signing it with the provided safe signer.

unsafeCertificate Source #

Arguments

:: EpochNumber
-> VerificationKey	The issuer of the certificate. See `UnsafeACertificate` .
-> VerificationKey	The delegate of the certificate. See `UnsafeACertificate` .
-> Signature EpochNumber
-> Certificate

Create a certificate using the provided signature.

Certificate Accessor

epoch :: ACertificate a -> EpochNumber Source #

recoverCertificateId :: ACertificate ByteString -> CertificateId Source #

Certificate Predicate

isValid :: Annotated ProtocolMagicId ByteString -> ACertificate ByteString -> Bool Source #

A Certificate is valid if the Signature is valid