Welcome to the ElectrumX-Dime Documentation!

ElectrumX-Dime is a fork of spesmilo/electrumx. ElectrumX-Dime allows users to run their own ElectrumX-Dime server. It connects to your full node and indexes the blockchain, allowing efficient querying of history of arbitrary addresses. The server can be exposed publicly, and joined to the public network of servers via peer discovery.

The current version of ElectrumX-Dime is 1.0.

Source Code

The project is hosted on GitHub.

Please submit an issue on the bug tracker if you have found a bug or have a suggestion to improve the server.

Authors and License

Neil Booth wrote the majority of the original code; see Authors for additional credits. Python version >= 3.8 is required.

The code is released under the MIT License.

Documentation

• Features
• Implementation
• ChangeLog
  • Version 1.0.0 (TBD)
• How-To Guide
  • Prerequisites
  • Installation and Setup of ElectrumX-Dime (Not as a Service)
  • Running ElectrumX-Dime (As a Service)
  • Additional Considerations
• Environment Variables
  • Required
  • For the run script
  • Services
  • Miscellaneous
  • Resource Usage Limits
  • Peer Discovery
  • Cache
• Electrum-Dime Protocol
  • Protocol Basics
  • Protocol Methods
  • Protocol Changes
  • Removed Protocol Methods
  • Protocol Ideas
• RPC Interface
  • add_peer
  • daemon_url
  • disconnect
  • getinfo
  • groups
  • log
  • peers
  • query
  • reorg
  • sessions
  • stop
• Architecture
  • Env
  • Controller
  • LocalRPC
  • ElectrumX-Dime
  • Daemon
  • Block Processor
  • Prefetcher
  • Mempool
  • Database
• Authors

Indices and Tables

• Index

• Search Page