Website | Download | Setup | Miner | ElectronCash | UnconfirmedChains
Bitcoin Unlimited includes support for electrum server (from version 1.6, Linux x64 only).
The server is maintained as a separate piece of software, but is integrated with the node software. Its process has the same lifetime as the bitcoind process, uses the same log files and adds functionality to the same RPC interface. Detailed documentation exists here.
Running a private electrum server gives you an extended API interface, for example allowing you to lookup transaction history and balances of any address on the blockchain. Having a private electrum server also allows you to use wallet software such as Electron Cash, without compromising your privacy.
By enabling SSL support and making the server public, you're able to support the network light client infrastructure, which is run on volunteer basis (you may want to add it to the server list in that case). You can make your server public without enabling SSL support, but some light wallet insist on a SSL connection.
Add electrum=1 to your bitcoin.conf file, or pass -electrum=1 argument to bitcoind when from command line. You may want to also add debug=electrum to enable useful logging.
To allow incoming connections from any wallet, use electrum.host=0.0.0.0. electrum.port=1234 will change the listening port. The default port is 50001. Don't forget to configure your firewall to pass this port though (similar to what you did for bitcoin port 8333), if you have a firewall/NAT.
The RPC call getelectruminfo gives you runtime details, such as indexing status of the server. More detailed metrics are available via Prometheus, see monitoring section of the usage document.
First install dependencies (rust version has to be 1.34+):
sudo apt install python3-git cargo clangThe latest stable release used by the node software can be compiled from the Bitcoin Unlimited source tree by running
make electrscashFor more recent development versions, see the usage document.
If you use RPC username/password rather than the default "RPC cookie", the credentials will be logged to debug.log by the electrs server.
Any public service can suffer from DOS attacks if "the public" chooses to make many or difficult requests into the service. Ultimately the only "solution" is mitigation since the purpose of this service is to offload CPU and storage tasks from light clients. Although we are working on better efficiency and DOS mitigation, this software should be run separately from other mission-critical software.