Fix build, READMEs and ChangeLog

Author: locallycompact

README.md

@@ -0,0 +1,24 @@
+# hydra-invoices
+
+Invoice types and functions for the hydra lightning protocol.
+
+This contains the following projects:
+* [hydra-invoices](hydra-invoices/)
+
+## Building
+
+```
+nix build
+````
+
+## Development
+
+```
+nix develop
+```
+
+## Testing
+
+```
+om ci run
+```

hydra-invoices/ChangeLog.md

@@ -1,3 +1,8 @@
 # Changelog for hydra-invoices
 
-## v0.1.0.0
+## v0.0.1.0
+
+* Initial commit of `hydra-invoices`.
+* Add `Invoice` type with parameterisable fields.
+* Add `StandardInvoice` type with typical field types for use with `cardano-api`.
+* Add `generateStandardInvoice` function.

hydra-invoices/README.md

@@ -1,9 +1,8 @@
 # hydra-invoices
 
-This template is a barebones haskell template using
-[horizon-platform](https://gitlab.horizon-haskell.net/package-sets/horizon-platform).
-Just add things to the dependencies in the cabal file.
+Invoice types and functions for use with Hydra Lightning payments.
 
-To change the package set, just alter the `horizon` input field in the `flake.nix` to
-a different url and ref.
+An `Invoice` is a request for payment of a certain amount.
 
+You can use the `Hydra.Invoice.StandardInvoice` type for the most common use case - which
+uses standard types from `cardano-api` for its fields.

hydra-invoices/app/Main.hs

@@ -31,22 +31,10 @@ library
   build-depends:
     , bytestring
     , cardano-api
-    , crypton
+    , cardano-binary
+    , cardano-crypto-class
     , random
     , time
 
   exposed-modules: Hydra.Invoice
   hs-source-dirs:  src
-
-executable hydra-invoices
-  import:         lang
-  main-is:        Main.hs
-  hs-source-dirs: app
-  build-depends:  hydra-invoices
-
-test-suite hydra-invoices-tests
-  import:         lang
-  type:           exitcode-stdio-1.0
-  main-is:        Main.hs
-  hs-source-dirs: test
-  build-depends:  hydra-invoices

hydra-invoices/hydra-invoices.cabal

@@ -1,36 +1,37 @@
 module Hydra.Invoice (
-    Invoice (MkInvoice),
-    PreImage,
-    PaymentId,
-    StandardInvoice,
-    generatePreImage,
-    hashPaymentId,
+  Invoice (MkInvoice),
+  PreImage (..),
+  PaymentId (..),
+  StandardInvoice,
+  generatePreImage,
+  hashPaymentId,
+  generateStandardInvoice,
 ) where
 
-import Cardano.Api (Address, Hash, ShelleyAddr, Value)
+import Cardano.Api (Address, ShelleyAddr, Value)
+import Cardano.Binary qualified as CBOR
+import Cardano.Crypto.Hash qualified as Crypto
 import Control.Monad (replicateM)
-import Crypto.Hash qualified as CH
 import Data.ByteString qualified as BS
-import Data.ByteString.Lazy qualified as BSL
 import Data.Kind (Type)
 import Data.Time (UTCTime)
 import System.Random (randomRIO)
 
 type Invoice :: Type -> Type -> Type -> Type -> Type
 data Invoice paymentIdType addressType amountType datetimeType = MkInvoice
-    { paymentId :: paymentIdType
-    , recipient :: addressType
-    , amount :: amountType
-    , date :: datetimeType
-    }
-    deriving stock (Eq, Show)
+  { paymentId :: paymentIdType
+  , recipient :: addressType
+  , amount :: amountType
+  , date :: datetimeType
+  }
+  deriving stock (Eq, Show)
 
 type PreImage :: Type
 newtype PreImage = UnsafePreImage {fromPreImage :: BS.ByteString}
-    deriving stock (Show, Eq)
+  deriving stock (Show, Eq)
 
 type PaymentId :: Type
-newtype PaymentId = UnsafePaymentId {fromPaymentId :: Hash BS.ByteString}
+newtype PaymentId = UnsafePaymentId {fromPaymentId :: Crypto.Hash Crypto.SHA256 BS.ByteString}
 
 type StandardInvoice :: Type
 type StandardInvoice = Invoice PaymentId (Address ShelleyAddr) Value UTCTime
@@ -39,16 +40,17 @@ generatePreImage :: IO PreImage
 generatePreImage = UnsafePreImage . BS.pack <$> replicateM 32 (randomRIO (0, 255))
 
 hashPaymentId :: PreImage -> PaymentId
-hashPaymentId (UnsafePreImage preimage) = UnsafePaymentId (CH.hashlazy $ BSL.fromStrict preimage)
+hashPaymentId (UnsafePreImage preimage) =
+  UnsafePaymentId $ Crypto.hashWith CBOR.serialize' preimage
 
 generateStandardInvoice :: Address ShelleyAddr -> Value -> UTCTime -> IO (StandardInvoice, PreImage)
 generateStandardInvoice recipient amount date = do
-    preImage <- generatePreImage
-    let invoice =
-            MkInvoice
-                { paymentId = hashPaymentId preImage
-                , recipient
-                , amount
-                , date
-                }
-    pure (invoice, preImage)
+  preImage <- generatePreImage
+  let invoice =
+        MkInvoice
+          { paymentId = hashPaymentId preImage
+          , recipient
+          , amount
+          , date
+          }
+  pure (invoice, preImage)

hydra-invoices/src/Hydra/Invoice.hs

@@ -0,0 +1,18 @@
+roots = [
+   "^Main.main$"
+ , "^Spec.main$"
+ , "^Paths_.*"
+]
+
+root-instances = [
+   { class = '\.Eq$' }
+ , { class = '\.Show$' }
+ , { class = '\.Read$' }
+ , { class = '\.Enum$' }
+ , { class = '\.Bounded$' }
+ , { class = '\.Generic$' }
+ , { class = '\.Ord$' }
+ , { class = '\.Num$' }
+ , { class = '\.Real$' }
+ , { class = '\.Integral$' }
+ ]