Skip to content

getfloresta/Floresta

Repository files navigation

Warning

We are currently migrating from the old Utreexo P2P protocol to the new version described in BIP-0183. Since there are no bridge nodes running the new protocol on mainnet yet, Floresta can currently sync only on signet. Mainnet support will return once the new protocol design and its implementation in both Floresta and utreexod are complete.

Floresta

A lightweight and embeddable Bitcoin client, built for sovereignty!

MIT Licensed Latest release Functional Tests API Docs Rustc Version 1.81.0+ Docker pulls Docker Build Status Chat on Discord

Floresta is a lightweight and embeddable Bitcoin client designed for users and applications that want strong validation guarantees without the operational overhead of traditional full nodes.

It can be run as a standalone fully validating node or embedded as a library, allowing developers to reuse the same client components across different applications and deployments.

Name

Floresta is the Portuguese word for forest. It is a reference to the Utreexo accumulator, which is a forest of Merkle trees. It's pronounced /floˈɾɛstɐ/.

Architecture

Floresta is written in Rust and implements modern Bitcoin validation techniques such as Utreexo, PoW Fraud Proofs, and pruning, to significantly reduce resource requirements while preserving trust and security.

Floresta is composed of two main components: libfloresta and florestad.

libfloresta is a collection of reusable components that can be integrated into Bitcoin applications. florestad builds on top of libfloresta to provide a full node daemon, including a watch-only wallet and an Electrum server.

If you only want to run a node, you can use florestad by building it from source, following the instructions for Unix or MacOS.

Consensus Implementation

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 and on par with Bitcoin Core. Instead of reimplementing a Bitcoin Script interpreter, we use rust-bitcoinkernel, which is a wrapper around libbitcoinkernel, a C++ library that exposes Bitcoin Core's validation engine. It allows validating blocks, transaction outputs and reading block data with the same API as Bitcoin Core.

Developing

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 documentation folder.

Contributions are welcome. Feel free to open an issue or a pull request. Check out our Contribution Guidelines for more information on best practices.

If you want to contribute but don't know where to start, take a look at the Good First Issues.

Community

If you want to discuss this project, you can join the Discord Server. To report security vulnerabilities, please see the Security Policy.

License

This project is licensed under the MIT License.

Acknowledgments

About

A lightweight and embeddable Bitcoin client, built for sovereignty.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors 41