Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/firoorg/firo

The privacy-focused cryptocurrency
https://github.com/firoorg/firo

asic-resistant blockchain cryptocurrency cryptography lelantus merkle-tree merkle-tree-proof-of-work p2p privacy sigma zcoin zero-knowledge zero-knowledge-proofs zerocoin zkp

Last synced: 3 months ago
JSON representation

The privacy-focused cryptocurrency

Awesome Lists containing this project

README 

        
# Firo



[![Financial Contributors on Open Collective](https://opencollective.com/firo/all/badge.svg?label=financial+contributors)](https://opencollective.com/firo) [![latest-release](https://img.shields.io/github/release/firoorg/firo)](https://github.com/firoorg/firo/releases)

[![GitHub last-release](https://img.shields.io/github/release-date/firoorg/firo)](https://github.com/firoorg/firo/releases)

[![GitHub downloads](https://img.shields.io/github/downloads/firoorg/firo/total)](https://github.com/firoorg/firo/releases)

[![GitHub commits-since-last-version](https://img.shields.io/github/commits-since/firoorg/firo/latest/master)](https://github.com/firoorg/firo/graphs/commit-activity)

[![GitHub commits-per-month](https://img.shields.io/github/commit-activity/m/firoorg/firo)](https://github.com/firoorg/firo/graphs/code-frequency)

[![GitHub last-commit](https://img.shields.io/github/last-commit/firoorg/firo)](https://github.com/firoorg/firo/commits/master)



[Firo](https://firo.org) formerly known as Zcoin, is a privacy focused cryptocurrency that utilizes the [Lelantus Spark protocol](https://eprint.iacr.org/2021/1173) which supports high anonymity sets without requiring trusted setup and relying on standard cryptographic assumptions.



The Lelantus Spark cryptographic library and implementation was audited by [HashCloak](https://firo.org/about/research/papers/lelantus_spark_code_audit_report.pdf). The Lelantus Spark cryptography paper has undergone two separate audits by [HashCloak](https://firo.org/about/research/papers/Lelantus_Spark_Audit_Report.pdf) and [Daniel (Linfeng) Zhao](https://firo.org/about/research/papers/LinfengSparkAudit.pdf).



Firo also utilises [Dandelion++](https://arxiv.org/abs/1805.11060) 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 the easier method for you. To run Firo using this method, first install [Docker](https://store.docker.com/search?type=edition&offering=community). 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](https://github.com/firoorg/firo/issues/1241) is resolved):



```sh

mkdir -p ${HOME}/.firo

```



Pull our [latest official Docker image](https://hub.docker.com/r/firoorg/firod):



```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](depends/README.md)



Alternatively, you can build dependencies manually. See the full [unix build instructions](doc/build-unix.md).



Bootstrappable builds can [be achieved with Guix.](contrib/guix/README.md)



## Development Dependencies (compiler and build tools)



- Debian/Ubuntu/Mint (minimum Ubuntu 18.04):



```sh

sudo apt-get update

sudo apt-get install git curl python build-essential libtool automake pkg-config cmake

# Also needed for GUI wallet only:

sudo apt-get install qttools5-dev qttools5-dev-tools libxcb-xkb-dev bison

```



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++ libtool make autoconf automake cmake patch which

# Also needed for GUI wallet only:

sudo dnf install qt5-qttools-devel qt5-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



1.  Download the source:



```sh

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

cd firo

```



2.  Build dependencies and firo:



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



```sh

cd depends

NO_QT=true make -j`nproc`

cd ..

./autogen.sh

./configure --prefix=`pwd`/depends/`depends/config.guess` --without-gui

make -j`nproc`

```



Or with GUI wallet as well:



```sh

cd depends

make -j`nproc`

cd ..

./autogen.sh

./configure --prefix=`pwd`/depends/`depends/config.guess`

make -j`nproc`

```



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



```sh

./configure --prefix=`pwd`/depends/`depends/config.guess` --enable-tests

make check

```



If the build succeeded, two binaries will be generated in `/src`: `firod` and `firo-cli`. If you chose to build the GUI, `firo-qt` will be also generated in the `qt` folder.



## macOS Build Instructions and Notes



See [doc/build-macos.md](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](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](https://firo.org/community/social/).



# Contributors



## Code Contributors



This project exists thanks to all the people who contribute. Would you like to help Firo and contribute? See the [[CONTRIBUTING](CONTRIBUTING.md)] file.




## Financial Contributors



Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/firo/contribute)]



You can also donate to the [MAGIC Firo Fund](https://magicgrants.org/funds/firo/) which allows some US entities to claim a charitable deduction.



## Individuals






## Organizations



Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/firo/contribute)]