{- |
Module      : Haskoin.Test.Keys
Copyright   : No rights reserved
License     : MIT
Maintainer  : jprupp@protonmail.ch
Stability   : experimental
Portability : POSIX
-}
module Haskoin.Util.Arbitrary.Keys where

import Data.Bits (clearBit)
import Data.Coerce (coerce)
import Data.List (foldl')
import Data.Word (Word32)
import Haskoin.Crypto
import Haskoin.Keys.Common
import Haskoin.Keys.Extended
import Haskoin.Keys.Extended.Internal (Fingerprint (..))
import Haskoin.Util.Arbitrary.Crypto
import Test.QuickCheck

-- | Arbitrary private key with arbitrary compressed flag.
arbitrarySecKeyI :: Gen SecKeyI
arbitrarySecKeyI :: Gen SecKeyI
arbitrarySecKeyI = Bool -> SecKey -> SecKeyI
wrapSecKey (Bool -> SecKey -> SecKeyI) -> Gen Bool -> Gen (SecKey -> SecKeyI)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Bool
forall a. Arbitrary a => Gen a
arbitrary Gen (SecKey -> SecKeyI) -> Gen SecKey -> Gen SecKeyI
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen SecKey
forall a. Arbitrary a => Gen a
arbitrary

-- | Arbitrary keypair, both either compressed or not.
arbitraryKeyPair :: Gen (SecKeyI, PubKeyI)
arbitraryKeyPair :: Gen (SecKeyI, PubKeyI)
arbitraryKeyPair = do
    SecKeyI
k <- Gen SecKeyI
arbitrarySecKeyI
    (SecKeyI, PubKeyI) -> Gen (SecKeyI, PubKeyI)
forall (m :: * -> *) a. Monad m => a -> m a
return (SecKeyI
k, SecKeyI -> PubKeyI
derivePubKeyI SecKeyI
k)

arbitraryFingerprint :: Gen Fingerprint
arbitraryFingerprint :: Gen Fingerprint
arbitraryFingerprint = Word32 -> Fingerprint
Fingerprint (Word32 -> Fingerprint) -> Gen Word32 -> Gen Fingerprint
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word32
forall a. Arbitrary a => Gen a
arbitrary

-- | Arbitrary extended private key.
arbitraryXPrvKey :: Gen XPrvKey
arbitraryXPrvKey :: Gen XPrvKey
arbitraryXPrvKey =
    Word8 -> Fingerprint -> Word32 -> ChainCode -> SecKey -> XPrvKey
XPrvKey (Word8 -> Fingerprint -> Word32 -> ChainCode -> SecKey -> XPrvKey)
-> Gen Word8
-> Gen (Fingerprint -> Word32 -> ChainCode -> SecKey -> XPrvKey)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word8
forall a. Arbitrary a => Gen a
arbitrary
        Gen (Fingerprint -> Word32 -> ChainCode -> SecKey -> XPrvKey)
-> Gen Fingerprint
-> Gen (Word32 -> ChainCode -> SecKey -> XPrvKey)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen Fingerprint
arbitraryFingerprint
        Gen (Word32 -> ChainCode -> SecKey -> XPrvKey)
-> Gen Word32 -> Gen (ChainCode -> SecKey -> XPrvKey)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen Word32
forall a. Arbitrary a => Gen a
arbitrary
        Gen (ChainCode -> SecKey -> XPrvKey)
-> Gen ChainCode -> Gen (SecKey -> XPrvKey)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen ChainCode
arbitraryHash256
        Gen (SecKey -> XPrvKey) -> Gen SecKey -> Gen XPrvKey
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen SecKey
forall a. Arbitrary a => Gen a
arbitrary

-- | Arbitrary extended public key with its corresponding private key.
arbitraryXPubKey :: Gen (XPrvKey, XPubKey)
arbitraryXPubKey :: Gen (XPrvKey, XPubKey)
arbitraryXPubKey = (\XPrvKey
k -> (XPrvKey
k, XPrvKey -> XPubKey
deriveXPubKey XPrvKey
k)) (XPrvKey -> (XPrvKey, XPubKey))
-> Gen XPrvKey -> Gen (XPrvKey, XPubKey)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen XPrvKey
arbitraryXPrvKey

{- Custom derivations -}

-- | Arbitrary derivation index with last bit unset.
genIndex :: Gen Word32
genIndex :: Gen Word32
genIndex = (Word32 -> Int -> Word32
forall a. Bits a => a -> Int -> a
`clearBit` Int
31) (Word32 -> Word32) -> Gen Word32 -> Gen Word32
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word32
forall a. Arbitrary a => Gen a
arbitrary

-- | Arbitrary BIP-32 path index. Can be hardened or not.
arbitraryBip32PathIndex :: Gen Bip32PathIndex
arbitraryBip32PathIndex :: Gen Bip32PathIndex
arbitraryBip32PathIndex =
    [Gen Bip32PathIndex] -> Gen Bip32PathIndex
forall a. [Gen a] -> Gen a
oneof
        [ Word32 -> Bip32PathIndex
Bip32SoftIndex (Word32 -> Bip32PathIndex) -> Gen Word32 -> Gen Bip32PathIndex
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word32
genIndex
        , Word32 -> Bip32PathIndex
Bip32HardIndex (Word32 -> Bip32PathIndex) -> Gen Word32 -> Gen Bip32PathIndex
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word32
genIndex
        ]

-- | Arbitrary BIP-32 derivation path composed of only hardened derivations.
arbitraryHardPath :: Gen HardPath
arbitraryHardPath :: Gen HardPath
arbitraryHardPath = (HardPath -> Word32 -> HardPath)
-> HardPath -> [Word32] -> HardPath
forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
foldl' HardPath -> Word32 -> HardPath
forall t. HardOrAny t => DerivPathI t -> Word32 -> DerivPathI t
(:|) HardPath
forall t. DerivPathI t
Deriv ([Word32] -> HardPath) -> Gen [Word32] -> Gen HardPath
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word32 -> Gen [Word32]
forall a. Gen a -> Gen [a]
listOf Gen Word32
genIndex

-- | Arbitrary BIP-32 derivation path composed of only non-hardened derivations.
arbitrarySoftPath :: Gen SoftPath
arbitrarySoftPath :: Gen SoftPath
arbitrarySoftPath = (SoftPath -> Word32 -> SoftPath)
-> SoftPath -> [Word32] -> SoftPath
forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
foldl' SoftPath -> Word32 -> SoftPath
forall t. AnyOrSoft t => DerivPathI t -> Word32 -> DerivPathI t
(:/) SoftPath
forall t. DerivPathI t
Deriv ([Word32] -> SoftPath) -> Gen [Word32] -> Gen SoftPath
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Word32 -> Gen [Word32]
forall a. Gen a -> Gen [a]
listOf Gen Word32
genIndex

-- | Arbitrary derivation path composed of hardened and non-hardened derivations.
arbitraryDerivPath :: Gen DerivPath
arbitraryDerivPath :: Gen DerivPath
arbitraryDerivPath = [Bip32PathIndex] -> DerivPath
concatBip32Segments ([Bip32PathIndex] -> DerivPath)
-> Gen [Bip32PathIndex] -> Gen DerivPath
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen Bip32PathIndex -> Gen [Bip32PathIndex]
forall a. Gen a -> Gen [a]
listOf Gen Bip32PathIndex
arbitraryBip32PathIndex

{- | Arbitrary parsed derivation path. Can contain 'ParsedPrv', 'ParsedPub' or
 'ParsedEmpty' elements.
-}
arbitraryParsedPath :: Gen ParsedPath
arbitraryParsedPath :: Gen ParsedPath
arbitraryParsedPath =
    [Gen ParsedPath] -> Gen ParsedPath
forall a. [Gen a] -> Gen a
oneof
        [ DerivPath -> ParsedPath
ParsedPrv (DerivPath -> ParsedPath) -> Gen DerivPath -> Gen ParsedPath
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen DerivPath
arbitraryDerivPath
        , DerivPath -> ParsedPath
ParsedPub (DerivPath -> ParsedPath) -> Gen DerivPath -> Gen ParsedPath
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen DerivPath
arbitraryDerivPath
        , DerivPath -> ParsedPath
ParsedEmpty (DerivPath -> ParsedPath) -> Gen DerivPath -> Gen ParsedPath
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen DerivPath
arbitraryDerivPath
        ]

{- | Arbitrary message hash, private key, nonce and corresponding signature. The
 signature is generated with a random message, random private key and a random
 nonce.
-}
arbitrarySignature :: Gen (Hash256, SecKey, Sig)
arbitrarySignature :: Gen (ChainCode, SecKey, Sig)
arbitrarySignature = do
    ChainCode
m <- Gen ChainCode
arbitraryHash256
    SecKey
key <- Gen SecKey
forall a. Arbitrary a => Gen a
arbitrary
    let sig :: Sig
sig = SecKey -> ChainCode -> Sig
signHash SecKey
key ChainCode
m
    (ChainCode, SecKey, Sig) -> Gen (ChainCode, SecKey, Sig)
forall (m :: * -> *) a. Monad m => a -> m a
return (ChainCode
m, SecKey
key, Sig
sig)