module description in Genesis.Convert

Author: avieth

src/lib/Ouroboros/Byron/Proxy/Genesis/Convert.hs

@@ -1,3 +1,14 @@
+{-|
+Module      : Ouroboros.Byron.Proxy.Genesis.Convert
+Description : Conversion of legacy cardano-sl genesis configuration.
+
+cardano-byron-proxy must use legacy cardano-sl genesis configuration in order
+to run the Byron side, and must also use a similar configuration to set up
+the Shelley side. The definitions in this module convert values of legacy Byron
+configuration types (cardano-sl) into their corresponding new Shelley
+types (cardano-ledger).
+-}
+
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE GADTSyntax #-}
 {-# LANGUAGE OverloadedStrings #-}
@@ -8,8 +19,6 @@
 {-# LANGUAGE ApplicativeDo #-}
 {-# LANGUAGE PatternSynonyms #-}
 
-{-# LANGUAGE TypeFamilies #-}
-
 module Ouroboros.Byron.Proxy.Genesis.Convert where
 
 import Data.Coerce (coerce)
@@ -196,7 +205,6 @@ convertProtocolParameters bvd = Cardano.ProtocolParameters
   , Cardano.ppUnlockStakeEpoch = convertEpochIndex (CSL.bvdUnlockStakeEpoch bvd)
   }
 
-
 convertGenesisSpec :: CSL.GenesisSpec -> Cardano.GenesisSpec
 convertGenesisSpec gspec = Cardano.UnsafeGenesisSpec
   { Cardano.gsAvvmDistr = convertAvvmDistr (CSL.gsAvvmDistr gspec)