cryptoadvance.specter


Namecryptoadvance.specter JSON
Version 0.5.3 PyPI version JSON
download
home_pagehttps://github.com/cryptoadvance/specter-desktop
SummaryA GUI for Bitcoin Core optimised to work with airgapped hardware wallets
upload_time2020-07-10 18:26:35
maintainer
docs_urlNone
authorStepan Snigirev, Kim Neunert
requires_python>=3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Specter Desktop](#specter-desktop)
  - [DISCLAIMER](#disclaimer)
  - [Why?](#why)
  - [How to run](#how-to-run)
  - [Detailed instructions](#detailed-instructions)
  - [A few screenshots](#a-few-screenshots)
    - [Adding a new device](#adding-a-new-device)
    - [Creating a new wallet](#creating-a-new-wallet)
    - [Wallet interface](#wallet-interface)
    - [Configuration](#configuration)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Specter Desktop

    "A specter is haunting the modern world, the specter of crypto anarchy."
    The Crypto Anarchist Manifesto - Timothy C. May - Sun, 22 Nov 92 12:11:24 PST

[![Build Status](https://travis-ci.org/cryptoadvance/specter-desktop.svg?branch=master)](https://travis-ci.org/cryptoadvance/specter-desktop)

## DISCLAIMER

This software might be ready to be used but at your own risk. The UI is currently only tested and optimised in Chrome, and looks a bit weird but usable in firefox. So in other browsers, it may even look more weird.

If something doesn't work open an issue here or ask a question in our [Telegram group](https://t.me/spectersupport).

## Why?

Bitcoin Core has a very powerful command line interface and a wonderful daemon. Using PSBT and HWI it can also work with hardware wallets, but at the moment it is too linux-way. The same applies to multisignature setups. 

The goal of this project is to make a convenient and user-friendly GUI around Bitcoin Core with a focus on multisignature setup with airgapped hardware wallets.

At the moment Specter-Desktop is working with all major Hardware-Wallets including [Specter-DIY hardware wallet](https://github.com/cryptoadvance/specter-diy) which uses QR codes as a main communication channel and ColdCard that uses SD cards. Also it already supports "hot" hardware wallets using [HWI tool](https://github.com/bitcoin-core/HWI) and is tested to work with Trezor One. It should also work with Keepkey and Ledger (Firmware >= 1.6.0).

## How to run
* HWI support requires `libusb` 
  * Ubuntu/Debian: `sudo apt install libusb-1.0-0-dev libudev-dev`
  * macOS: `brew install libusb`
  * windows: follow instructions in [`windows.md`](docs/windows.md)
 * Install Specter
```sh
pip3 install cryptoadvance.specter
```
* Run Specter
```sh
python3 -m cryptoadvance.specter server 
# Or as a deamon:
python3 -m cryptoadvance.specter server --daemon
# Stop the daemon again:
python3 -m cryptoadvance.specter server --stop
```
* Upgrade Specter
```sh
pip3 install cryptoadvance.specter --upgrade
```

After that, specter will be available at [http://127.0.0.1:25441/](http://127.0.0.1:25441/).

You can also run it (as a daemon), using tor, provide ssl certificates to run over https. Https is especially important because browsers don't allow the website to access camera without secure connection, and we need camera access to scan QR codes.

An example how to run specter server in the background (`--daemon`) with ssl certificates (`--key`, `--cert`) over tor:

```sh
python3 -m cryptoadvance.specter server --tor=mytorpassword --cert=./cert.pem --key=./key.pem --daemon
```

If your Bitcoin Core is using a default data folder the app should detect it automatically. If not, consider setting `rpcuser` and `rpcpassword` in the `bitcoin.conf` file or set in directly in the specter-app settings.

If you use Specter from a remote machine and want to use it with hardware wallets connected via USB, please read [this guide on setting up HWIBridge](docs/hwibridge.md) to facilitate such connection to hardware wallets. 

Have a look at [DEVELOPMENT.md](DEVELOPMENT.md) for further information about hacking on specter-desktop.

## Detailed instructions

- Beyond local network - how to forward your node through a cheap VPS: [docs/reverse-proxy.md](docs/reverse-proxy.md)
- Setting up Specter over Tor: [docs/tor.md](docs/tor.md)
- Using self-signed certificates in local network or Tor: [docs/self-signed-certificates.md](docs/self-signed-certificates.md)

## A few screenshots

### Adding a new device

![](screenshots/devices.jpg)

![](screenshots/device_keys.jpg)

### Creating a new wallet

![](screenshots/wallets.jpg)

![](screenshots/new_multisig.jpg)

### Wallet interface

![](screenshots/transactions.jpg)

![](screenshots/receive.jpg)

![](screenshots/send.jpg)

### Configuration

![](screenshots/bitcoin-rpc.jpg)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cryptoadvance/specter-desktop",
    "name": "cryptoadvance.specter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Stepan Snigirev, Kim Neunert",
    "author_email": "snigirev.stepan@gmail.com, kim.neunert@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e4/8f/edc49034f770629adffc7708d8204f64fbb40aba60e8b47e35ec66c3296d/cryptoadvance.specter-0.5.3.tar.gz",
    "platform": "",
    "description": "<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Specter Desktop](#specter-desktop)\n  - [DISCLAIMER](#disclaimer)\n  - [Why?](#why)\n  - [How to run](#how-to-run)\n  - [Detailed instructions](#detailed-instructions)\n  - [A few screenshots](#a-few-screenshots)\n    - [Adding a new device](#adding-a-new-device)\n    - [Creating a new wallet](#creating-a-new-wallet)\n    - [Wallet interface](#wallet-interface)\n    - [Configuration](#configuration)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n# Specter Desktop\n\n    \"A specter is haunting the modern world, the specter of crypto anarchy.\"\n    The Crypto Anarchist Manifesto - Timothy C. May - Sun, 22 Nov 92 12:11:24 PST\n\n[![Build Status](https://travis-ci.org/cryptoadvance/specter-desktop.svg?branch=master)](https://travis-ci.org/cryptoadvance/specter-desktop)\n\n## DISCLAIMER\n\nThis software might be ready to be used but at your own risk. The UI is currently only tested and optimised in Chrome, and looks a bit weird but usable in firefox. So in other browsers, it may even look more weird.\n\nIf something doesn't work open an issue here or ask a question in our [Telegram group](https://t.me/spectersupport).\n\n## Why?\n\nBitcoin Core has a very powerful command line interface and a wonderful daemon. Using PSBT and HWI it can also work with hardware wallets, but at the moment it is too linux-way. The same applies to multisignature setups. \n\nThe goal of this project is to make a convenient and user-friendly GUI around Bitcoin Core with a focus on multisignature setup with airgapped hardware wallets.\n\nAt the moment Specter-Desktop is working with all major Hardware-Wallets including [Specter-DIY hardware wallet](https://github.com/cryptoadvance/specter-diy) which uses QR codes as a main communication channel and ColdCard that uses SD cards. Also it already supports \"hot\" hardware wallets using [HWI tool](https://github.com/bitcoin-core/HWI) and is tested to work with Trezor One. It should also work with Keepkey and Ledger (Firmware >= 1.6.0).\n\n## How to run\n* HWI support requires `libusb` \n  * Ubuntu/Debian: `sudo apt install libusb-1.0-0-dev libudev-dev`\n  * macOS: `brew install libusb`\n  * windows: follow instructions in [`windows.md`](docs/windows.md)\n * Install Specter\n```sh\npip3 install cryptoadvance.specter\n```\n* Run Specter\n```sh\npython3 -m cryptoadvance.specter server \n# Or as a deamon:\npython3 -m cryptoadvance.specter server --daemon\n# Stop the daemon again:\npython3 -m cryptoadvance.specter server --stop\n```\n* Upgrade Specter\n```sh\npip3 install cryptoadvance.specter --upgrade\n```\n\nAfter that, specter will be available at [http://127.0.0.1:25441/](http://127.0.0.1:25441/).\n\nYou can also run it (as a daemon), using tor, provide ssl certificates to run over https. Https is especially important because browsers don't allow the website to access camera without secure connection, and we need camera access to scan QR codes.\n\nAn example how to run specter server in the background (`--daemon`) with ssl certificates (`--key`, `--cert`) over tor:\n\n```sh\npython3 -m cryptoadvance.specter server --tor=mytorpassword --cert=./cert.pem --key=./key.pem --daemon\n```\n\nIf your Bitcoin Core is using a default data folder the app should detect it automatically. If not, consider setting `rpcuser` and `rpcpassword` in the `bitcoin.conf` file or set in directly in the specter-app settings.\n\nIf you use Specter from a remote machine and want to use it with hardware wallets connected via USB, please read [this guide on setting up HWIBridge](docs/hwibridge.md) to facilitate such connection to hardware wallets. \n\nHave a look at [DEVELOPMENT.md](DEVELOPMENT.md) for further information about hacking on specter-desktop.\n\n## Detailed instructions\n\n- Beyond local network - how to forward your node through a cheap VPS: [docs/reverse-proxy.md](docs/reverse-proxy.md)\n- Setting up Specter over Tor: [docs/tor.md](docs/tor.md)\n- Using self-signed certificates in local network or Tor: [docs/self-signed-certificates.md](docs/self-signed-certificates.md)\n\n## A few screenshots\n\n### Adding a new device\n\n![](screenshots/devices.jpg)\n\n![](screenshots/device_keys.jpg)\n\n### Creating a new wallet\n\n![](screenshots/wallets.jpg)\n\n![](screenshots/new_multisig.jpg)\n\n### Wallet interface\n\n![](screenshots/transactions.jpg)\n\n![](screenshots/receive.jpg)\n\n![](screenshots/send.jpg)\n\n### Configuration\n\n![](screenshots/bitcoin-rpc.jpg)\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A GUI for Bitcoin Core optimised to work with airgapped hardware wallets",
    "version": "0.5.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8c546f2de09db32b5d90e5da384bd4b7",
                "sha256": "36d6ef744abb3ecd5bfd75cf247368b764a40bf0d9f09b57d09c4b3bd76c4e76"
            },
            "downloads": -1,
            "filename": "cryptoadvance.specter-0.5.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8c546f2de09db32b5d90e5da384bd4b7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 972307,
            "upload_time": "2020-07-10T18:26:30",
            "upload_time_iso_8601": "2020-07-10T18:26:30.907806Z",
            "url": "https://files.pythonhosted.org/packages/51/58/af6e13f122db5b7da0967b52686d87b9a2aaf6cb72bba4bb4cc2f7f65565/cryptoadvance.specter-0.5.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "3ebe066cc8ae190f02f0b8987f8c9554",
                "sha256": "fd6ab9094a39cf3a34a66e3ccc6e3f3bf0e153938ad8feef79c75b3ca564eb7a"
            },
            "downloads": -1,
            "filename": "cryptoadvance.specter-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "3ebe066cc8ae190f02f0b8987f8c9554",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 927968,
            "upload_time": "2020-07-10T18:26:35",
            "upload_time_iso_8601": "2020-07-10T18:26:35.960927Z",
            "url": "https://files.pythonhosted.org/packages/e4/8f/edc49034f770629adffc7708d8204f64fbb40aba60e8b47e35ec66c3296d/cryptoadvance.specter-0.5.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-10 18:26:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "cryptoadvance",
    "error": "Could not fetch GitHub repository",
    "lcname": "cryptoadvance.specter"
}
        
Elapsed time: 0.12717s