Skip to content

Commit

Permalink
add: docs for connection to Esplora REST API
Browse files Browse the repository at this point in the history
  • Loading branch information
0xB10C committed Jan 24, 2025
1 parent a8a48f1 commit 53671c4
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,21 @@ rpcwhitelist=forkobserver:getchaintips,getblockheader,getblockhash,getblock

[rpcauth.py]: https://github.com/bitcoin/bitcoin/tree/master/share/rpcauth
[online version]: https://jlopp.github.io/bitcoin-core-rpc-auth-generator/

## Connecting to an Esplora REST API

Block explorers like blockstream.info and mempool.space are based on [esplora].
While they don't offer a `getchaintips`-like API endpoint, it can be useful to
know which blocks these explores consider to be the tip. A esplora backend can,
for example, be configured using the following "node" configuration.

```toml
[[networks.nodes]]
id = 2
name = "mempool.space"
description = "mempool.space REST API"
rpc_host = "https://mempool.space/api"
implementation = "esplora"
```

[esplora]: https://github.com/Blockstream/esplora

0 comments on commit 53671c4

Please sign in to comment.