Skip to content

Add BIP-329 wallet label support #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Musab1258 opened this issue May 10, 2025 · 0 comments
Open

Add BIP-329 wallet label support #184

Musab1258 opened this issue May 10, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@Musab1258
Copy link

Describe the enhancement

This enhancement aims to integrate BIP-329 ("Wallet Labels Export Format") support into bdk-cli. This will allow users to:

  1. Set and manage human-readable labels for wallet items such as transactions (TXIDs), addresses, and UTXOs (outputs).
  2. Import labels from other BIP-329 compliant wallets or previously exported bdk-cli label files.
  3. Export labels in the standard BIP-329 JSONL format for backup or use in other compatible wallet software.
  4. View these labels alongside relevant items in existing bdk-cli list commands (e.g., transactions, unspent).

The implementation will leverage the external bip329 crate for parsing, managing, and persisting label data in a separate .jsonl file (e.g., <wallet_name>.labels.jsonl) within the wallet's data directory.

Use case

Users of bdk-cli will benefit from this feature in several ways:

  • Improved Wallet Management: Instead of relying solely on cryptic identifiers (TXIDs, long addresses), users can add descriptive labels (e.g., "Payment from Steve," "Savings Address," "Coinjoin UTXO"). This significantly improves transaction history comprehension and overall wallet organization.
  • Enhanced Interoperability: By adhering to the BIP-329 standard, users can easily migrate their label data to or from other Bitcoin wallets that support this BIP, reducing vendor lock-in and improving the portability of their wallet metadata.
  • Better Record Keeping: Labels provide context for financial activities, which can be useful for personal accounting or tax purposes.
  • Streamlined Debugging/Testing: Developers using bdk-cli to test BDK applications can label specific test transactions or UTXOs for easier identification and tracking.

Additional context

@Musab1258 Musab1258 added the enhancement New feature or request label May 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

1 participant