Firo

CodeRabbit Pull Request Reviews

Firo formerly known as Zcoin, is a privacy-focused cryptocurrency that utilizes the Spark protocol which supports high anonymity sets without requiring trusted setup and relying on standard cryptographic assumptions.

Firo also utilises Dandelion++ to obscure the originating IP of transactions without relying on any external services such as Tor/i2P.

Firo uses a hybrid PoW and LLMQ Chainlocks system combining fair distribution of supply with protection against 51% attacks and quick finality of blocks and transactions. FiroPOW (a ProgPOW variant) is used as its Proof-of-Work algorithm which targets GPUs and is FPGA/ASIC resistant.

Running with Docker

If you are already familiar with Docker, then running Firo with Docker might be the easier method for you. To run Firo using this method, first install Docker. After this you may
continue with the following instructions.

Please note that we currently don't support the GUI when running with Docker. Therefore, you can only use RPC (via HTTP or the firo-cli utility) to interact with Firo via this method.

Local Dockerfile

This repository contains a Dockerfile that you can build and run locally.

To build it, run from the root of this repository:

sh
docker build . -t firo-local

After the process is completed, run a container based on the firo-local image you built:

sh
docker run -d --name firod -v "${HOME}/.firo:/home/firod/.firo" firo-local

This will start a detached docker container, which you can interact with using docker exec. See the section "Interact with the container" for a list of useful commands you can use to manage your node. Make sure to change firod with firo-local, if you have built the local Docker image.

Docker image on DockerHub

If it doesn't already exist, create a .firo folder in your home (this is a workaround until #1241 is resolved):

sh
mkdir -p ${HOME}/.firo

Pull our latest official Docker image:

sh
docker pull firoorg/firod

Start Firo daemon:

sh
docker run -d --name firod -v "${HOME}/.firo:/home/firod/.firo" firoorg/firod

Interact with the container

View current block count (this might take a while since the daemon needs to find other nodes and download blocks first):

sh
docker exec firod firo-cli getblockcount

View connected nodes:

sh
docker exec firod firo-cli getpeerinfo

Stop daemon:

sh
docker stop firod

Backup wallet:

sh
docker cp firod:/home/firod/.firo/wallet.dat .

Start daemon again:

sh
docker start firod

Linux Build Instructions and Notes

Firo contains build scripts for its dependencies to ensure all component versions are compatible. For additional options
such as cross compilation, read the depends instructions

Alternatively, you can build dependencies manually. See the full unix build instructions.

Bootstrappable builds can be achieved with Guix.

Development Dependencies (compiler and build tools)

Debian/Ubuntu/Mint (minimum Ubuntu 18.04):

sh
sudo apt-get update
sudo apt-get install python git curl build-essential cmake pkg-config ccache
# Also needed for GUI wallet only:
sudo apt-get install qttools5-dev qttools5-dev-tools libxcb-xkb-dev bison ninja-build meson libx11-dev

If you use a later version of Ubuntu, you may need to replace python with python3.

Redhat/Fedora:

sh
sudo dnf update
sudo dnf install bzip2 perl-lib perl-FindBin gcc-c++ make cmake patch which
# Also needed for GUI wallet only:
sudo dnf install qt6-qttools-devel qt6-qtbase-devel xz bison
sudo ln /usr/bin/bison /usr/bin/yacc

Arch:

sh
sudo pacman -Sy
sudo pacman -S git base-devel python cmake

Build Firo

Prerequisites (macOS Specific)

Ensure Homebrew is installed as per the macOS build guide.

Download the source:

sh
git clone https://github.com/firoorg/firo
cd firo

Build dependencies:

sh
cd depends
make -j$(nproc)
cd ..

Configure and build Firo:

Headless (command-line only for servers etc.):

sh
cd depends
NO_QT=true make -j`nproc`
cd ..
cmake -B build -DCMAKE_TOOLCHAIN_FILE=$(pwd)/depends/$(depends/config.guess)/toolchain.cmake \
-DBUILD_GUI=OFF -DBUILD_CLI=ON
cd build && make -j$(nproc)

Or with GUI wallet as well:

sh
cmake -B build -DCMAKE_TOOLCHAIN_FILE=$(pwd)/depends/$(depends/config.guess)/toolchain.cmake \
-DBUILD_GUI=ON -DBUILD_CLI=ON
cd build && make -j$(nproc)

(optional) It is recommended to build and run the unit tests:

sh
cmake -B build -DCMAKE_TOOLCHAIN_FILE=$(pwd)/depends/$(depends/config.guess)/toolchain.cmake \
-DBUILD_TESTS=ON -DBUILD_GUI=OFF -DBUILD_CLI=ON
cd build && make -j$(nproc)
make test

If the build succeeded, binaries will be generated in build/bin/: firod, firo-cli, and if GUI is enabled, firo-qt.

3. Run GUI Client

./bin/firo-qt

CMake Options Reference

Flag	Description	Default
`BUILD_DAEMON`	Build `firod` executable	`ON`
`BUILD_GUI`	Build `firo-qt` GUI client	`ON`
`BUILD_CLI`	Build `firo-tx` and other command-line tools	`ON`
`ENABLE_WALLET`	Enable wallet functionality	`ON`
`BUILD_TESTS`	Build test suite	`OFF`
`BUILD_TX`	Build `firo-tx` transaction tool	Subset of `BUILD_CLI`
`ENABLE_CRASH_HOOKS`	Enable crash reporting/stack traces	`OFF`
`WITH_ZMQ`	Enable ZeroMQ notifications	`ON`

Supported Cross-Compilation Targets

To build for other platforms, specify the HOST variable when building dependencies:

Host Target	Platform
`x86_64-pc-linux-gnu`	Linux 64-bit (default)
`x86_64-w64-mingw32`	Windows 64-bit
`aarch64-apple-darwin`	macOS
`arm-linux-gnueabihf`	Linux ARM 32-bit
`aarch64-linux-gnu`	Linux ARM 64-bit

Usage Example:

Build dependencies:

bash
# Build dependencies for Windows 64-bit
cd depends
make HOST=x86_64-w64-mingw32 -j$(nproc)
cd ..

Configure and build Firo:

bash
cmake -B build -DCMAKE_TOOLCHAIN_FILE=$(pwd)/depends/x86_64-w64-mingw32/toolchain.cmake \
  -DBUILD_TESTS=ON -DBUILD_CLI=ON -DBUILD_GUI=ON \
cd build && make -j$(nproc)

Notes

The toolchain path in CMAKE_TOOLCHAIN_FILEmust match your target architecture.
BUILD_TX is automatically enabled if BUILD_CLI=ON is enabled.

macOS Build Instructions and Notes

See doc/build-macos.md for instructions on building on macOS.

Note: these instructions are inherited from Bitcoin and might not work as expected

Windows (64/32 bit) Build Instructions and Notes

See doc/build-windows.md for instructions on building on Windows 64/32 bit.

Note: these instructions are inherited from Bitcoin and might not work as expected

Run Firo

Now that you have your self-built or precompiled binaries, it's time to run Firo! Depending by your skill level and/or setup, you might want to use the command line tool or the graphic user interface. If you have problems or need support, contact the community.

Install Firo

After building with CMake, generate .sh file with make package. Once you run make package you should have ./FiroCore-VERSION_MAJOR.VERSION_MINOR.VERSION_REVISION-Linux.sh in your build directory.

For example, you can install Firo on your /usr/bin with:

./FiroCore-0.14.14-Linux.sh --prefix=/usr/bin --exclude-subdir

Contributors

Code Contributors

This project exists thanks to all the people who contribute. Would you like to help Firo and contribute? See the [CONTRIBUTING] file.
<a href="https://github.com/firoorg/firo/graphs/contributors"><img src="https://opencollective.com/firo/contributors.svg?width=890&button=false" /></a>