| description |
|---|
On Ubuntu/Debian, this guide will illustrate how to install and configure a Cardano stake pool from source code on a two node setup with 1 block producer node and 1 relay node. |
{% hint style="info" %} If you want to support this free educational Cardano content or found this helpful, visit cointr.ee to find our donation addresses. Much appreciated in advance. 🙏 {% endhint %}
{% hint style="success" %} As of October 30 2021, this is guide version 5.0.0 and written for **cardano mainnet **with release v.1.30.1 😁 {% endhint %}
- Re-organized content to improve loading speed.
- Added high-level explanation of Topology API.
- Increased the cardano-node service unit file timeout from 2 to 300 seconds.
- Added a collection of projects built by this amazing community.
- Added cardano-node RTS flags to reduce chance of missed slot leader checks.
- Added Leaderlog changes and improvements
- Increased minimum RAM requirements to 12GB.
- Updated for Alonzo release 1.29.0.
- Various fixes to testnet / alonzo / storage requirements / cli commands
- Updated CNCLI's Leaderlog command with the stake-snapshot approach
- Added CNCLI tool for sending slot to Pooltool and for LeaderLog scripts
- Updated guide for release cardano-node/cli v1.27.0 changes
- Added Stake Pool Operator's Best Practices Checklist
- Contribution By Billionaire Pool - Guide to monitor your node security with OSSEC and Slack.
- Added how to Secure your pool pledge with a 2nd pool owner using a hardware wallet
As a stake pool operator for Cardano, you will be competent with the following abilities:
- operational knowledge of how to set up, run and maintain a Cardano node continuously
- a commitment to maintain your node 24/7/365
- system operation skills
- server administration skills (operational and maintenance).
- experience of development and operations (DevOps)
- experience on how to harden and secure a server.
- passed the official Stake Pool School course.
{% hint style="danger" %} :octagonal_sign: **Before continuing this guide, you must satisfy the above requirements. **:construction: {% endhint %}
- **Two separate servers: **1 for block producer node, 1 for relay node
- One air-gapped offline machine (cold environment)
- **Operating system: **64-bit Linux (i.e. Ubuntu Server 20.04 LTS)
- Processor: An Intel or AMD x86 processor with two or more cores, at 2GHz or faster
- Memory: 12GB of RAM
- Storage: 50GB of free storage
- Internet: Broadband internet connection with speeds at least 10 Mbps.
- Data Plan: at least 1GB per hour. 720GB per month.
- Power: Reliable electrical power
- ADA balance: at least 505 ADA for pool deposit and transaction fees
- **Three separate servers: **1 for block producer node, 2 for relay nodes
- One air-gapped offline machine (cold environment)
- **Operating system: **64-bit Linux (i.e. Ubuntu 20.04 LTS)
- Processor: 4 core or higher CPU
- **Memory: **16GB+ of RAM
- **Storage: **256GB+ SSD
- **Internet: **Broadband internet connections with speeds at least 100 Mbps
- Data Plan: Unlimited
- Power: Reliable electrical power with UPS
- **ADA balance: **more pledge is better, to be determined by a0, the pledge influence factor
If you need ideas on how to harden your stake pool's nodes, refer to this guide.
If you need to install Ubuntu Server, refer to this guide.
For instructions on installing Ubuntu Desktop, refer to this guide.
If you are rebuilding or reusing an existing cardano-node installation, refer to section 18.2 on how to reset the installation.
If using Ubuntu Desktop, **press **Ctrl+Alt+T. This will launch a terminal window.
First, update packages and install Ubuntu dependencies.
sudo apt-get update -ysudo apt-get upgrade -y
sudo apt-get install git jq bc make automake rsync htop curl build-essential pkg-config libffi-dev libgmp-dev libssl-dev libtinfo-dev libsystemd-dev zlib1g-dev make g++ wget libncursesw5 libtool autoconf -y
Install Libsodium.
mkdir $HOME/git
cd $HOME/git
git clone https://github.com/input-output-hk/libsodium
cd libsodium
git checkout 66f017f1
./autogen.sh
./configure
make
sudo make install{% hint style="info" %} Debian OS pool operators: extra lib linking may be required.
sudo ln -s /usr/local/lib/libsodium.so.23.3.0 /usr/lib/libsodium.so.23**AWS Linux CentOS pool operators: **clearing the lib cache may be required.
sudo ldconfig**Raspberry Pi 4 with Ubuntu pool operators **: extra lib linking may be required.
sudo apt-get install libnuma-devThis will help to solve "cannot find -lnuma" error when compiling. {% endhint %}
Install Cabal and dependencies.
sudo apt-get -y install pkg-config libgmp-dev libssl-dev libtinfo-dev libsystemd-dev zlib1g-dev build-essential curl libgmp-dev libffi-dev libncurses-dev libtinfo5curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | shAnswer **NO **to installing haskell-language-server (HLS).
Answer **YES **to automatically add the required PATH variable to ".bashrc".
cd $HOME
source .bashrc
ghcup upgrade
ghcup install cabal 3.4.0.0
ghcup set cabal 3.4.0.0Install GHC.
ghcup install ghc 8.10.4
ghcup set ghc 8.10.4Update PATH to include Cabal and GHC and add exports. Your node's location will be in $NODE_HOME. The cluster configuration is set by $NODE_CONFIG.
echo PATH="$HOME/.local/bin:$PATH" >> $HOME/.bashrc
echo export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH" >> $HOME/.bashrc
echo export NODE_HOME=$HOME/cardano-my-node >> $HOME/.bashrc
echo export NODE_CONFIG=mainnet>> $HOME/.bashrc
source $HOME/.bashrc{% hint style="info" %} :bulb: How to use this Guide on TestNet
Run the following commands to set your NODE_CONFIG to testnet rather than mainnet.
echo export NODE_CONFIG=testnet>> $HOME/.bashrc
source $HOME/.bashrcAs you work through this guide, replace every instance of** **CLI parameter
--mainnet with
--testnet-magic 1097911063{% endhint %}
Update cabal and verify the correct versions were installed successfully.
cabal update
cabal --version
ghc --version{% hint style="info" %} Cabal library should be version 3.4.0.0 and GHC should be version 8.10.4 {% endhint %}
Download source code and switch to the latest tag.
cd $HOME/git
git clone https://github.com/input-output-hk/cardano-node.git
cd cardano-node
git fetch --all --recurse-submodules --tags
git checkout $(curl -s https://api.github.com/repos/input-output-hk/cardano-node/releases/latest | jq -r .tag_name)Configure build options.
cabal configure -O0 -w ghc-8.10.4
Update the cabal config, project settings, and reset build folder.
echo -e "package cardano-crypto-praos\n flags: -external-libsodium-vrf" > cabal.project.local
sed -i $HOME/.cabal/config -e "s/overwrite-policy:/overwrite-policy: always/g"
rm -rf $HOME/git/cardano-node/dist-newstyle/build/x86_64-linux/ghc-8.10.4Build the cardano-node from source code.
cabal build cardano-cli cardano-node
{% hint style="info" %} Building process may take a few minutes up to a few hours depending on your computer's processing power. {% endhint %}
Copy **cardano-cli **and cardano-node files into bin directory.
sudo cp $(find $HOME/git/cardano-node/dist-newstyle/build -type f -name "cardano-cli") /usr/local/bin/cardano-clisudo cp $(find $HOME/git/cardano-node/dist-newstyle/build -type f -name "cardano-node") /usr/local/bin/cardano-nodeVerify your **cardano-cli **and cardano-node are the expected versions.
cardano-node version
cardano-cli version
Here you'll grab the config.json, genesis.json, and topology.json files needed to configure your node.
mkdir $NODE_HOME
cd $NODE_HOME
wget -N https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/${NODE_CONFIG}-config.json
wget -N https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/${NODE_CONFIG}-byron-genesis.json
wget -N https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/${NODE_CONFIG}-shelley-genesis.json
wget -N https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/${NODE_CONFIG}-alonzo-genesis.json
wget -N https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/${NODE_CONFIG}-topology.jsonRun the following to modify mainnet-config.json and
- update TraceBlockFetchDecisions to "true"
sed -i ${NODE_CONFIG}-config.json \
-e "s/TraceBlockFetchDecisions\": false/TraceBlockFetchDecisions\": true/g"{% hint style="info" %} ****:sparkles: Tip for relay nodes: It's possible to reduce the number of missed slot leader checks, memory and cpu usage by setting "TraceMempool" to "false" in mainnet-config.json
Side effects of TraceMempool = false
- gLiveView will show 0 for transactions processed
- If your block producer is configured this way, troubleshooting topology / firewall / transaction processing issues may be harder to diagnose and identify. For block producer nodes, it is considered best practice to keep TraceMempool as true. {% endhint %}
Update **.bashrc **shell variables.
echo export CARDANO_NODE_SOCKET_PATH="$NODE_HOME/db/socket" >> $HOME/.bashrc
source $HOME/.bashrc{% hint style="info" %} A block producer node will be configured with various key-pairs needed for block generation (cold keys, KES hot keys and VRF hot keys). It can only connect to its relay nodes. {% endhint %}
{% hint style="info" %} A relay node will not be in possession of any keys and will therefore be unable to produce blocks. It will be connected to its block-producing node, other relays and external nodes. {% endhint %}
{% hint style="success" %} For the purposes of this guide, we will be building two nodes on two separate servers. One node will be designated the block producer node, and the other will be the relay node, named relaynode1. {% endhint %}
{% hint style="danger" %} Configure topology.json file so that
- relay node(s) connect to public relay nodes (like IOHK) and your block-producer node
- block-producer node **only **connects to your relay node(s) {% endhint %}
On your **block-producer node, **run the following. Update the **addr **with your relay node's IP address.
{% hint style="warning" %} What IP address to use?
- If both block producer and relay nodes are a local network, then use the relay node's local IP address.
i.e. 192.168.1.123 - If you are running all nodes in the cloud/VPS , then use the relay node's public IP address.
i.e. 173.45.12.32 - If your block producer node is local and relay node is in the cloud, then use the relay node's public IP address.
i.e. 173.45.12.32{% endhint %}
{% tabs %} {% tab title="block producer node" %}
cat > $NODE_HOME/${NODE_CONFIG}-topology.json << EOF
{
"Producers": [
{
"addr": "<RELAYNODE1'S IP ADDRESS>",
"port": 6000,
"valency": 1
}
]
}
EOF{% endtab %} {% endtabs %}
{% hint style="warning" %} :construction: On your other server that will be designed as your relay node or what we will call relaynode1 throughout this guide, carefully repeat steps 1 through 3 in order to build the cardano binaries. {% endhint %}
{% hint style="info" %} You can have multiple relay nodes as you scale up your stake pool architecture. Simply create relaynodeN and adapt the guide instructions accordingly. {% endhint %}
On your **relaynode1, run **with the following after updating with your block producer's IP address.
{% hint style="warning" %} What IP address to use?
- If both block producer and relay nodes are a local network, then use the local IP address.
i.e. 192.168.1.123 - If you are running on a cloud or VPS configuration, then use the block producer's public IP address.
i.e. 173.45.12.32 - If your block producer node is local and relay node is in the cloud, then use the block producer's public IP address (also known as your local network's public IP address).
i.e. 173.45.12.32{% endhint %}
{% tabs %} {% tab title="relaynode1" %}
cat > $NODE_HOME/${NODE_CONFIG}-topology.json << EOF
{
"Producers": [
{
"addr": "<BLOCK PRODUCER NODE'S IP ADDRESS>",
"port": 6000,
"valency": 1
},
{
"addr": "relays-new.cardano-mainnet.iohk.io",
"port": 3001,
"valency": 2
}
]
}
EOF{% endtab %} {% endtabs %}
{% hint style="info" %} Valency tells the node how many connections to keep open. Only DNS addresses are affected. If value is 0, the address is ignored. {% endhint %}
{% hint style="danger" %} ****:sparkles: **Port Forwarding Tip: **You'll need to forward and open ports 6000 to your nodes. Check with https://www.yougetsignal.com/tools/open-ports/ or https://canyouseeme.org/ . {% endhint %}
{% hint style="info" %} An air-gapped offline machine is called your cold environment.
- Protects against key-logging attacks, malware/virus based attacks and other firewall or security exploits.
- Physically isolated from the rest of your network.
- Must not have a network connection, wired or wireless.
- Is not a VM on a machine with a network connection.
- Learn more about air-gapping at wikipedia. {% endhint %}
{% hint style="info" %} A note about hardware requirements for an air-gapped offline machine.
- Can be as basic as a Raspberry Pi or an upcycled older laptop/desktop.
- Uses an usb port to transport files back and forth. {% endhint %}
{% tabs %} {% tab title="air-gapped offline machine" %}
echo export NODE_HOME=$HOME/cardano-my-node >> $HOME/.bashrc
source $HOME/.bashrc
mkdir -p $NODE_HOME{% endtab %} {% endtabs %}
Copy from your hot environment, also known as your block producer node, a copy of the **cardano-cli **to your cold environment, this air-gapped offline machine.
Location of your cardano-cli.
/usr/local/bin/cardano-cli
{% hint style="danger" %} In order to remain a true air-gapped environment, you must move files physically between your cold and hot environments with USB keys or other removable media. {% endhint %}
After copying over to your cold environment, add execute permissions to the file.
sudo chmod +x /usr/local/bin/cardano-cli
The startup script contains all the variables needed to run a cardano-node such as directory, port, db path, config file, and topology file.
{% tabs %} {% tab title="block producer node" %}
cat > $NODE_HOME/startBlockProducingNode.sh << EOF
#!/bin/bash
DIRECTORY=$NODE_HOME
PORT=6000
HOSTADDR=0.0.0.0
TOPOLOGY=\${DIRECTORY}/${NODE_CONFIG}-topology.json
DB_PATH=\${DIRECTORY}/db
SOCKET_PATH=\${DIRECTORY}/db/socket
CONFIG=\${DIRECTORY}/${NODE_CONFIG}-config.json
/usr/local/bin/cardano-node run +RTS -N -A16m -qg -qb -RTS --topology \${TOPOLOGY} --database-path \${DB_PATH} --socket-path \${SOCKET_PATH} --host-addr \${HOSTADDR} --port \${PORT} --config \${CONFIG}
EOF{% endtab %}
{% tab title="relaynode1" %}
cat > $NODE_HOME/startRelayNode1.sh << EOF
#!/bin/bash
DIRECTORY=$NODE_HOME
PORT=6000
HOSTADDR=0.0.0.0
TOPOLOGY=\${DIRECTORY}/${NODE_CONFIG}-topology.json
DB_PATH=\${DIRECTORY}/db
SOCKET_PATH=\${DIRECTORY}/db/socket
CONFIG=\${DIRECTORY}/${NODE_CONFIG}-config.json
/usr/local/bin/cardano-node run +RTS -N -A16m -qg -qb -RTS --topology \${TOPOLOGY} --database-path \${DB_PATH} --socket-path \${SOCKET_PATH} --host-addr \${HOSTADDR} --port \${PORT} --config \${CONFIG}
EOF{% endtab %} {% endtabs %}
Add execute permissions to the startup script.
{% tabs %} {% tab title="block producer node" %}
chmod +x $NODE_HOME/startBlockProducingNode.sh{% endtab %}
{% tab title="relaynode1" %}
chmod +x $NODE_HOME/startRelayNode1.sh {% endtab %} {% endtabs %}
Run the following to create a systemd unit file to define yourcardano-node.service configuration.
{% hint style="info" %}
- Auto-start your stake pool when the computer reboots due to maintenance, power outage, etc.
- Automatically restart crashed stake pool processes.
- Maximize your stake pool up-time and performance. {% endhint %}
{% tabs %} {% tab title="block producer node" %}
cat > $NODE_HOME/cardano-node.service << EOF
# The Cardano node service (part of systemd)
# file: /etc/systemd/system/cardano-node.service
[Unit]
Description = Cardano node service
Wants = network-online.target
After = network-online.target
[Service]
User = ${USER}
Type = simple
WorkingDirectory= ${NODE_HOME}
ExecStart = /bin/bash -c '${NODE_HOME}/startBlockProducingNode.sh'
KillSignal=SIGINT
RestartKillSignal=SIGINT
TimeoutStopSec=300
LimitNOFILE=32768
Restart=always
RestartSec=5
SyslogIdentifier=cardano-node
[Install]
WantedBy = multi-user.target
EOF{% endtab %}
{% tab title="relaynode1" %}
cat > $NODE_HOME/cardano-node.service << EOF
# The Cardano node service (part of systemd)
# file: /etc/systemd/system/cardano-node.service
[Unit]
Description = Cardano node service
Wants = network-online.target
After = network-online.target
[Service]
User = ${USER}
Type = simple
WorkingDirectory= ${NODE_HOME}
ExecStart = /bin/bash -c '${NODE_HOME}/startRelayNode1.sh'
KillSignal=SIGINT
RestartKillSignal=SIGINT
TimeoutStopSec=300
LimitNOFILE=32768
Restart=always
RestartSec=5
SyslogIdentifier=cardano-node
[Install]
WantedBy = multi-user.target
EOF{% endtab %} {% endtabs %}
Move the unit file to /etc/systemd/system and give it permissions.
sudo mv $NODE_HOME/cardano-node.service /etc/systemd/system/cardano-node.servicesudo chmod 644 /etc/systemd/system/cardano-node.serviceRun the following to enable auto-starting of your stake pool at boot time.
sudo systemctl daemon-reload
sudo systemctl enable cardano-node
{% hint style="success" %} Your stake pool is now managed by the reliability and robustness of systemd. Below are some commands for using systemd. {% endhint %}
sudo systemctl status cardano-node
sudo systemctl reload-or-restart cardano-node
sudo systemctl stop cardano-node
journalctl --unit=cardano-node --followjournalctl --unit=cardano-node --since=yesterdayjournalctl --unit=cardano-node --since=today
journalctl --unit=cardano-node --since='2020-07-29 00:00:00' --until='2020-07-29 12:00:00'
Start your stake pool with systemctl and begin syncing the blockchain!
{% tabs %} {% tab title="block producer node" %}
sudo systemctl start cardano-node{% endtab %}
{% tab title="relaynode1" %}
sudo systemctl start cardano-node{% endtab %} {% endtabs %}
Install gLiveView, a monitoring tool.
{% hint style="info" %} gLiveView displays crucial node status information and works well with systemd services. Credits to the Guild Operators for creating this tool. {% endhint %}
cd $NODE_HOME
sudo apt install bc tcptraceroute -y
curl -s -o gLiveView.sh https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/gLiveView.sh
curl -s -o env https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/env
chmod 755 gLiveView.shRun the following to modify env with the updated file locations.
sed -i env \
-e "s/\#CONFIG=\"\${CNODE_HOME}\/files\/config.json\"/CONFIG=\"\${NODE_HOME}\/mainnet-config.json\"/g" \
-e "s/\#SOCKET=\"\${CNODE_HOME}\/sockets\/node0.socket\"/SOCKET=\"\${NODE_HOME}\/db\/socket\"/g"{% hint style="warning" %}
A node must reach epoch 208 (Shelley launch) before gLiveView.sh can start tracking the node syncing. You can track the node syncing using journalctl before epoch 208.
journalctl --unit=cardano-node --follow
{% endhint %}
Run gLiveView to monitor the progress of the sync'ing of the blockchain.
./gLiveView.sh
Sample output of gLiveView.
For more information, refer to the official Guild Live View docs.
{% hint style="info" %} ****:sparkles: Pro tip: If you synchronize a node's database, you can copy the database directory over to your other node directly and save time. {% endhint %}
{% hint style="success" %} Congratulations! Your node is running successfully now. Let it sync up. {% endhint %}
The block-producer node requires you to create 3 keys as defined in the Shelley ledger specs:
- stake pool cold key (node.cert)
- stake pool hot key (kes.skey)
- stake pool VRF key (vrf.skey)
First, make a KES key pair.
{% tabs %} {% tab title="block producer node" %}
cd $NODE_HOME
cardano-cli node key-gen-KES \
--verification-key-file kes.vkey \
--signing-key-file kes.skey{% endtab %} {% endtabs %}
{% hint style="info" %} KES (key evolving signature) keys are created to secure your stake pool against hackers who might compromise your keys.
On mainnet, you will need to regenerate the KES key every 90 days. {% endhint %}
{% hint style="danger" %}
****:fire: Cold keys must be generated and stored on your air-gapped offline machine. The cold keys are the files stored in $HOME/cold-keys.
{% endhint %}
Make a directory to store your cold keys
{% tabs %} {% tab title="Air-gapped offline machine" %}
mkdir $HOME/cold-keys
pushd $HOME/cold-keys
{% endtab %} {% endtabs %}
Make a set of cold keys and create the cold counter file.
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli node key-gen \
--cold-verification-key-file node.vkey \
--cold-signing-key-file $HOME/cold-keys/node.skey \
--operational-certificate-issue-counter node.counter{% endtab %} {% endtabs %}
{% hint style="warning" %} Be sure to back up your all your keys to another secure storage device. Make multiple copies. {% endhint %}
Determine the number of slots per KES period from the genesis file.
{% tabs %} {% tab title="block producer node" %}
pushd +1
slotsPerKESPeriod=$(cat $NODE_HOME/${NODE_CONFIG}-shelley-genesis.json | jq -r '.slotsPerKESPeriod')
echo slotsPerKESPeriod: ${slotsPerKESPeriod}{% endtab %} {% endtabs %}
{% hint style="warning" %} Before continuing, your node must be fully synchronized to the blockchain. Otherwise, you won't calculate the latest KES period. Your node is synchronized when the _epoch _and _slot# _is equal to that found on a block explorer such as https://pooltool.io/ {% endhint %}
{% tabs %} {% tab title="block producer node" %}
slotNo=$(cardano-cli query tip --mainnet | jq -r '.slot')
echo slotNo: ${slotNo}{% endtab %} {% endtabs %}
Find the kesPeriod by dividing the slot tip number by the slotsPerKESPeriod.
{% tabs %} {% tab title="block producer node" %}
kesPeriod=$((${slotNo} / ${slotsPerKESPeriod}))
echo kesPeriod: ${kesPeriod}
startKesPeriod=${kesPeriod}
echo startKesPeriod: ${startKesPeriod}{% endtab %} {% endtabs %}
With this calculation, you can generate a operational certificate for your pool.
Copy kes.vkey to your cold environment.
Change the <**startKesPeriod> **value accordingly.
{% hint style="info" %} Stake pool operators must provide an operational certificate to verify that the pool has the authority to run. The certificate includes the operator’s signature, and includes key information about the pool (addresses, keys, etc.). Operational certificates represent the link between the operator’s offline key and their operational key. {% endhint %}
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli node issue-op-cert \
--kes-verification-key-file kes.vkey \
--cold-signing-key-file $HOME/cold-keys/node.skey \
--operational-certificate-issue-counter $HOME/cold-keys/node.counter \
--kes-period <startKesPeriod> \
--out-file node.cert{% endtab %} {% endtabs %}
Copy node.cert to your hot environment.
Make a VRF key pair.
{% tabs %} {% tab title="block producer node" %}
cardano-cli node key-gen-VRF \
--verification-key-file vrf.vkey \
--signing-key-file vrf.skey{% endtab %} {% endtabs %}
Update vrf key permissions to read-only. You must also copy vrf.vkey to your cold environment.
chmod 400 vrf.skey
Stop your** **stake pool by running the following:
{% tabs %} {% tab title="block producer node" %}
sudo systemctl stop cardano-node{% endtab %} {% endtabs %}
Update your startup script with the new** KES, VRF and Operation Certificate.**
{% tabs %} {% tab title="block producer node" %}
cat > $NODE_HOME/startBlockProducingNode.sh << EOF
DIRECTORY=$NODE_HOME
PORT=6000
HOSTADDR=0.0.0.0
TOPOLOGY=\${DIRECTORY}/${NODE_CONFIG}-topology.json
DB_PATH=\${DIRECTORY}/db
SOCKET_PATH=\${DIRECTORY}/db/socket
CONFIG=\${DIRECTORY}/${NODE_CONFIG}-config.json
KES=\${DIRECTORY}/kes.skey
VRF=\${DIRECTORY}/vrf.skey
CERT=\${DIRECTORY}/node.cert
/usr/local/bin/cardano-node run +RTS -N -A16m -qg -qb -RTS --topology \${TOPOLOGY} --database-path \${DB_PATH} --socket-path \${SOCKET_PATH} --host-addr \${HOSTADDR} --port \${PORT} --config \${CONFIG} --shelley-kes-key \${KES} --shelley-vrf-key \${VRF} --shelley-operational-certificate \${CERT}
EOF{% endtab %} {% endtabs %}
{% hint style="info" %} To operate a stake pool, you need the KES, VRF key and Operational Certificate. Cold keys generate new operational certificates periodically. {% endhint %}
Now start your block producer node.
{% tabs %} {% tab title="block producer node" %}
sudo systemctl start cardano-node
# Monitor with gLiveView
./gLiveView.sh{% endtab %} {% endtabs %}
First, obtain the protocol-parameters.
{% hint style="info" %} Wait for the block-producing node to start syncing before continuing if you get this error message.
cardano-cli: Network.Socket.connect: : does not exist (No such file or directory)
{% endhint %}
{% tabs %} {% tab title="block producer node" %}
cardano-cli query protocol-parameters \
--mainnet \
--out-file params.json{% endtab %} {% endtabs %}
{% hint style="info" %} Payment keys are used to send and receive payments and stake keys are used to manage stake delegations. {% endhint %}
There are two ways to create your payment and stake key pair. Pick the one that best suits your needs.
{% hint style="danger" %}
:fire: Critical Operational Security Advice: payment and stake keys must be generated and used to build transactions in an cold environment. In other words, your air-gapped offline machine. Copy cardano-cli binary over to your offline machine and run the CLI method or mnemonic method. The only steps performed online in a hot environment are those steps that require live data. Namely the follow type of steps:
- querying the current slot tip
- querying the balance of an address
- submitting a transaction {% endhint %}
{% tabs %}
{% tab title="CLI Method" %}
Create a new payment key pair: payment.skey & payment.vkey
###
### On air-gapped offline machine,
###
cd $NODE_HOME
cardano-cli address key-gen \
--verification-key-file payment.vkey \
--signing-key-file payment.skey Create a new stake address key pair: stake.skey & stake.vkey
###
### On air-gapped offline machine,
###
cardano-cli stake-address key-gen \
--verification-key-file stake.vkey \
--signing-key-file stake.skeyCreate your stake address from the stake address verification key and store it in stake.addr
###
### On air-gapped offline machine,
###
cardano-cli stake-address build \
--stake-verification-key-file stake.vkey \
--out-file stake.addr \
--mainnetBuild a payment address for the payment key payment.vkey which will delegate to the stake address, stake.vkey
###
### On air-gapped offline machine,
###
cardano-cli address build \
--payment-verification-key-file payment.vkey \
--stake-verification-key-file stake.vkey \
--out-file payment.addr \
--mainnet{% endtab %}
{% tab title="Mnemonic Method" %} {% hint style="info" %} Credits to ilap for creating this process. {% endhint %}
{% hint style="success" %} Benefits: Track and control pool rewards from any wallet (Daedalus, Yoroi or any other wallet) that support stakings. {% endhint %}
Create a 15-word or 24-word length shelley compatible mnemonic with Daedalus or Yoroi on a offline machine preferred.
Using your online block producer node, download cardano-wallet
###
### On block producer node,
###
cd $NODE_HOME
wget https://hydra.iohk.io/build/3662127/download/1/cardano-wallet-shelley-2020.7.28-linux64.tar.gzVerify the legitimacy of cardano-wallet by checking the sha256 hash found in the **Details **button.
echo "f75e5b2b4cc5f373d6b1c1235818bcab696d86232cb2c5905b2d91b4805bae84 *cardano-wallet-shelley-2020.7.28-linux64.tar.gz" | shasum -a 256 --checkExample valid output:
cardano-wallet-shelley-2020.7.28-linux64.tar.gz: OK
{% hint style="danger" %} Only proceed if the sha256 check passes with OK! {% endhint %}
Transfer the cardano-wallet to your air-gapped offline machine via USB key or other removable media.
Extract the wallet files and cleanup.
###
### On air-gapped offline machine,
###
tar -xvf cardano-wallet-shelley-2020.7.28-linux64.tar.gz
rm cardano-wallet-shelley-2020.7.28-linux64.tar.gzCreateextractPoolStakingKeys.sh script.
###
### On air-gapped offline machine,
###
cat > extractPoolStakingKeys.sh << HERE
#!/bin/bash
CADDR=\${CADDR:=\$( which cardano-address )}
[[ -z "\$CADDR" ]] && ( echo "cardano-address cannot be found, exiting..." >&2 ; exit 127 )
CCLI=\${CCLI:=\$( which cardano-cli )}
[[ -z "\$CCLI" ]] && ( echo "cardano-cli cannot be found, exiting..." >&2 ; exit 127 )
OUT_DIR="\$1"
[[ -e "\$OUT_DIR" ]] && {
echo "The \"\$OUT_DIR\" is already exist delete and run again." >&2
exit 127
} || mkdir -p "\$OUT_DIR" && pushd "\$OUT_DIR" >/dev/null
shift
MNEMONIC="\$*"
# Generate the master key from mnemonics and derive the stake account keys
# as extended private and public keys (xpub, xprv)
echo "\$MNEMONIC" |\
"\$CADDR" key from-recovery-phrase Shelley > root.prv
cat root.prv |\
"\$CADDR" key child 1852H/1815H/0H/2/0 > stake.xprv
cat root.prv |\
"\$CADDR" key child 1852H/1815H/0H/0/0 > payment.xprv
TESTNET=0
MAINNET=1
NETWORK=\$MAINNET
cat payment.xprv |\
"\$CADDR" key public | tee payment.xpub |\
"\$CADDR" address payment --network-tag \$NETWORK |\
"\$CADDR" address delegation \$(cat stake.xprv | "\$CADDR" key public | tee stake.xpub) |\
tee base.addr_candidate |\
"\$CADDR" address inspect
echo "Generated from 1852H/1815H/0H/{0,2}/0"
cat base.addr_candidate
echo
# XPrv/XPub conversion to normal private and public key, keep in mind the
# keypars are not a valind Ed25519 signing keypairs.
TESTNET_MAGIC="--testnet-magic 1097911063"
MAINNET_MAGIC="--mainnet"
MAGIC="\$MAINNET_MAGIC"
SESKEY=\$( cat stake.xprv | bech32 | cut -b -128 )\$( cat stake.xpub | bech32)
PESKEY=\$( cat payment.xprv | bech32 | cut -b -128 )\$( cat payment.xpub | bech32)
cat << EOF > stake.skey
{
"type": "StakeExtendedSigningKeyShelley_ed25519_bip32",
"description": "",
"cborHex": "5880\$SESKEY"
}
EOF
cat << EOF > payment.skey
{
"type": "PaymentExtendedSigningKeyShelley_ed25519_bip32",
"description": "Payment Signing Key",
"cborHex": "5880\$PESKEY"
}
EOF
"\$CCLI" shelley key verification-key --signing-key-file stake.skey --verification-key-file stake.evkey
"\$CCLI" shelley key verification-key --signing-key-file payment.skey --verification-key-file payment.evkey
"\$CCLI" shelley key non-extended-key --extended-verification-key-file payment.evkey --verification-key-file payment.vkey
"\$CCLI" shelley key non-extended-key --extended-verification-key-file stake.evkey --verification-key-file stake.vkey
"\$CCLI" shelley stake-address build --stake-verification-key-file stake.vkey \$MAGIC > stake.addr
"\$CCLI" shelley address build --payment-verification-key-file payment.vkey \$MAGIC > payment.addr
"\$CCLI" shelley address build \
--payment-verification-key-file payment.vkey \
--stake-verification-key-file stake.vkey \
\$MAGIC > base.addr
echo "Important the base.addr and the base.addr_candidate must be the same"
diff base.addr base.addr_candidate
popd >/dev/null
HEREAdd permissions and export PATH to use the binaries.
###
### On air-gapped offline machine,
###
chmod +x extractPoolStakingKeys.sh
export PATH="$(pwd)/cardano-wallet-shelley-2020.7.28:$PATH"Extract your keys. Update the command with your mnemonic phrase.
###
### On air-gapped offline machine,
###
./extractPoolStakingKeys.sh extractedPoolKeys/ <15|24-word length mnemonic>{% hint style="danger" %} Important: The base.addr and the base.addr_candidate must be the same. Review the screen output. {% endhint %}
Your new staking keys are in the folder extractedPoolKeys/
Now move payment/stake key pair over to your $NODE_HOME for use with your stake pool.
###
### On air-gapped offline machine,
###
cd extractedPoolKeys/
cp stake.vkey stake.skey stake.addr payment.vkey payment.skey base.addr $NODE_HOME
cd $NODE_HOME
#Rename to base.addr file to payment.addr
mv base.addr payment.addr{% hint style="info" %} payment.addr, or also known as base.addr from this extraction script, will be the cardano address which holds your pool's pledge. {% endhint %}
Clear the bash history in order to protect your mnemonic phrase and remove the cardano-wallet files.
###
### On air-gapped offline machine,
###
history -c && history -w
rm -rf $NODE_HOME/cardano-wallet-shelley-2020.7.28Finally close all your terminal windows and open new ones with zero history.
{% hint style="success" %} Awesome. Now you can track your pool rewards in your wallet. {% endhint %} {% endtab %} {% endtabs %}
Next step is to fund your payment address.
Copy payment.addr to your hot environment.
Payment address can be funded from your Daedalus / Yoroi wallet.
Run the following to find your payment address.
cat payment.addrAfter funding your account, check your payment address balance.
{% hint style="danger" %} Before continuing, your nodes must be fully synchronized to the blockchain. Otherwise, you won't see your funds. {% endhint %}
{% tabs %} {% tab title="block producer node" %}
cardano-cli query utxo \
--address $(cat payment.addr) \
--mainnet{% endtab %} {% endtabs %}
You should see output similar to this. This is your unspent transaction output (UXTO).
TxHash TxIx Lovelace
----------------------------------------------------------------------------------------
100322a39d02c2ead.... 0 1000000000
Create a certificate, stake.cert, using the stake.vkey
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli stake-address registration-certificate \
--stake-verification-key-file stake.vkey \
--out-file stake.cert
{% endtab %} {% endtabs %}
Copy **stake.cert **to your hot environment.
You need to find the **tip **of the blockchain to set the **invalid-hereafter **parameter properly.
{% tabs %} {% tab title="block producer node" %}
currentSlot=$(cardano-cli query tip --mainnet | jq -r '.slot')
echo Current Slot: $currentSlot{% endtab %} {% endtabs %}
Find your balance and UTXOs.
{% tabs %} {% tab title="block producer node" %}
cardano-cli query utxo \
--address $(cat payment.addr) \
--mainnet > fullUtxo.out
tail -n +3 fullUtxo.out | sort -k3 -nr > balance.out
cat balance.out
tx_in=""
total_balance=0
while read -r utxo; do
in_addr=$(awk '{ print $1 }' <<< "${utxo}")
idx=$(awk '{ print $2 }' <<< "${utxo}")
utxo_balance=$(awk '{ print $3 }' <<< "${utxo}")
total_balance=$((${total_balance}+${utxo_balance}))
echo TxHash: ${in_addr}#${idx}
echo ADA: ${utxo_balance}
tx_in="${tx_in} --tx-in ${in_addr}#${idx}"
done < balance.out
txcnt=$(cat balance.out | wc -l)
echo Total ADA balance: ${total_balance}
echo Number of UTXOs: ${txcnt}{% endtab %} {% endtabs %}
Find the stakeAddressDeposit value.
{% tabs %} {% tab title="block producer node" %}
stakeAddressDeposit=$(cat $NODE_HOME/params.json | jq -r '.stakeAddressDeposit')
echo stakeAddressDeposit : $stakeAddressDeposit{% endtab %} {% endtabs %}
{% hint style="info" %} Registration of a stake address certificate (stakeAddressDeposit) costs 2000000 lovelace. {% endhint %}
Run the build-raw transaction command
{% hint style="info" %} The invalid-hereafter value must be greater than the current tip. In this example, we use current slot + 10000. {% endhint %}
{% tabs %} {% tab title="block producer node" %}
cardano-cli transaction build-raw \
${tx_in} \
--tx-out $(cat payment.addr)+0 \
--invalid-hereafter $(( ${currentSlot} + 10000)) \
--fee 0 \
--out-file tx.tmp \
--certificate stake.cert{% endtab %} {% endtabs %}
Calculate the current minimum fee:
{% tabs %} {% tab title="block producer node" %}
fee=$(cardano-cli transaction calculate-min-fee \
--tx-body-file tx.tmp \
--tx-in-count ${txcnt} \
--tx-out-count 1 \
--mainnet \
--witness-count 2 \
--byron-witness-count 0 \
--protocol-params-file params.json | awk '{ print $1 }')
echo fee: $fee{% endtab %} {% endtabs %}
{% hint style="info" %} Ensure your balance is greater than cost of fee + stakeAddressDeposit or this will not work. {% endhint %}
Calculate your change output.
{% tabs %} {% tab title="block producer node" %}
txOut=$((${total_balance}-${stakeAddressDeposit}-${fee}))
echo Change Output: ${txOut}{% endtab %} {% endtabs %}
Build your transaction which will register your stake address.
{% tabs %} {% tab title="block producer node" %}
cardano-cli transaction build-raw \
${tx_in} \
--tx-out $(cat payment.addr)+${txOut} \
--invalid-hereafter $(( ${currentSlot} + 10000)) \
--fee ${fee} \
--certificate-file stake.cert \
--out-file tx.raw{% endtab %} {% endtabs %}
Copy tx.raw to your cold environment.
Sign the transaction with both the payment and stake secret keys.
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli transaction sign \
--tx-body-file tx.raw \
--signing-key-file payment.skey \
--signing-key-file stake.skey \
--mainnet \
--out-file tx.signed{% endtab %} {% endtabs %}
Copy tx.signed to your hot environment.
Send the signed transaction.
{% tabs %} {% tab title="block producer node" %}
cardano-cli transaction submit \
--tx-file tx.signed \
--mainnet{% endtab %} {% endtabs %}
Create your pool's metadata with a JSON file. Update with your pool information.
{% hint style="warning" %} **ticker **must be between 3-5 characters in length. Characters must be A-Z and 0-9 only. {% endhint %}
{% hint style="warning" %} **description **cannot exceed 255 characters in length. {% endhint %}
{% tabs %} {% tab title="block producer node" %}
cat > poolMetaData.json << EOF
{
"name": "MyPoolName",
"description": "My pool description",
"ticker": "MPN",
"homepage": "https://myadapoolnamerocks.com"
}
EOF{% endtab %} {% endtabs %}
Calculate the hash of your metadata file. It's saved to poolMetaDataHash.txt
{% tabs %} {% tab title="block producer node" %}
cardano-cli stake-pool metadata-hash --pool-metadata-file poolMetaData.json > poolMetaDataHash.txt{% endtab %} {% endtabs %}
Copy poolMetaDataHash.txt to your air-gapped offline machine, cold environment.
Now upload your poolMetaData.json to your website or a public website such as https://pages.github.com/
Refer to this quick guide if you need help hosting your metadata on github.com
Verify the metadata hashes by comparing your uploaded .json file and your local .json file's hash.
{% tabs %} {% tab title="block producer node" %} Get the metadata hash from your metadata json URL. Replace <https://REPLACE WITH YOUR METADATA_URL> with your actual URL.
cardano-cli stake-pool metadata-hash --pool-metadata-file <(curl -s -L <https://REPLACE WITH YOUR METADATA_URL>)This above hash must equal the local metadata hash.
cat poolMetaDataHash.txt
{% endtab %} {% endtabs %}
{% hint style="warning" %} If the hashes do no match, then the uploaded .json file likely was truncated or extra whitespace caused issues. Upload the .json again or to a different web host. {% endhint %}
Find the minimum pool cost.
{% tabs %} {% tab title="block producer node" %}
minPoolCost=$(cat $NODE_HOME/params.json | jq -r .minPoolCost)
echo minPoolCost: ${minPoolCost}{% endtab %} {% endtabs %}
{% hint style="info" %}
minPoolCost is 340000000 lovelace or 340 ADA. Therefore, your --pool-cost must be at a minimum this amount.
{% endhint %}
Create a registration certificate for your stake pool. Update with your metadata URL and your relay node information. Choose one of the three options available to configure relay nodes -- DNS based, Round Robin DNS based, or IP based.
{% hint style="info" %} DNS based relays are recommended for simplicity of node management. In other words, you don't need to re-submit this registration certificate transaction every time your IP changes. Also you can easily update the DNS to point towards a new IP should you re-locate or re-build a relay node, for example. {% endhint %}
{% hint style="info" %}
Update the next operation
cardano-cli stake-pool registration-certificate
to be run on your air-gapped offline machine appropriately. Replace with your proper domain names or IP addresses.
DNS based relays, 1 entry per DNS record
--single-host-pool-relay <relaynode1.myadapoolnamerocks.com> \
--pool-relay-port 6000 \
--single-host-pool-relay <relaynode2.myadapoolnamerocks.com> \
--pool-relay-port 6000 \Round Robin DNS based relays, 1 entry per SRV DNS record
--multi-host-pool-relay <relayNodes.myadapoolnamerocks.com> \
--pool-relay-port 6000 \IP based relays, 1 entry per IP address
--pool-relay-port 6000 \
--pool-relay-ipv4 <your first relay node public IP address> \
--pool-relay-port 6000 \
--pool-relay-ipv4 <your second relay node public IP address> \{% endhint %}
{% hint style="warning" %} metadata-url must be no longer than 64 characters. {% endhint %}
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli stake-pool registration-certificate \
--cold-verification-key-file $HOME/cold-keys/node.vkey \
--vrf-verification-key-file vrf.vkey \
--pool-pledge 100000000 \
--pool-cost 345000000 \
--pool-margin 0.15 \
--pool-reward-account-verification-key-file stake.vkey \
--pool-owner-stake-verification-key-file stake.vkey \
--mainnet \
--single-host-pool-relay <dns based relay, example ~ relaynode1.myadapoolnamerocks.com> \
--pool-relay-port 6000 \
--metadata-url <url where you uploaded poolMetaData.json> \
--metadata-hash $(cat poolMetaDataHash.txt) \
--out-file pool.cert{% endtab %} {% endtabs %}
{% hint style="info" %} Here we are pledging 100 ADA with a fixed pool cost of 345 ADA and a pool margin of 15%. {% endhint %}
Copy pool.cert to your hot environment.
Pledge stake to your stake pool.
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli stake-address delegation-certificate \
--stake-verification-key-file stake.vkey \
--cold-verification-key-file $HOME/cold-keys/node.vkey \
--out-file deleg.cert{% endtab %} {% endtabs %}
Copy deleg.cert to your hot environment.
{% hint style="info" %}
This operation creates a delegation certificate which delegates funds from all stake addresses associated with key stake.vkey to the pool belonging to cold key node.vkey
{% endhint %}
{% hint style="info" %} A stake pool owner's promise to fund their own pool is called Pledge.
- Your balance needs to be greater than the pledge amount.
- You pledge funds are not moved anywhere. In this guide's example, the pledge remains in the stake pool's owner keys, specifically
payment.addr - Failing to fulfill pledge will result in missed block minting opportunities and your delegators would miss rewards.
- Your pledge is not locked up. You are free to transfer your funds. {% endhint %}
You need to find the **tip **of the blockchain to set the **invalid-hereafter **parameter properly.
{% tabs %} {% tab title="block producer node" %}
currentSlot=$(cardano-cli query tip --mainnet | jq -r '.slot')
echo Current Slot: $currentSlot{% endtab %} {% endtabs %}
Find your balance and UTXOs.
{% tabs %} {% tab title="block producer node" %}
cardano-cli query utxo \
--address $(cat payment.addr) \
--mainnet > fullUtxo.out
tail -n +3 fullUtxo.out | sort -k3 -nr > balance.out
cat balance.out
tx_in=""
total_balance=0
while read -r utxo; do
in_addr=$(awk '{ print $1 }' <<< "${utxo}")
idx=$(awk '{ print $2 }' <<< "${utxo}")
utxo_balance=$(awk '{ print $3 }' <<< "${utxo}")
total_balance=$((${total_balance}+${utxo_balance}))
echo TxHash: ${in_addr}#${idx}
echo ADA: ${utxo_balance}
tx_in="${tx_in} --tx-in ${in_addr}#${idx}"
done < balance.out
txcnt=$(cat balance.out | wc -l)
echo Total ADA balance: ${total_balance}
echo Number of UTXOs: ${txcnt}{% endtab %} {% endtabs %}
Find the deposit fee for a pool.
{% tabs %} {% tab title="block producer node" %}
stakePoolDeposit=$(cat $NODE_HOME/params.json | jq -r '.stakePoolDeposit')
echo stakePoolDeposit: $stakePoolDeposit{% endtab %} {% endtabs %}
Run the build-raw transaction command.
{% hint style="info" %} The **invalid-hereafter **value must be greater than the current tip. In this example, we use current slot + 10000. {% endhint %}
{% tabs %} {% tab title="block producer node" %}
cardano-cli transaction build-raw \
${tx_in} \
--tx-out $(cat payment.addr)+$(( ${total_balance} - ${stakePoolDeposit})) \
--invalid-hereafter $(( ${currentSlot} + 10000)) \
--fee 0 \
--certificate-file pool.cert \
--certificate-file deleg.cert \
--out-file tx.tmp{% endtab %} {% endtabs %}
Calculate the minimum fee:
{% tabs %} {% tab title="block producer node" %}
fee=$(cardano-cli transaction calculate-min-fee \
--tx-body-file tx.tmp \
--tx-in-count ${txcnt} \
--tx-out-count 1 \
--mainnet \
--witness-count 3 \
--byron-witness-count 0 \
--protocol-params-file params.json | awk '{ print $1 }')
echo fee: $fee{% endtab %} {% endtabs %}
{% hint style="info" %} Ensure your balance is greater than cost of fee + minPoolCost or this will not work. {% endhint %}
Calculate your change output.
{% tabs %} {% tab title="block producer node" %}
txOut=$((${total_balance}-${stakePoolDeposit}-${fee}))
echo txOut: ${txOut}{% endtab %} {% endtabs %}
Build the transaction.
{% tabs %} {% tab title="block producer node" %}
cardano-cli transaction build-raw \
${tx_in} \
--tx-out $(cat payment.addr)+${txOut} \
--invalid-hereafter $(( ${currentSlot} + 10000)) \
--fee ${fee} \
--certificate-file pool.cert \
--certificate-file deleg.cert \
--out-file tx.raw{% endtab %} {% endtabs %}
Copy tx.raw to your cold environment.
Sign the transaction.
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli transaction sign \
--tx-body-file tx.raw \
--signing-key-file payment.skey \
--signing-key-file $HOME/cold-keys/node.skey \
--signing-key-file stake.skey \
--mainnet \
--out-file tx.signed{% endtab %} {% endtabs %}
Copy tx.signed to your hot environment.
Send the transaction.
{% tabs %} {% tab title="block producer node" %}
cardano-cli transaction submit \
--tx-file tx.signed \
--mainnet{% endtab %} {% endtabs %}
Your stake pool ID can be computed with:
{% tabs %} {% tab title="air-gapped offline machine" %}
cardano-cli stake-pool id --cold-verification-key-file $HOME/cold-keys/node.vkey --output-format hex > stakepoolid.txt
cat stakepoolid.txt{% endtab %} {% endtabs %}
Copy **stakepoolid.txt **to your hot environment.
Now that you have your stake pool ID, verify it's included in the blockchain.
{% tabs %} {% tab title="block producer node" %}
cardano-cli query stake-snapshot --stake-pool-id $(cat stakepoolid.txt) --mainnet {% endtab %} {% endtabs %}
{% hint style="info" %} A non-empty string return means you're registered! 👏 {% endhint %}
With your stake pool ID, now you can find your data on block explorers such as https://pooltool.io/
{% hint style="info" %} Shelley has been launched without peer-to-peer (p2p) node discovery so that means we will need to manually add trusted nodes in order to configure our topology. This is a critical step as skipping this step will result in your minted blocks being orphaned by the rest of the network. {% endhint %}
{% hint style="info" %} Credits to GROWPOOL for this addition and credits to CNTOOLS Guild OPS on creating this process. {% endhint %}
{% hint style="info" %} How Topology API works
- Your relay node pings an API server.
- When the API server is convinced that your relay node is stable and is actually a running Cardano node, based on the ability to report the current block number accurately a number of times over a period of time, then the domain name or IP address of your node is automatically added to a list of other nodes that have been vetted similarly for quality and stability.
- When your relay node is on the list, the relay node can request from the API server a list of other active Cardano nodes with which your node can synchronize in order to participate in the network of nodes as a peer. Also, the domain name or IP address of your relay node is distributed on lists that other active Cardano nodes may request from the same API server. NOTE: Other nodes refreshing their list of peer nodes with a list that may include the domain name or IP address of your relay node is dependent on how often other nodes request an updated list from the API server. Request an updated list of nodes from the API server for your relay regularly so that your list of peers remains accurate.
- In order to stay on the list of active nodes, your relay node must ping the API server once every hour. If your relay node stops pinging the API server, then your relay node is removed from the list of active nodes after three hours.
Credits for the high level explanation: Oliver Sterzik - Change (CHG) Cardano Stake Pool Operator {% endhint %}
Create the topologyUpdater.sh script which publishes your node information to a topology fetch list.
###
### On relaynode1
###
cat > $NODE_HOME/topologyUpdater.sh << EOF
#!/bin/bash
# shellcheck disable=SC2086,SC2034
USERNAME=$(whoami)
CNODE_PORT=6000 # must match your relay node port as set in the startup command
CNODE_HOSTNAME="CHANGE ME" # optional. must resolve to the IP you are requesting from
CNODE_BIN="/usr/local/bin"
CNODE_HOME=$NODE_HOME
CNODE_LOG_DIR="\${CNODE_HOME}/logs"
GENESIS_JSON="\${CNODE_HOME}/${NODE_CONFIG}-shelley-genesis.json"
NETWORKID=\$(jq -r .networkId \$GENESIS_JSON)
CNODE_VALENCY=1 # optional for multi-IP hostnames
NWMAGIC=\$(jq -r .networkMagic < \$GENESIS_JSON)
[[ "\${NETWORKID}" = "Mainnet" ]] && HASH_IDENTIFIER="--mainnet" || HASH_IDENTIFIER="--testnet-magic \${NWMAGIC}"
[[ "\${NWMAGIC}" = "764824073" ]] && NETWORK_IDENTIFIER="--mainnet" || NETWORK_IDENTIFIER="--testnet-magic \${NWMAGIC}"
export PATH="\${CNODE_BIN}:\${PATH}"
export CARDANO_NODE_SOCKET_PATH="\${CNODE_HOME}/db/socket"
blockNo=\$(/usr/local/bin/cardano-cli query tip \${NETWORK_IDENTIFIER} | jq -r .block )
# Note:
# if you run your node in IPv4/IPv6 dual stack network configuration and want announced the
# IPv4 address only please add the -4 parameter to the curl command below (curl -4 -s ...)
if [ "\${CNODE_HOSTNAME}" != "CHANGE ME" ]; then
T_HOSTNAME="&hostname=\${CNODE_HOSTNAME}"
else
T_HOSTNAME=''
fi
if [ ! -d \${CNODE_LOG_DIR} ]; then
mkdir -p \${CNODE_LOG_DIR};
fi
curl -s "https://api.clio.one/htopology/v1/?port=\${CNODE_PORT}&blockNo=\${blockNo}&valency=\${CNODE_VALENCY}&magic=\${NWMAGIC}\${T_HOSTNAME}" | tee -a \$CNODE_LOG_DIR/topologyUpdater_lastresult.json
EOFAdd permissions and run the updater script.
###
### On relaynode1
###
cd $NODE_HOME
chmod +x topologyUpdater.sh
./topologyUpdater.shWhen the topologyUpdater.sh runs successfully, you will see
{ "resultcode": "201", "datetime":"2020-07-28 01:23:45", "clientIp": "1.2.3.4", "iptype": 4, "msg": "nice to meet you" }
{% hint style="info" %}
Every time the script runs and updates your IP, a log is created in $NODE_HOME/logs
{% endhint %}
Add a crontab job to automatically run topologyUpdater.sh every hour on the 33rd minute. You can change the 33 value to your own preference.
###
### On relaynode1
###
cat > $NODE_HOME/crontab-fragment.txt << EOF
33 * * * * ${NODE_HOME}/topologyUpdater.sh
EOF
crontab -l | cat - ${NODE_HOME}/crontab-fragment.txt > ${NODE_HOME}/crontab.txt && crontab ${NODE_HOME}/crontab.txt
rm ${NODE_HOME}/crontab-fragment.txt{% hint style="success" %} After four hours and four updates, your node IP will be registered in the topology fetch list. {% endhint %}
{% hint style="danger" %} Complete this section after four hours when your relay node IP is properly registered. {% endhint %}
Create relay-topology_pull.sh script which fetches your relay node buddies and updates your topology file. Update with your block producer's IP address.
{% tabs %} {% tab title="mainnet" %}
###
### On relaynode1
###
cat > $NODE_HOME/relay-topology_pull.sh << EOF
#!/bin/bash
BLOCKPRODUCING_IP=<BLOCK PRODUCERS IP ADDRESS>
BLOCKPRODUCING_PORT=6000
curl -s -o $NODE_HOME/${NODE_CONFIG}-topology.json "https://api.clio.one/htopology/v1/fetch/?max=20&customPeers=\${BLOCKPRODUCING_IP}:\${BLOCKPRODUCING_PORT}:1|relays-new.cardano-mainnet.iohk.io:3001:2"
EOF{% endtab %}
{% tab title="testnet" %}
###
### On relaynode1
###
cat > $NODE_HOME/relay-topology_pull.sh << EOF
#!/bin/bash
BLOCKPRODUCING_IP=<BLOCK PRODUCERS IP ADDRESS>
BLOCKPRODUCING_PORT=6000
curl -s -o $NODE_HOME/testnet-topology.json "https://api.clio.one/htopology/v1/fetch/?max=20&magic=1097911063&customPeers=${BLOCKPRODUCING_IP}:${BLOCKPRODUCING_PORT}:1|relays-new.cardano-testnet.iohkdev.io:3001:2"
EOF{% endtab %} {% endtabs %}
Add permissions and pull new topology files.
###
### On relaynode1
###
chmod +x relay-topology_pull.sh
./relay-topology_pull.shThe new topology takes after after restarting your stake pool.
###
### On relaynode1
###
sudo systemctl restart cardano-node{% hint style="warning" %} Don't forget to restart your relay nodes after every time you fetch the topology! {% endhint %}
{% hint style="danger" %} ****:octagonal_sign: Critical Key Security Reminder: The only stake pool **keys **and **certs **that are required to run a stake pool are those required by the block producer. Namely, the following three files.
###
### On block producer node
###
KES=${NODE_HOME}/kes.skey
VRF=${NODE_HOME}/vrf.skey
CERT=${NODE_HOME}/node.certAll other keys must remain offline in your air-gapped offline cold environment. {% endhint %}
{% hint style="danger" %}
****:fire: Relay Node Security Reminder: Relay nodes must not contain any operational certifications, vrf, skey or cold keys.
{% endhint %}
{% hint style="success" %} Congratulations! Your stake pool is registered and ready to produce blocks.
Continue to the next section 15 - Checking stake pool rewards. {% endhint %}