Skip to content

v0.1.0-alpha - The Genesis Release

Pre-release
Pre-release

Choose a tag to compare

@djschnei21 djschnei21 released this 16 Jan 14:07
· 36 commits to main since this release

Overview

A HashiCorp Vault secrets engine for Bitcoin custodial operations. Features a lightweight Electrum-based backend (no full node required), modern Taproot by default, and secure signing workflows from simple sends to multi-sig coordination.

Features

Wallet Management

  • HD Wallets — BIP84/BIP86 hierarchical deterministic wallets with secure seed storage in Vault
  • Taproot Default — bc1p... (P2TR) addresses with Schnorr signatures, or bc1q... (P2WPKH)
  • Address Reuse Prevention — Automatic tracking of spent addresses

Transactions

  • Simple Send — Single API call to create, sign, and broadcast transactions
  • Fee Estimation — dry_run=true to preview fees before committing
  • Max Send — max_send=true to sweep all funds minus fee
  • UTXO Management — List, filter, and consolidate UTXOs

Advanced Workflows

  • PSBT Signing — Sign PSBTs created by external wallets (Sparrow, Caravan, etc.)
  • Multi-Sig Support — Participate as one signer in P2WSH, P2SH-P2WSH, or Taproot multi-sig
  • Watch-Only Coordination — Export xpubs for watch-only wallet setups
  • QR Codes — Generate receive address QR codes (PNG or ASCII)

Operations

  • Multi-Network — Mainnet, Testnet4, and Signet support
  • Automatic Reconnection — Graceful recovery from stale Electrum connections
  • Address Scanning — Find funds on retired or gap addresses
  • Compaction — Clean up spent address records

Alpha Notice

This is an alpha release intended for testing and development. Do not use with mainnet funds you cannot afford to lose.

Known limitations:

  • No hardware wallet integration
  • Single-account wallets only (no multi-account support yet)
  • Fee estimation relies on user-provided fee rate (no mempool-based estimation)

Documentation

See https://github.com/djschnei21/vault-plugin-btc/blob/main/README.md for full API documentation with CLI examples.