cardano-crypto-class-2.0.0.0.0.0.0.2: Type classes abstracting over cryptography primitives for Cardano
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Crypto.VRF.Class

Description

Abstract Verifiable Random Functions.

Synopsis

VRF algorithm class

class (Typeable v, Show (VerKeyVRF v), Eq (VerKeyVRF v), Show (SignKeyVRF v), Show (CertVRF v), Eq (CertVRF v), NoThunks (CertVRF v), NoThunks (VerKeyVRF v), NoThunks (SignKeyVRF v)) => VRFAlgorithm v where Source #

Minimal complete definition

algorithmNameVRF, deriveVerKeyVRF, evalVRF, verifyVRF, seedSizeVRF, (genKeyVRF | genKeyPairVRF), rawSerialiseVerKeyVRF, rawSerialiseSignKeyVRF, rawSerialiseCertVRF, rawDeserialiseVerKeyVRF, rawDeserialiseSignKeyVRF, rawDeserialiseCertVRF, sizeVerKeyVRF, sizeSignKeyVRF, sizeCertVRF, sizeOutputVRF

Associated Types

data VerKeyVRF v :: Type Source #

data SignKeyVRF v :: Type Source #

data CertVRF v :: Type Source #

type ContextVRF v :: Type Source #

Context required to run the VRF algorithm

Unit by default (no context required)

type ContextVRF v = ()

type Signable v :: Type -> Constraint Source #

type Signable c = Empty

Methods

algorithmNameVRF :: proxy v -> String Source #

deriveVerKeyVRF :: SignKeyVRF v -> VerKeyVRF v Source #

hashVerKeyVRF :: HashAlgorithm h => VerKeyVRF v -> Hash h (VerKeyVRF v) Source #

evalVRF :: (HasCallStack, Signable v a) => ContextVRF v -> a -> SignKeyVRF v -> (OutputVRF v, CertVRF v) Source #

verifyVRF :: (HasCallStack, Signable v a) => ContextVRF v -> VerKeyVRF v -> a -> (OutputVRF v, CertVRF v) -> Bool Source #

genKeyVRF :: Seed -> SignKeyVRF v Source #

genKeyPairVRF :: Seed -> (SignKeyVRF v, VerKeyVRF v) Source #

seedSizeVRF :: proxy v -> Word Source #

The upper bound on the Seed size needed by genKeyVRF, in bytes.

sizeVerKeyVRF :: proxy v -> Word Source #

sizeSignKeyVRF :: proxy v -> Word Source #

sizeCertVRF :: proxy v -> Word Source #

sizeOutputVRF :: proxy v -> Word Source #

rawSerialiseVerKeyVRF :: VerKeyVRF v -> ByteString Source #

rawSerialiseSignKeyVRF :: SignKeyVRF v -> ByteString Source #

rawSerialiseCertVRF :: CertVRF v -> ByteString Source #

rawDeserialiseVerKeyVRF :: ByteString -> Maybe (VerKeyVRF v) Source #

rawDeserialiseSignKeyVRF :: ByteString -> Maybe (SignKeyVRF v) Source #

rawDeserialiseCertVRF :: ByteString -> Maybe (CertVRF v) Source #

Instances

Instances details
VRFAlgorithm MockVRF Source # 
Instance details

Defined in Cardano.Crypto.VRF.Mock

Associated Types

data VerKeyVRF MockVRF Source #

data SignKeyVRF MockVRF Source #

data CertVRF MockVRF Source #

type ContextVRF MockVRF Source #

type Signable MockVRF :: Type -> Constraint Source #

Methods

algorithmNameVRF :: proxy MockVRF -> String Source #

deriveVerKeyVRF :: SignKeyVRF MockVRF -> VerKeyVRF MockVRF Source #

hashVerKeyVRF :: HashAlgorithm h => VerKeyVRF MockVRF -> Hash h (VerKeyVRF MockVRF) Source #

evalVRF :: (HasCallStack, Signable MockVRF a) => ContextVRF MockVRF -> a -> SignKeyVRF MockVRF -> (OutputVRF MockVRF, CertVRF MockVRF) Source #

verifyVRF :: (HasCallStack, Signable MockVRF a) => ContextVRF MockVRF -> VerKeyVRF MockVRF -> a -> (OutputVRF MockVRF, CertVRF MockVRF) -> Bool Source #

genKeyVRF :: Seed -> SignKeyVRF MockVRF Source #

genKeyPairVRF :: Seed -> (SignKeyVRF MockVRF, VerKeyVRF MockVRF) Source #

seedSizeVRF :: proxy MockVRF -> Word Source #

sizeVerKeyVRF :: proxy MockVRF -> Word Source #

sizeSignKeyVRF :: proxy MockVRF -> Word Source #

sizeCertVRF :: proxy MockVRF -> Word Source #

sizeOutputVRF :: proxy MockVRF -> Word Source #

rawSerialiseVerKeyVRF :: VerKeyVRF MockVRF -> ByteString Source #

rawSerialiseSignKeyVRF :: SignKeyVRF MockVRF -> ByteString Source #

rawSerialiseCertVRF :: CertVRF MockVRF -> ByteString Source #

rawDeserialiseVerKeyVRF :: ByteString -> Maybe (VerKeyVRF MockVRF) Source #

rawDeserialiseSignKeyVRF :: ByteString -> Maybe (SignKeyVRF MockVRF) Source #

rawDeserialiseCertVRF :: ByteString -> Maybe (CertVRF MockVRF) Source #

VRFAlgorithm NeverVRF Source # 
Instance details

Defined in Cardano.Crypto.VRF.NeverUsed

Associated Types

data VerKeyVRF NeverVRF Source #

data SignKeyVRF NeverVRF Source #

data CertVRF NeverVRF Source #

type ContextVRF NeverVRF Source #

type Signable NeverVRF :: Type -> Constraint Source #

Methods

algorithmNameVRF :: proxy NeverVRF -> String Source #

deriveVerKeyVRF :: SignKeyVRF NeverVRF -> VerKeyVRF NeverVRF Source #

hashVerKeyVRF :: HashAlgorithm h => VerKeyVRF NeverVRF -> Hash h (VerKeyVRF NeverVRF) Source #

evalVRF :: (HasCallStack, Signable NeverVRF a) => ContextVRF NeverVRF -> a -> SignKeyVRF NeverVRF -> (OutputVRF NeverVRF, CertVRF NeverVRF) Source #

verifyVRF :: (HasCallStack, Signable NeverVRF a) => ContextVRF NeverVRF -> VerKeyVRF NeverVRF -> a -> (OutputVRF NeverVRF, CertVRF NeverVRF) -> Bool Source #

genKeyVRF :: Seed -> SignKeyVRF NeverVRF Source #

genKeyPairVRF :: Seed -> (SignKeyVRF NeverVRF, VerKeyVRF NeverVRF) Source #

seedSizeVRF :: proxy NeverVRF -> Word Source #

sizeVerKeyVRF :: proxy NeverVRF -> Word Source #

sizeSignKeyVRF :: proxy NeverVRF -> Word Source #

sizeCertVRF :: proxy NeverVRF -> Word Source #

sizeOutputVRF :: proxy NeverVRF -> Word Source #

rawSerialiseVerKeyVRF :: VerKeyVRF NeverVRF -> ByteString Source #

rawSerialiseSignKeyVRF :: SignKeyVRF NeverVRF -> ByteString Source #

rawSerialiseCertVRF :: CertVRF NeverVRF -> ByteString Source #

rawDeserialiseVerKeyVRF :: ByteString -> Maybe (VerKeyVRF NeverVRF) Source #

rawDeserialiseSignKeyVRF :: ByteString -> Maybe (SignKeyVRF NeverVRF) Source #

rawDeserialiseCertVRF :: ByteString -> Maybe (CertVRF NeverVRF) Source #

VRFAlgorithm SimpleVRF Source # 
Instance details

Defined in Cardano.Crypto.VRF.Simple

Associated Types

data VerKeyVRF SimpleVRF Source #

data SignKeyVRF SimpleVRF Source #

data CertVRF SimpleVRF Source #

type ContextVRF SimpleVRF Source #

type Signable SimpleVRF :: Type -> Constraint Source #

Methods

algorithmNameVRF :: proxy SimpleVRF -> String Source #

deriveVerKeyVRF :: SignKeyVRF SimpleVRF -> VerKeyVRF SimpleVRF Source #

hashVerKeyVRF :: HashAlgorithm h => VerKeyVRF SimpleVRF -> Hash h (VerKeyVRF SimpleVRF) Source #

evalVRF :: (HasCallStack, Signable SimpleVRF a) => ContextVRF SimpleVRF -> a -> SignKeyVRF SimpleVRF -> (OutputVRF SimpleVRF, CertVRF SimpleVRF) Source #

verifyVRF :: (HasCallStack, Signable SimpleVRF a) => ContextVRF SimpleVRF -> VerKeyVRF SimpleVRF -> a -> (OutputVRF SimpleVRF, CertVRF SimpleVRF) -> Bool Source #

genKeyVRF :: Seed -> SignKeyVRF SimpleVRF Source #

genKeyPairVRF :: Seed -> (SignKeyVRF SimpleVRF, VerKeyVRF SimpleVRF) Source #

seedSizeVRF :: proxy SimpleVRF -> Word Source #

sizeVerKeyVRF :: proxy SimpleVRF -> Word Source #

sizeSignKeyVRF :: proxy SimpleVRF -> Word Source #

sizeCertVRF :: proxy SimpleVRF -> Word Source #

sizeOutputVRF :: proxy SimpleVRF -> Word Source #

rawSerialiseVerKeyVRF :: VerKeyVRF SimpleVRF -> ByteString Source #

rawSerialiseSignKeyVRF :: SignKeyVRF SimpleVRF -> ByteString Source #

rawSerialiseCertVRF :: CertVRF SimpleVRF -> ByteString Source #

rawDeserialiseVerKeyVRF :: ByteString -> Maybe (VerKeyVRF SimpleVRF) Source #

rawDeserialiseSignKeyVRF :: ByteString -> Maybe (SignKeyVRF SimpleVRF) Source #

rawDeserialiseCertVRF :: ByteString -> Maybe (CertVRF SimpleVRF) Source #

VRF output

newtype OutputVRF v Source #

The output bytes of the VRF.

The output size is a fixed number of bytes and is given by sizeOutputVRF.

Constructors

OutputVRF 

Fields

Instances

Instances details
Show (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

showsPrec :: Int -> OutputVRF v -> ShowS Source #

show :: OutputVRF v -> String Source #

showList :: [OutputVRF v] -> ShowS Source #

Typeable v => FromCBOR (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

fromCBOR :: Decoder s (OutputVRF v) Source #

label :: Proxy (OutputVRF v) -> Text Source #

Typeable v => ToCBOR (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

toCBOR :: OutputVRF v -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (OutputVRF v) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [OutputVRF v] -> Size Source #

NFData (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

rnf :: OutputVRF v -> () Source #

Eq (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

(==) :: OutputVRF v -> OutputVRF v -> Bool Source #

(/=) :: OutputVRF v -> OutputVRF v -> Bool Source #

Ord (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

compare :: OutputVRF v -> OutputVRF v -> Ordering Source #

(<) :: OutputVRF v -> OutputVRF v -> Bool Source #

(<=) :: OutputVRF v -> OutputVRF v -> Bool Source #

(>) :: OutputVRF v -> OutputVRF v -> Bool Source #

(>=) :: OutputVRF v -> OutputVRF v -> Bool Source #

max :: OutputVRF v -> OutputVRF v -> OutputVRF v Source #

min :: OutputVRF v -> OutputVRF v -> OutputVRF v Source #

NoThunks (OutputVRF v) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

noThunks :: Context -> OutputVRF v -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> OutputVRF v -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy (OutputVRF v) -> String Source #

getOutputVRFNatural :: OutputVRF v -> Natural Source #

The output bytes of the VRF interpreted as a big endian natural number.

The range of this number is determined by the size of the VRF output bytes. It is thus in the range 0 .. 2 ^ (8 * sizeOutputVRF proxy) - 1.

mkTestOutputVRF :: forall v. VRFAlgorithm v => Natural -> OutputVRF v Source #

For testing purposes, make an OutputVRF from a Natural.

The OutputVRF will be of the appropriate size for the VRFAlgorithm.

CertifiedVRF wrapper

data CertifiedVRF v a Source #

Constructors

CertifiedVRF 

Fields

Instances

Instances details
Generic (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Associated Types

type Rep (CertifiedVRF v a) :: Type -> Type Source #

Methods

from :: CertifiedVRF v a -> Rep (CertifiedVRF v a) x Source #

to :: Rep (CertifiedVRF v a) x -> CertifiedVRF v a Source #

VRFAlgorithm v => Show (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

showsPrec :: Int -> CertifiedVRF v a -> ShowS Source #

show :: CertifiedVRF v a -> String Source #

showList :: [CertifiedVRF v a] -> ShowS Source #

(VRFAlgorithm v, Typeable a) => FromCBOR (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

fromCBOR :: Decoder s (CertifiedVRF v a) Source #

label :: Proxy (CertifiedVRF v a) -> Text Source #

(VRFAlgorithm v, Typeable a) => ToCBOR (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

toCBOR :: CertifiedVRF v a -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (CertifiedVRF v a) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [CertifiedVRF v a] -> Size Source #

VRFAlgorithm v => Eq (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

(==) :: CertifiedVRF v a -> CertifiedVRF v a -> Bool Source #

(/=) :: CertifiedVRF v a -> CertifiedVRF v a -> Bool Source #

VRFAlgorithm v => NoThunks (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

noThunks :: Context -> CertifiedVRF v a -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> CertifiedVRF v a -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy (CertifiedVRF v a) -> String Source #

type Rep (CertifiedVRF v a) Source # 
Instance details

Defined in Cardano.Crypto.VRF.Class

type Rep (CertifiedVRF v a) = D1 ('MetaData "CertifiedVRF" "Cardano.Crypto.VRF.Class" "cardano-crypto-class-2.0.0.0.0.0.0.2-DK6Ti6yI0b4E6vuoX0zDQ9" 'False) (C1 ('MetaCons "CertifiedVRF" 'PrefixI 'True) (S1 ('MetaSel ('Just "certifiedOutput") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (OutputVRF v)) :*: S1 ('MetaSel ('Just "certifiedProof") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CertVRF v))))

evalCertified :: (VRFAlgorithm v, Signable v a) => ContextVRF v -> a -> SignKeyVRF v -> CertifiedVRF v a Source #

verifyCertified :: (VRFAlgorithm v, Signable v a) => ContextVRF v -> VerKeyVRF v -> a -> CertifiedVRF v a -> Bool Source #

CBOR encoding and decoding

encodeVerKeyVRF :: VRFAlgorithm v => VerKeyVRF v -> Encoding Source #

decodeVerKeyVRF :: forall v s. VRFAlgorithm v => Decoder s (VerKeyVRF v) Source #

encodeSignKeyVRF :: VRFAlgorithm v => SignKeyVRF v -> Encoding Source #

decodeSignKeyVRF :: forall v s. VRFAlgorithm v => Decoder s (SignKeyVRF v) Source #

encodeCertVRF :: VRFAlgorithm v => CertVRF v -> Encoding Source #

decodeCertVRF :: forall v s. VRFAlgorithm v => Decoder s (CertVRF v) Source #

Encoded Size expressions

encodedVerKeyVRFSizeExpr :: forall v. VRFAlgorithm v => Proxy (VerKeyVRF v) -> Size Source #

Size expression for VerKeyVRF which is using sizeVerKeyVRF encoded as Size.

encodedSignKeyVRFSizeExpr :: forall v. VRFAlgorithm v => Proxy (SignKeyVRF v) -> Size Source #

Size expression for SignKeyVRF which is using sizeSignKeyVRF encoded as Size

encodedCertVRFSizeExpr :: forall v. VRFAlgorithm v => Proxy (CertVRF v) -> Size Source #

Size expression for CertVRF which is using sizeCertVRF encoded as Size.