Skip to content

Update Electrs docs for multi-backend failover support #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adamkrellenstein wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Electrs docs for multi-backend failover support #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions docs/basics/manual-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,27 +161,29 @@ When you create a transaction using the Counterparty API, the server needs to kn

### Default Public APIs

By default, Counterparty connects to public APIs based on your network:
By default, Counterparty connects to public APIs based on your network. On mainnet, multiple backends are configured for automatic failover:

| Network | Default Electrs URL |
|---------|---------------------|
| Mainnet | `https://blockstream.info/api` |
| Network | Default Electrs URLs |
|---------|----------------------|
| Mainnet | `https://blockstream.info/api`, `https://mempool.space/api` |
| Testnet3 | `https://blockstream.info/testnet/api` |
| Testnet4 | `https://mempool.space/testnet4/api` |
| Signet | `https://mempool.space/signet/api` |

These defaults work out of the box with no configuration required.
These defaults work out of the box with no configuration required, but are **not recommended for production**. A warning will be printed on startup if default URLs are in use. For production deployments, run your own Electrs instance (see below).

### Alternative Public APIs
### Custom and Failover APIs

You can use any Electrs-compatible API by setting the `--electrs-url` flag:
You can use any Electrs-compatible API by setting the `--electrs-url` flag. Specify the flag multiple times to configure failover -- if the first backend fails, the next will be tried automatically:

```bash
# Use Mempool.space for mainnet
counterparty-server start --electrs-url=https://mempool.space/api

# Use the Counterparty public Electrs instance
# Use a single custom backend
counterparty-server start --electrs-url=https://api.counterparty.io:3000

# Use multiple backends with failover
counterparty-server start \
--electrs-url=http://localhost:3000 \
--electrs-url=https://mempool.space/api
```

### Running Your Own Electrs Instance
Expand Down