cardano-crypto-class-2.1.1.0: 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 #

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 #

data SignKeyVRF v :: Type #

data CertVRF v :: Type #

type ContextVRF v :: Type #

Context required to run the VRF algorithm

Unit by default (no context required)

type ContextVRF v = ()

type Signable v :: Type -> Constraint #

type Signable c = Empty

Methods

algorithmNameVRF :: proxy v -> String #

deriveVerKeyVRF :: SignKeyVRF v -> VerKeyVRF v #

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

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

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

genKeyVRF :: Seed -> SignKeyVRF v #

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

seedSizeVRF :: proxy v -> Word #

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

sizeVerKeyVRF :: proxy v -> Word #

sizeSignKeyVRF :: proxy v -> Word #

sizeCertVRF :: proxy v -> Word #

sizeOutputVRF :: proxy v -> Word #

rawSerialiseVerKeyVRF :: VerKeyVRF v -> ByteString #

rawSerialiseSignKeyVRF :: SignKeyVRF v -> ByteString #

rawSerialiseCertVRF :: CertVRF v -> ByteString #

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

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

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

Instances

Instances details
VRFAlgorithm MockVRF # 
Instance details

Defined in Cardano.Crypto.VRF.Mock

Associated Types

data VerKeyVRF MockVRF #

data SignKeyVRF MockVRF #

data CertVRF MockVRF #

type ContextVRF MockVRF #

type Signable MockVRF :: Type -> Constraint #

Methods

algorithmNameVRF :: proxy MockVRF -> String #

deriveVerKeyVRF :: SignKeyVRF MockVRF -> VerKeyVRF MockVRF #

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

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

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

genKeyVRF :: Seed -> SignKeyVRF MockVRF #

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

seedSizeVRF :: proxy MockVRF -> Word #

sizeVerKeyVRF :: proxy MockVRF -> Word #

sizeSignKeyVRF :: proxy MockVRF -> Word #

sizeCertVRF :: proxy MockVRF -> Word #

sizeOutputVRF :: proxy MockVRF -> Word #

rawSerialiseVerKeyVRF :: VerKeyVRF MockVRF -> ByteString #

rawSerialiseSignKeyVRF :: SignKeyVRF MockVRF -> ByteString #

rawSerialiseCertVRF :: CertVRF MockVRF -> ByteString #

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

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

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

VRFAlgorithm NeverVRF # 
Instance details

Defined in Cardano.Crypto.VRF.NeverUsed

Associated Types

data VerKeyVRF NeverVRF #

data SignKeyVRF NeverVRF #

data CertVRF NeverVRF #

type ContextVRF NeverVRF #

type Signable NeverVRF :: Type -> Constraint #

Methods

algorithmNameVRF :: proxy NeverVRF -> String #

deriveVerKeyVRF :: SignKeyVRF NeverVRF -> VerKeyVRF NeverVRF #

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

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

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

genKeyVRF :: Seed -> SignKeyVRF NeverVRF #

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

seedSizeVRF :: proxy NeverVRF -> Word #

sizeVerKeyVRF :: proxy NeverVRF -> Word #

sizeSignKeyVRF :: proxy NeverVRF -> Word #

sizeCertVRF :: proxy NeverVRF -> Word #

sizeOutputVRF :: proxy NeverVRF -> Word #

rawSerialiseVerKeyVRF :: VerKeyVRF NeverVRF -> ByteString #

rawSerialiseSignKeyVRF :: SignKeyVRF NeverVRF -> ByteString #

rawSerialiseCertVRF :: CertVRF NeverVRF -> ByteString #

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

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

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

VRFAlgorithm SimpleVRF # 
Instance details

Defined in Cardano.Crypto.VRF.Simple

Associated Types

data VerKeyVRF SimpleVRF #

data SignKeyVRF SimpleVRF #

data CertVRF SimpleVRF #

type ContextVRF SimpleVRF #

type Signable SimpleVRF :: Type -> Constraint #

Methods

algorithmNameVRF :: proxy SimpleVRF -> String #

deriveVerKeyVRF :: SignKeyVRF SimpleVRF -> VerKeyVRF SimpleVRF #

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

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

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

genKeyVRF :: Seed -> SignKeyVRF SimpleVRF #

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

seedSizeVRF :: proxy SimpleVRF -> Word #

sizeVerKeyVRF :: proxy SimpleVRF -> Word #

sizeSignKeyVRF :: proxy SimpleVRF -> Word #

sizeCertVRF :: proxy SimpleVRF -> Word #

sizeOutputVRF :: proxy SimpleVRF -> Word #

rawSerialiseVerKeyVRF :: VerKeyVRF SimpleVRF -> ByteString #

rawSerialiseSignKeyVRF :: SignKeyVRF SimpleVRF -> ByteString #

rawSerialiseCertVRF :: CertVRF SimpleVRF -> ByteString #

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

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

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

VRF output

newtype OutputVRF v #

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) # 
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) # 
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) # 
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) # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

rnf :: OutputVRF v -> () Source #

Eq (OutputVRF v) # 
Instance details

Defined in Cardano.Crypto.VRF.Class

Methods

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

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

Ord (OutputVRF v) # 
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) # 
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 #

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 #

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 #

Constructors

CertifiedVRF 

Fields

Instances

Instances details
Generic (CertifiedVRF v a) # 
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) # 
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) # 
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) # 
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) # 
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) # 
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) # 
Instance details

Defined in Cardano.Crypto.VRF.Class

type Rep (CertifiedVRF v a) = D1 ('MetaData "CertifiedVRF" "Cardano.Crypto.VRF.Class" "cardano-crypto-class-2.1.1.0-inplace" '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 #

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

CBOR encoding and decoding

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

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

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

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

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

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

Encoded Size expressions

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

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

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

Size expression for SignKeyVRF which is using sizeSignKeyVRF encoded as Size

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

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