[CO-410] Add RequiresNetworkMagic and modify ProtocolMagic (input-output-hk/cardano-sl#3715)

* [CO-410] Port release/1.3.1 config to develop

* [CO-410] Modify ProtocolMagic

* [CO-410] Continue modifying ProtocolMagic

* [CO-410] Change naming

* [CO-410] Add golden files for legacy `RequiresNetworkMagic`

* [CO-410] Modify `RequiresNetworkMagic`'s `FromJSON` instance to support legacy encoding

* [CO-410] Add golden decoding tests for legacy `ProtocolMagic` encoding

* [CO-410] Add golden decode only test for `Configuration`

* [CO-410] Run `pkgs/generate.sh`, remove reference files, hardcode
`systemTag` in `Configuration_Legacy` golden file

Author: intricate

src/Cardano/Wallet/Kernel/DB/InDb.hs

@@ -445,20 +445,20 @@ instance SC.SafeCopy (InDb Core.BlockHeader) where
 -- class for the actual fields, so they are actually totally different types.
 instance SC.SafeCopy (InDb Core.MainBlockHeader) where
     getCopy = SC.contain $ do
-        InDb protocolMagic <- SC.safeGet
+        InDb protocolMagicId <- SC.safeGet
         InDb prevBlock <- SC.safeGet
         InDb bodyProof <- SC.safeGet
         InDb consensus <- SC.safeGet
         InDb extra <- SC.safeGet
         pure . InDb $
             Core.mkGenericBlockHeaderUnsafe
-                protocolMagic
+                (Core.ProtocolMagic protocolMagicId Core.RequiresNoMagic)
                 prevBlock
                 bodyProof
                 consensus
                 extra
     putCopy (InDb header) = SC.contain $ do
-        safePutDb $ header ^. Core.gbhProtocolMagic
+        safePutDb $ header ^. Core.gbhProtocolMagicId
         safePutDb $ header ^. Core.gbhPrevBlock
         safePutDb $ header ^. Core.gbhBodyProof
         safePutDb $ header ^. Core.gbhConsensus
@@ -750,26 +750,51 @@ instance SC.SafeCopy (InDb Core.GenesisBlockHeader) where
         InDb extra <- SC.safeGet
         pure . InDb $
             Core.mkGenericBlockHeaderUnsafe
-                protocolMagic
+                (Core.ProtocolMagic protocolMagic Core.RequiresNoMagic)
                 prevBlock
                 bodyProof
                 consensus
                 extra
 
     putCopy (InDb header) = SC.contain $ do
-        safePutDb $ header ^. Core.gbhProtocolMagic
+        safePutDb $ header ^. Core.gbhProtocolMagicId
         safePutDb $ header ^. Core.gbhPrevBlock
         safePutDb $ header ^. Core.gbhBodyProof
         safePutDb $ header ^. Core.gbhConsensus
         safePutDb $ header ^. Core.gbhExtra
 
 instance SC.SafeCopy (InDb Core.ProtocolMagic) where
     getCopy = SC.contain $ do
-        InDb . Core.ProtocolMagic <$> SC.safeGet
+        i <- SC.safeGet
+        rnm <- SC.safeGet
+        pure $ Core.ProtocolMagic
+            <$> i
+            <*> rnm
+
+    putCopy (InDb (Core.ProtocolMagic i rnm)) = SC.contain $ do
+        safePutDb i
+        safePutDb rnm
+
+instance SC.SafeCopy (InDb Core.ProtocolMagicId) where
+    getCopy = SC.contain $ do
+        InDb . Core.ProtocolMagicId <$> SC.safeGet
 
-    putCopy (InDb (Core.ProtocolMagic i)) = SC.contain $ do
+    putCopy (InDb (Core.ProtocolMagicId i)) = SC.contain $ do
         SC.safePut i
 
+instance SC.SafeCopy (InDb Core.RequiresNetworkMagic) where
+    getCopy = SC.contain $
+        SC.safeGet >>= \case
+            0 -> pure (InDb Core.RequiresNoMagic)
+            1 -> pure (InDb Core.RequiresMagic)
+            (n :: Word8) -> fail
+                $  "Expected one of 0,1 for RequiresNetworkMagic tag,\
+                  \ got: "
+                <> show n
+    putCopy (InDb rnm) = SC.contain $ case rnm of
+        Core.RequiresNoMagic -> SC.safePut (0 :: Word8)
+        Core.RequiresMagic   -> SC.safePut (1 :: Word8)
+
 instance SC.SafeCopy (InDb Core.GenesisProof) where
     getCopy = SC.contain $ do
         hashLeaders <- SC.safeGet

test/MarshallingSpec.hs

@@ -156,6 +156,8 @@ spec = parallel $ describe "Marshalling & Unmarshalling" $ do
         safeCopyRoundTrip @(InDb Core.BlockCount)
         safeCopyRoundTrip @(InDb Core.GenesisBlockHeader)
         safeCopyRoundTrip @(InDb Core.ProtocolMagic)
+        safeCopyRoundTrip @(InDb Core.ProtocolMagicId)
+        safeCopyRoundTrip @(InDb Core.RequiresNetworkMagic)
         safeCopyRoundTrip @(InDb Core.GenesisProof)
         safeCopyRoundTrip @(InDb Core.GenesisConsensusData)
         safeCopyRoundTrip @(InDb Core.GenesisExtraHeaderData)

test/unit/Test/Spec/Submission.hs

@@ -27,7 +27,8 @@ import qualified Formatting as F
 import           Formatting.Buildable (build)
 import qualified Pos.Chain.Txp as Txp
 import           Pos.Core.Attributes (Attributes (..), UnparsedFields (..))
-import           Pos.Crypto (ProtocolMagic (..))
+import           Pos.Crypto (ProtocolMagic (..), ProtocolMagicId (..),
+                     RequiresNetworkMagic (..))
 import           Pos.Crypto.Hashing (hash)
 import           Pos.Crypto.Signing.Safe (safeDeterministicKeyGen)
 import           Serokell.Util.Text (listJsonIndent)
@@ -89,7 +90,7 @@ genSchedule maxRetries pending (Slot lowerBound) = do
 
 genWalletSubmissionState :: HdAccountId -> MaxRetries -> Gen WalletSubmissionState
 genWalletSubmissionState accId maxRetries = do
-    pending   <- M.singleton accId <$> genPending (ProtocolMagic 0)
+    pending   <- M.singleton accId <$> genPending protocolMagic
     let slot  = Slot 0 -- Make the layer always start from 0, to make running the specs predictable.
     scheduler <- genSchedule maxRetries pending slot
     return $ WalletSubmissionState pending scheduler slot
@@ -178,7 +179,7 @@ dependentTransactions = do
     outputForB <- (Txp.TxOut <$> arbitrary <*> arbitrary)
     outputForC <- (Txp.TxOut <$> arbitrary <*> arbitrary)
     outputForD <- (Txp.TxOut <$> arbitrary <*> arbitrary)
-    [a,b,c,d] <- vectorOf 4 (Txp.genTxAux (ProtocolMagic 0))
+    [a,b,c,d] <- vectorOf 4 (Txp.genTxAux protocolMagic)
     let a' = a { Txp.taTx = (Txp.taTx a) {
                      Txp._txInputs  = inputForA :| mempty
                    , Txp._txOutputs = outputForA :| mempty
@@ -219,7 +220,7 @@ genPureWalletSubmission accId =
 genPurePair :: Gen (ShowThroughBuild (WalletSubmission, M.Map HdAccountId Pending))
 genPurePair = do
     STB layer <- genPureWalletSubmission myAccountId
-    pending <- genPending (ProtocolMagic 0)
+    pending <- genPending protocolMagic
     let pending' = Pending.delete (toTxIdSet $ layer ^. localPendingSet myAccountId) pending
     pure $ STB (layer, M.singleton myAccountId pending')
 
@@ -434,3 +435,7 @@ spec = do
                        , mustNotIncludeEvents "none of [a,b,c,d] was scheduled" (ScheduleEvents scheduledInSlot2 confirmed2) [a,b,c,d]
                        , includeEvents "[c,d] scheduled slot 3" (ScheduleEvents scheduledInSlot3 confirmed3) [c,d]
                        ]
+
+
+protocolMagic :: ProtocolMagic
+protocolMagic = ProtocolMagic (ProtocolMagicId 0) RequiresNoMagic