π οΈSpin up a Tezos baking node (DEPRECATED)
This module will guide you through the complete installation and setup of your own Tezos baker on Linux, using Docker images, PPA packages, or by building from source.
PLEASE REFER TO: https://opentezos.com/baking/cli-baker
Prerequisites
Baking blocks on the Tezos blockchain requires:
6,000 tez (can be achieved through delegations)
and a dedicated machine online 24/7 with at least:
8 GB RAM
2 CPU cores
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.ioand follow instructions on: https://docs.docker.com/engine/install/linux-postinstall/
Step 2: Let's config and run!
Run the node in detached mode (-d), as instance on the testnet "jakartanet" network with the history-mode "full" using the following command:
(This command will automatically download the tezos/tezos:latest image)
(--privileged mode is only used to allow a connection with an Hardware secure module, e.g. Ledger)
(--name option to specify the name of the container)
(-v /dev/bus/usb:/dev/bus/usb allows to mount USB volumes to the specified container)
(-v node-data-volume:/var/run/tezos/node mount node-data-volume to the specified container. It is where blockchain data will be stored)
--network=NETWORK selects which network to run. Possible values are: sandbox, mainnet, [testnet] (e.g., jakartanet, kathmandunet. See current testnets here). Default is mainnet.
--history-mode=MODE lets you set the mode for the node's blockchain 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 of 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.
(More information about node configuration here)
After 1-2 minutes, your node identity will be generated and you will be able to check if the node is bootstrapped:
(Use Ctrl+C to stop logs displaying)
Step 3: Import your keys
Option 1: Import keys from a Ledger
Prerequisites: The Ledger Nano should be configured with the Tezos wallet and Tezos baking apps.
Access the "Tezos wallet" app on your ledger and list the connected Ledgers with the following command:
Import a key from the Ledger:
You have to replace<key_alias> by the alias of your choice, and <ledger://path/to/the/secret/key/on/your/device> by the path to your secret key on your ledger (four options are available to generate either tz1, tz2 or tz3 addresses).
(You will need to validate the public key hash displayed on the ledger to validate the key importation).
Option 2: Import a secret key with the tezos-client
β οΈβ οΈβ οΈ This option isn't recommended. Be careful when using your private keys unencrypted β οΈβ οΈβ οΈ
You have to replace<key_alias> by the alias of your choice, and provide the clear private key to the tezos-client, after the keyword "unencrypted:" :
Step 4: Let's register as delegate
If you have a Ledger: Setup the Ledger to bake for your address
Access the "Tezos Baking" app on your ledger and then execute the following command:
(replace <key_alias> by the alias chosen in Step 3)
Validate the request on your ledger.
In both cases: Register your key as a delegate on the network
(Replace <key-alias> by the alias chosen in Step 3)
Step 5: Let's bake!
β Since the Jakarta amendment, the --liquidity-baking-toggle-vote <vote> command line toggle is mandatory. <vote> should be replaced by on, off or pass. Read more about liquidity baking in the technical documentation.
You can launch the baker with:
(In the future, you may change tezos-baker-013-PtJakart by the next protocol binary)
Check baking has started by watching the logs.
π Congratulations on setting up a baker node! π
Some useful commands
To see the manual of commands you can use:
To see the various commands and options of the tezos node, use the following command:
To use the client:
Docker-compose
One way to run those Docker images is with Docker Compose!
Step 1: Let's launch the node and the baker !
The code below launches a full node, a baker and accuser for the Jakarta protocol. You can adapt it to run a baker and accuser for another protocol by replacing the PROTOCOL environment variable, in our case 013-PtJakart, with the desired protocol.
(full mode is recommended to bake. More information here)
Copy-paste the code above into a docker-compose.yml file, and start the node with:
To check if the node is bootstrapped:
Step 2: Import your keys
Option 1: Import keys from a Ledger
Prerequisites: The Ledger Nano should be configured with the Tezos wallet and Tezos baking apps.
Open the "Tezos wallet" app on your ledger and list the connected Ledgers with the following command:
Import a key from the Ledger:
You have to replace<key_alias> by the alias of your choice, and <ledger://path/to/the/secret/key/on/your/device> by the path to your secret key on your ledger (four options are available to generate either tz1, tz2 or tz3 addresses).
Validate the public key hash displayed on the ledger to validate the key import.
Option 2: Import a secret key with the tezos-client
β οΈβ οΈβ οΈ This option isn't recommended. Be careful when using your private keys unencrypted β οΈβ οΈβ οΈ
You have to replace<key_alias> by the alias of your choice, and provide the clear private key to the tezos-client, after the keyword "unencrypted:" :
Step 3: Let's register as delegate
If you have a Ledger: Setup the Ledger to bake for your address
Open the "Tezos Baking" app on your ledger. Then execute the following command:
(Replace <key_alias> by the alias chosen earlier in Step 3)
Validate the request on your ledger.
In both cases: Register your key as a delegate on the network
(Replace <key-alias> by the alias chosen earlier in Step 3)
π Congratulations on setting up your baking node! π
Bonus: Quick synchronization from a snapshot
If you want your node to be bootstrapped quickly, you can synchronize it with the blockchain using a snapshot.
1: Download a .full snapshot from https://snapshots-tezos.giganode.io/ in your current repository by replacing with <snapshot_url> in following command:
2: Launch the node and baker daemons:
3: Stop the node, baker and accuser daemons:
4: Execute these commands to clean up data and avoid duplicates:
(do Ctrl+d to quit su mode)
5: In the .yml file presented in Step 1, replace "/absolute/path/to/your_snapshot.full:/snapshot" by the absolute path to the downloaded snapshot. You can use pwd command to know the absolute path of your current repository. (Read the comment in the .yml file in Step 1)
6: Upload the snapshot into the mainnet-node volume:
You will have to wait ~1-2 hours to import a full snapshot.
7: Start synchro from snapshot:
Set up using PPA with Tezos packages from Serokell
If youβre using Ubuntu, you can install packages with Tezos binaries from a Launchpad PPA.
Step 1: Installation
In order to add the stable release PPA repository to your machine, do:
Then choose the desired protocol for your baker/accuser (you probably want to replace "013-PtJakart" by the latest protocol version):
Then, to install the binaries, run the following commands:
Step 2: 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 .tezos-node).
--network=NETWORK Select which network to run. Possible values are: sandbox, mainnet, [testnet] (e.g., jakartanet, kathmandunet. See current testnets 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.
(More information about node configuration here)
For example, the following command configures the node for the Jakartanet Network and stores data in the specified directory ~/tezos-ithacanet with the full mode.
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 3: Check synchronization β
The Tezos 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) :
(-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 !
Step 4: Import your keys
Option 1: Import keys from a Ledger
Prerequisites: The Ledger Nano should be configured with the Tezos wallet and Tezos baking apps.
Access the "Tezos wallet" app on your ledger and list the connected Ledgers with the following command:
Import a key from a Ledger with the following command:
You have to replace<key_alias> by the alias of your choice, and <ledger://path/to/the/secret/key/on/your/device> by the path to your secret key on your ledger (four options are available to generate either tz1, tz2 or tz3 addresses).
Validate the public key hash displayed on the ledger to validate the key import.
Option 2: Import a secret key with the tezos-client
β οΈβ οΈβ οΈ This option isn't recommended. Be careful when using your private keys unencrypted β οΈβ οΈβ οΈ
You have to replace<key_alias> by the alias of your choice, and provide the clear private key to the tezos-client, after the keyword "unencrypted:" :
Step 5: Let's register as delegate
If you have a Ledger: Setup the Ledger to bake for your address
Access the "Tezos Baking" app on your ledger and then do execute the following command:
(Replace <key_alias> by the alias chosen in step 4)
You will need to validate the request on your ledger.
In both cases: Register your key as a delegate on the network
(Replace <key-alias> by the alias chosen in step 4)
Step 6: Let's bake!
β Since the Jakarta amendment, the --liquidity-baking-toggle-vote <vote> command line toggle is mandatory. <vote> should be replaced by on, off or pass. Read more about liquidity baking in the technical documentation.
You can launch the baker with:
π Congratulations on setting up your baking node! π
Bonus: Quick synchronization from a snapshot
If you want your node to be bootstrapped quickly, you can synchronize it with the blockchain using a snapshot.
1: Download a .full snapshot from https://snapshots-tezos.giganode.io/ in your current repository by replacing with <snapshot_url> in following command:
2: Register the current directory in a variable:
3: Import from the snapshot !
(Replace <name_of_snapshot_file>)
(It is possible to define the directory where the data will be stored with --data-dir <directory>, by default, it is in .tezos-node)
4: You can get some information with the following command:
Set up by building from source
In this part, we will see how to install Tezos from source.
The easiest way to build the binaries from the source code is to use the OPAM source package manager for OCaml.
This method is recommended for advanced users as it requires basic knowledge of the OPAM package manager and the OCaml packages workflow. In particular, upgrading Tezos from release to release might require tinkering with different options of the OPAM package manager to adjust the local environment for the new dependencies.
From scratch 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 :
(If you have trouble with curl, just download the script and run sh 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.
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 installed, you can use rustup 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:
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 :
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:
Step 4 : Install Tezos dependencies
Install the libraries that Tezos is dependent on:β
Get the source code:
Install tezos dependencies :
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 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 .tezos-node).
--network=NETWORK Select which network to run. Possible values are: sandbox, mainnet, [testnet] (e.g., jakartanet, kathmandunet. See current testnets 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.
(More information about node configuration here)
For example, the following command configure the node for the Jakartanet Network and stores data in the specified directory ~/tezos-ithacanet with the full mode.
You can run the node with :
The parameter --rpc-addr url:port activate's 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 Tezos 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) :
(-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 !
Step 9: Import your keys
Option 1: Import keys from a Ledger
Prerequisites: The Ledger Nano should be configured with the Tezos wallet and Tezos baking apps.
Access the "Tezos wallet" app on your ledger and list the connected Ledgers with the following command:
Import a key from a Ledger with the following command:
You have to replace<key_alias> by the alias of your choice, and <ledger://path/to/the/secret/key/on/your/device> by the path to your secret key on your ledger (four options are available to generate either tz1, tz2 or tz3 addresses).
Validate the public key hash displayed on the ledger to validate the key import.
Option 2: Import a secret key with the tezos-client
β οΈβ οΈβ οΈ This option is not recommended. Be careful when using your private keys unencrypted β οΈβ οΈβ οΈ
You have to replace<key_alias> by the alias of your choice, and provide the clear private key to the tezos-client, after the keyword "unencrypted:" :
Step 10: Let's register as delegate
If you have a Ledger: Setup the Ledger to bake for your address
Access the "Tezos Baking" app on your ledger and then do execute the following command:
(Replace <key_alias> by the alias chosen in step 9)
Validate the request on your ledger.
In both cases: Register your key as a delegate on the network
(Replace <key-alias> by the alias chosen earlier in step 9)
Step 11: Let's bake !
β Since the Jakarta amendment, the --liquidity-baking-toggle-vote <vote> command line toggle is mandatory. <vote> should be replaced by on, off or pass. Read more about liquidity baking in the technical documentation.
You can launch the baker with:
π Congratulations on setting up your baking node! π
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 :
(If you have trouble with curl, just download the script and run sh 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.
Step 2: Get an environment
The binaries need a specific version of the OCaml compiler (see the value of variable $ocaml_version in file /tezos/scripts/version.sh).
If you get a "c compiler error", run this to install some necessary tools:
Now follow Steps 6-7-8-9-10-11 of "From scratch method"
π Congratulations on setting up your baking node! π
Bonus: Quick synchronization from a snapshot
If you want your node to be bootstrapped quickly, you can synchronize it with the blockchain using a snapshot.
1: Download a .full snapshot from https://snapshots-tezos.giganode.io/ in your current repository by replacing with <snapshot_url> in following command:
2: Register the current directory in a variable:
3: Import from the snapshot !
(Replace <name_of_snapshot_file>)
(It is possible to define the directory where the data will be stored with --data-dir <directory>, by default it is in .tezos-node)
4: You can get some information with the following command:
β οΈβ οΈβ οΈ Be careful when closing terminal windows because this stops the node. β οΈβ οΈβ οΈ (hint: use screen, or nohup to keep the node running)
Last updated
Was this helpful?