Long-term Bitcoin savings made Easy
Project description
Bitcoin Safe
Long-term Bitcoin savings made Easy
BETA Version -- Use with Caution
Features
- Easy Multisig-Wallet Setup
- Step-by-Step instructions for a secure MultiSig setup with PDF backup sheets
- Test transactions ensure that all hardware signers are ready
- Full support for Coldcard, Coldcard Q, Bitbox02, Blockstream Jade, and Specter DIY, supporting QR, USB, SD-card
- Secure: Hardware signers only
- All wallets require hardware signers/wallets for safe seed storage
- Powered by BDK
- Multi-Language:
- 🇺🇸 English, 🇨🇳 Chinese - 简体中文, 🇪🇸 Spanish - español de España, 🇯🇵 Japanese - 日本語, 🇷🇺 Russian - русский, 🇵🇹 Portuguese - português europeu, 🇮🇳 Hindi - हिन्दी, Arabic - العربية, 🇮🇹 Italian - italiano, 🇫🇷 French - Français, 🇩🇪 German - Deutsch, (more upon request)
- Simpler address labels by using categories (e.g. "KYC", "Non-KYC", "Work", "Friends", ...)
- Automatic coin selection within categories
- Transaction flow diagrams, visualizing inputs and outputs, click on inputs and output to trace the money flow
- Sending for non-technical users
- 1-click fee selection via mempool-blocks
- Automatic merging of utxos when fees are low
- SyncTalk:
- Encrypted cloud backup (via nostr) of labels
- Label synchronization between different computers
- Wallet chat and PSBTs sharing between different computers
- Fast:
- Electrum server syncing
- planned upgrade to Compact Block Filters for the Bitcoin Safe 2.0 release
Preview
Setup a multisig wallet
Transaction exploring via the money flow diagram
Sending
PSBT sharing with trusted devices
Label Synchronization with trusted devices
Easy search across wallets
Full Features List
-
Import and Export Capabilities
- CSV export for all lists
- CSV import for batch transactions
- Label import and export using BIP329
- Label import from Electrum wallet
- Export of the money flow diagram to svg
- Drag and drop for Transactions, PSBTs, and CSV files
-
Wallet Features
- Simplified address labeling using categories like KYC, Non-KYC, Work, Friends
- Cancel unconfirmed transactions (via Replace-by-Fee)
- Bump fee on transactions (via Replace-by-Fee)
- Encrypted wallet storage
- Backup PDF with Descriptor (Text and QR code)
-
Hardware Signer Connectivity
- MicroSD (files)
- USB
- QR codes (enhanced QR code detection for Laptop cameras)
- Animated QR codes including BBQr and legacy formats
-
Search and Filtering Options
- Fast filtering across txids, utxos, labels, dates, amounts, categories
- Search across all open wallets, txids, utxos, labels, dates, amounts, categories
-
Languages
- 🇺🇸 English, 🇨🇳 Chinese - 简体中文, 🇪🇸 Spanish - español de España, 🇯🇵 Japanese - 日本語, 🇷🇺 Russian - русский, 🇵🇹 Portuguese - português europeu, 🇮🇳 Hindi - हिन्दी, Arabic - العربية, 🇮🇹 Italian - italiano, 🇫🇷 French - Français, 🇩🇪 German - Deutsch, (more upon request)
-
Transaction / PSBT Creation
- 1-click fee selection and mempool block preview
- Automatic merging of utxos when fees are low
- Highlighting of own addresses
-
Security and Reliability
- No seed generation or storage on mainnet
- Seed storage requires a separate hardware signer
- Update notifications and signature verification
- Powered by Bitcoin Development Kit (BDK)
-
Ease of Use for Multisig Wallets
- Simplified setup for multisig wallets, including step-by-step instructions and PDF backup sheet
- Test signing with all hardware signers
- Collaborative wallet management including chat and PSBT sharing via nostr and label synchronization between trusted devices
- Optional custom nostr server
-
Upcoming Features
- For the 2.0 Release
- Compact Block Filters by default
- Compact Block Filters are fast and private
- Compact Block Filters (bdk) are being worked on, and will be included in bdk 1.1. For now RPC, Electrum and Esplora are available, but will be replaced completely with Compact Block Filters.
- Compact Block Filters by default
- For the 2.0 Release
Installation from Git repository
Ubuntu, Debian, Windows
Install dependencies:
sudo apt install qt6-tools-dev-tools libqt6*
-
Install
poetry
and runbitcoin_safe
git clone https://github.com/andreasgriffin/bitcoin-safe.git cd bitcoin-safe pip install poetry && poetry install && poetry run python -m bitcoin_safe
Mac
-
Run
bitcoin_safe
git clone https://github.com/andreasgriffin/bitcoin-safe.git cd bitcoin-safe python3 -m pip install poetry && python3 -m poetry install && python3 -m poetry run python3 -m bitcoin_safe
-
Optional: dependency
zbar
xcode-select --install /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" brew install zbar
Development
- Run the precommit manually for debugging
poetry run pre-commit run --all-files
Regtest docker environement with electrs and mempool
- install docker
# see https://docs.docker.com/engine/install/ubuntu/
- setting up a regtest environment in docker + mempool instance
curl https://getnigiri.vulpem.com | sudo bash # see https://nigiri.vulpem.com/#install
sudo nigiri start
xdg-open http://localhost:5000/
- This creates
- esplora localhost:3000 electrs localhost:50000
- and a gui block explorer at http://localhost:5000
- Setup mempool instance
sudo apt install docker-compose
git clone https://github.com/ngutech21/nigiri-mempool.git
pushd nigiri-mempool
sudo docker-compose up -d
sleep 10
# this is needed because the database needs time to start up
sudo docker-compose up -d
popd
xdg-open http://localhost:8080/
# if the mempool is endlessly loading, then get the debug output with
sudo docker-compose logs -f mempool-api
- this opens a mempool at http://localhost:8080/
Control the Regtest environment
- get coins to an address
nigiri rpc generatetoaddress 1 bcrt1qgsnt3d4sny4w4zd5zl9x6jufc5rankqmgphyms9vz0ds73q4xfms655y4c # mine blocks
# or use the internal faucet
nigiri faucet bcrt1qgsnt3d4sny4w4zd5zl9x6jufc5rankqmgphyms9vz0ds73q4xfms655y4c 0.01
-
Installation from PyPi
Ubuntu, Debian, Windows
-
Install
poetry
and runbitcoin_safe
pip install bitcoin-safe python -m bitcoin_safe
Mac
-
Run
bitcoin_safe
python3 -m pip install bitcoin-safe python3 -m bitcoin_safe
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bitcoin_safe-1.0.0b4.tar.gz
(3.6 MB
view details)
Built Distribution
File details
Details for the file bitcoin_safe-1.0.0b4.tar.gz
.
File metadata
- Download URL: bitcoin_safe-1.0.0b4.tar.gz
- Upload date:
- Size: 3.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.9 Linux/6.8.0-48-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0906650776be5f08eb17f11a5dc994f973260b2bfe960722818999c49a77c263 |
|
MD5 | 8e58fe6cfa20aadab346c3480c6af54e |
|
BLAKE2b-256 | 82200a0095fd2bf91ca825e12b54cc4c3e66fa29efb53b1a5f5bf8fad21a5cfb |
File details
Details for the file bitcoin_safe-1.0.0b4-py3-none-any.whl
.
File metadata
- Download URL: bitcoin_safe-1.0.0b4-py3-none-any.whl
- Upload date:
- Size: 3.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.9 Linux/6.8.0-48-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc72c3b12de3ba8d2b1cf418c4463543d7e8d423d2d6310dfc014149a86fa70d |
|
MD5 | f7a86d4aa6f39cac75be536136c34a8e |
|
BLAKE2b-256 | 41ef5f1cfac7bf275073a0eaa3726ad0679d0ff8ff10b6fa5e15ad037142e2e2 |