Morley.Tezos.Crypto

Cryptographic primitives used in Tezos.

WARNING: some functions may be vulnerable to timing attacks. Also, this code was not reviewed by cryptography/security experts. Do not use it with secret keys that have some value. We provide SecretKey type and (limited) signing functionality only for testing. If you need to sign something in production, use something else (e. g. `tezos-client`).

Tezos supports 3 cryptographic curves that are denoted by the number after tz in the public key hash: tz1, tz2 or tz3. • tz1 — ed25519 • tz2 — secp256k1 • tz3 — P256 We have Morley.Tezos.Crypto.Curve module for each of these curves. They expose very similar functionality and their main purpose is to hide implementation details for each curve as well as some other specifics (e. g. prefixes that are used for human-readable representation).

This module serves two purposes: 1. It is an umbrella module that re-exports some stuff from other modules. 2. Michelson types such as key and signature may store primitive of any curve, so we need "union" types in Haskell as well.

During conversion to human-readable representation usually some magical prefix is used. They have been found in source code in some repos (e. g. https://gitlab.com/tezos/tezos/blob/c52ee69231c5ae4d9cec1f3c8aba0c3573922e2a/src/lib_crypto/base58.ml) and checked manually. Existing tests confirm they are correct.

Cryptographic primitive types

data PublicKey

Public cryptographic key used by Tezos. There are three cryptographic curves each represented by its own constructor.

Constructors

PublicKeyEd25519 PublicKey

Public key that uses the ed25519 cryptographic curve.

PublicKeySecp256k1 PublicKey

Public key that uses the secp256k1 cryptographic curve.

PublicKeyP256 PublicKey

Public key that uses the NIST P-256 cryptographic curve.

Instances

Eq PublicKey

Defined in Morley.Tezos.Crypto

Methods

(==) :: PublicKey -> PublicKey -> Bool

(/=) :: PublicKey -> PublicKey -> Bool

Ord PublicKey

Defined in Morley.Tezos.Crypto

Methods

compare :: PublicKey -> PublicKey -> Ordering

(<) :: PublicKey -> PublicKey -> Bool

(<=) :: PublicKey -> PublicKey -> Bool

(>) :: PublicKey -> PublicKey -> Bool

(>=) :: PublicKey -> PublicKey -> Bool

max :: PublicKey -> PublicKey -> PublicKey

min :: PublicKey -> PublicKey -> PublicKey

Show PublicKey

Defined in Morley.Tezos.Crypto

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

Generic PublicKey

Defined in Morley.Tezos.Crypto

Associated Types

type Rep PublicKey :: Type -> Type

Methods

from :: PublicKey -> Rep PublicKey x

to :: Rep PublicKey x -> PublicKey

ToJSON PublicKey

Defined in Morley.Tezos.Crypto

Methods

toJSON :: PublicKey -> Value

toEncoding :: PublicKey -> Encoding

toJSONList :: [PublicKey] -> Value

toEncodingList :: [PublicKey] -> Encoding

FromJSON PublicKey

Defined in Morley.Tezos.Crypto

Methods

parseJSON :: Value -> Parser PublicKey

parseJSONList :: Value -> Parser [PublicKey]

NFData PublicKey

Defined in Morley.Tezos.Crypto

Methods

rnf :: PublicKey -> ()

Buildable PublicKey

Defined in Morley.Tezos.Crypto

Methods

build :: PublicKey -> Builder

IsoValue PublicKey

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT PublicKey :: T

Methods

toVal :: PublicKey -> Value (ToT PublicKey)

fromVal :: Value (ToT PublicKey) -> PublicKey

TypeHasDoc PublicKey

Defined in Morley.Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions PublicKey :: FieldDescriptions

Methods

typeDocName :: Proxy PublicKey -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy PublicKey -> WithinParens -> Markdown

typeDocDependencies :: Proxy PublicKey -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep PublicKey

typeDocMichelsonRep :: TypeDocMichelsonRep PublicKey

type Rep PublicKey

Defined in Morley.Tezos.Crypto

type Rep PublicKey = D1 ('MetaData "PublicKey" "Morley.Tezos.Crypto" "morley-1.16.1-inplace" 'False) (C1 ('MetaCons "PublicKeyEd25519" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicKey)) :+: (C1 ('MetaCons "PublicKeySecp256k1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicKey)) :+: C1 ('MetaCons "PublicKeyP256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicKey))))

type ToT PublicKey

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT PublicKey = 'TKey

type TypeDocFieldDescriptions PublicKey

Defined in Morley.Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions PublicKey = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data SecretKey

Secret cryptographic key used by Tezos. Constructors correspond to PublicKey constructors.

Constructors

SecretKeyEd25519 SecretKey

Secret key that uses the ed25519 cryptographic curve.

SecretKeySecp256k1 SecretKey

Secret key that uses the secp256k1 cryptographic curve.

SecretKeyP256 SecretKey

Secret key that uses the NIST P-256 cryptographic curve.

Instances

Eq SecretKey

Defined in Morley.Tezos.Crypto

Methods

(==) :: SecretKey -> SecretKey -> Bool

(/=) :: SecretKey -> SecretKey -> Bool

Show SecretKey

Defined in Morley.Tezos.Crypto

Methods

showsPrec :: Int -> SecretKey -> ShowS

show :: SecretKey -> String

showList :: [SecretKey] -> ShowS

Generic SecretKey

Defined in Morley.Tezos.Crypto

Associated Types

type Rep SecretKey :: Type -> Type

Methods

from :: SecretKey -> Rep SecretKey x

to :: Rep SecretKey x -> SecretKey

NFData SecretKey

Defined in Morley.Tezos.Crypto

Methods

rnf :: SecretKey -> ()

Buildable SecretKey

Defined in Morley.Tezos.Crypto

Methods

build :: SecretKey -> Builder

HasCLReader SecretKey

Defined in Morley.Tezos.Crypto

Methods

getReader :: ReadM SecretKey

getMetavar :: String

type Rep SecretKey

Defined in Morley.Tezos.Crypto

type Rep SecretKey = D1 ('MetaData "SecretKey" "Morley.Tezos.Crypto" "morley-1.16.1-inplace" 'False) (C1 ('MetaCons "SecretKeyEd25519" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecretKey)) :+: (C1 ('MetaCons "SecretKeySecp256k1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecretKey)) :+: C1 ('MetaCons "SecretKeyP256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecretKey))))

data Signature

Cryptographic signatures used by Tezos. Constructors correspond to PublicKey constructors.

Tezos distinguishes signatures for different curves. For instance, ed25519 signatures and secp256k1 signatures are printed differently (have different prefix). However, signatures are packed without information about the curve. For this purpose there is a generic signature which only stores bytes and doesn't carry information about the curve. Apparently unpacking from bytes always produces such signature. Unpacking from string produces a signature with curve information.

Constructors

SignatureEd25519 Signature

Signature that uses the ed25519 cryptographic curve.

SignatureSecp256k1 Signature

Siganture that uses the secp256k1 cryptographic curve.

SignatureP256 Signature

Signature that uses the NIST P-256 cryptographic curve.

SignatureGeneric ByteString

Generic signature for which curve is unknown.

Instances

Eq Signature

Defined in Morley.Tezos.Crypto

Methods

(==) :: Signature -> Signature -> Bool

(/=) :: Signature -> Signature -> Bool

Ord Signature

Defined in Morley.Tezos.Crypto

Methods

compare :: Signature -> Signature -> Ordering

(<) :: Signature -> Signature -> Bool

(<=) :: Signature -> Signature -> Bool

(>) :: Signature -> Signature -> Bool

(>=) :: Signature -> Signature -> Bool

max :: Signature -> Signature -> Signature

min :: Signature -> Signature -> Signature

Show Signature

Defined in Morley.Tezos.Crypto

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

Generic Signature

Defined in Morley.Tezos.Crypto

Associated Types

type Rep Signature :: Type -> Type

Methods

from :: Signature -> Rep Signature x

to :: Rep Signature x -> Signature

ToJSON Signature

Defined in Morley.Tezos.Crypto

Methods

toJSON :: Signature -> Value

toEncoding :: Signature -> Encoding

toJSONList :: [Signature] -> Value

toEncodingList :: [Signature] -> Encoding

FromJSON Signature

Defined in Morley.Tezos.Crypto

Methods

parseJSON :: Value -> Parser Signature

parseJSONList :: Value -> Parser [Signature]

NFData Signature

Defined in Morley.Tezos.Crypto

Methods

rnf :: Signature -> ()

Buildable Signature

Defined in Morley.Tezos.Crypto

Methods

build :: Signature -> Builder

IsoValue Signature

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT Signature :: T

Methods

toVal :: Signature -> Value (ToT Signature)

fromVal :: Value (ToT Signature) -> Signature

TypeHasDoc Signature

Defined in Morley.Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions Signature :: FieldDescriptions

Methods

typeDocName :: Proxy Signature -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Signature -> WithinParens -> Markdown

typeDocDependencies :: Proxy Signature -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep Signature

typeDocMichelsonRep :: TypeDocMichelsonRep Signature

type Rep Signature

Defined in Morley.Tezos.Crypto

type Rep Signature = D1 ('MetaData "Signature" "Morley.Tezos.Crypto" "morley-1.16.1-inplace" 'False) ((C1 ('MetaCons "SignatureEd25519" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Signature)) :+: C1 ('MetaCons "SignatureSecp256k1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Signature))) :+: (C1 ('MetaCons "SignatureP256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Signature)) :+: C1 ('MetaCons "SignatureGeneric" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))

type ToT Signature

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT Signature = 'TSignature

type TypeDocFieldDescriptions Signature

Defined in Morley.Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions Signature = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data KeyHashTag

Which curve was used for the hashed public key inside KeyHash.

Constructors

KeyHashEd25519

KeyHashSecp256k1

KeyHashP256

Instances

Bounded KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

minBound :: KeyHashTag

maxBound :: KeyHashTag

Enum KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

succ :: KeyHashTag -> KeyHashTag

pred :: KeyHashTag -> KeyHashTag

toEnum :: Int -> KeyHashTag

fromEnum :: KeyHashTag -> Int

enumFrom :: KeyHashTag -> [KeyHashTag]

enumFromThen :: KeyHashTag -> KeyHashTag -> [KeyHashTag]

enumFromTo :: KeyHashTag -> KeyHashTag -> [KeyHashTag]

enumFromThenTo :: KeyHashTag -> KeyHashTag -> KeyHashTag -> [KeyHashTag]

Eq KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

(==) :: KeyHashTag -> KeyHashTag -> Bool

(/=) :: KeyHashTag -> KeyHashTag -> Bool

Ord KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

compare :: KeyHashTag -> KeyHashTag -> Ordering

(<) :: KeyHashTag -> KeyHashTag -> Bool

(<=) :: KeyHashTag -> KeyHashTag -> Bool

(>) :: KeyHashTag -> KeyHashTag -> Bool

(>=) :: KeyHashTag -> KeyHashTag -> Bool

max :: KeyHashTag -> KeyHashTag -> KeyHashTag

min :: KeyHashTag -> KeyHashTag -> KeyHashTag

Show KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

showsPrec :: Int -> KeyHashTag -> ShowS

show :: KeyHashTag -> String

showList :: [KeyHashTag] -> ShowS

Generic KeyHashTag

Defined in Morley.Tezos.Crypto

Associated Types

type Rep KeyHashTag :: Type -> Type

Methods

from :: KeyHashTag -> Rep KeyHashTag x

to :: Rep KeyHashTag x -> KeyHashTag

NFData KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

rnf :: KeyHashTag -> ()

Lift KeyHashTag

Defined in Morley.Tezos.Crypto

Methods

lift :: KeyHashTag -> Q Exp

liftTyped :: KeyHashTag -> Q (TExp KeyHashTag)

type Rep KeyHashTag

Defined in Morley.Tezos.Crypto

type Rep KeyHashTag = D1 ('MetaData "KeyHashTag" "Morley.Tezos.Crypto" "morley-1.16.1-inplace" 'False) (C1 ('MetaCons "KeyHashEd25519" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "KeyHashSecp256k1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "KeyHashP256" 'PrefixI 'False) (U1 :: Type -> Type)))

data KeyHash

Blake2b_160 hash of a public key.

Constructors

KeyHash

Fields

• khTag :: KeyHashTag

  We store which curve was used because it affects formatting.

• khBytes :: ByteString

  Hash itself.

Instances

Eq KeyHash

Defined in Morley.Tezos.Crypto

Methods

(==) :: KeyHash -> KeyHash -> Bool

(/=) :: KeyHash -> KeyHash -> Bool

Ord KeyHash

Defined in Morley.Tezos.Crypto

Methods

compare :: KeyHash -> KeyHash -> Ordering

(<) :: KeyHash -> KeyHash -> Bool

(<=) :: KeyHash -> KeyHash -> Bool

(>) :: KeyHash -> KeyHash -> Bool

(>=) :: KeyHash -> KeyHash -> Bool

max :: KeyHash -> KeyHash -> KeyHash

min :: KeyHash -> KeyHash -> KeyHash

Show KeyHash

Defined in Morley.Tezos.Crypto

Methods

showsPrec :: Int -> KeyHash -> ShowS

show :: KeyHash -> String

showList :: [KeyHash] -> ShowS

Generic KeyHash

Defined in Morley.Tezos.Crypto

Associated Types

type Rep KeyHash :: Type -> Type

Methods

from :: KeyHash -> Rep KeyHash x

to :: Rep KeyHash x -> KeyHash

ToJSON KeyHash

Defined in Morley.Tezos.Crypto

Methods

toJSON :: KeyHash -> Value

toEncoding :: KeyHash -> Encoding

toJSONList :: [KeyHash] -> Value

toEncodingList :: [KeyHash] -> Encoding

ToJSONKey KeyHash

Defined in Morley.Tezos.Crypto

Methods

toJSONKey :: ToJSONKeyFunction KeyHash

toJSONKeyList :: ToJSONKeyFunction [KeyHash]

FromJSON KeyHash

Defined in Morley.Tezos.Crypto

Methods

parseJSON :: Value -> Parser KeyHash

parseJSONList :: Value -> Parser [KeyHash]

FromJSONKey KeyHash

Defined in Morley.Tezos.Crypto

Methods

fromJSONKey :: FromJSONKeyFunction KeyHash

fromJSONKeyList :: FromJSONKeyFunction [KeyHash]

NFData KeyHash

Defined in Morley.Tezos.Crypto

Methods

rnf :: KeyHash -> ()

Buildable KeyHash

Defined in Morley.Tezos.Crypto

Methods

build :: KeyHash -> Builder

HasCLReader KeyHash

Defined in Morley.Tezos.Crypto

Methods

getReader :: ReadM KeyHash

getMetavar :: String

IsoValue KeyHash

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT KeyHash :: T

Methods

toVal :: KeyHash -> Value (ToT KeyHash)

fromVal :: Value (ToT KeyHash) -> KeyHash

TypeHasDoc KeyHash

Defined in Morley.Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions KeyHash :: FieldDescriptions

Methods

typeDocName :: Proxy KeyHash -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy KeyHash -> WithinParens -> Markdown

typeDocDependencies :: Proxy KeyHash -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep KeyHash

typeDocMichelsonRep :: TypeDocMichelsonRep KeyHash

Lift KeyHash

Defined in Morley.Tezos.Crypto

Methods

lift :: KeyHash -> Q Exp

liftTyped :: KeyHash -> Q (TExp KeyHash)

type Rep KeyHash

Defined in Morley.Tezos.Crypto

type Rep KeyHash = D1 ('MetaData "KeyHash" "Morley.Tezos.Crypto" "morley-1.16.1-inplace" 'False) (C1 ('MetaCons "KeyHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "khTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyHashTag) :*: S1 ('MetaSel ('Just "khBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))

type ToT KeyHash

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT KeyHash = 'TKeyHash

type TypeDocFieldDescriptions KeyHash

Defined in Morley.Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions KeyHash = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data Bls12381Fr

An element of an algebraic number field (scalar), used for multiplying Bls12381G1 and Bls12381G2.

Instances

Bounded Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

minBound :: Bls12381Fr

maxBound :: Bls12381Fr

Enum Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

succ :: Bls12381Fr -> Bls12381Fr

pred :: Bls12381Fr -> Bls12381Fr

toEnum :: Int -> Bls12381Fr

fromEnum :: Bls12381Fr -> Int

enumFrom :: Bls12381Fr -> [Bls12381Fr]

enumFromThen :: Bls12381Fr -> Bls12381Fr -> [Bls12381Fr]

enumFromTo :: Bls12381Fr -> Bls12381Fr -> [Bls12381Fr]

enumFromThenTo :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr -> [Bls12381Fr]

Eq Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

(==) :: Bls12381Fr -> Bls12381Fr -> Bool

(/=) :: Bls12381Fr -> Bls12381Fr -> Bool

Fractional Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

(/) :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

recip :: Bls12381Fr -> Bls12381Fr

fromRational :: Rational -> Bls12381Fr

Integral Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

quot :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

rem :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

div :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

mod :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

quotRem :: Bls12381Fr -> Bls12381Fr -> (Bls12381Fr, Bls12381Fr)

divMod :: Bls12381Fr -> Bls12381Fr -> (Bls12381Fr, Bls12381Fr)

toInteger :: Bls12381Fr -> Integer

Num Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

(+) :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

(-) :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

(*) :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

negate :: Bls12381Fr -> Bls12381Fr

abs :: Bls12381Fr -> Bls12381Fr

signum :: Bls12381Fr -> Bls12381Fr

fromInteger :: Integer -> Bls12381Fr

Ord Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

compare :: Bls12381Fr -> Bls12381Fr -> Ordering

(<) :: Bls12381Fr -> Bls12381Fr -> Bool

(<=) :: Bls12381Fr -> Bls12381Fr -> Bool

(>) :: Bls12381Fr -> Bls12381Fr -> Bool

(>=) :: Bls12381Fr -> Bls12381Fr -> Bool

max :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

min :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

Real Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

toRational :: Bls12381Fr -> Rational

Show Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

showsPrec :: Int -> Bls12381Fr -> ShowS

show :: Bls12381Fr -> String

showList :: [Bls12381Fr] -> ShowS

NFData Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

rnf :: Bls12381Fr -> ()

CurveObject Bls12381Fr

Defined in Morley.Tezos.Crypto.BLS12381

Methods

zero :: Bls12381Fr

negate :: Bls12381Fr -> Bls12381Fr

add :: Bls12381Fr -> Bls12381Fr -> Bls12381Fr

generate :: MonadRandom m => m Bls12381Fr

fromMichelsonBytes :: ByteString -> Either DeserializationError Bls12381Fr

toMichelsonBytes :: Bls12381Fr -> ByteString

IsoValue Bls12381Fr

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT Bls12381Fr :: T

Methods

toVal :: Bls12381Fr -> Value (ToT Bls12381Fr)

fromVal :: Value (ToT Bls12381Fr) -> Bls12381Fr

MultiplyPoint Bls12381Fr Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

multiply :: Bls12381Fr -> Bls12381G2 -> Bls12381G2

MultiplyPoint Bls12381Fr Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

multiply :: Bls12381Fr -> Bls12381G1 -> Bls12381G1

type ToT Bls12381Fr

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT Bls12381Fr = 'TBls12381Fr

data Bls12381G1

G1 point on the curve.

Instances

Eq Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

(==) :: Bls12381G1 -> Bls12381G1 -> Bool

(/=) :: Bls12381G1 -> Bls12381G1 -> Bool

Show Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

showsPrec :: Int -> Bls12381G1 -> ShowS

show :: Bls12381G1 -> String

showList :: [Bls12381G1] -> ShowS

NFData Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

rnf :: Bls12381G1 -> ()

CurveObject Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

zero :: Bls12381G1

negate :: Bls12381G1 -> Bls12381G1

add :: Bls12381G1 -> Bls12381G1 -> Bls12381G1

generate :: MonadRandom m => m Bls12381G1

fromMichelsonBytes :: ByteString -> Either DeserializationError Bls12381G1

toMichelsonBytes :: Bls12381G1 -> ByteString

IsoValue Bls12381G1

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT Bls12381G1 :: T

Methods

toVal :: Bls12381G1 -> Value (ToT Bls12381G1)

fromVal :: Value (ToT Bls12381G1) -> Bls12381G1

MultiplyPoint Integer Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

multiply :: Integer -> Bls12381G1 -> Bls12381G1

MultiplyPoint Bls12381Fr Bls12381G1

Defined in Morley.Tezos.Crypto.BLS12381

Methods

multiply :: Bls12381Fr -> Bls12381G1 -> Bls12381G1

type ToT Bls12381G1

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT Bls12381G1 = 'TBls12381G1

data Bls12381G2

G2 point on the curve.

Instances

Eq Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

(==) :: Bls12381G2 -> Bls12381G2 -> Bool

(/=) :: Bls12381G2 -> Bls12381G2 -> Bool

Show Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

showsPrec :: Int -> Bls12381G2 -> ShowS

show :: Bls12381G2 -> String

showList :: [Bls12381G2] -> ShowS

NFData Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

rnf :: Bls12381G2 -> ()

CurveObject Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

zero :: Bls12381G2

negate :: Bls12381G2 -> Bls12381G2

add :: Bls12381G2 -> Bls12381G2 -> Bls12381G2

generate :: MonadRandom m => m Bls12381G2

fromMichelsonBytes :: ByteString -> Either DeserializationError Bls12381G2

toMichelsonBytes :: Bls12381G2 -> ByteString

IsoValue Bls12381G2

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT Bls12381G2 :: T

Methods

toVal :: Bls12381G2 -> Value (ToT Bls12381G2)

fromVal :: Value (ToT Bls12381G2) -> Bls12381G2

MultiplyPoint Integer Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

multiply :: Integer -> Bls12381G2 -> Bls12381G2

MultiplyPoint Bls12381Fr Bls12381G2

Defined in Morley.Tezos.Crypto.BLS12381

Methods

multiply :: Bls12381Fr -> Bls12381G2 -> Bls12381G2

type ToT Bls12381G2

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT Bls12381G2 = 'TBls12381G2

Public/secret key functions

detSecretKey :: HasCallStack => ByteString -> SecretKey

Deterministicaly generate a secret key from seed. Type of the key depends on seed length.

toPublic :: SecretKey -> PublicKey

Create a public key from a secret key.

Signature

signatureToBytes :: ByteArray ba => Signature -> ba

Convert a Signature to raw bytes.

mkSignature :: ByteArray ba => ba -> Maybe Signature

Make a Signature from raw bytes. Can return only generic signature.

parseSignatureRaw :: ByteString -> Either ParseSignatureRawError Signature

signatureLengthBytes :: HasCallStack => Integral n => n

checkSignature :: PublicKey -> Signature -> ByteString -> Bool

Check that a sequence of bytes has been signed with a given key.

sign :: MonadRandom m => SecretKey -> ByteString -> m Signature

Formatting

data CryptoParseError

Error that can happen during parsing of cryptographic primitive types.

Constructors

CryptoParseWrongBase58Check

CryptoParseWrongTag ByteString

CryptoParseCryptoError CryptoError

CryptoParseUnexpectedLength Builder Int

CryptoParseBinaryError Text

Instances

Eq CryptoParseError

Defined in Morley.Tezos.Crypto.Util

Methods

(==) :: CryptoParseError -> CryptoParseError -> Bool

(/=) :: CryptoParseError -> CryptoParseError -> Bool

Show CryptoParseError

Defined in Morley.Tezos.Crypto.Util

Methods

showsPrec :: Int -> CryptoParseError -> ShowS

show :: CryptoParseError -> String

showList :: [CryptoParseError] -> ShowS

NFData CryptoParseError

Defined in Morley.Tezos.Crypto.Util

Methods

rnf :: CryptoParseError -> ()

Buildable CryptoParseError

Defined in Morley.Tezos.Crypto.Util

Methods

build :: CryptoParseError -> Builder

RenderDoc CryptoParseError

Defined in Morley.Tezos.Crypto.Util

Methods

renderDoc :: RenderContext -> CryptoParseError -> Doc

isRenderable :: CryptoParseError -> Bool

formatPublicKey :: PublicKey -> Text

mformatPublicKey :: PublicKey -> MText

parsePublicKey :: Text -> Either CryptoParseError PublicKey

parsePublicKeyRaw :: ByteString -> Either Text PublicKey

formatSignature :: Signature -> Text

mformatSignature :: Signature -> MText

parseSignature :: Text -> Either CryptoParseError Signature

formatKeyHash :: KeyHash -> Text

mformatKeyHash :: KeyHash -> MText

parseKeyHash :: Text -> Either CryptoParseError KeyHash

unsafeParseKeyHash :: HasCallStack => Text -> KeyHash

parseKeyHashRaw :: ByteString -> Either CryptoParseError KeyHash

keyHashLengthBytes :: Integral n => n

Length of key hash in bytes (only hash itself, no tags, checksums or anything).

formatSecretKey :: SecretKey -> Text

parseSecretKey :: Text -> Either CryptoParseError SecretKey

Parse unencrypted secret key. It accepts formats containing either with or without the unecrypted prefix.

Hashing

hashKey :: PublicKey -> KeyHash

Compute the b58check of a public key hash.

blake2b :: ByteString -> ByteString

Compute a cryptographic hash of a bytestring using the Blake2b_256 cryptographic hash function. It's used by the BLAKE2B instruction in Michelson.

blake2b160 :: ByteString -> ByteString

Compute a cryptographic hash of a bytestring using the Blake2b_160 cryptographic hash function.

keccak :: ByteString -> ByteString

Compute a cryptographic hash of a bytestring using the Keccak_256 cryptographic hash function. It is used by the KECCAK Michelson instruction.

sha256 :: ByteString -> ByteString

Compute a cryptographic hash of a bytestring using the Sha256 cryptographic hash function.

sha3 :: ByteString -> ByteString

Compute a cryptographic hash of a bytestring using the Sha3_256 cryptographic hash function. It is used by the SHA3 Michelson instruction.

sha512 :: ByteString -> ByteString

Compute a cryptographic hash of a bytestring using the Sha512 cryptographic hash function.

Timelock puzzle

data Chest

A locked chest

Instances

Eq Chest

Defined in Morley.Tezos.Crypto.Timelock

Methods

(==) :: Chest -> Chest -> Bool

(/=) :: Chest -> Chest -> Bool

Show Chest

Defined in Morley.Tezos.Crypto.Timelock

Methods

showsPrec :: Int -> Chest -> ShowS

show :: Chest -> String

showList :: [Chest] -> ShowS

Generic Chest

Defined in Morley.Tezos.Crypto.Timelock

Associated Types

type Rep Chest :: Type -> Type

Methods

from :: Chest -> Rep Chest x

to :: Rep Chest x -> Chest

Binary Chest

Defined in Morley.Tezos.Crypto.Timelock

Methods

put :: Chest -> Put

get :: Get Chest

putList :: [Chest] -> Put

NFData Chest

Defined in Morley.Tezos.Crypto.Timelock

Methods

rnf :: Chest -> ()

IsoValue Chest

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT Chest :: T

Methods

toVal :: Chest -> Value (ToT Chest)

fromVal :: Value (ToT Chest) -> Chest

TypeHasDoc Chest

Defined in Morley.Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions Chest :: FieldDescriptions

Methods

typeDocName :: Proxy Chest -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Chest -> WithinParens -> Markdown

typeDocDependencies :: Proxy Chest -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep Chest

typeDocMichelsonRep :: TypeDocMichelsonRep Chest

type Rep Chest

Defined in Morley.Tezos.Crypto.Timelock

type Rep Chest

type ToT Chest

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT Chest = 'TChest

type TypeDocFieldDescriptions Chest

Defined in Morley.Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions Chest = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data ChestKey

A chest "key" with proof that it was indeed opened fairly.

Instances

Eq ChestKey

Defined in Morley.Tezos.Crypto.Timelock

Methods

(==) :: ChestKey -> ChestKey -> Bool

(/=) :: ChestKey -> ChestKey -> Bool

Show ChestKey

Defined in Morley.Tezos.Crypto.Timelock

Methods

showsPrec :: Int -> ChestKey -> ShowS

show :: ChestKey -> String

showList :: [ChestKey] -> ShowS

Generic ChestKey

Defined in Morley.Tezos.Crypto.Timelock

Associated Types

type Rep ChestKey :: Type -> Type

Methods

from :: ChestKey -> Rep ChestKey x

to :: Rep ChestKey x -> ChestKey

Binary ChestKey

Defined in Morley.Tezos.Crypto.Timelock

Methods

put :: ChestKey -> Put

get :: Get ChestKey

putList :: [ChestKey] -> Put

NFData ChestKey

Defined in Morley.Tezos.Crypto.Timelock

Methods

rnf :: ChestKey -> ()

IsoValue ChestKey

Defined in Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT ChestKey :: T

Methods

toVal :: ChestKey -> Value (ToT ChestKey)

fromVal :: Value (ToT ChestKey) -> ChestKey

TypeHasDoc ChestKey

Defined in Morley.Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions ChestKey :: FieldDescriptions

Methods

typeDocName :: Proxy ChestKey -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy ChestKey -> WithinParens -> Markdown

typeDocDependencies :: Proxy ChestKey -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep ChestKey

typeDocMichelsonRep :: TypeDocMichelsonRep ChestKey

type Rep ChestKey

Defined in Morley.Tezos.Crypto.Timelock

type Rep ChestKey

type ToT ChestKey

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT ChestKey = 'TChestKey

type TypeDocFieldDescriptions ChestKey

Defined in Morley.Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions ChestKey = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

data OpeningResult

The result of opening the chest.

Constructors

Correct ByteString

The chest was opened correctly.

BogusCipher

The chest was opened correctly, but the contents do not decode with the given symmetric key.

BogusOpening

The chest was not opened correctly, i.e. proof verification failed.

Instances

Eq OpeningResult

Defined in Morley.Tezos.Crypto.Timelock

Methods

(==) :: OpeningResult -> OpeningResult -> Bool

(/=) :: OpeningResult -> OpeningResult -> Bool

Show OpeningResult

Defined in Morley.Tezos.Crypto.Timelock

Methods

showsPrec :: Int -> OpeningResult -> ShowS

show :: OpeningResult -> String

showList :: [OpeningResult] -> ShowS

newtype TLTime

Number of steps a timelock needs to be opened without knowing a "secret", i.e. modulo factorization.

The reference implementation uses OCaml int, and it can only be positive, so on 64-bit architecture it's actually a 62-bit natural. We use Word64 to represent it.

Constructors

UnsafeTLTime

Fields

• unTLTime :: Word64

Bundled Patterns

pattern TLTime :: Word64 -> TLTime

Instances

Bounded TLTime

Defined in Morley.Tezos.Crypto.Timelock

Methods

minBound :: TLTime

maxBound :: TLTime

Eq TLTime

Defined in Morley.Tezos.Crypto.Timelock

Methods

(==) :: TLTime -> TLTime -> Bool

(/=) :: TLTime -> TLTime -> Bool

Num TLTime

Defined in Morley.Tezos.Crypto.Timelock

Methods

(+) :: TLTime -> TLTime -> TLTime

(-) :: TLTime -> TLTime -> TLTime

(*) :: TLTime -> TLTime -> TLTime

negate :: TLTime -> TLTime

abs :: TLTime -> TLTime

signum :: TLTime -> TLTime

fromInteger :: Integer -> TLTime

Show TLTime

Defined in Morley.Tezos.Crypto.Timelock

Methods

showsPrec :: Int -> TLTime -> ShowS

show :: TLTime -> String

showList :: [TLTime] -> ShowS

Buildable TLTime

Defined in Morley.Tezos.Crypto.Timelock

Methods

build :: TLTime -> Builder

HasCLReader TLTime

Defined in Morley.Tezos.Crypto.Timelock

Methods

getReader :: ReadM TLTime

getMetavar :: String

openChest :: Chest -> ChestKey -> TLTime -> OpeningResult

Try to (quickly) open a chest with the given key, verifying the proof.

mkTLTime :: (Integral i, Bits i) => i -> Either Text TLTime

Safely creates TLTime checking for overflow and underflow. Accepts a number of any type.

unsafeMkTLTime :: HasCallStack => Word64 -> TLTime

Partial function for TLTime creation, it's pre-condition is that the argument must not exceed bounds of the TLTime.

Utilities

encodeBase58Check :: ByteString -> Text

Encode a bytestring in Base58Check format.

decodeBase58Check :: Text -> Maybe ByteString

Decode a bytestring from Base58Check format.

data B58CheckWithPrefixError

Constructors

B58CheckWithPrefixWrongPrefix ByteString

B58CheckWithPrefixWrongEncoding

Instances

Show B58CheckWithPrefixError

Defined in Morley.Tezos.Crypto.Util

Methods

showsPrec :: Int -> B58CheckWithPrefixError -> ShowS

show :: B58CheckWithPrefixError -> String

showList :: [B58CheckWithPrefixError] -> ShowS

decodeBase58CheckWithPrefix :: ByteString -> Text -> Either B58CheckWithPrefixError ByteString

Parse a base58check encoded value expecting some prefix. If the actual prefix matches the expected one, it's stripped of and the resulting payload is returned.

keyDecoders :: [TaggedDecoder PublicKey]

keyHashDecoders :: [TaggedDecoder KeyHash]