lucidwallet


Namelucidwallet JSON
Version 0.2.21 PyPI version JSON
download
home_page
SummaryA Graphical interface for FluxWallet
upload_time2023-08-22 18:29:27
maintainer
docs_urlNone
authorDavid White
requires_python>=3.10,<4.0
licensebsd 3-clause
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Lucidwallet

## A Frontend for Fluxwallet

![wallet landing](https://github.com/MorningLightMountain713/lucidwallet/blob/main/static/images/wallet_landing.png?raw=true)

## Features

* Full graphical wallet in your terminal
* Browser support coming soon
* Can work over ssh with full copy paste (even headless)
* Flux native wallet (other chains coming soon)
* Optionally encrypt keys
* Send / receive transactions
* Sign messages (login to home.runonflux.io)
* Create wallet / import from mnemonic
* Uses Websocket to subscribe for latest blocks etc

## Quickstart (Python 3.10+)

Install:

```bash
pip install lucidwallet
```

Once installed run from a terminal:

Run:

```bash
lucidwallet
```

`OR` if you're having trouble with your Python path:

```bash
python3 -m lucidwallet
```

`OR`  if you want a portable, albiet slower way to run:

```bash
docker run --name lucidwallet -it megachips/lucidwallet:latest
```

Then on subsequent runs:

```bash
docker start lucidwallet -ia
```

## Installation

Requires Python 3.10 or greater. If you don't have Python 3.10 - use the docker image

### macOS

Prerequisites:

`gmp`

```bash
brew install gmp
```

Install:

```bash
python3 -m pip install lucidwallet
```

A note on macOS terminal, it is recommended that you use `ITerm2`, native terminal works, however you need to modify some settings. See [here](https://github.com/Textualize/textual/blob/main/questions/why-looks-bad-on-macos.question.md) if you plan on using `Terminal.app`

### Ubuntu 22.04 (comes standard with Python 3.10)

Prerequisites:

`libgmp-dev`

```bash
sudo apt-get update && apt-get install python3-pip libgmp3-dev
```

Install:

```bash
python3 -m pip install lucidwallet
```

Source your profile to pick up new bin folder (or restart terminal)

```bash
source ~/.profile
```

### Windows

Tested on a Windows Server 2022 VM.

Prerequisites:

A decent terminal. Powershell 7 works, but it's not pretty.

[tabby.sh](https://tabby.sh/) has been tested and works well.

Once Python is installed, install with pip. Make sure your paths are up to date.

```bash
python3 -m pip install lucidwallet
```

Note, there is no `fastecdsa` natively on Windows. So some cryptographic functions are slower. You can install the `fastecdsa-any` package however you will need a working gmp and C++ build tools for Python installed.

OR - Just use docker.

### Docker

Usage notes:

The perfered method to run in docker is to NOT use mounts and reuse the same container.

Performance takes a bit of a hit on docker (especially on macOS) You can try virtiofs for faster mounts. (If you are bind mounting a database) See [here](https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/)

However, docker lucidwallet is the easiest to install.

Preferred method:

```bash
docker run --name lucidwallet -it megachips/lucidwallet:latest
```

Then on subsequent runs:

```bash
docker start lucidwallet -ia
```

If you want to use a local db dir, mount it like this:

```bash
docker run -v $(pwd)/database/:/database --rm -it megachips/lucidwallet:latest
```

This will create a `database` folder in your current directory, and the container will store database files there.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "lucidwallet",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "David White",
    "author_email": "dr.white.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/70/2d/d47bea22b20dff7ab3a2e3d4a905a5a613cb9219b00316a01a556dc0db36/lucidwallet-0.2.21.tar.gz",
    "platform": null,
    "description": "# Lucidwallet\n\n## A Frontend for Fluxwallet\n\n![wallet landing](https://github.com/MorningLightMountain713/lucidwallet/blob/main/static/images/wallet_landing.png?raw=true)\n\n## Features\n\n* Full graphical wallet in your terminal\n* Browser support coming soon\n* Can work over ssh with full copy paste (even headless)\n* Flux native wallet (other chains coming soon)\n* Optionally encrypt keys\n* Send / receive transactions\n* Sign messages (login to home.runonflux.io)\n* Create wallet / import from mnemonic\n* Uses Websocket to subscribe for latest blocks etc\n\n## Quickstart (Python 3.10+)\n\nInstall:\n\n```bash\npip install lucidwallet\n```\n\nOnce installed run from a terminal:\n\nRun:\n\n```bash\nlucidwallet\n```\n\n`OR` if you're having trouble with your Python path:\n\n```bash\npython3 -m lucidwallet\n```\n\n`OR`  if you want a portable, albiet slower way to run:\n\n```bash\ndocker run --name lucidwallet -it megachips/lucidwallet:latest\n```\n\nThen on subsequent runs:\n\n```bash\ndocker start lucidwallet -ia\n```\n\n## Installation\n\nRequires Python 3.10 or greater. If you don't have Python 3.10 - use the docker image\n\n### macOS\n\nPrerequisites:\n\n`gmp`\n\n```bash\nbrew install gmp\n```\n\nInstall:\n\n```bash\npython3 -m pip install lucidwallet\n```\n\nA note on macOS terminal, it is recommended that you use `ITerm2`, native terminal works, however you need to modify some settings. See [here](https://github.com/Textualize/textual/blob/main/questions/why-looks-bad-on-macos.question.md) if you plan on using `Terminal.app`\n\n### Ubuntu 22.04 (comes standard with Python 3.10)\n\nPrerequisites:\n\n`libgmp-dev`\n\n```bash\nsudo apt-get update && apt-get install python3-pip libgmp3-dev\n```\n\nInstall:\n\n```bash\npython3 -m pip install lucidwallet\n```\n\nSource your profile to pick up new bin folder (or restart terminal)\n\n```bash\nsource ~/.profile\n```\n\n### Windows\n\nTested on a Windows Server 2022 VM.\n\nPrerequisites:\n\nA decent terminal. Powershell 7 works, but it's not pretty.\n\n[tabby.sh](https://tabby.sh/) has been tested and works well.\n\nOnce Python is installed, install with pip. Make sure your paths are up to date.\n\n```bash\npython3 -m pip install lucidwallet\n```\n\nNote, there is no `fastecdsa` natively on Windows. So some cryptographic functions are slower. You can install the `fastecdsa-any` package however you will need a working gmp and C++ build tools for Python installed.\n\nOR - Just use docker.\n\n### Docker\n\nUsage notes:\n\nThe perfered method to run in docker is to NOT use mounts and reuse the same container.\n\nPerformance takes a bit of a hit on docker (especially on macOS) You can try virtiofs for faster mounts. (If you are bind mounting a database) See [here](https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/)\n\nHowever, docker lucidwallet is the easiest to install.\n\nPreferred method:\n\n```bash\ndocker run --name lucidwallet -it megachips/lucidwallet:latest\n```\n\nThen on subsequent runs:\n\n```bash\ndocker start lucidwallet -ia\n```\n\nIf you want to use a local db dir, mount it like this:\n\n```bash\ndocker run -v $(pwd)/database/:/database --rm -it megachips/lucidwallet:latest\n```\n\nThis will create a `database` folder in your current directory, and the container will store database files there.\n",
    "bugtrack_url": null,
    "license": "bsd 3-clause",
    "summary": "A Graphical interface for FluxWallet",
    "version": "0.2.21",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "76d6ea96879a15fde32c6d3df593fb3f76cf32dd8eb251b3c5cb835eefb53db7",
                "md5": "a90e090429d2232cdd0ce0f19db237ed",
                "sha256": "ce2a5b6f2cc87f83187e3fa79c9a0a5c595b9fcc1034de0fbc0b3662ea34d1aa"
            },
            "downloads": -1,
            "filename": "lucidwallet-0.2.21-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a90e090429d2232cdd0ce0f19db237ed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 1230160,
            "upload_time": "2023-08-22T18:29:20",
            "upload_time_iso_8601": "2023-08-22T18:29:20.091792Z",
            "url": "https://files.pythonhosted.org/packages/76/d6/ea96879a15fde32c6d3df593fb3f76cf32dd8eb251b3c5cb835eefb53db7/lucidwallet-0.2.21-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "702dd47bea22b20dff7ab3a2e3d4a905a5a613cb9219b00316a01a556dc0db36",
                "md5": "aa9814c6da587ae4a51acb81357682d1",
                "sha256": "051fce06fa9b6084706aa4b6c6fc157aa75aec987de3bc7bee98ac1af8ef00b3"
            },
            "downloads": -1,
            "filename": "lucidwallet-0.2.21.tar.gz",
            "has_sig": false,
            "md5_digest": "aa9814c6da587ae4a51acb81357682d1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 1214341,
            "upload_time": "2023-08-22T18:29:27",
            "upload_time_iso_8601": "2023-08-22T18:29:27.271132Z",
            "url": "https://files.pythonhosted.org/packages/70/2d/d47bea22b20dff7ab3a2e3d4a905a5a613cb9219b00316a01a556dc0db36/lucidwallet-0.2.21.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-22 18:29:27",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "lucidwallet"
}
        
Elapsed time: 0.10775s