Add tip about jq and round-tripping bug (#1682)

Fixes #1679
cardano-scaling · Oct 4, 2024 · ff30a60 · ff30a60
2 parents 22b5cf3 + 7b9ecb2
commit ff30a60
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/demo/seed-devnet.sh b/demo/seed-devnet.sh
@@ -3,6 +3,10 @@
 # Seed a "devnet" by distributing Ada to hydra nodes
 set -eo pipefail
 
+# See: https://github.com/cardano-scaling/hydra/pull/1682
+[[ $(jq -n '9223372036854775807') == "9223372036854775807" ]] \
+  || (echo "bad jq roundtrip: please upgrade your jq to version 1.7+"; exit 1)
+
 SCRIPT_DIR=${SCRIPT_DIR:-$(realpath $(dirname $(realpath $0)))}
 NETWORK_ID=42
 

diff --git a/docs/docs/tutorial/index.md b/docs/docs/tutorial/index.md
@@ -26,6 +26,20 @@ This tutorial assumes the following tools are available on your system:
 
 After ensuring the tools above are available, begin by downloading pre-built binaries of the involved Cardano software components and placing them in a `bin/` directory:
 
+:::tip
+Older versions of `jq` (<= 1.6) have a bug where they do not successfully
+round-trip large integers, [which can cause
+issues](https://github.com/cardano-scaling/hydra/issues/1679) you can verify
+that you have a good version of jq with this command:
+
+```
+[[ $(jq -n '9223372036854775807') == "9223372036854775807" ]] \
+  && echo "jq ok" \
+  || echo "bad: please upgrade jq"
+```
+:::
+
+
 <Tabs queryString="system">
 <TabItem value="linux" label="Linux x86-64">