change the repository structure to contain multiple packages

Author: evgeny-osipenko

CHANGELOG.md renamed to secp256k1-haskell/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.7.1
+### Changed
+- Reworked the structure of the Internal modules to allow having add-on packages for optional libsecp256k1 features.
+
+## 0.7.0
+### Changed
+- Bump base16 dependency version.
+
 ## 0.6.1
 ### Changed
 - Bump version and LTS Haskell.

secp256k1-haskell/LICENSE

@@ -0,0 +1 @@
+../LICENSE

secp256k1-haskell/README.md

@@ -0,0 +1 @@
+../README.md

Setup.hs renamed to secp256k1-haskell/Setup.hs

@@ -23,7 +23,7 @@ dependencies:
   - hashable >=1.2.6 && <1.5
   - QuickCheck >=2.9.2 && <2.15
   - string-conversions >=0.4 && <0.5
-  - unliftio-core >=0.1.0 && <0.3 
+  - unliftio-core >=0.1.0 && <0.3
 library:
   source-dirs: src
   generated-exposed-modules:

package.yaml renamed to secp256k1-haskell/package.yaml

@@ -1,6 +1,6 @@
 cabal-version: 2.0
 
--- This file has been generated from package.yaml by hpack version 0.35.1.
+-- This file has been generated from package.yaml by hpack version 0.35.2.
 --
 -- see: https://github.com/sol/hpack
 
@@ -28,7 +28,11 @@ source-repository head
 library
   exposed-modules:
       Crypto.Secp256k1
-      Crypto.Secp256k1.Internal
+      Crypto.Secp256k1.Internal.Base
+      Crypto.Secp256k1.Internal.BaseOps
+      Crypto.Secp256k1.Internal.Context
+      Crypto.Secp256k1.Internal.ForeignTypes
+      Crypto.Secp256k1.Internal.Util
       Paths_secp256k1_haskell
   autogen-modules:
       Paths_secp256k1_haskell

secp256k1-haskell.cabal renamed to secp256k1-haskell/secp256k1-haskell.cabal

@@ -0,0 +1,56 @@
+-- |
+-- Module      : Crypto.Secp256k1
+-- License     : UNLICENSE
+-- Maintainer  : Jean-Pierre Rupp <[email protected]>
+-- Stability   : experimental
+-- Portability : POSIX
+--
+-- Crytpographic functions from Bitcoin’s secp256k1 library.
+module Crypto.Secp256k1
+  ( -- * Messages
+    Msg,
+    msg,
+    getMsg,
+
+    -- * Secret Keys
+    SecKey,
+    secKey,
+    getSecKey,
+    derivePubKey,
+
+    -- * Public Keys
+    PubKey,
+    importPubKey,
+    exportPubKey,
+
+    -- * Signatures
+    Sig,
+    signMsg,
+    verifySig,
+    normalizeSig,
+
+    -- ** DER
+    importSig,
+    exportSig,
+
+    -- ** Compact
+    CompactSig,
+    getCompactSig,
+    compactSig,
+    exportCompactSig,
+    importCompactSig,
+
+    -- * Addition & Multiplication
+    Tweak,
+    tweak,
+    getTweak,
+    tweakAddSecKey,
+    tweakMulSecKey,
+    tweakAddPubKey,
+    tweakMulPubKey,
+    combinePubKeys,
+    tweakNegate,
+  )
+where
+
+import Crypto.Secp256k1.Internal.Base

secp256k1-haskell/src/Crypto/Secp256k1.hs

@@ -1,8 +1,8 @@
 {-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
-{-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE ImportQualifiedPost #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
 
 -- |
 -- Module      : Crypto.Secp256k1
@@ -12,60 +12,46 @@
 -- Portability : POSIX
 --
 -- Crytpographic functions from Bitcoin’s secp256k1 library.
-module Crypto.Secp256k1
-  ( -- * Messages
-    Msg,
-    msg,
-    getMsg,
-
-    -- * Secret Keys
-    SecKey,
-    secKey,
-    getSecKey,
-    derivePubKey,
-
-    -- * Public Keys
-    PubKey,
-    importPubKey,
-    exportPubKey,
-
-    -- * Signatures
-    Sig,
-    signMsg,
-    verifySig,
-    normalizeSig,
-
-    -- ** DER
-    importSig,
-    exportSig,
-
-    -- ** Compact
-    CompactSig,
-    getCompactSig,
-    compactSig,
-    exportCompactSig,
-    importCompactSig,
-
-    -- * Addition & Multiplication
-    Tweak,
-    tweak,
-    getTweak,
-    tweakAddSecKey,
-    tweakMulSecKey,
-    tweakAddPubKey,
-    tweakMulPubKey,
-    combinePubKeys,
-    tweakNegate,
-  )
-where
+--
+-- The API for this module may change at any time. This is an internal module only
+-- exposed for hacking and experimentation.
+module Crypto.Secp256k1.Internal.Base where
 
 import Control.DeepSeq (NFData)
 import Control.Monad (replicateM, unless, (<=<))
-import Crypto.Secp256k1.Internal
-import Data.Base16.Types (assertBase16, extractBase16)
+import Crypto.Secp256k1.Internal.BaseOps
+  ( ecPubKeyCombine,
+    ecPubKeyCreate,
+    ecPubKeyParse,
+    ecPubKeySerialize,
+    ecPubKeyTweakAdd,
+    ecPubKeyTweakMul,
+    ecSecKeyTweakAdd,
+    ecSecKeyTweakMul,
+    ecTweakNegate,
+    ecdsaSign,
+    ecdsaSignatureNormalize,
+    ecdsaSignatureParseCompact,
+    ecdsaSignatureParseDer,
+    ecdsaSignatureSerializeCompact,
+    ecdsaSignatureSerializeDer,
+    ecdsaVerify,
+  )
+import Crypto.Secp256k1.Internal.Context (ctx)
+import Crypto.Secp256k1.Internal.ForeignTypes
+  ( compressed,
+    isSuccess,
+    uncompressed,
+  )
+import Crypto.Secp256k1.Internal.Util
+  ( decodeHex,
+    packByteString,
+    showsHex,
+    unsafePackByteString,
+    unsafeUseByteString,
+  )
 import Data.ByteString (ByteString)
 import Data.ByteString qualified as BS
-import Data.ByteString.Base16 (decodeBase16, encodeBase16, isBase16)
 import Data.Hashable (Hashable (..))
 import Data.Maybe (fromJust, fromMaybe, isJust)
 import Data.Serialize
@@ -74,7 +60,6 @@ import Data.Serialize
     putByteString,
   )
 import Data.String (IsString (..))
-import Data.String.Conversions (ConvertibleStrings, cs)
 import Foreign
   ( alloca,
     allocaArray,
@@ -144,12 +129,6 @@ instance Serialize CompactSig where
   put (CompactSig bs) = putByteString bs
   get = CompactSig <$> getByteString 64
 
-decodeHex :: (ConvertibleStrings a ByteString) => a -> Maybe ByteString
-decodeHex str =
-  if isBase16 $ cs str
-    then Just . decodeBase16 $ assertBase16 $ cs str
-    else Nothing
-
 instance Read PubKey where
   readPrec = do
     String str <- lexP
@@ -164,7 +143,7 @@ instance IsString PubKey where
       e = error "Could not decode public key from hex string"
 
 instance Show PubKey where
-  showsPrec _ = shows . extractBase16 . encodeBase16 . exportPubKey True
+  showsPrec _ = showsHex . exportPubKey True
 
 instance Read Msg where
   readPrec = parens $ do
@@ -180,7 +159,7 @@ instance IsString Msg where
       e = error "Could not decode message from hex string"
 
 instance Show Msg where
-  showsPrec _ = shows . extractBase16 . encodeBase16 . getMsg
+  showsPrec _ = showsHex . getMsg
 
 instance Read Sig where
   readPrec = parens $ do
@@ -196,7 +175,7 @@ instance Hashable Sig where
   i `hashWithSalt` s = i `hashWithSalt` exportSig s
 
 instance Show Sig where
-  showsPrec _ = shows . extractBase16 . encodeBase16 . exportSig
+  showsPrec _ = showsHex . exportSig
 
 instance Read SecKey where
   readPrec = parens $ do
@@ -212,7 +191,7 @@ instance IsString SecKey where
       e = error "Colud not decode secret key from hex string"
 
 instance Show SecKey where
-  showsPrec _ = shows . extractBase16 . encodeBase16 . getSecKey
+  showsPrec _ = showsHex . getSecKey
 
 instance Hashable Tweak where
   i `hashWithSalt` t = i `hashWithSalt` getTweak t
@@ -228,7 +207,7 @@ instance IsString Tweak where
       e = error "Could not decode tweak from hex string"
 
 instance Show Tweak where
-  showsPrec _ = shows . extractBase16 . encodeBase16 . getTweak
+  showsPrec _ = showsHex . getTweak
 
 -- | Import 32-byte 'ByteString' as 'Msg'.
 msg :: ByteString -> Maybe Msg