Skip to content

Commit 58fbdda

Browse files
committed
1 parent 29bc656 commit 58fbdda

File tree

8 files changed

+7
-534
lines changed

8 files changed

+7
-534
lines changed

README.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ and install bwt using one of the methods below.
6363

6464
### Installation
6565

66-
*New in v0.1.1*: You can now also [install bwt as an Electrum plugin](#electrum-plugin) with an embedded server
67-
(which doesn't require the standalone server installation described below).
66+
💥 Electrum desktop users can also [install bwt as an Electrum plugin](https://github.com/bwt-dev/bwt-electrum-plugin),
67+
which provides a GUI and doesn't require the standalone server installation described below.
6868

6969
#### Signed pre-built binaries
7070

@@ -188,7 +188,7 @@ or downloading the `electrum_only` pre-built binary.
188188
This removes several large dependencies and disables the `track-spends` database index
189189
(which is not needed for the electrum server).
190190

191-
(Also see the [Electrum plugin](#electrum-plugin).)
191+
(Also see the [Electrum plugin](https://github.com/bwt-dev/bwt-electrum-plugin).)
192192

193193
### Pruning
194194

@@ -268,28 +268,12 @@ For example, to broadcast transactions over Tor using the blockstream.info onion
268268

269269
## Electrum plugin
270270

271-
You can setup bwt as an Electrum plugin that embeds the Electrum server into the Electrum wallet.
271+
You can setup bwt as an Electrum plugin, which allows connecting Electrum to a Bitcoin Core full node backend
272+
by running an embedded Electrum server within the Electrum wallet itself.
272273

273-
![Screenshot of bwt integrated into Electrum](doc/electrum-plugin.png)
274-
275-
Download the `electrum_plugin` package from the [releases page](https://github.com/shesek/bwt/releases), verify the signature and unpack into your `electrum/plugins` directory.
276-
After restarting Electrum, you should see bwt in the list of installed plugins under `Tools -> Plugins`.
277-
278-
The plugin supports Electrum v3 and v4. It works with multi-signature wallets. It is available for Linux, Mac, Windows and ARM.
279-
280-
Note that it is not possible to install external plugins with the Electrum AppImage or standalone Windows executable.
281-
You will need to [run from tar.gz](https://github.com/spesmilo/electrum/#running-from-targz) on Linux, use the Windows installer, or [run from source](https://github.com/spesmilo/electrum/#development-version-git-clone).
274+
See https://github.com/bwt-dev/bwt-electrum-plugin for more details and installation instructions.
282275

283-
The plugin automatically configures Electrum with `--oneserver` (to avoid connecting to public servers) and `--skipmerklecheck` (necessary for [pruning](#pruning)).
284-
285-
To avoid connecting to public servers while setting up the plugin, make sure the "auto connect" feature is disabled or run Electrum with `--offline` until everything is ready.
286-
287-
To build the plugin from source, first build the binary as [described here](#from-source), copy it into the `contrib/electrum-plugin` directory, then place that directory under `electrum/plugins`, *but renamed to `bwt`* (Electrum won't recognize it otherwise).
288-
289-
> ⚠️ **NOTE:** The plugin supports watch-only wallets only and **cannot be used with hot wallets**.
290-
> This is done as a security measure, which is expected to eventually be relaxed.
291-
> You can use the plugin with hardware wallets or with an offline Electrum setup.
292-
> For hot wallets, you will need to setup a standalone server instead of using the plugin, ideally away from your keys.
276+
![Screenshot of bwt integrated into Electrum](doc/electrum-plugin.png)
293277

294278
## Manual Electrum setup (without the plugin)
295279

contrib/electrum-plugin/.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

contrib/electrum-plugin/__init__.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

contrib/electrum-plugin/bwt.py

Lines changed: 0 additions & 261 deletions
This file was deleted.

contrib/electrum-plugin/cmdline.py

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)