PR review changes

Signed-off-by: Sasha Bogicevic <[email protected]>

Author: v0d1ch

CONTRIBUTING.md

@@ -156,7 +156,7 @@ To perform a release of the next `<version>`:
 1. Make sure all tests are passing.
 2. Publish Hydra scripts onto `preview`, `preprod`, and `mainnet` using the
    [smoke test][smoke-test] and put the transaction IDs as new `<version>`
-   entries into [networks.json](./networks.json).
+   entries into [networks.json](./hydra-node/networks.json).
 3. Update CHANGELOG.md by replacing `UNRELEASED` with a date in
    [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) and prepare contents.
 4. Run `./release.sh <version>`.

docs/docs/configuration.md

@@ -83,15 +83,21 @@ See the [how-to](./how-to/incremental-commit) and [protocol documentation](./dev
 
 The `hydra-node` uses reference scripts to reduce transaction sizes driving the head's lifecycle. Specify the `--hydra-scripts-tx-id` to reference the correct scripts. The `hydra-node` will verify the availability of these scripts on-chain.
 
-Since we pre-publish hydra scrips before each release, in case you want to run the official released version instead of specifying hydra-scripts using `--hydra-scripts-tx-id`, you can use `--network` together with the network name you would like to run your hydra-node on (e.g. `--network preview`).
+:::important Alternative: use --network
+Since we pre-publish hydra scrips before each release, instead of specifying hydra-scripts using `--hydra-scripts-tx-id`, you can use `--network` together with the network name you would like to run your hydra-node on (e.g. `--network preview`).
+:::
+
+:::warning
+`--network` argument only works with officially released hydra-node versions!
+:::
 
 Check the scripts against which a hydra-node was compiled using:
 
 ```shell
 hydra-node --script-info
 ```
 
-For public [(test) networks](https://book.world.dev.cardano.org/environments.html), we publish Hydra scripts with each new release, listing transaction IDs in the [release notes](https://github.com/cardano-scaling/hydra/releases) and [`networks.json`](https://github.com/cardano-scaling/hydra/blob/master/networks.json).
+For public [(test) networks](https://book.world.dev.cardano.org/environments.html), we publish Hydra scripts with each new release, listing transaction IDs in the [release notes](https://github.com/cardano-scaling/hydra/releases) and [`networks.json`](https://github.com/cardano-scaling/hydra/blob/master/hydra-node/networks.json).
 
 To publish scripts yourself, use the `publish-scripts` command:
 

docs/docs/tutorial/index.md

@@ -421,7 +421,7 @@ hydra-node \
   --persistence-dir persistence-alice \
   --cardano-signing-key credentials/alice-node.sk \
   --hydra-signing-key credentials/alice-hydra.sk \
-  --hydra-scripts-tx-id $(curl https://raw.githubusercontent.com/cardano-scaling/hydra/master/networks.json | jq -r ".preprod.\"${hydra_version}\"") \
+  --hydra-scripts-tx-id $(curl https://raw.githubusercontent.com/cardano-scaling/hydra/master/hydra-node/networks.json | jq -r ".preprod.\"${hydra_version}\"") \
   --ledger-protocol-parameters protocol-parameters.json \
   --testnet-magic 1 \
   --node-socket node.socket \
@@ -443,7 +443,7 @@ hydra-node \
   --persistence-dir persistence-bob \
   --cardano-signing-key credentials/bob-node.sk \
   --hydra-signing-key credentials/bob-hydra.sk \
-  --hydra-scripts-tx-id $(curl https://raw.githubusercontent.com/cardano-scaling/hydra/master/networks.json | jq -r ".preprod.\"${hydra_version}\"") \
+  --hydra-scripts-tx-id $(curl https://raw.githubusercontent.com/cardano-scaling/hydra/master/hydra-node/networks.json | jq -r ".preprod.\"${hydra_version}\"") \
   --ledger-protocol-parameters protocol-parameters.json \
   --testnet-magic 1 \
   --node-socket node.socket \

hydra-cluster/src/Hydra/Cluster/Faucet.hs

@@ -134,8 +134,8 @@ seedFromFaucetBlockfrost receivingVerificationKey lovelace = do
       case eResult of
         Left err -> liftIO $ throwIO $ FaucetBlockfrostError{blockFrostError = show err}
         Right _ -> do
-          void $ Blockfrost.awaitUTxO networkId [changeAddress] (txId signedTx) 100
-          Blockfrost.awaitUTxO networkId [receivingAddress] (txId signedTx) 100
+          void $ Blockfrost.awaitUTxO networkId [changeAddress] (txId signedTx) 200
+          Blockfrost.awaitUTxO networkId [receivingAddress] (txId signedTx) 200
  where
   findUTxO networkId address lovelace' = do
     faucetUTxO <- Blockfrost.queryUTxO networkId [address]

hydra-node/hydra-node.cabal

@@ -12,7 +12,8 @@ license-files:
 data-files:
   json-schemas/api.yaml
   json-schemas/common.yaml
-  networks.json
+
+extra-source-files: networks.json
 
 source-repository head
   type:     git

networks.json renamed to hydra-node/networks.json

@@ -1,4 +1,5 @@
 {-# LANGUAGE DerivingStrategies #-}
+{-# LANGUAGE TemplateHaskell #-}
 
 module Hydra.NetworkVersions where
 
@@ -9,16 +10,16 @@ import Data.Aeson (Value (..))
 import Data.Aeson.Key qualified as Key
 import Data.Aeson.KeyMap qualified as KeyMap
 import Data.Aeson.Lens (members, _Object)
+import Data.FileEmbed (embedFile, makeRelativeToProject)
 import Data.List qualified as List
 import Data.Text (pack, splitOn, toLower, unpack)
 import Data.Text.Encoding (encodeUtf8)
 import Hydra.Cardano.Api (TxId, deserialiseFromRawBytesHex)
-import Paths_hydra_node qualified as Pkg
-import System.IO.Unsafe (unsafePerformIO)
+import Hydra.Version (embeddedRevision)
 
 {-# NOINLINE networkVersions #-}
 networkVersions :: ByteString
-networkVersions = unsafePerformIO $ Pkg.getDataFileName "networks.json" >>= readFileBS
+networkVersions = $(makeRelativeToProject "./networks.json" >>= embedFile)
 
 parseNetworkTxIds :: String -> Either String [TxId]
 parseNetworkTxIds networkString = do
@@ -30,9 +31,12 @@ parseNetworkTxIds networkString = do
  where
   getLastTxId t = do
     lastTxIds <-
-      case List.last $ KeyMap.elems t of
-        String s -> Right s
-        _ -> Left "Failed to find the last tx-id string in networks.json"
+      case embeddedRevision of
+        Nothing -> Left "Missing hydra-node revision."
+        Just rev ->
+          case List.find (String (pack rev) ==) (KeyMap.elems t) of
+            Just (String s) -> Right s
+            _ -> Left "Failed to find released hydra-node version in networks.json."
     mapM parseToTxId (splitOn "," lastTxIds)
 
   parseToTxId textTxId = do

hydra-node/src/Hydra/NetworkVersions.hs

@@ -44,7 +44,6 @@ import Hydra.Options (
  )
 import Test.Aeson.GenericSpecs (roundtripAndGoldenSpecs)
 import Test.QuickCheck (Property, chooseEnum, counterexample, forAll, property, vectorOf, (===))
-import Test.QuickCheck.Monadic (monadicIO)
 import Text.Regex.TDFA ((=~))
 
 spec :: Spec
@@ -326,18 +325,17 @@ spec = parallel $
             { chainConfig = Cardano (defaultCardanoChainConfig & #chainBackendOptions .~ Blockfrost (BlockfrostOptions "blockfrost-project.txt"))
             }
 
-    it "parses --network into related tx ids" $ monadicIO $ do
+    it "parses --network into related tx ids" $ do
       let networks = ["Mainnet", "preview", "Preprod"]
       forM_ networks $ \network -> do
         case parseNetworkTxIds network of
-          Left err -> error $ "Failed to parse network versions: " <> show err
-          Right txIds -> do
-            pure $
-              ["--network", network]
-                `shouldParse` Run
-                  defaultRunOptions
-                    { chainConfig = Cardano defaultCardanoChainConfig{hydraScriptsTxId = txIds}
-                    }
+          Left err -> err `shouldBe` ("Failed to find released hydra-node version in networks.json." :: String)
+          Right txIds ->
+            ["--network", network]
+              `shouldParse` Run
+                defaultRunOptions
+                  { chainConfig = Cardano defaultCardanoChainConfig{hydraScriptsTxId = txIds}
+                  }
 
     it "switches to offline mode when using --offline-head-seed and --initial-utxo" $
       mconcat

hydra-node/test/Hydra/OptionsSpec.hs

@@ -145,7 +145,7 @@ check_networks_is_up_to_date() {
     preview
   )
 
-  local networks_file=networks.json
+  local networks_file=hydra-node/networks.json
 
   for network in "${networks[@]}"; do
     cat ${networks_file} | jq -e ".\"${network}\".\"${version}\"" >/dev/null ||