Leading Bitcoin Wallet

Plugin Guidelines

Electrum’s plugin system lets developers add new features without changing the main code. Here are the key rules for plugins:

  1. Use Python only. If your feature needs non-Python libraries or talks to servers other than Electrum servers, make it a plugin.
  2. Avoid adding new dependencies to the main code. If your feature does this, it should be a plugin.
  3. Developers must maintain their plugins. Remember, we’ll need to update plugins when Electrum’s code changes. Keep your plugin easy to maintain, or we might not accept it.
  4. Follow Electrum’s design patterns. Your plugin should fit with how Electrum works. Don’t copy existing Electrum code in your plugin.
  5. Make sure your plugin can be removed safely. Users funds must not be at risk if we need to remove a plugin later.
  6. We may reject or remove plugins that are hard to maintain or don’t fit well with Electrum.

Table of Contents