Skip to content

Commit

Permalink
Add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasDorier committed Nov 29, 2024
1 parent fb26917 commit b31fa11
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ It works on a pruned node and indexes only what you track.

This explorer is not intended to be exposed to the internet; it should be used as an infrastructure tool for tracking the UTXOs of your own service.

## What about alternatives to NBXplorer?

1. `Electrum wallet` requires an unpruned node with indexing, which is space-intensive and may be difficult to sync.
2. `Electrum wallet` only supports a single cryptocurrency on a single server. If you are an exchange, you would end up running multiple versions of barely maintained Electrum instances.
3. `Personal Electrum Server` supports only a single wallet.
4. `Electrum protocol` is cumbersome for HD wallets.
3. `Bitcoin Core RPC` is inflexible and difficult to use. It also scales poorly when a wallet has too many addresses or UTXOs.
4. `Bitcoin Core RPC` supports multiple wallets but isn't designed to handle thousands of them. Having too many wallets will not scale.
5. While NBXplorer exposes an API, it also allows you to query the data using the most expressive and flexible language designed for this purpose: `SQL`.

## Typical usage

You start by [Creating a wallet (hot wallet)](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/GenerateWallet), or [Tracking a derivation scheme (cold wallet)](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/Track).
Expand Down

0 comments on commit b31fa11

Please sign in to comment.