Skip to main content

A Wallet implementation for Flux

Project description

fluxwallet

Python wallet library and CLI for the Flux blockchain with SSP 2-of-2 multisig co-signing support.

Features

  • HD wallets — BIP32/BIP44 key derivation with BIP39 mnemonic support
  • Multisig — 2-of-2 (SSP) and m-of-n P2SH multisig wallets
  • SSP integration — pair with SSP Key mobile app for 2FA transaction co-signing via relay
  • CLI — full wallet management via fluxwallet command (typer + rich)
  • MCP server — expose wallet operations to Claude Code and other MCP clients
  • Encrypted storage — AES-256-GCM with Argon2id key derivation, OS keychain integration
  • Fully async — async/await throughout, SQLAlchemy 2.0 with aiosqlite

Installation

pip install fluxwallet

Or with uv:

uv add fluxwallet

Requires Python 3.13+.

Quick Start

CLI

# Generate a mnemonic
fluxwallet mnemonic

# Create a new wallet
fluxwallet wallet create my_wallet

# Restore a wallet from mnemonic (prompted)
fluxwallet wallet restore my_wallet

# Check balance
fluxwallet wallet balance my_wallet

# Get receive address
fluxwallet key address my_wallet

# Send a transaction
fluxwallet tx send my_wallet t1abc... 1.5

# List all wallets
fluxwallet wallet list

Library

import asyncio
from fluxwallet.db import Db
from fluxwallet.wallet import Wallet

async def main():
    await Db.start()
    w = await Wallet.create("my_wallet", network="flux")
    key = await w.new_key()
    print(key.address)

asyncio.run(main())

SSP Multisig

Create a 2-of-2 multisig wallet paired with the SSP Key mobile app:

# Create and pair a new SSP wallet
fluxwallet ssp pair --new my_ssp

# Send (auto-detects SSP, waits for phone approval)
fluxwallet tx send my_ssp t1abc... 0.5

# Re-pair an existing wallet
fluxwallet ssp pair my_ssp

Database Encryption

Private keys are encrypted at rest with AES-256-GCM. The encryption key is derived from your password via Argon2id and stored in your OS keychain.

# Encrypt the database (first time)
fluxwallet db setup

# Check encryption status
fluxwallet db info

# Change password
fluxwallet db change-password

# Export key for headless servers
fluxwallet db setup --export-key /path/to/keyfile

# Unlock on a headless server
fluxwallet --key-file /path/to/keyfile wallet list

# Or pipe the key via stdin
cat /path/to/keyfile | fluxwallet wallet list

Auto-unlock priority: stdin > key file > OS keychain.

Platform support

Platform Keychain backend Notes
macOS Keychain Access Works out of the box
Windows Credential Locker Works out of the box
Linux (GNOME) GNOME Keyring Requires desktop session
Linux (KDE) KWallet Requires desktop session
Headless Key file or stdin --key-file or pipe

CLI Reference

fluxwallet
  wallet list|create|restore|info|rename|delete|balance|scan
  key    import|address|list|new
  tx     list|utxos|update|send|sweep
  ssp    pair|info
  db     info|setup|unlock|change-password
  mnemonic

Global options:

  • --key-file PATH — path to encryption key file

Examples

uv run python examples/wallet_demo.py       # Wallet creation and key generation
uv run python examples/mnemonic_demo.py      # BIP39 mnemonic generation
uv run python examples/keys_demo.py          # HD key derivation and multisig addresses
uv run python examples/multisig_demo.py      # 2-of-2 and 2-of-3 multisig wallets
uv run python examples/transaction_demo.py   # Transaction creation and signing
uv run python examples/encryption_demo.py    # Database encryption round-trip
uv run python examples/ssp_pair.py           # SSP Key pairing
uv run python examples/ssp_send.py           # SSP co-signed transaction
uv run python examples/wallet_balance.py     # Check balance and UTXOs

Development

git clone https://github.com/MorningLightMountain713/fluxwallet.git
cd fluxwallet
uv sync
uv run pytest tests/

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fluxwallet-2.2.0.tar.gz (279.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fluxwallet-2.2.0-py3-none-any.whl (308.4 kB view details)

Uploaded Python 3

File details

Details for the file fluxwallet-2.2.0.tar.gz.

File metadata

  • Download URL: fluxwallet-2.2.0.tar.gz
  • Upload date:
  • Size: 279.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for fluxwallet-2.2.0.tar.gz
Algorithm Hash digest
SHA256 c141653f070d372b772d61a728061b67bd9811e48181b6c58bdcc734846e4d57
MD5 e94c8abdcbe4c07c49b7c56b80935183
BLAKE2b-256 476f68b424093065436227fe2a4baffd748028913dbeb51cf82f708841deca80

See more details on using hashes here.

File details

Details for the file fluxwallet-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: fluxwallet-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 308.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for fluxwallet-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 545088ed557890c6e421e0d8d070354766cf3d4e0de983bd9d5b0790ef00cf36
MD5 9821bbbdc0aa11e1bd836627f09ddb15
BLAKE2b-256 8bfe9faf1992fb8ede4acf14d14b24806ee1b4a0c20fa6a2fb540b9c9adc994d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page