From fa5c74d361207a9a3621a41f5bc82eb2d451a6bf Mon Sep 17 00:00:00 2001 From: Johannes Lund Date: Mon, 1 Jul 2019 16:35:26 +0200 Subject: [PATCH] Update Jormungandr.Binary module comment --- lib/jormungandr/src/Cardano/Wallet/Jormungandr/Binary.hs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/jormungandr/src/Cardano/Wallet/Jormungandr/Binary.hs b/lib/jormungandr/src/Cardano/Wallet/Jormungandr/Binary.hs index d9641a0b32d..19840d6dafa 100644 --- 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 (..)