Advance

Installation & Set up of a node

Welcome to our tutorial on the installation and setup of a node on the Tezos blockchain network. In this tutorial, we will cover the process of setting up a Tezos node, including the necessary software and configuration steps. We will also explore the different types of nodes that can be set up on the Tezos network, such as a full node, a light node, and a baker node.

By the end of this tutorial, you will have the knowledge and hands-on experience needed to set up your own Tezos node and be able to participate in the network by validating transactions, baking blocks, and endorsing. This tutorial is ideal for developers, researchers, and anyone interested in running a node and participating in the Tezos network.

Running an Octez node​

A node is responsible for receiving, validating, and transmitting blocks and operations to nodes it is connected to on the network.

What you need​

• A reliable internet connection

• 8 GB RAM

• 2 CPU cores

• Preferably 256 GB SSD drive

Set up using Docker images​

In this part, we will see how to install Tezos with Docker.

Docker​

Step 1: Installation

If you don’t have Docker on your machine, you can install it with the following command:

sudo apt install docker.io

docker run --name=tezos-public-node-full -v node-data-volume:/var/run/tezos/node tezos/tezos:latest octez-node --network=limanet

docker exec -it tezos-public-node-full octez-client --endpoint http://127.0.0.1:8732 bootstrapped

docker run -it tezos/tezos:latest man

docker run -it tezos/tezos:latest octez-node --help

docker exec -it tezos-public-node-full octez-client --help

version: "3.4"
volumes:
  node_data_full:
    name: mainnet-node
    external: false  
  client_data:
    name: mainnet-client
    external: false
services:
####################################################################################################################################
# You have to uncomment this section if you want to synchronize your node using a snapshot, else you can ignore or delete it.
# Replace /absolute/path/to/your_snapshot.full:/snapshot by the absolute path to the downloaded snapshot.
###################################################################################################################################  
#  import:
#    image: tezos/tezos:latest
#    container_name: tezos-snapshot-import
#    command: tezos-snapshot-import
#    volumes:
#      - node_data_full:/var/run/tezos/node
#      - client_data:/var/run/tezos/client
#      - "/absolute/path/to/your_snapshot.full:/snapshot"
################################################################################################
# If you want to run a node with history-mode=full, keep that "node_full" part, else delete it.
# You can change the version of the image of tezos in : image: tezos/tezos:v15.1
# You can change the --network=NETWORK option.
################################################################################################
  node_full:
    container_name: tezos-public-node-full
    image: tezos/tezos:latest
    command: octez-node --net-addr :9732 --rpc-addr 127.0.0.1:8732 --rpc-addr 0.0.0.0:8732 --allow-all-rpc 0.0.0.0:8732 --history-mode=full
    ports:
    - '9732:9732'
    - '8732:8732'
    expose:
    - "8732"
    - "9732" 
    privileged: true
    volumes:
     - node_data_full:/var/run/tezos/node
     - client_data:/var/run/tezos/client
     - /dev/bus/usb:/dev/bus/usb
    restart: on-failure
    network_mode: "host"

docker-compose -f docker-compose.yml up -d

docker exec -it tezos-public-node-full octez-client --endpoint http://127.0.0.1:8732 bootstrapped

wget <snapshot_url>

docker-compose up -d node_full
sudo docker exec -it tezos-public-node-full sh
sudo rm /var/run/tezos/data/lock
exit

docker-compose stop node_full

sudo su
rm -rf /var/lib/docker/volumes/mainnet-node/_data/data/context
rm -rf /var/lib/docker/volumes/mainnet-node/_data/data/store
rm -rf /var/lib/docker/volumes/mainnet-node/_data/data/lock

docker-compose up import

docker-compose stop import
docker-compose up -d node_full

docker-compose stop node_full

docker run -it -v node_data_full:/var/run/tezos/node tezos/tezos:latest tezos-upgrade-storage

REPO="ppa:serokell/tezos"

sudo add-apt-repository -y $REPO && sudo apt-get update
sudo apt-get install -y tezos-client
sudo apt-get install -y tezos-node

tezos-node config init --data-dir ~/tezos-ghostnet --network=ghostnet --history-mode=full

tezos-node run --rpc-addr 127.0.0.1:8732 --log-output tezos.log --data-dir ~/tezos-ghostnet

tezos-client -E http://127.0.0.1:8732/ bootstrapped

1. Download a .full snapshot from a snapshot provider (XTZ-Shots , Marigold – Tezos Snapshots , https://snapshots-tezos.giganode.io/, Lambs on acid ) in your current repository by replacing with <snapshot_url> in the following command:

   wget <snapshot_url>

   2. Register the current directory in a variable:

path=$(pwd)

tezos-node snapshot import $path/<name_of_snapshot_file>

tezos-node snapshot info $path/<name_of_snapshot_file>

bash -c "sh <(curl -fsSL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)"

For the next command line, answers the prompts with ‘N’ then ‘y’. You may also be prompted for your sudo password. You may encounter a “switch” error, but you can ignore it.

opam init --bare

Step 2: Install Rust

Compiling Tezos requires the Rust compiler, version 1.52.1, and the Cargo package manager for Rust to be installed. If you have [rustup](rustup.rs – The Rust toolchain installer ) installed, you can use [rustup](rustup.rs – The Rust toolchain installer ) to install both. If you do not have `rustup`, please avoid installing it from Snapcraft; you can rather follow the simple installation process shown below:

cd $HOME
wget https://sh.rustup.rs/rustup-init.sh
chmod +x rustup-init.sh
./rustup-init.sh --profile minimal --default-toolchain 1.52.1 -y

Once Rust is installed, note that your PATH environment variable (in .profile) may be updated and you will need to restart your session so that changes can be taken into account. Alternatively, you can do it manually without restarting your session with the following command :

source $HOME/.cargo/env

Step 3: Install Zcash Parameters

Tezos binaries require the Zcash parameter files to run. This is for shielded/confidential transactions with Sapling, that were added in the Edo amendment. If you compile from source and move Tezos to another location (such as /usr/local/bin), the Tezos binaries may prompt you to install the Zcash parameter files. The easiest way is to download and run this script:

wget https://raw.githubusercontent.com/zcash/zcash/master/zcutil/fetch-params.sh
chmod +x fetch-params.sh
./fetch-params.sh

Step 4: Install Tezos dependencies

Install the libraries that Tezos is dependent on:

sudo apt-get install -y rsync git m4 build-essential patch unzip wget pkg-config libgmp-dev libev-dev libhidapi-dev opam jq zlib1g-dev bc autoconf

Get the source code:

git clone https://gitlab.com/tezos/tezos.git
cd tezos
git checkout latest-release

Install tezos dependencies:

make build-deps

You may encounter a “switch” error, but you can ignore it.

You may encounter failures in the processes of the make build-deps command. In that case, just re-type the command opam init --bare to re-initiate.

Step 5: Compile sources

Compile sources:

eval $(opam env)
make

Step 6: Check the installation

To check the installation you can use the following commands:

octez-node --version

Step 7: Let’s config and run!

It is possible to define the directory where the data will be stored with --data-dir (by default, it is in .octez-node).

--network=NETWORK Select which network to run. Possible values are: sandbox, mainnet, [testnet] (e.g., ghostnet, limanet, kathmandunet. Learn more about testnet aliases here). Default is mainnet.

--history-mode= MODE Set the mode for the chain’s data history storage. Possible values are archive , full (default), full:N, rolling, rolling:N.

• Archive mode retains all data since the genesis block.

• Full mode only maintains block headers and operations allowing replaying the chain since the genesis if wanted (full mode is recommended to bake. More information here).

• Rolling mode retains only the most recent data and deletes the rest.

For both Full and Rolling modes, it is possible to adjust the number of cycles to preserve by using the :N annotation. The default number of preserved cycles is 5. The value experimental-rolling is deprecated but is equivalent to rolling which should be used instead.

Read more about node configuration here).

For example, the following command configures the node for the Ghostnet Network and stores data in the specified directory ~/tezos-ghostnet with the full mode.

octez-node config init --data-dir ~/tezos-ghostnet --network=ghostnet --history-mode=full

You can run the node with :

The parameter --rpc-addr url:port activate the RPC interface that will allow communication with the node. By default, it runs on port 8732 so it is not mandatory to specify it. The file tezos.log will be saved in /home/user/.

Step 8: Check synchronization ✅

The Octez client can be used to interact with the node. It can query its status or ask the node to perform some actions. For example, after starting your node, you can check if it has finished synchronizing with the following command (you can use another terminal window if you still watch the log) :

octez-client -E http://127.0.0.1:8732/ bootstrapped

Where:

• -E option is equal to --endpoint option

When you see the message ” Node is Bootstrapped “, your Tezos node is synchronized with the blockchain, and you may now perform operations on it!

Tezos OPAM packages method​

Step 1: Install OPAM

First, you need to install the OPAM package manager, at least version 2.0, that you can get by following the install instructions. The quickest way to get the latest opam up and working is to run this script:

bash -c "sh <(curl -fsSL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)"

For the next command line, answers the prompts with ‘N’ then ‘y’. You may also be prompted for your sudo password. You may encounter a “switch” error, but you can ignore it.

opam init --bare

Step 2: Get an environment

wget -O latest-release:version.sh https://gitlab.com/tezos/tezos/raw/latest-release/scripts/version.sh

The binaries need a specific version of the OCaml compiler (see the value of the variable $ocaml_version in file /tezos/scripts/version.sh).

source latest-release:version.sh
opam switch create for_tezos $ocaml_version
eval $(opam env)

If you get a c compiler error, run this to install some necessary tools:

sudo apt-get install build-essential

Step 3: Get dependencies

In order to get the system dependencies of the binaries, do:

opam depext tezos

Step 4: Install binaries

opam install tezos

Upgrade an Octez node​

As you may know, Tezos is an evolving blockchain. Through its on-chain governance mechanism, Tezos smoothly evolves to become more secure and scalable over time.

The following commands help to upgrade your node to the latest Octez version.

CAUTION

That version 14.0 changes the storage format. A tezos-node upgrade storage is mandatory to update your storage. This upgrade is instantaneous but the data-directory used by your node can no longer be used with version 13.0 once upgraded (if you are using docker, see upgrade instructions in Bonus: Quick synchronization from a snapshot).

Docker and docker-compose

Upgrade the docker image

To upgrade your node to the lastest Octez version, replace your previous image version (probably v13.0) by the lastest: v15.1. Note that if you run the image latest, a restart of your container is sufficient.

To use the v15.1 image, execute the following command:

docker run tezos/tezos:v15.1 ...

Serokell PPA with Tezos packages

Upgrade tezos packages

To fetch the latest node version, run the following command:

sudo apt-get update
sudo apt-get upgrade

From source​

From scratch

Upgrade from scratch

Execute the following commands in your tezos repository:

git fetch
git checkout v15.1
opam switch remove .
rm -rf _opam _build
make build-deps
eval $(opam env)
make

Tezos opam packages

Upgrade using opam

Run the following commands:

opam update
opam depext
opam upgrade

This module is a prerequisite to becoming a baker, and the Deploy Bakers module explains how to become a baker and start earning Tez rewards.

By this, you complete this workshop successfully!!