Tezos.Crypto.Secp256k1

Secp256k1 cryptographic primitives.

Cryptographic primitive types

data PublicKey

Secp256k1 public cryptographic key.

Constructors

PublicKey

Fields

• unPublicKey :: PublicKey
• pkBytes :: Maybe ByteString

  This is the hack we use to make serialization correct. Decoding is currently not implemented, so when we have to decode bytes we remember these bytes and produce some random public key.

  TODO (#18) remove it.

Instances

Eq PublicKey

Defined in Tezos.Crypto.Secp256k1

Methods

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

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

Show PublicKey

Defined in Tezos.Crypto.Secp256k1

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

Generic PublicKey

Defined in Tezos.Crypto.Secp256k1

Associated Types

type Rep PublicKey :: Type -> Type

Methods

from :: PublicKey -> Rep PublicKey x

to :: Rep PublicKey x -> PublicKey

Arbitrary PublicKey

Defined in Tezos.Crypto.Secp256k1

Methods

arbitrary :: Gen PublicKey

shrink :: PublicKey -> [PublicKey]

NFData PublicKey

Defined in Tezos.Crypto.Secp256k1

Methods

rnf :: PublicKey -> ()

Buildable PublicKey

Defined in Tezos.Crypto.Secp256k1

Methods

build :: PublicKey -> Builder

type Rep PublicKey

Defined in Tezos.Crypto.Secp256k1

type Rep PublicKey = D1 ('MetaData "PublicKey" "Tezos.Crypto.Secp256k1" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'False) (C1 ('MetaCons "PublicKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicKey) :*: S1 ('MetaSel ('Just "pkBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString))))

data SecretKey

Secp256k1 secret cryptographic key.

Instances

Eq SecretKey

Defined in Tezos.Crypto.Secp256k1

Methods

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

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

Show SecretKey

Defined in Tezos.Crypto.Secp256k1

Methods

showsPrec :: Int -> SecretKey -> ShowS

show :: SecretKey -> String

showList :: [SecretKey] -> ShowS

Generic SecretKey

Defined in Tezos.Crypto.Secp256k1

Associated Types

type Rep SecretKey :: Type -> Type

Methods

from :: SecretKey -> Rep SecretKey x

to :: Rep SecretKey x -> SecretKey

Arbitrary SecretKey

Defined in Tezos.Crypto.Secp256k1

Methods

arbitrary :: Gen SecretKey

shrink :: SecretKey -> [SecretKey]

NFData SecretKey

Defined in Tezos.Crypto.Secp256k1

Methods

rnf :: SecretKey -> ()

type Rep SecretKey

Defined in Tezos.Crypto.Secp256k1

type Rep SecretKey = D1 ('MetaData "SecretKey" "Tezos.Crypto.Secp256k1" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'True) (C1 ('MetaCons "SecretKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSecretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KeyPair)))

newtype Signature

Secp256k1 cryptographic signature.

Constructors

Signature

Fields

• unSignature :: Signature

Instances

Eq Signature

Defined in Tezos.Crypto.Secp256k1

Methods

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

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

Show Signature

Defined in Tezos.Crypto.Secp256k1

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

Generic Signature

Defined in Tezos.Crypto.Secp256k1

Associated Types

type Rep Signature :: Type -> Type

Methods

from :: Signature -> Rep Signature x

to :: Rep Signature x -> Signature

Arbitrary Signature

Defined in Tezos.Crypto.Secp256k1

Methods

arbitrary :: Gen Signature

shrink :: Signature -> [Signature]

NFData Signature

Defined in Tezos.Crypto.Secp256k1

Methods

rnf :: Signature -> ()

Buildable Signature

Defined in Tezos.Crypto.Secp256k1

Methods

build :: Signature -> Builder

type Rep Signature

Defined in Tezos.Crypto.Secp256k1

type Rep Signature = D1 ('MetaData "Signature" "Tezos.Crypto.Secp256k1" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Signature)))

detSecretKey :: ByteString -> SecretKey

Deterministicaly generate a secret key from seed.

toPublic :: SecretKey -> PublicKey

Create a public key from a secret key.

Raw bytes (no checksums, tags or anything)

publicKeyToBytes :: forall ba. ByteArray ba => PublicKey -> ba

Convert a PublicKey to raw bytes.

TODO (#18): apparently it uses compressed SEC format as described in https://www.oreilly.com/library/view/programming-bitcoin/9781492031482/ch04.html However, it is not tested yet.

mkPublicKey :: ByteArrayAccess ba => ba -> Either CryptoParseError PublicKey

Make a PublicKey from raw bytes.

TODO (#18): it should decode from compressed SEC format, but it's left for a future task, so for now we return a constant.

publicKeyLengthBytes :: Integral n => n

signatureToBytes :: ByteArray ba => Signature -> ba

Convert a PublicKey to raw bytes.

TODO (#18): apparently a signature always has 64 bytes, so this format might be correct, but it is not tested.

mkSignature :: ByteArray ba => ba -> Either CryptoParseError Signature

Make a Signature from raw bytes.

TODO (#18): apparently a signature always has 64 bytes, so this format might be correct, but it is not tested.

signatureLengthBytes :: Integral n => n

Formatting and parsing

formatPublicKey :: PublicKey -> Text

mformatPublicKey :: PublicKey -> MText

parsePublicKey :: Text -> Either CryptoParseError PublicKey

formatSignature :: Signature -> Text

mformatSignature :: Signature -> MText

parseSignature :: Text -> Either CryptoParseError Signature

Signing

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

Sign a message using the secret key.

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

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