Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreasgriffin/bitcoin-safe
A Bitcoin Wallet for the entire Family
https://github.com/andreasgriffin/bitcoin-safe
Last synced: about 2 months ago
JSON representation
A Bitcoin Wallet for the entire Family
- Host: GitHub
- URL: https://github.com/andreasgriffin/bitcoin-safe
- Owner: andreasgriffin
- License: other
- Created: 2023-05-06T17:34:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-26T14:56:29.000Z (about 2 months ago)
- Last Synced: 2024-07-26T19:34:44.956Z (about 2 months ago)
- Language: Python
- Size: 25.2 MB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
- awesome-bdk - Bitcoin Safe
README
# Bitcoin Safe
#### Long-term Bitcoin savings made Easy
#### ⚠️ Currently ALPHA -- Use only on regtest / testnet / signet ⚠️
## Features
- **Easy** Multisig-Wallet Setup
- Step-by-Step instructions with a PDF backup sheet
- test signing with all hardware signer
- **Simpler** address labels by using categories (e.g. "KYC", "Non-KYC", "Work", "Friends", ...)
- Automatic coin selection within categories
- **Sending** for non-technical users
- 1-click fee selection
- Automatic merging of small utxos when fees are low
- **Collaborative**:
- Wallet chat and sharing of PSBTs (via nostr)
- Label synchronization between trusted devices (via nostr)
- **Multi-Language**:
- 🇺🇸 English, 🇨🇳 Chinese - 简体中文, 🇪🇸 Spanish - español de España, 🇯🇵 Japanese - 日本語, 🇷🇺 Russian - русский, 🇵🇹 Portuguese - português europeu, 🇮🇳 Hindi - हिन्दी, Arabic - العربية, (more upon request)
- **Fast**:
- Electrum server connectivity
- planned upgrade to **Compact Block Filters** for the Bitcoin Safe 2.0 release
- **Secure**: No seed generation or storage (on mainnet).
- A hardware signer/signing device for safe seed storage is needed (storing seeds on a computer is reckless)
- Powered by **[BDK](https://github.com/bitcoindevkit/bdk)**
## Preview
##### Sending
##### Setup a multisig wallet
##### PSBT sharing with trusted devices
##### Label Synchronization with trusted devices
##### Easy search across wallets
## Full Features List
- **Connectivity Features**
- Electrum Servers
- Esplora Server
- RPC Bitcoin Node
- **Import and Export Capabilities**
- CSV export for all lists
- Label import and export using [BIP329](https://bip329.org/)
- Label import from Electrum wallet
- Drag and drop for Transactions, PSBTs, and CSV files
- **Wallet Features**
- Encrypted wallet storage
- Backup PDF with Descriptor (Text and QR code)
- Simplified address labeling using categories like KYC, Non-KYC, Work, Friends
- **Hardware Signer Connectivity**
- MicroSD (files)
- USB
- QR codes
- Animated QR codes including [BBQr](https://bbqr.org/) 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 - العربية, (more upon request)
- **Transaction / PSBT Creation**
- 1-click fee selection and mempool block preview
- Automatic merging of small 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)](https://github.com/bitcoindevkit/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
- **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](https://github.com/bitcoindevkit/bdk/issues/679), 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.
#### TODOs for beta release
- [ ] Add more pytests
## Installation from Git repository
### Ubuntu, Debian, Windows
- Install `poetry` and run `bitcoin_safe`
```sh
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`
```sh
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`
```sh
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
```shell
poetry run pre-commit run --all-files
```
#### Regtest docker environement with electrs and mempool
* install docker
```shell
# see https://docs.docker.com/engine/install/ubuntu/
```
* setting up a regtest environment in docker + mempool instance
```shell
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
```shell
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
```shell
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 run `bitcoin_safe`
```sh
pip install bitcoin-safe
python -m bitcoin_safe
```
### Mac
- Run `bitcoin_safe`
```sh
python3 -m pip install bitcoin-safe
python3 -m bitcoin_safe
```