Saturday, November 2, 2024

bitcoin core – Configure esplora to level to the bitcoind servers ip handle

esplora is simply the online ui frontend, you additionally have to setup the (forked) electrs backend for indexing and for offering the HTTP API that esplora queries.

electrs can index the bitcoin block chain utilizing two strategies: by studying the blk recordsdata immediately out of disk, or by querying for blocks utilizing the bitcoind rpc. The primary methodology is considerably sooner, however requires electrs to have filesystem entry to the bitcoin datadir, which might sometimes imply working them on the identical server (you can technically do that remotely however you may lose many of the efficiency achieve, so not a lot level in doing that). The second methodology can work when you’ve got two separate servers, however I would not advocate it (can be painfully gradual).

To setup electrs, set up Rust and:

$ sudo apt set up clang cmake # required for constructing rust-rocksdb
$ git clone https://github.com/blockstream/electrs && cd electrs
$ git checkout new-index
$ cargo run --release --bin electrs -- -vvv --daemon-dir ~/.bitcoin

If the bitcoin datadir is just not at ~/.bitcoin, change --daemon-dir to level to it. It ought to robotically choose up the rpc credentials from the cookie file. If you wish to index from a distant bitcoind node, set --jsonrpc-import --daemon-rpc-addr <addr:port> --cookie <person:move>.

By default, electrs will bind its HTTP API server on 127.0.0.1:3000. To allow distant entry, it’s endorsed to setup a reverse proxy with tls (like nginx) in entrance of electrs. You could possibly additionally set --http-addr <host:ip> to have electrs settle for distant connections immediately, however you most likely should not.

The preliminary indexing course of will take fairly a while and disk house (as much as 1TB on the peak in the course of the indexing, which then shrinks right down to about 450GB after compaction). To check it labored, you’ll be able to attempt issuing requests to the electrs HTTP API:

$ curl http://localhost:3000/blocks/tip/peak
$ curl http://localhost:3000/handle/1EMBaSSyxMQPV2fmUsdB7mMfMoocgfiMNw

Then, to start out esplora and level it to your electrs server, set up nodejs and:

$ git clone https://github.com/Blockstream/esplora && cd esplora
$ npm set up

# must be set to the URL the place the electrs HTTP API is offered for
# requests coming from the person's browser. if you happen to're shopping from the identical
# machine working electrs, this could work:
$ export API_URL=http://localhost:3000/

# begin a dev server on port 5000 (on-the-fly babel/browserify transpilation, gradual, cpu hog)
$ npm run dev-server

# or pre-build the online ui as a static listing with:
$ npm run dist

You’ll then have the esplora net ui obtainable at http://localhost:5000/. As with electrs, it’s advocate to setup a tls-enabled frontend http server for distant entry, both reverse proxying the dev server, or (extra ideally) immediately serving the pre-built static recordsdata.

The very last thing that you’re going to have to do is configure electrs to simply accept cross-origin requests from the esplora net ui. Do to this, add --cors <origin> to the top of the cargo run command. In case you’re accessing esplora domestically, --cors http://localhost:5000 ought to work. In any other case, set it to the origin that the esplora net ui is served from. Or simply use --cors '*' if you happen to’re okay permitting cors requests from all origins.

Alternatively, you can additionally use the esplora docker picture that makes organising every thing (bitcoind+electrs+esplora) a lot simpler, however that does not play properly with an current bitcoind node.

Related Articles

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Latest Articles