docs: update README to identify Electrum Purple as unofficial BitcoinPurple fork by Davide Grilli
This commit is contained in:
@@ -1,16 +1,46 @@
|
||||
# Electrum - Lightweight Bitcoin client
|
||||
# Electrum Purple - Lightweight BitcoinPurple Wallet
|
||||
|
||||
> **Unofficial fork** of [Electrum](https://github.com/spesmilo/electrum) with support for the [BitcoinPurple](https://bitcoinpurple.org) network.
|
||||
|
||||
```
|
||||
Licence: MIT Licence
|
||||
Author: Thomas Voegtlin
|
||||
Language: Python (>= 3.10)
|
||||
Homepage: https://electrum.org/
|
||||
Licence: MIT Licence
|
||||
Fork author: Davide Grilli <davide.grilli@outlook.com>
|
||||
Original author: Thomas Voegtlin
|
||||
Language: Python (>= 3.10)
|
||||
Upstream: https://github.com/spesmilo/electrum
|
||||
```
|
||||
|
||||
[](https://cirrus-ci.com/github/spesmilo/electrum)
|
||||
[](https://coveralls.io/github/spesmilo/electrum?branch=master)
|
||||
[](https://crowdin.com/project/electrum)
|
||||
---
|
||||
|
||||
## About this fork
|
||||
|
||||
This project is an **unofficial, independent fork** of Electrum, maintained by **Davide Grilli**.
|
||||
It adds first-class support for the **BitcoinPurple (BTCP)** network — a Bitcoin fork with
|
||||
1-minute blocks and a 120-block difficulty retarget window — while keeping full compatibility
|
||||
with the original Electrum codebase and all upstream bug fixes.
|
||||
|
||||
This fork is **not affiliated with, endorsed by, or supported by** the original Electrum project
|
||||
or its developers. For the official Bitcoin wallet, use [electrum.org](https://electrum.org/).
|
||||
|
||||
### What is different from upstream Electrum
|
||||
|
||||
- `--bitcoinpurple` and `--bitcoinpurple_testnet` launch flags
|
||||
- BitcoinPurple chain parameters (1-min blocks, 120-block retarget, adjusted PoW limits)
|
||||
- Lightning Network timeouts scaled for 1-minute block times
|
||||
- Branding and packaging renamed to `electrum-purple` / `Electrum Purple`
|
||||
|
||||
Everything else — wallet format, Lightning support, hardware wallets, plugins — is identical
|
||||
to upstream Electrum.
|
||||
|
||||
### Licence and credits
|
||||
|
||||
This software is released under the **MIT Licence**, the same licence as the original Electrum.
|
||||
All original copyright notices are preserved as required by the licence.
|
||||
|
||||
Original copyright: © 2011-2024 Thomas Voegtlin and The Electrum developers.
|
||||
Fork additions: © 2024-2026 Davide Grilli.
|
||||
|
||||
---
|
||||
|
||||
## Getting started
|
||||
|
||||
@@ -142,15 +172,13 @@ $ pytest tests/test_bitcoin.py -v
|
||||
|
||||
## Contributing
|
||||
|
||||
Any help testing the software, reporting or fixing bugs, reviewing pull requests
|
||||
and recent changes, writing tests, or helping with outstanding issues is very welcome.
|
||||
Implementing new features, or improving/refactoring the codebase, is of course
|
||||
also welcome, but to avoid wasted effort, especially for larger changes,
|
||||
we encourage discussing these on the issue tracker or IRC first.
|
||||
Bug reports, testing, and pull requests for BitcoinPurple-specific features are welcome.
|
||||
|
||||
Besides [GitHub](https://github.com/spesmilo/electrum),
|
||||
most communication about Electrum development happens on IRC, in the
|
||||
`#electrum` channel on Libera Chat. The easiest way to participate on IRC is
|
||||
with the web client, [web.libera.chat](https://web.libera.chat/#electrum).
|
||||
For issues unrelated to BitcoinPurple support (core wallet, Lightning, hardware wallets),
|
||||
please check the [upstream Electrum project](https://github.com/spesmilo/electrum) first —
|
||||
fixes merged upstream can be rebased into this fork.
|
||||
|
||||
Please improve translations on [Crowdin](https://crowdin.com/project/electrum).
|
||||
---
|
||||
|
||||
*Electrum Purple is an independent fork and is not affiliated with the Electrum project.*
|
||||
*Original Electrum translations are maintained on [Crowdin](https://crowdin.com/project/electrum).*
|
||||
|
||||
Reference in New Issue
Block a user