Skip to main content

Node Setup

Prerequisites

Before proceeding please ensure that you are meeting the minimum system & software requirements to operate a node. As long as those requirements are met it should be possible to launch a validator and other types of KIRA nodes in a home environment and use off-the-shelf single-board computers such as a Raspberry PI. There are no slashing penalties for validators going offline or becoming temporarily inaccessible. Nodes that go offline for a prolonged period of time will become inactivate and removed from the consensus automatically by the state machine.

The network is designed to halt in the case where ≥ 1/3 of consensus nodes suddenly become unresponsive, however in the case of individual nodes leaving and entering the consensus randomly there should be no interruption to the network operation. As long as the number of validators does not fall below min_validators as defined in Network Properties, the chain will continue producing new blocks.

Setup

Using KIRA Manager (KM) is the quickest way to run your node, as it is a straightforward bash-shell script that can easily create a new personal network or join an existing one on your behalf. However, it is important to note that KM is only intended for internal testing and should not be used on the mainnet. For operating each aspect of the infrastructure manually on the mainnet, please refer to our public documentation page after you have become comfortable and familiar with the process. At present, KM can only be installed on Ubuntu. If you prefer to use a Mac, you will need to install VMware and virtualize the Ubuntu OS. On Windows, WSL2 is supported.

To join an existing network, you will require knowledge of the specific software version you need to run and the IP address of a trusted node operator within that network. You can find all of this information conveniently located in the "Active Testnets" section below, so there is no need to worry. Let us now examine some simple setup examples.

Interactive KM Setup - Terms & Conditions

caution

Validators do not store the entire block history in order to conserve disk space. This task should only be performed by sentry and archival nodes. If you are syncing your node from an exposed validator instead of a full node, it is important to ensure that you are connecting to a legitimate network and that the party you are connecting to is trustworthy. It is also important to note that during fast sync mode, the blockchain history will not be replayed which might pose additional risks.

Simple Interactive Km Setup From Github Releases

# assume root permissions
sudo -s

# Example installation from github releases, please copy entire code section from below.
# You will be prompted do enter release version. Each testnet has a different KM version.
# Example release version is v0.11.14, see "Active Testnets" for the correct version to use.

cd /tmp && apt-get install -y wget && \
UBUNTU_AGENT="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.85 Safari/537.36" && \
echo -ne "\033[1;32m\nPlease enter version of KM to install: \033[0m" && read V && \
wget --user-agent="$UBUNTU_AGENT" https://github.com/KiraCore/kira/releases/download/${V}/init.sh -O ./i.sh && \
chmod +x -v ./i.sh && ./i.sh --infra-src="$V" --init-mode="interactive" || echo -e "\033[1;31mERROR: KM setup failed, error code '$?'\033[0m"

Simple Interactive Km Setup From Ipfs

# assume root permissions
sudo -s

# Example installation from IPFS CID, please copy entire code section from below.
# You will be prompted do enter CID. Each testnet has a different KM CID.
# Example CID is bafybeiczsnbmbf4pvpbbxk3gnjlieno4vinrku4e5c32q7wqqjbw6t2ctu
# Please see "Active Testnets" for the correct CID to use.

cd /tmp && apt-get install -y wget && \
echo -ne "\033[1;32m\nPlease enter CID of the KM release you want to install: \033[0m" && read CID && \
wget https://ipfs.kira.network/ipfs/$CID/init.sh -O ./i.sh && chmod +x -v ./i.sh && \
./i.sh --infra-src="$CID" --init-mode="interactive" || echo -e "\033[1;31mERROR: KM setup failed, error code '$?'\033[0m"