bdk-floresta

KO | EN

gitlite — search

#javascript #python #php #ruby #c-plus-plus #c-sharp #game #theme #hacktoberfest #ios #statistics #chef

★ 19 Open GitHub ↗

A Floresta-powered chain source crate for BDK (WIP 🏗️)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# bdk-floresta

A Floresta-powered chain-source crate for BDK.

## Synopsis

This crate is a novel chain-source crate implementation meant for wallet applications
built with [`BDK`](https://github.com/bitcoindevkit/bdk_wallet), allowing for zero-trust
and completely local wallet synchronization, by embedding a lightweight full node direcly
inside a wallet application.

By leveraging [`Utreexo`](https://eprint.iacr.org/2019/611) and [`Floresta`](https://github.com/getfloresta/Floresta),
it's possible to implement a lightweight full node with minimal resource requirements,
making it possible for every wallet to have it's own node.

## Developing

This project uses [`just`](https://github.com/casey/just) for command running, and
[`cargo-rbmt`](https://github.com/rust-bitcoin/rust-bitcoin-maintainer-tools/tree/master/cargo-rbmt)
to manage everything related to `cargo`, such as formatting, linting, testing and CI.
It also uses `uv` to run Zizmor, for GitHub Action static analysis.

To install them with `cargo`, run:

```text
~$ cargo install just

~$ cargo install cargo-rbmt
```

Alternatively, use your preferred package manager to install `just` and `uv`.

A `justfile` is provided for convenience. Run `just` to see available commands:

```text
> bdk-floresta
> A Floresta-powered chain-source crate for BDK

Available recipes:
    audit                  # Run `cargo audit` on all lockfiles and prune ignored advisories [alias: a]
    check                  # Check Formatting, Linting and Documentation [alias: c]
    docs                   # Generate Documentation
    docs-open              # Generate and Open Documentation
    example-client-regtest # Run the Regtest Client Example [alias: cr]
    example-client-signet  # Run the Signet Client Cxample [alias: cs]
    fmt                    # Format Code [alias: f]
    lock                   # Regenerate Lockfiles [alias: l]
    pre-push               # Run pre-push checks [alias: p]
    shellcheck             # Run ShellCheck [alias: sc]
    test                   # Run Tests [alias: t]
    toolchains             # Update Stable and Nightly Toolchains
    tools                  # Install cargo-rbmt Tools
    zizmor                 # Run Zizmor [alias: z]
```

## Architecture

This crate is implemented on top of [`libfloresta`](https://github.com/getfloresta/Floresta/tree/master/crates),
a set of libraries for building lightweight Bitcoin nodes, and is composed of two main components: the `Builder` and the `Node`.

Wallet updates can either stem from new blocks that the `Node` validates, which can then be applied to the wallet, or
from a blockchain scan using [Compact Block Filters](https://bips.dev/158).

### libfloresta

The crates below are used to implement the `Node`:

- [`floresta-chain`](https://github.com/getfloresta/Floresta/tree/master/crates/floresta-chain):
  Implements the `Node`'s chain state, and validates blocks and transactions.

- [`floresta-compact-filters`](https://github.com/getfloresta/Floresta/tree/master/crates/floresta-compact-filters):
  Implements a storage mechanism for [Compact Block Filters](https://bips.dev/158), 
  used to figure out which blocks to request from the P2P network to update the wallet.

- [`floresta-mempool`](https://github.com/getfloresta/Floresta/tree/master/crates/floresta-mempool):
  Implements the `Node`'s mempool, used to relay and cache transactions, as well as generating fee estimates.

- [`floresta-wire`](https://github.com/getfloresta/Floresta/tree/master/crates/floresta-wire):
  Implements all of the `Node`'s peer-to-peer logic.

## Security Policy

To report a security issue, please refer to the [security policy](SECURITY.md).

## Minimum Supported Rust Version

This library should compile with any combination of features on Rust 1.85.0.

To build with the MSRV toolchain, copy `Cargo-minimal.lock` to `Cargo.lock`.

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.

bdk-floresta

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README