Merge pull request #1 from input-output-hk/master

sionsmith · web-flow · commit 849dcc737fd3 · 2020-06-29T13:55:42.000+01:00
Updated docs from base
diff --git a/README.md b/README.md
@@ -9,3 +9,28 @@ The current release of tutorials focus on setting up & monitoring the node and u
 ## Exercises
 
 A set of exercises to help you become familiar with running a stake pool on the Testnet can be found [here](Shelley-testnet/).
+```eval_rst
+.. toctree::
+   :maxdepth: 3
+   :titlesonly:
+   :hidden:
+
+   node-setup/000_AWS.md
+   node-setup/000_install.md
+   node-setup/010_getConfigFiles_AND_Connect.md
+   node-setup/011_cli.md
+   node-setup/012_understanding-config-files.md
+   node-setup/020_keys_and_addresses.md
+   node-setup/030_faucet.md
+   node-setup/040_transactions.md
+   node-setup/050_register_key.md
+   node-setup/060_node_keys.md
+   node-setup/061_KES_period.md
+   node-setup/070_core_relay.md
+   node-setup/080_register_stakepool.md
+   node-setup/081_start_your_nodes.md
+   node-setup/090_retire_stakepool.md
+   node-setup/091_logging.md
+   node-setup/092_ekg.md
+   node-setup/093_prometheus.md
+```
diff --git a/Shelley-testnet/Exercise-1.md b/Shelley-testnet/Exercise-1.md
@@ -38,7 +38,7 @@ This should be everything that you need to get you up and running.
 
 ### Exercises
 
-1. Download, Build and Install the Cardano Node Software using the instructions in the [Cardano Tutorial](../node-setup/020_keys_and_addresses.md).  You may need to do this repeatedly, so you may want to bookmark the instructions.  You will need to use the correctly tagged version at each stage. The most recent tag at the time of writing is 1.13.0.
+1. Download, Build and Install the Cardano Node Software using the instructions in the [Cardano Tutorial](../node-setup/000_install.md).  You may need to do this repeatedly, so you may want to bookmark the instructions.  You will need to use the correctly tagged version at each stage. The most recent tag at the time of writing is 1.13.0.
 
 2. Download the genesis, topology, and configuration files, as described in the tutorial.
 
diff --git a/Shelley-testnet/Exercise-5.md b/Shelley-testnet/Exercise-5.md
@@ -1,6 +1,6 @@
 # Shelley Stakepool Exercise Sheet 5
 
-LATEST TAG: 1.13.0
+LATEST TAG: 1.14.0
 
 ## Running a Stake Pool
 
@@ -43,7 +43,13 @@ Please report any bugs through the cardano-node and cardano-tutorials github rep
 
 ### Exercises
 
-1. 	Generate a registration certificate for your stake pool:
+1. Generate a JSON file containing the _metadata_ for your stake pool, and get the hash:
+
+        cardano-cli shelley stake-pool metadata-hash ...
+
+    Put the file somewhere accessible, and obtain its URL.
+
+2.  Generate a registration certificate for your stake pool:
 
    	    cardano-cli shelley stake-pool registration-certificate ...
 
@@ -59,14 +65,16 @@ Please report any bugs through the cardano-node and cardano-tutorials github rep
     If you don’t know what to choose, set the cost to 256 ada,
     the margin to 0.07 (i.e. 7%)
     and the pledge to 1,000 ada.
+    
+    You will also need to specify the metadata URL and hash for your pool from Step 1.
 
-2. 	Pledge some stake to your stake pool.
+3. 	Pledge some stake to your stake pool.
     You do this by creating a delegation certificate (as you did in
     [Exercise 4](Exercise-4.md)) that delegates
     enough stake from the "owner staking key" specified in the registration certificate
     to your own pool to cover your pledge promise.
 
-3. 	Register the pool online.
+4. 	Register the pool online.
     Registration is done by submitting a transaction that contains the
     pool registration certificate.
     You can include the pledge delegation certificate in the same transaction.
@@ -79,47 +87,49 @@ In addition to the usual transaction fees, you will also have to pay the
     Note that this transaction will have to be signed by the payment key,
     the cold key and the staking key.
 
-4. 	Start your stake pool, and link it to the relay node as you did in
+5. 	Start your stake pool, and link it to the relay node as you did in
     [Exercise 3](Exercise-3.md).
 
         cardano-node run ...
 
-5. 	Advertise that your pool is running.
+6. 	Obtain your stake pool id
+
+        cardano-cli shelley stake-pool id ...
+
+    If necessary, advertise that your pool is running using the P2P and off-chain registration workarounds that are described in the tutorials.
 
-    __Note:__ At the time of writing, there is no way to determine your pool id yet.  Please use the CBOR-hex from the cold key verification file instead.
 
-6. 	Check that you are delegating to your own pool,
+7. 	Check that you are delegating to your own pool through the pledge address,
     then wait until the following epoch (around 6 hours),
     and confirm that your pool is producing blocks by e.g. inspecting the log data.
     Also confirm that your pool is receiving the correct rewards.
     Congratulations, you are now a fully fledged Shelley Testnet pool operator!
 
-    __Note:__ At the time of writing, there is no way to check rewards yet. This feature is coming very soon.
 
-7. 	Optional Exercise (Easy).
+8. 	Optional Exercise (Easy).
 
     Persuade other Testnet users to delegate to your pool.
 
-8. 	Optional Exercise (Medium).
+9. 	Optional Exercise (Medium).
 
     Join forces with one or more other Testnet stakepool operators
     to run a new stake pool that you jointly own.
     What happens if you fail to collectively meet the pledge that you have promised?
 
-9. 	Optional Exercise (Easy).
+10. 	Optional Exercise (Easy).
 
     Change your pool’s cost, margin and pledge.
     What is the effect on the rewards that you receive?
     How long does it take for the change to take effect?
 
-10. Optional Exercise (Easy).
+11. Optional Exercise (Easy).
 
     Retire (de-register) your original pool, and start a new one with different cost,
-    margin and pledge.  Update your pool advertisement.
+    margin and pledge.  Update your pool advertisement if you need to.
 
-11. Optional Exercise (Medium).
+12. Optional Exercise (Medium).
 
-    Set up two stake pools, each behind its own relay node.
+    Set up two new stake pools, each behind its own relay node.
     Advertise both pools.
 
 You have now successfully set up and run your own stake pool and learnt the basics of how to manage it.  In the final exercises, we will test some operational parameters that are relevant to running a pool and see how to submit more forms of transaction.
diff --git a/Shelley-testnet/solutions/Exercise-1-solutions.md b/Shelley-testnet/solutions/Exercise-1-solutions.md
@@ -194,7 +194,7 @@ In the  `relay/ff-topology.json` we instruct the node to "talk" to the block-pro
 	{
 	   "Producers": [
 	     {
-	       "addr": x.x.x.x", # Replace with your public IP
+	       "addr": "x.x.x.x", # Replace with your public IP
 	       "port": 3000,
 	       "valency": 1
 	     },
diff --git a/Shelley-testnet/solutions/Exercise-2-solutions.md b/Shelley-testnet/solutions/Exercise-2-solutions.md
@@ -36,7 +36,7 @@ Let's create a second __payment key pair__ and __address__ (You should have crea
 
 **Generate Payment Key Pair**
 
-	$ cardano-cli shelley address key-gen \
+	cardano-cli shelley address key-gen \
 	    --verification-key-file payment2.vkey \
 	    --signing-key-file payment2.skey
 
@@ -83,10 +83,10 @@ This has created another set of keys, these ones will later allow us to delegate
 
 Now we will use both `payment2.vkey` and `stake2.vkey`to build a **payment address**. This will link our payment address to our **stake keys** and **stake address**.
 
-	$ cardano-cli shelley address build \
+	cardano-cli shelley address build \
 	--payment-verification-key-file payment2.vkey \
 	--stake-verification-key-file stake2.vkey \
-	--out-file payment2.addr
+	--out-file payment2.addr \
 	--testnet-magic 42
 
 
@@ -96,7 +96,7 @@ And, now generate you stake address. This will collect your rewards from delegat
 
 	cardano-cli shelley stake-address build \
 	--staking-verification-key-file stake2.vkey \
-	--out-file stake2.addr
+	--out-file stake2.addr \
 	--testnet-magic 42
 
 
@@ -106,13 +106,13 @@ And, now generate you stake address. This will collect your rewards from delegat
 
 To create our transaction we will need the protocl parameters, so let's query the parameters and save them in `protocol.json`
 
-	$ cardano-cli shelley query protocol-parameters \
+	cardano-cli shelley query protocol-parameters \
 	    --testnet-magic 42 \
 	    --out-file protocol.json
 
 We also need the UTXO details of the __payment.addr__ that will send the funds.
 
-	$ cardano-cli shelley query utxo \
+	cardano-cli shelley query utxo \
 	    --address $(cat payment.addr) \
 	    --testnet-magic 42
 
@@ -144,7 +144,7 @@ So we are currently on slot 266201, __Let's make our transaction TTL 267500__. W
 
 **CALCULATE FEE**
 
-Our transaction will have 1 input (tx-in-count), the UTXO from our sending address `e757f0...5d8cf` from above,  and 2 outputs (tx-in-count), the receiveing address (payment2.addr) and a second ouput to send the change (payment.addr)
+Our transaction will have 1 input (tx-in-count), the UTXO from our sending address `e757f0...5d8cf` from above,  and 2 outputs (tx-out-count), the receiving address (payment2.addr) and a second ouput to send the change (payment.addr)
 
 	$ cardano-cli shelley transaction calculate-min-fee \
 	    --tx-in-count 1 \
@@ -169,7 +169,7 @@ Now we need to make some quick math, lets say we want to send 100 tADA to `payme
 
 Again, you may want to open a text editor to work on building the transaction, and then when it is ready you can go to the CLI
 
-	$ cardano-cli shelley transaction build-raw \
+	 cardano-cli shelley transaction build-raw \
 		--tx-in e757f08b856c5f12d5784f749c4fc2b1fda8b48299b520f29f6055ce94a5d8cf#0 \
 		--tx-out $(cat payment2.addr)+100000000 \
 		--tx-out $(cat payment.addr)+499398236348 \
@@ -190,7 +190,7 @@ Again, you may want to open a text editor to work on building the transaction, a
 
 We use the __payment.skey__ to sign the transaction
 
-	$ cardano-cli shelley transaction sign \
+	 cardano-cli shelley transaction sign \
 	    --tx-body-file tx008.raw \
 	    --signing-key-file payment.skey \
 	    --testnet-magic 42 \
@@ -199,7 +199,7 @@ We use the __payment.skey__ to sign the transaction
 
 **SUBMIT TRANSACTION**
 
-	$ cardano-cli shelley transaction submit \
+	 cardano-cli shelley transaction submit \
 	    --tx-file tx008.signed \
 	    --testnet-magic 42
 
diff --git a/Shelley-testnet/solutions/Exercise-6-solutions.md b/Shelley-testnet/solutions/Exercise-6-solutions.md
@@ -285,7 +285,8 @@ GitHub repositories.
             --pool-margin 0.03 \
             --pool-reward-account-verification-key-file stake2.vkey \
             --pool-owner-stake-verification-key-file stake2.vkey \
-            --out-file pool2.cert
+            --out-file pool2.cert \
+            --testnet-magic 42 
 
         cardano-cli shelley stake-address registration-certificate \
             --stake-verification-key-file stake2.vkey \
@@ -410,6 +411,7 @@ GitHub repositories.
             --pool-reward-account-verification-key-file stake2.vkey \
             --pool-owner-stake-verification-key-file stake1.vkey \
             --out-file pool1.cert
+            --testnet-magic 42
 
     Here we have additionally (although this was not required) changed the reward account to `stake2.vkey`,
     so the rewards from both our pools will go to the same stake key `stake2.vkey` from now on.
diff --git a/node-setup/000_install.md b/node-setup/000_install.md
@@ -36,7 +36,7 @@ For Debian/Ubuntu use the following instead:
 
 
     sudo apt-get update -y
-    sudo apt-get install build-essential pkg-config libffi-dev libgmp-dev libssl-dev libtinfo-dev libsystemd-dev zlib1g-dev make g++ tmux git jq wget libncursesw5 -y
+    sudo apt-get install build-essential pkg-config libffi-dev libgmp-dev libssl-dev libtinfo-dev libsystemd-dev zlib1g-dev make g++ tmux git jq wget libncursesw5 libtool autoconf -y
 
 If you are using a different flavor of Linux, you will need to use the package manager suitable for your platform instead of `yum` or `apt-get`, and the names of the packages you need to install might differ.
 
@@ -82,7 +82,7 @@ Above instructions install Cabal version `3.2.0.0`. You can check the version by
 
    cabal --version
 
-Finally we download and install GHC:
+Download and install GHC:
 
     wget https://downloads.haskell.org/~ghc/8.6.5/ghc-8.6.5-x86_64-deb9-linux.tar.xz
     tar -xf ghc-8.6.5-x86_64-deb9-linux.tar.xz
@@ -91,6 +91,19 @@ Finally we download and install GHC:
     ./configure
     sudo make install
     cd ..
+    
+Install Libsodium 
+    
+    git clone https://github.com/input-output-hk/libsodium
+    cd libsodium
+    git checkout 66f017f1
+    ./autogen.sh
+    ./configure
+    make
+    sudo make install
+
+    export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH"
+
 
 ## Download the source code for cardano-node
 
@@ -116,7 +129,7 @@ For the FF-testnet, we will use tag `1.13.0`, which we can check out as follows:
 
     git fetch --all --tags
     git tag
-    git checkout tags/1.13.0
+    git checkout tags/1.14.0
 
 
 ## Build and install the node
diff --git a/node-setup/011_cli.md b/node-setup/011_cli.md
@@ -33,4 +33,4 @@ by typing
             --cold-signing-key-file cold.skey \
             --operational-certificate-issue-counter-file cold.counter
 
-![`cardano-cli` command hierarchy](cli.png)
+![`cardano-cli` command hierarchy](011_cli.png)
diff --git a/node-setup/020_keys_and_addresses.md b/node-setup/020_keys_and_addresses.md
@@ -54,7 +54,7 @@ It's content look like this:
 
 This created the file payment.addr that is already associated with our stake keys:
 
-    cat payment.address
+    cat payment.addr
     > 00ec78e3d3916636101f6d9539c451f248ba200f38f2c33129f7ef36d66853603e872296956a4d86
 
 4. To query your address (see the utxo's at that address),
@@ -66,9 +66,9 @@ This created the file payment.addr that is already associated with our stake key
 
    and make sure that your node is running.  Then use
 
-    cardano-cli shelley query utxo \
-            --address $(cat payment.addr) \
-            --testnet-magic 42
+       cardano-cli shelley query utxo \
+       --address $(cat payment.addr) \
+       --testnet-magic 42
 
    you should see something like this:
 
diff --git a/node-setup/030_faucet.md b/node-setup/030_faucet.md
@@ -25,7 +25,6 @@ If all goes well, the last line of the output should declare success and say how
     * Connection #0 to host faucet.ff.dev.cardano.org left intact
     {"success":true,"amount":1000000000,"fee":168141,"txid":"8ed4383f7af20e81c9cef88b8aab0ff2b1b284dff0ed6614480f8dbfec7d6fb5"}
 
-
 Now, check the balance of your address to see if you have got the funds:
 
     export CARDANO_NODE_SOCKET_PATH=~/cardano-node/relay/db/node.socket
@@ -42,3 +41,8 @@ You should see something like this:
                               TxHash                                 TxIx        Lovelace
     ----------------------------------------------------------------------------------------
     65e99578e91dbf400c42989b5b5ae6dde877510900074f4afd8ff472639da6b3     0     1000000000000
+    
+    (Please note: although this command usually completes very quickly, under some conditions it could take severl minutes or even hours to complete.)
+
+
+IMPORTANT: Extra funds can be returned to 00677291d73b71471afa49fe2d20b96f7227b05f863dafe802598964533e0dc3bc0cf7eb8153441db271a2288560378b209014350792f273bdc307f06ca34f0c6f
diff --git a/node-setup/080_register_stakepool.md b/node-setup/080_register_stakepool.md
diff --git a/node-setup/081_start_your_nodes.md b/node-setup/081_start_your_nodes.md
diff --git a/node-setup/092_ekg.md b/node-setup/092_ekg.md
diff --git a/node-setup/README.md b/node-setup/README.md

Original file line number	Diff line number	Diff line change
@@ -194,7 +194,7 @@ In the `relay/ff-topology.json` we instruct the node to "talk" to the block-pro
`194`	`194`	`{`
`195`	`195`	`"Producers": [`
`196`	`196`	`{`
`197`		`- "addr": x.x.x.x", # Replace with your public IP`
	`197`	`+ "addr": "x.x.x.x", # Replace with your public IP`
`198`	`198`	`"port": 3000,`
`199`	`199`	`"valency": 1`
`200`	`200`	`},`