Welcome to Floresta: a lightweight Bitcoin full node implementation written in Rust and powered by Utreexo, a novel dynamic accumulator designed for the Bitcoin UTXO set.
This project is composed of two parts, libfloresta and florestad. libfloresta is a set of reusable components that can be used to build Bitcoin applications. florestad is built on top of libfloresta to provide a full node implementation, including a watch-only wallet and an Electrum server. If you just want to run a full node, you can use florestad directly, either by building it from source using the given instructions on the doc folder or by downloading a pre-built binary from the releases.
Detailed documentation for libfloresta is available here. Additionally, the floresta-docs mdBook provides an in-depth look at the libraries' architecture and internals.
Further information can be found in the doc folder.
If you want to discuss this project, you can join our Discord server here. If you want to disclose a security vulnerability, please email Davidson Souza at me AT dlsouza DOT lol, using the PGP key 2C8E0F 836FD7D BBBB9E 9B2EF899 64EC3AB 22B2E3.
Contributions are welcome, feel free to open an issue or a pull request. Check out our CONTRIBUTING.md for more information on best practices and guidelines.
If you want to contribute but don't know where to start, take a look at the issues, there's a few of them marked as good first issue.
This project is licensed under the MIT License - see the LICENSE file for details
One of the most challenging parts of working with Bitcoin is keeping up with the consensus rules. Given its nature as a consensus protocol, it's very important to make sure that the implementation is correct. Instead of reimplementing a Script interpreter, we use rust-bitcoinconsensus to verify transactions. This is a bind around a shared library that is part of Bitcoin Core. This way, we can be sure that the consensus rules are the same as Bitcoin Core, at least for scripts.
Although tx validation is arguably the hardest part in this process. This integration can be further improved by using libbitcoinkernel, that will increase the scope of libbitcoinconsensus to outside scripts, but this is still a work in progress.
