Update Jormungandr.Binary module comment

cardano-foundation · Jul 1, 2019 · fa5c74d · fa5c74d
1 parent 96d09ee
commit fa5c74d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lib/jormungandr/src/Cardano/Wallet/Jormungandr/Binary.hs b/lib/jormungandr/src/Cardano/Wallet/Jormungandr/Binary.hs
@@ -12,8 +12,14 @@
 -- License: MIT
 --
 -- The format is for the Shelley era as implemented by the Jörmungandr node.
---
 -- It is described [here](https://github.com/input-output-hk/rust-cardano/blob/master/chain-impl-mockchain/doc/format.md)
+--
+-- The module to some extent defines its own Jörmungandr-specific types,
+-- different from "Cardano.Wallet.Primitive.Types". Here, transactions are just
+-- one of many possible 'Message's that can be included in a block.
+--
+-- In some cases it also leads us to /throw exceptions/ when integers would
+-- otherwise overflow (look for uses of 'toEnum').
 
 module Cardano.Wallet.Jormungandr.Binary
     ( Block (..)