bitcoindevkit/bdk-dart
Vedi su GitHubdocs: add dartdoc comments to core public API classes
Open
#75 aperta il 2 giu 2026
documentationgood first issue
Metriche repository
- Star
- (11 star)
- Metriche merge PR
- (Metriche PR in attesa)
Descrizione
The generated lib/bdk.dart file exposes the full BDK API surface to Dart consumers but currently has no dartdoc comments on any of its public classes or methods. This means:
dart docproduces empty or near-empty documentation pages- pub.dev shows no API docs, which affects package scoring
- Developers have no in-editor guidance on usage, disposal, thread safety, or error handling
At a minimum, the following classes should have documented:
Wallet— lifecycle, persistence, and disposal expectationsDescriptor— construction patterns and supported script typesMnemonic— entropy, wordcount, and language optionsElectrumClient/EsploraClient— connection setup and async behaviourTransaction/Psbt— building, signing, and broadcasting flow- Exception types — there are 360+ exception classes; at least the common ones should explain when they're thrown
Since lib/bdk.dart is generated by UniFFI, the docs may need to be injected via UDL annotations or a post-generation script rather than edited directly.