michaelhly / docker-electrum-daemon

Electrum client running as a daemon in docker container

docker-electrum-daemon

Electrum client running as a daemon in docker container with JSON-RPC enabled.

Electrum client is light bitcoin wallet software operates through supernodes (Electrum server instances actually).

Don't confuse with Electrum server that use bitcoind and full blockchain data.

Star this project on Docker Hub 🌟 https://hub.docker.com/r/osminogin/electrum-daemon/

Ports

• 7000 - JSON-RPC port.

Volumes

• /data - user data folder (on host it usually has a path /home/user/.electrum).

Getting started

docker

Running with Docker:

docker run --rm --name electrum \
    --env TESTNET=false \
    --publish 127.0.0.1:7000:7000 \
    --volume /srv/electrum:/data \
    osminogin/electrum-daemon

docker exec -it electrum-daemon electrum create
docker exec -it electrum-daemon electrum daemon load_wallet
docker exec -it electrum-daemon electrum daemon status
{
    "auto_connect": true,
    "blockchain_height": 505136,
    "connected": true,
    "fee_per_kb": 427171,
    "path": "/home/electrum/.electrum",
    "server": "us01.hamster.science",
    "server_height": 505136,
    "spv_nodes": 10,
    "version": "3.0.6",
    "wallets": {
        "/home/electrum/.electrum/wallets/default_wallet": true
    }
}

docker-compose

docker-compose.yml to see minimal working setup. When running in production, you can use this as a guide.

docker-compose up
docker-compose exec electrum electrum daemon status
docker-compose exec electrum electrum create
docker-compose exec electrum electrum daemon load_wallet
curl --data-binary '{"id":"1","method":"listaddresses"}' http://electrum:electrumz@localhost:7000

❗Warning❗

Always link electrum daemon to containers or bind to localhost directly and not expose 7000 port for security reasons.

API

• Electrum protocol specs
• API related sources

License

See LICENSE