Crypto.Secp256k1

Crytpographic functions from Bitcoin’s secp256k1 library.

Core Types

data SecKey

Secret Key

Instances

Read SecKey

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS SecKey

readList :: ReadS [SecKey]

readPrec :: ReadPrec SecKey

readListPrec :: ReadPrec [SecKey]

Show SecKey

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> SecKey -> ShowS

show :: SecKey -> String

showList :: [SecKey] -> ShowS

NFData SecKey

Defined in Crypto.Secp256k1

Methods

rnf :: SecKey -> ()

Eq SecKey

Defined in Crypto.Secp256k1

Methods

(==) :: SecKey -> SecKey -> Bool

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

Ord SecKey

Defined in Crypto.Secp256k1

Methods

compare :: SecKey -> SecKey -> Ordering

(<) :: SecKey -> SecKey -> Bool

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

(>) :: SecKey -> SecKey -> Bool

(>=) :: SecKey -> SecKey -> Bool

max :: SecKey -> SecKey -> SecKey

min :: SecKey -> SecKey -> SecKey

Hashable SecKey

Defined in Crypto.Secp256k1

Methods

hashWithSalt :: Int -> SecKey -> Int

hash :: SecKey -> Int

data PubKeyXY

Public Key with both X and Y coordinates

Instances

Read PubKeyXY

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS PubKeyXY

readList :: ReadS [PubKeyXY]

readPrec :: ReadPrec PubKeyXY

readListPrec :: ReadPrec [PubKeyXY]

Show PubKeyXY

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> PubKeyXY -> ShowS

show :: PubKeyXY -> String

showList :: [PubKeyXY] -> ShowS

NFData PubKeyXY

Defined in Crypto.Secp256k1

Methods

rnf :: PubKeyXY -> ()

Eq PubKeyXY

Defined in Crypto.Secp256k1

Methods

(==) :: PubKeyXY -> PubKeyXY -> Bool

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

Ord PubKeyXY

Defined in Crypto.Secp256k1

Methods

compare :: PubKeyXY -> PubKeyXY -> Ordering

(<) :: PubKeyXY -> PubKeyXY -> Bool

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

(>) :: PubKeyXY -> PubKeyXY -> Bool

(>=) :: PubKeyXY -> PubKeyXY -> Bool

max :: PubKeyXY -> PubKeyXY -> PubKeyXY

min :: PubKeyXY -> PubKeyXY -> PubKeyXY

Hashable PubKeyXY

Defined in Crypto.Secp256k1

Methods

hashWithSalt :: Int -> PubKeyXY -> Int

hash :: PubKeyXY -> Int

data PubKeyXO

Public Key with only an X coordinate.

Instances

Read PubKeyXO

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS PubKeyXO

readList :: ReadS [PubKeyXO]

readPrec :: ReadPrec PubKeyXO

readListPrec :: ReadPrec [PubKeyXO]

Show PubKeyXO

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> PubKeyXO -> ShowS

show :: PubKeyXO -> String

showList :: [PubKeyXO] -> ShowS

NFData PubKeyXO

Defined in Crypto.Secp256k1

Methods

rnf :: PubKeyXO -> ()

Eq PubKeyXO

Defined in Crypto.Secp256k1

Methods

(==) :: PubKeyXO -> PubKeyXO -> Bool

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

Ord PubKeyXO

Defined in Crypto.Secp256k1

Methods

compare :: PubKeyXO -> PubKeyXO -> Ordering

(<) :: PubKeyXO -> PubKeyXO -> Bool

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

(>) :: PubKeyXO -> PubKeyXO -> Bool

(>=) :: PubKeyXO -> PubKeyXO -> Bool

max :: PubKeyXO -> PubKeyXO -> PubKeyXO

min :: PubKeyXO -> PubKeyXO -> PubKeyXO

Hashable PubKeyXO

Defined in Crypto.Secp256k1

Methods

hashWithSalt :: Int -> PubKeyXO -> Int

hash :: PubKeyXO -> Int

data KeyPair

Structure containing information equivalent to SecKey and PubKeyXY

Instances

NFData KeyPair

Defined in Crypto.Secp256k1

Methods

rnf :: KeyPair -> ()

Eq KeyPair

Defined in Crypto.Secp256k1

Methods

(==) :: KeyPair -> KeyPair -> Bool

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

data Signature

Structure containing Signature (R,S) data.

Instances

Read Signature

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS Signature

readList :: ReadS [Signature]

readPrec :: ReadPrec Signature

readListPrec :: ReadPrec [Signature]

Show Signature

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

NFData Signature

Defined in Crypto.Secp256k1

Methods

rnf :: Signature -> ()

Eq Signature

Defined in Crypto.Secp256k1

Methods

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

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

data RecoverableSignature

Structure containing Signature AND recovery ID

Instances

Read RecoverableSignature

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS RecoverableSignature

readList :: ReadS [RecoverableSignature]

readPrec :: ReadPrec RecoverableSignature

readListPrec :: ReadPrec [RecoverableSignature]

Show RecoverableSignature

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> RecoverableSignature -> ShowS

show :: RecoverableSignature -> String

showList :: [RecoverableSignature] -> ShowS

NFData RecoverableSignature

Defined in Crypto.Secp256k1

Methods

rnf :: RecoverableSignature -> ()

Eq RecoverableSignature

Defined in Crypto.Secp256k1

Methods

(==) :: RecoverableSignature -> RecoverableSignature -> Bool

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

data SchnorrSignature

Structure containing Schnorr Signature

Instances

Read SchnorrSignature

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS SchnorrSignature

readList :: ReadS [SchnorrSignature]

readPrec :: ReadPrec SchnorrSignature

readListPrec :: ReadPrec [SchnorrSignature]

Show SchnorrSignature

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> SchnorrSignature -> ShowS

show :: SchnorrSignature -> String

showList :: [SchnorrSignature] -> ShowS

NFData SchnorrSignature

Defined in Crypto.Secp256k1

Methods

rnf :: SchnorrSignature -> ()

Eq SchnorrSignature

Defined in Crypto.Secp256k1

Methods

(==) :: SchnorrSignature -> SchnorrSignature -> Bool

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

data Tweak

Isomorphic to SecKey but specifically used for tweaking (EC Group operations) other keys

Instances

Read Tweak

Defined in Crypto.Secp256k1

Methods

readsPrec :: Int -> ReadS Tweak

readList :: ReadS [Tweak]

readPrec :: ReadPrec Tweak

readListPrec :: ReadPrec [Tweak]

Show Tweak

Defined in Crypto.Secp256k1

Methods

showsPrec :: Int -> Tweak -> ShowS

show :: Tweak -> String

showList :: [Tweak] -> ShowS

NFData Tweak

Defined in Crypto.Secp256k1

Methods

rnf :: Tweak -> ()

Eq Tweak

Defined in Crypto.Secp256k1

Methods

(==) :: Tweak -> Tweak -> Bool

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

Ord Tweak

Defined in Crypto.Secp256k1

Methods

compare :: Tweak -> Tweak -> Ordering

(<) :: Tweak -> Tweak -> Bool

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

(>) :: Tweak -> Tweak -> Bool

(>=) :: Tweak -> Tweak -> Bool

max :: Tweak -> Tweak -> Tweak

min :: Tweak -> Tweak -> Tweak

Parsing and Serialization

importSecKey :: ByteString -> Maybe SecKey

Parses SecKey, will be Nothing if the ByteString corresponds to 0{32} or is not 32 bytes in length

exportSecKey :: SecKey -> ByteString

importPubKeyXY :: ByteString -> Maybe PubKeyXY

Parses a 33 or 65 byte PubKeyXY, all other lengths will result in Nothing

exportPubKeyXY :: Bool -> PubKeyXY -> ByteString

Serialize PubKeyXY. First argument True for compressed output (33 bytes), False for uncompressed (65 bytes).

importPubKeyXO :: ByteString -> Maybe PubKeyXO

Parses PubKeyXO from ByteString, will be Nothing if the pubkey corresponds to the Point at Infinity or the the ByteString is not 32 bytes long

exportPubKeyXO :: PubKeyXO -> ByteString

Serializes PubKeyXO to 32 byte ByteString

importSignatureCompact :: ByteString -> Maybe Signature

Parses Signature from Compact (64 bytes) representation.

importSignatureDer :: ByteString -> Maybe Signature

Parses Signature from DER representation.

exportSignatureCompact :: Signature -> ByteString

Serializes Signature to Compact (64 byte) representation

exportSignatureDer :: Signature -> ByteString

Serializes Signature to DER (71 | 72 bytes) representation

importRecoverableSignature :: ByteString -> Maybe RecoverableSignature

Parses RecoverableSignature from Compact (65 byte) representation

exportRecoverableSignature :: RecoverableSignature -> ByteString

Serializes RecoverableSignature to Compact (65 byte) representation

importSchnorrSignature :: ByteString -> Maybe SchnorrSignature

Parses SchnorrSignature from Schnorr (64 byte) representation

exportSchnorrSignature :: SchnorrSignature -> ByteString

Serializes SchnorrSignature to Schnorr (64 byte) representation

importTweak :: ByteString -> Maybe Tweak

Parses Tweak from 32 byte ByteString. If the ByteString is an invalid SecKey then this will yield Nothing

ECDSA Operations

ecdsaVerify :: ByteString -> PubKeyXY -> Signature -> Bool

Verify message signature. True means that the signature is correct.

ecdsaSign :: SecKey -> ByteString -> Maybe Signature

Signs ByteString with SecKey only if ByteString is 32 bytes.

ecdsaSignRecoverable :: SecKey -> ByteString -> Maybe RecoverableSignature

Signs ByteString with SecKey only if ByteString is 32 bytes. Retains ability to compute PubKeyXY from the RecoverableSignature and the original message (ByteString)

ecdsaRecover :: RecoverableSignature -> ByteString -> Maybe PubKeyXY

Computes PubKeyXY from RecoverableSignature and the original message that was signed (must be 32 bytes).

ecdsaNormalizeSignature :: Signature -> Signature

Convert a Signature to a normalized lower-S form. If the Signature was already in its lower-S form it will be equal to the input.

Conversions

recSigToSig :: RecoverableSignature -> Signature

Forgets the recovery id of a signature

derivePubKey :: SecKey -> PubKeyXY

Use SecKey to compute the corresponding PubKeyXY

keyPairCreate :: SecKey -> KeyPair

Compute KeyPair structure from SecKey

keyPairSecKey :: KeyPair -> SecKey

Project SecKey from KeyPair

keyPairPubKeyXY :: KeyPair -> PubKeyXY

Project PubKeyXY from KeyPair

keyPairPubKeyXO :: KeyPair -> (PubKeyXO, Bool)

Project PubKeyXO from KeyPair as well as parity bit. True indicates that the public key is the same as it would be if you had serialized the PubKeyXO and it was prefixed with flagsTagPubkeyOdd. False indicates it would be prefixed by flagsTagPubkeyEven

xyToXO :: PubKeyXY -> (PubKeyXO, Bool)

Convert PubKeyXY to PubKeyXO. See keyPairPubKeyXO for more information on how to interpret the parity bit.

Tweaks

secKeyTweakAdd :: SecKey -> Tweak -> Maybe SecKey

Add Tweak to SecKey.

secKeyTweakMul :: SecKey -> Tweak -> Maybe SecKey

Multiply SecKey by Tweak.

keyPairPubKeyXOTweakAdd :: KeyPair -> Tweak -> Maybe KeyPair

Tweak a KeyPair with a Tweak. If the resulting KeyPair is invalid (0, Infinity), then the result is Nothing

pubKeyCombine :: [PubKeyXY] -> Maybe PubKeyXY

Combine a list of PubKeyXYs into a single PubKeyXY. This will result in Nothing if the group operation results in the Point at Infinity

pubKeyNegate :: PubKeyXY -> PubKeyXY

Negate a PubKeyXY

secKeyNegate :: SecKey -> SecKey

Negate a SecKey

tweakNegate :: Tweak -> Tweak

Negate a Tweak

pubKeyTweakAdd :: PubKeyXY -> Tweak -> Maybe PubKeyXY

Add Tweak to PubKeyXY. This will result in Nothing if the group operation results in the Point at Infinity

pubKeyTweakMul :: PubKeyXY -> Tweak -> Maybe PubKeyXY

Multiply PubKeyXY by Tweak. This will result in Nothing if the group operation results in the Point at Infinity

pubKeyXOTweakAdd :: PubKeyXO -> Tweak -> Maybe PubKeyXY

Add Tweak to PubKeyXO. This will result in Nothing if the group operation results in the Point at Infinity

pubKeyXOTweakAddCheck :: PubKeyXO -> Bool -> PubKeyXO -> Tweak -> Bool

Check that a PubKeyXO is the result of the specified tweak operation. True means it was.

Schnorr Operations

schnorrSign :: Maybe StdGen -> KeyPair -> ByteString -> Maybe SchnorrSignature

Compute a schnorr signature using a KeyPair. The ByteString must be 32 bytes long to get a Just out of this function. Optionally takes a StdGen for deterministic signing.

schnorrSignDeterministic :: KeyPair -> ByteString -> Maybe SchnorrSignature

Compute a deterministic schnorr signature using a KeyPair.

schnorrSignNondeterministic :: KeyPair -> ByteString -> IO (Maybe SchnorrSignature)

Compute a non-deterministic schnorr signature using a KeyPair.

schnorrVerify :: PubKeyXO -> ByteString -> SchnorrSignature -> Bool

Verify the authenticity of a schnorr signature. True means the Signature is correct.

Other

taggedSha256 :: ByteString -> ByteString -> SizedByteArray 32 ByteString

Generate a tagged sha256 digest as specified in BIP340

ecdh :: SecKey -> PubKeyXY -> SizedByteArray 32 ByteString

Compute a shared secret using ECDH and SHA256. This algorithm uses your own SecKey, your counterparty's PubKeyXY and results in a 32 byte SHA256 Digest.