https://github.com/bp-wg/bp-node
Daemons and tools for Bitcoin transaction index
https://github.com/bp-wg/bp-node
bitcoin lightning-network lnp-bp rust
Last synced: about 1 year ago
JSON representation
Daemons and tools for Bitcoin transaction index
- Host: GitHub
- URL: https://github.com/bp-wg/bp-node
- Owner: BP-WG
- License: apache-2.0
- Created: 2020-03-23T09:27:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-25T10:53:32.000Z (about 1 year ago)
- Last Synced: 2025-04-25T11:39:40.901Z (about 1 year ago)
- Topics: bitcoin, lightning-network, lnp-bp, rust
- Language: Rust
- Homepage:
- Size: 1.33 MB
- Stars: 27
- Watchers: 4
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# BP Node
[](./LICENSE)
Bitcoin blockchain indexing and wallet notification node.
It may be considered Electrum server or Esplora replacement,
being faster,
providing modern binary API,
supporting wallet descriptors,
LN-specific queries,
client-side-validation tech like RGB,
modern publication-subscribe interfaces,
Noise encryption in network connectivity,
asymmetric cryptographic client authentication
and many more.
The node designed and implemented by
[Dr Maxim Orlovsky](https://github.com/dr-orlovsky) from [Pandora Prime] and
[@will-bitlightlabs](https://github.com/will-bitlightlabs) from [Bitlight Labs]
as a part of [LNP/BP Labs](https://github.com/LNP-BP) effort
on building the foundation for LNP/BP layer 2 and 3 bitcoin application ecosystem.
It is based on other LNP/BP projects such as [BP Core Lib], [BP Standard Lib], [BP Wallet Lib]
and can be easily integrated with the rest of LNP/BP nodes like [LNP Node].
In the future it is planned to upgrade the node into a fully-validating bitcoin node by using
[`bitcoinkernel`] library for validating blocks.
## Components
This repository contains the following crates:
- `bp-node`: main indexing daemon, which can be used as an embedded multi-thread service,
or compiled into a standalone binary (`bpd`);
- `bp-client`: client to work with the daemon and a command-line utility `bp-cli`;
- `bp-rpc`: a shared crate between `bp-node` and `bp-client`.
## Node Architecture
The node operates as a set of threads, communicating through Crossbeam channels.
It leverages [`microservices.rs`] and [`netservices.rs`] crates,
which serves as the node non-blocking reactor-based (see [`io-reactor`]) microservice frameworks.
The node daemon has the following components:
- **Broker**, integrating all services and managing their communications;
- **RPC**: reactor-based thread managing incoming client connections,
notifying them about changes to the subscribed information;
- **Persistence**, an embedded ReDB database;
- **Block importer**: a client connecting an integration service (see below)
to bitcoin blockchain provider (Bitcoin Core, other Bitcoin nodes or indexers)
receiving downloaded and new blocks and adding them into the database;
- **Query workers**, thread pool running queries for the client subscriptions in the database.
To operate, one also needs
to provide the node with an interface to bitcoin blocks integrating it with either Bitcoin Core,
or any other node or indexer.
By default, the node exposes a binary RPC API over TCP, which can be exposed as more high-level APIs
(HTTP REST, Websocket-based or JSON-RPC) using special adaptor services.
## OS Support
The project currently supports Linux, macOS and UNIX.
Windows support is a work-in-progress, requiring downstream [`io-reactor`] framework changes.
[`bitcoinkernel`]: https://github.com/bitcoin/bitcoin/issues/27587
[BP Core Lib]: https://github.com/BP-WG/bp-core
[BP Standard Lib]: https://github.com/BP-WG/bp-std
[BP Wallet Lib]: https://github.com/BP-WG/bp-wallet
[LNP Node]: https://github.com/LNP-WG/lnp-node
[`io-reactor`]: https://github.com/rust-amplify/io-reactor
[`microservices.rs`]: https://github.com/cyphernet-labs/microservices.rs
[`netservices.rs`]: https://github.com/cyphernet-labs/netservices.rs
[Pandora Prime]: https://pandoraprime.ch
[Bitlight Labs]: https://bitlightlabs.com