From c6596dcf9f1597290af472526ba2e9b175b77c64 Mon Sep 17 00:00:00 2001
From: Duncan Coutts <duncan@well-typed.com>
Date: Mon, 22 Jun 2020 19:36:05 +0100
Subject: [PATCH] Work in progress on a test setup for Byron;Shelley node
 testing

Modeled on the shelley-from-genesis setup script, but now for a
Byron;Shelley setup.

This is more complicated as we need a full Byron setup and most of a
Shelley setup too, and appropriately aligned between the two so we can
start block producing nodes in Byron mode and switch over to Shelley.
---
 scripts/byron-shelley/mkfiles.sh | 438 +++++++++++++++++++++++++++++++
 1 file changed, 438 insertions(+)
 create mode 100755 scripts/byron-shelley/mkfiles.sh

diff --git a/scripts/byron-shelley/mkfiles.sh b/scripts/byron-shelley/mkfiles.sh
new file mode 100755
index 00000000000..45ccaa7ab25
--- /dev/null
+++ b/scripts/byron-shelley/mkfiles.sh
@@ -0,0 +1,438 @@
+#!/usr/bin/env bash
+
+set -e
+#set -x
+
+ROOT=example
+
+BFT_NODES="node-bft1 node-bft2"
+BFT_NODES_N="1 2"
+NUM_BFT_NODES=2
+
+POOL_NODES="node-pool1"
+
+ALL_NODES="${BFT_NODES} ${POOL_NODES}"
+
+NUM_UTXO_KEYS=1
+MAX_SUPPLY=1000000000
+INIT_SUPPLY=1000000000
+
+
+NETWORK_MAGIC=42
+SECURITY_PARAM=10
+
+START_TIME=$(ghc -e 'fmap ((+30) . floor) Data.Time.Clock.POSIX.getPOSIXTime')
+
+
+if ! mkdir "${ROOT}"; then
+  echo "The ${ROOT} directory already exists, please move or remove it"
+  exit
+fi
+
+# copy and tweak the configuration
+cp configuration/defaults/byron-mainnet/configuration.yaml ${ROOT}/
+sed -i ${ROOT}/configuration.yaml \
+    -e 's/Protocol: RealPBFT/Protocol: Cardano/' \
+    -e '/Protocol/ aPBftSignatureThreshold: 0.6' \
+    -e 's/minSeverity: Info/minSeverity: Debug/' \
+    -e 's|GenesisFile: genesis.json|ByronGenesisFile: byron/genesis.json|' \
+    -e '/ByronGenesisFile/ aShelleyGenesisFile: shelley/genesis.json' \
+    -e 's/RequiresNoMagic/RequiresMagic/'
+
+pushd ${ROOT}
+
+# create the node directories
+for NODE in ${ALL_NODES}; do
+
+  mkdir ${NODE} ${NODE}/byron ${NODE}/shelley
+
+done
+
+# Make topology files
+#TODO generalise this over the N BFT nodes and pool nodes
+cat > node-bft1/topology.json <<EOF
+{
+   "Producers": [
+     {
+       "addr": "127.0.0.1",
+       "port": 3002,
+       "valency": 1
+     }
+   , {
+       "addr": "127.0.0.1",
+       "port": 3003,
+       "valency": 1
+     }
+   ]
+ }
+EOF
+echo 3001 > node-bft1/port
+
+cat > node-bft2/topology.json <<EOF
+{
+   "Producers": [
+     {
+       "addr": "127.0.0.1",
+       "port": 3001,
+       "valency": 1
+     }
+   , {
+       "addr": "127.0.0.1",
+       "port": 3003,
+       "valency": 1
+     }
+   ]
+ }
+EOF
+echo 3002 > node-bft2/port
+
+cat > node-pool1/topology.json <<EOF
+{
+   "Producers": [
+     {
+       "addr": "127.0.0.1",
+       "port": 3001,
+       "valency": 1
+     }
+   , {
+       "addr": "127.0.0.1",
+       "port": 3002,
+       "valency": 1
+     }
+   ]
+ }
+EOF
+echo 3003 > node-pool1/port
+
+
+cat > byron.genesis.spec.json <<EOF
+{
+  "heavyDelThd":     "300000000000",
+  "maxBlockSize":    "2000000",
+  "maxTxSize":       "4096",
+  "maxHeaderSize":   "2000000",
+  "maxProposalSize": "700",
+  "mpcThd": "20000000000000",
+  "scriptVersion": 0,
+  "slotDuration": "2000",
+  "softforkRule": {
+    "initThd": "900000000000000",
+    "minThd": "600000000000000",
+    "thdDecrement": "50000000000000"
+  },
+  "txFeePolicy": {
+    "multiplier": "43946000000",
+    "summand": "155381000000000"
+  },
+  "unlockStakeEpoch": "18446744073709551615",
+  "updateImplicit": "10000",
+  "updateProposalThd": "100000000000000",
+  "updateVoteThd": "1000000000000"
+}
+EOF
+
+cardano-cli genesis \
+  --protocol-magic ${NETWORK_MAGIC} \
+  --start-time ${START_TIME} \
+  --k ${SECURITY_PARAM} \
+  --n-poor-addresses 0 \
+  --n-delegate-addresses ${NUM_BFT_NODES} \
+  --total-balance ${INIT_SUPPLY} \
+  --byron-formats \
+  --delegate-share 1 \
+  --avvm-entry-count 0 \
+  --avvm-entry-balance 0 \
+  --protocol-parameters-file byron.genesis.spec.json \
+  --genesis-output-dir byron
+mv byron.genesis.spec.json byron/genesis.spec.json
+
+
+# Symlink the BFT operator keys from the genesis delegates, for uniformity
+for N in ${BFT_NODES_N}; do
+
+  ln -s ../../byron/delegate-keys.00$((${N} - 1)).key     node-bft${N}/byron/delegate.key
+  ln -s ../../byron/delegation-cert.00$((${N} - 1)).json  node-bft${N}/byron/delegate.cert
+
+done
+
+echo "====================================================================="
+echo "Generated genesis keys and genesis files:"
+echo
+ls -1 byron/*
+echo "====================================================================="
+
+
+# Set up our template
+mkdir shelley
+cardano-cli shelley genesis create --testnet-magic 42 --genesis-dir shelley
+
+# Then edit the genesis.spec.json ...
+
+# We're going to use really quick epochs (300 seconds), by using short slots 0.2s
+# and K=10, but we'll keep long KES periods so we don't have to bother
+# cycling KES keys
+sed -i shelley/genesis.spec.json \
+    -e 's/"slotLength": 1/"slotLength": 0.2/' \
+    -e 's/"activeSlotsCoeff": 5.0e-2/"activeSlotsCoeff": 0.1/' \
+    -e 's/"securityParam": 2160/"securityParam": 10/' \
+    -e 's/"epochLength": 432000/"epochLength": 1500/' \
+    -e 's/"maxLovelaceSupply": 0/"maxLovelaceSupply": 1000000000/' \
+    -e 's/"decentralisationParam": 1/"decentralisationParam": 0.7/'
+
+# Now generate for real:
+
+cardano-cli shelley genesis create \
+    --testnet-magic 42 \
+    --genesis-dir shelley/ \
+    --gen-genesis-keys ${NUM_BFT_NODES} \
+    --gen-utxo-keys 1
+
+echo "====================================================================="
+echo "Generated genesis keys and genesis files:"
+echo
+ls -1 shelley/*
+echo "====================================================================="
+
+echo "Generated genesis.json:"
+echo
+cat shelley/genesis.json
+echo
+echo "====================================================================="
+
+echo "To start the nodes, in separate terminals use:"
+echo
+for NODE in ${ALL_NODES}; do
+
+  echo "cardano-node run \\"
+  echo "  --config                          ${ROOT}/configuration.yaml \\"
+  echo "  --topology                        ${ROOT}/${NODE}/topology.json \\"
+  echo "  --database-path                   ${ROOT}/${NODE}/db \\"
+  echo "  --socket-path                     ${ROOT}/${NODE}/node.sock \\"
+if [ -f ${NODE}/byron/delegate.key ]; then
+  echo "  --signing-key                     ${ROOT}/${NODE}/byron/delegate.key \\"
+  echo "  --delegation-certificate          ${ROOT}/${NODE}/byron/delegate.cert \\"
+fi
+  echo "  --shelley-kes-key                 ${ROOT}/${NODE}/shelley/kes.skey \\"
+  echo "  --shelley-vrf-key                 ${ROOT}/${NODE}/shelley/vrf.skey \\"
+  echo "  --shelley-operational-certificate ${ROOT}/${NODE}/shelley/node.cert \\"
+  echo "  --port                            $(cat ${NODE}/port)"
+
+done
+
+# Make the pool operator cold keys
+# This was done already for the BFT nodes as part of the genesis creation
+
+for NODE in ${POOL_NODES}; do
+
+  cardano-cli shelley node key-gen \
+      --cold-verification-key-file                 ${NODE}/shelley/operator.vkey \
+      --cold-signing-key-file                      ${NODE}/shelley/operator.skey \
+      --operational-certificate-issue-counter-file ${NODE}/shelley/operator.counter
+
+  cardano-cli shelley node key-gen-VRF \
+      --verification-key-file ${NODE}/shelley/vrf.vkey \
+      --signing-key-file      ${NODE}/shelley/vrf.skey
+
+done
+
+# Symlink the BFT operator keys from the genesis delegates, for uniformity
+
+for N in ${BFT_NODES_N}; do
+
+  ln -s ../../shelley/delegate-keys/delegate${N}.skey node-bft${N}/shelley/operator.skey
+  ln -s ../../shelley/delegate-keys/delegate${N}.vkey node-bft${N}/shelley/operator.vkey
+  ln -s ../../shelley/delegate-keys/delegate${N}.counter node-bft${N}/shelley/operator.counter
+  ln -s ../../shelley/delegate-keys/delegate${N}.vrf.vkey node-bft${N}/shelley/vrf.vkey
+  ln -s ../../shelley/delegate-keys/delegate${N}.vrf.skey node-bft${N}/shelley/vrf.skey
+
+done
+
+
+# Make hot keys and for all nodes
+
+for NODE in ${ALL_NODES}; do
+
+  cardano-cli shelley node key-gen-KES \
+      --verification-key-file ${NODE}/shelley/kes.vkey \
+      --signing-key-file      ${NODE}/shelley/kes.skey
+
+  cardano-cli shelley node issue-op-cert \
+      --kes-period 0 \
+      --kes-verification-key-file                  ${NODE}/shelley/kes.vkey \
+      --cold-signing-key-file                      ${NODE}/shelley/operator.skey \
+      --operational-certificate-issue-counter-file ${NODE}/shelley/operator.counter \
+      --out-file                                   ${NODE}/shelley/node.cert
+
+done
+
+echo "Generated node operator keys (cold, hot) and operational certs:"
+echo
+ls -1 ${ALL_NODES}
+echo "====================================================================="
+
+
+# Make some payment and stake addresses
+# user1..n:       will own all the funds in the system, we'll set this up from
+#                 initial utxo the
+# pool-owner1..n: will be the owner of the pools and we'll use their reward
+#                 account for pool rewards
+
+USER_ADDRS="user1"
+POOL_ADDRS="pool-owner1"
+
+ADDRS="${USER_ADDRS} ${POOL_ADDRS}"
+
+mkdir addresses
+
+for ADDR in ${ADDRS}; do
+
+  # Payment address keys
+  cardano-cli shelley address key-gen \
+      --verification-key-file addresses/${ADDR}.vkey \
+      --signing-key-file      addresses/${ADDR}.skey
+
+  # Stake address keys
+  cardano-cli shelley stake-address key-gen \
+      --verification-key-file addresses/${ADDR}-stake.vkey \
+      --signing-key-file      addresses/${ADDR}-stake.skey
+
+  # Payment addresses
+  cardano-cli shelley address build \
+      --payment-verification-key-file addresses/${ADDR}.vkey \
+      --stake-verification-key-file addresses/${ADDR}-stake.vkey \
+      --testnet-magic 42 \
+      --out-file addresses/${ADDR}.addr
+
+  # Stake addresses
+  cardano-cli shelley stake-address build \
+      --stake-verification-key-file addresses/${ADDR}-stake.vkey \
+      --testnet-magic 42 \
+      --out-file addresses/${ADDR}-stake.addr
+
+  # Stake addresses registration certs
+  cardano-cli shelley stake-address registration-certificate \
+      --stake-verification-key-file addresses/${ADDR}-stake.vkey \
+      --out-file addresses/${ADDR}-stake.reg.cert
+
+done
+
+# user N will delegate to pool N
+USER_POOL_N="1"
+
+for N in ${USER_POOL_N}; do
+
+  # Stake address delegation certs
+  cardano-cli shelley stake-address delegation-certificate \
+      --stake-verification-key-file addresses/user${N}-stake.vkey \
+      --cold-verification-key-file  node-pool${N}/operator.vkey \
+      --out-file addresses/user${N}-stake.deleg.cert
+
+  ln -s ../addresses/pool-owner${N}-stake.vkey node-pool${N}/owner.vkey
+  ln -s ../addresses/pool-owner${N}-stake.skey node-pool${N}/owner.skey
+
+done
+
+echo "Generated payment address keys, stake address keys,"
+echo "stake address regitration certs, and stake address delegatation certs"
+echo
+ls -1 addresses/
+echo "====================================================================="
+
+
+# Next is to make the stake pool registration cert
+
+for NODE in ${POOL_NODES}; do
+
+  cardano-cli shelley stake-pool registration-certificate \
+    --testnet-magic 42 \
+    --pool-pledge 0 --pool-cost 0 --pool-margin 0 \
+    --cold-verification-key-file             ${NODE}/operator.vkey \
+    --vrf-verification-key-file              ${NODE}/vrf.vkey \
+    --reward-account-verification-key-file   ${NODE}/owner.vkey \
+    --pool-owner-stake-verification-key-file ${NODE}/owner.vkey \
+    --out-file                               ${NODE}/registration.cert
+done
+
+echo "Generated stake pool registration certs:"
+ls -1 node-*/registration.cert
+echo "====================================================================="
+
+
+# Now we'll construct one whopper of a transaction that does everything
+# just to show off that we can, and to make the script shorter
+
+# We'll transfer all the funds to the user1, which delegates to pool1
+# We'll register certs to:
+#  1. register the pool-owner1 stake address
+#  2. register the stake pool 1
+#  3. register the user1 stake address
+#  4. delegate from the user1 stake address to the stake pool
+
+cardano-cli shelley transaction build-raw \
+    --ttl 1000 \
+    --fee 0 \
+    --tx-in $(cardano-cli shelley genesis initial-txin \
+                --testnet-magic 42 \
+                --verification-key-file utxo-keys/utxo1.vkey) \
+    --tx-out $(cat addresses/user1.addr)+${SUPPLY} \
+    --certificate-file addresses/pool-owner1-stake.reg.cert \
+    --certificate-file node-pool1/registration.cert \
+    --certificate-file addresses/user1-stake.reg.cert \
+    --certificate-file addresses/user1-stake.deleg.cert \
+    --out-file tx1.txbody
+
+# So we'll need to sign this with a bunch of keys:
+# 1. the initial utxo spending key, for the funds
+# 2. the user1 stake address key, due to the delegatation cert
+# 3. the pool1 owner key, due to the pool registration cert
+# 3. the pool1 operator key, due to the pool registration cert
+
+cardano-cli shelley transaction sign \
+    --signing-key-file utxo-keys/utxo1.skey \
+    --signing-key-file addresses/user1-stake.skey \
+    --signing-key-file node-pool1/owner.skey \
+    --signing-key-file node-pool1/operator.skey \
+    --testnet-magic 42 \
+    --tx-body-file  tx1.txbody \
+    --out-file      tx1.tx
+
+echo "Generated a signed 'do it all' transaction:"
+ls -1 tx1.tx
+echo "====================================================================="
+
+echo "So you can now do various things:"
+echo " * Start the nodes"
+echo " * Submit the initial 'do it all' transaction"
+echo " * Query the node's ledger state"
+echo
+echo "To start the nodes, in separate terminals use:"
+echo
+for NODE in ${ALL_NODES}; do
+
+  echo "cardano-node run \\"
+  echo "  --config                          ${ROOT}/configuration.yaml \\"
+  echo "  --topology                        ${ROOT}/${NODE}/topology.json \\"
+  echo "  --database-path                   ${ROOT}/${NODE}/db \\"
+  echo "  --socket-path                     ${ROOT}/${NODE}/node.sock \\"
+  echo "  --shelley-kes-key                 ${ROOT}/${NODE}/kes.skey \\"
+  echo "  --shelley-vrf-key                 ${ROOT}/${NODE}/vrf.skey \\"
+  echo "  --shelley-operational-certificate ${ROOT}/${NODE}/node.cert \\"
+  echo "  --port                            $(cat ${NODE}/port)"
+
+done
+echo
+echo "To submit the transaction"
+echo
+echo "CARDANO_NODE_SOCKET_PATH=${ROOT}/node-bft1/node.sock \\"
+echo "  cardano-cli shelley transaction submit \\"
+echo "    --tx-file ${ROOT}/tx1.tx \\"
+echo "    --testnet-magic 42"
+echo
+echo "Then wait until epoch #2 (counting from 0) starting at slot 3000"
+echo "and query the stake distribution, and see if the pool node creates blocks"
+echo
+echo "CARDANO_NODE_SOCKET_PATH=example/node-bft1/node.sock \\"
+echo "  cardano-cli shelley query stake-distribution --testnet-magic 42"
+echo
+
+popd