How to set up NBXplorer with Docker for production?

Use the official Docker image and compose it with Bitcoin Core, as shown in the docker-compose.regtest.yml sample. Configure via environment variables for chains, network, and PostgreSQL connection string to ensure persistence.

NBXplorer vs Electrum server for wallet tracking?

NBXplorer is lighter, supports pruned nodes and multiple coins, while Electrum requires unpruned nodes and is single-coin. NBXplorer is better for self-hosted services, but Electrum might suit users needing a battle-tested, community-driven wallet server.

Can NBXplorer handle high volumes of wallets and transactions?

Yes, it's designed for scalability with features like transaction pruning and PostgreSQL querying. However, performance depends on your node and database setup; test with the provided suite to gauge limits.

How to add support for a new altcoin in NBXplorer?

First, add the coin to NBitcoin.Altcoins, then update NBXplorer's network provider similar to Litecoin. You must run tests to verify compatibility, as outlined in the 'How to add support to my altcoin' section.

What are security best practices for the NBXplorer API?

Use cookie authentication or --noauth only for testing, and do not expose NBXplorer to the internet—it's intended as an internal tool. Secure PostgreSQL and message broker connections to prevent data leaks.

Does NBXplorer support smart contracts or only UTXOs?

It only supports UTXO-based cryptocurrencies like Bitcoin and listed altcoins; it cannot track account-based chains like Ethereum, limiting its use for DeFi or smart contract projects.

How to monitor NBXplorer logs and performance?

Leverage .NET logging frameworks and PostgreSQL monitoring tools, as NBXplorer doesn't include built-in dashboards. Check the API endpoints for health status and use message brokers for event-driven alerts.

Open-Awesome

NBXplorer

MITC#

A minimalist .NET-based UTXO tracker for HD wallets, designed to work with pruned Bitcoin nodes and multiple altcoins.

Visit Website GitHub

367 stars216 forks0 contributors

What is NBXplorer?

NBXplorer is a .NET-based UTXO tracker designed for Bitcoin and altcoin HD wallets. It solves the problem of efficiently tracking wallet balances and transactions without requiring a fully indexed blockchain, enabling services to operate with pruned nodes and maintain privacy.

Target Audience

Developers building cryptocurrency services like exchanges, payment processors, or wallet backends that need scalable, self-hosted UTXO tracking.

Value Proposition

It offers a lightweight, flexible alternative to heavy solutions like Electrum or Bitcoin Core RPC, with multi-coin support, a clean REST API, and the ability to work on pruned nodes.

Overview

NBitcoin Explorer

Use Cases

Best For

Building self-hosted cryptocurrency exchange backends
Tracking HD wallet balances for payment processing services
Developing multi-coin wallet applications
Creating Bitcoin-based microservices with a REST API
Integrating UTXO tracking into .NET blockchain projects
Running wallet infrastructure on pruned nodes to save disk space

Not Ideal For

Projects needing public-facing blockchain explorers for end-users
Teams working with non-UTXO cryptocurrencies like Ethereum or Solana
Startups seeking managed, serverless wallet APIs without self-hosting overhead
Environments where .NET or PostgreSQL dependencies are prohibitive

Pros & Cons

Pros

Efficient UTXO Indexing

Indexes only tracked wallets, minimizing storage and sync time compared to full-node solutions like Electrum, as highlighted in the README's focus on pruned node compatibility.

Pruned Node Support

Operates without a fully indexed blockchain, saving disk space, which is emphasized as a key feature for lightweight infrastructure.

Multi-Coin Flexibility

Supports Bitcoin and over 20 altcoins such as Litecoin and Dash, enabling services to track multiple UTXO-based cryptocurrencies from a single instance.

SQL Query Capability

Uses PostgreSQL for persistence, allowing developers to run complex queries on wallet data beyond the REST API, as documented in the schema docs.

Real-Time Event Streaming

Integrates with Azure Service Bus and RabbitMQ for message brokering, providing scalable event listening for transactions and blocks.

Cons

Complex Initial Setup

Requires a synced Bitcoin Core node, PostgreSQL v13+, and .NET SDK, making deployment time-consuming compared to plug-and-play SaaS alternatives.

.NET Ecosystem Dependency

Primarily targets .NET with limited client libraries outside C# and NodeJS, which can hinder integration in non-.NET stacks.

Manual Rescan Required

Does not automatically index historical transactions; users must manually configure start height and rescan parameters to see old payments, as noted in the 'Important Note' section.

Incomplete Documentation

The README admits that better documentation is pending, and some features like message broker integration lack detailed guides, relying on unit tests for examples.

Open Source Alternative To

NBXplorer is an open-source alternative to the following products:

Bitcoin Core RPC

Electrum

Electrum is a lightweight Bitcoin wallet that focuses on speed and simplicity, with support for hardware wallets and advanced features like multi-signature.

Frequently Asked Questions

Related Projects

BTCPayServer

Accept Bitcoin payments. Free, open-source & self-hosted, Bitcoin payment processor.

NEO Smart Economy

Last commit6 days ago

WalletWasabi

Open-source, non-custodial, privacy preserving Bitcoin wallet for Windows, Linux, and Mac.

Stars2,572

Forks561

Last commit2 days ago

NBitcoin

Comprehensive Bitcoin library for the .NET framework.

Stars1,941

Forks869

Last commit15 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub